vendor/sentry/sentry/src/Integration/IntegrationRegistry.php line 58

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\Integration;
  7. use Psr\Log\LoggerInterface;
  8. use Sentry\Options;
  10. /**
  11. * @internal
  12. */
  13. final class IntegrationRegistry
  14. {
  15. /**
  16. * @var self|null The current instance
  17. */
  18. private static $instance;
  20. /**
  21. * @var array<class-string<IntegrationInterface>, bool> The registered integrations
  22. */
  23. private $integrations = [];
  25. private function __construct()
  26. {
  27. }
  29. /**
  30. * Gets the current singleton instance or creates a new one if it didn't
  31. * exists yet.
  32. */
  33. public static function getInstance(): self
  34. {
  35. if (null === self::$instance) {
  36. self::$instance = new self();
  37. }
  39. return self::$instance;
  40. }
  42. /**
  43. * Setups the integrations according to the given options. For each integration
  44. * the {@see IntegrationInterface::setupOnce()} method will be called only once
  45. * during the application lifetime.
  46. *
  47. * @param Options $options The SDK client options
  48. *
  49. * @return array<class-string<IntegrationInterface>, IntegrationInterface>
  50. */
  51. public function setupIntegrations(Options $options, LoggerInterface $logger): array
  52. {
  53. $integrations = [];
  55. foreach ($this->getIntegrationsToSetup($options) as $integration) {
  56. $integrations[\get_class($integration)] = $integration;
  58. $this->setupIntegration($integration, $logger);
  59. }
  61. return $integrations;
  62. }
  64. private function setupIntegration(IntegrationInterface $integration, LoggerInterface $logger): void
  65. {
  66. $integrationName = \get_class($integration);
  68. if (isset($this->integrations[$integrationName])) {
  69. return;
  70. }
  72. $integration->setupOnce();
  74. $this->integrations[$integrationName] = true;
  76. $logger->debug(sprintf('The "%s" integration has been installed.', $integrationName));
  77. }
  79. /**
  80. * @return IntegrationInterface[]
  81. */
  82. private function getIntegrationsToSetup(Options $options): array
  83. {
  84. $integrations = [];
  85. $defaultIntegrations = $this->getDefaultIntegrations($options);
  86. $userIntegrations = $options->getIntegrations();
  88. if (\is_array($userIntegrations)) {
  89. $userIntegrationsClasses = array_map('get_class', $userIntegrations);
  90. $pickedIntegrationsClasses = [];
  92. foreach ($defaultIntegrations as $defaultIntegration) {
  93. $integrationClassName = \get_class($defaultIntegration);
  95. if (!\in_array($integrationClassName, $userIntegrationsClasses, true) && !isset($pickedIntegrationsClasses[$integrationClassName])) {
  96. $integrations[] = $defaultIntegration;
  97. $pickedIntegrationsClasses[$integrationClassName] = true;
  98. }
  99. }
  101. foreach ($userIntegrations as $userIntegration) {
  102. $integrationClassName = \get_class($userIntegration);
  104. if (!isset($pickedIntegrationsClasses[$integrationClassName])) {
  105. $integrations[] = $userIntegration;
  106. $pickedIntegrationsClasses[$integrationClassName] = true;
  107. }
  108. }
  109. } else {
  110. $integrations = $userIntegrations($defaultIntegrations);
  112. if (!\is_array($integrations)) {
  113. throw new \UnexpectedValueException(sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', get_debug_type($integrations)));
  114. }
  115. }
  117. return $integrations;
  118. }
  120. /**
  121. * @return IntegrationInterface[]
  122. */
  123. private function getDefaultIntegrations(Options $options): array
  124. {
  125. if (!$options->hasDefaultIntegrations()) {
  126. return [];
  127. }
  129. $integrations = [
  130. new RequestIntegration(),
  131. new TransactionIntegration(),
  132. new FrameContextifierIntegration(),
  133. new EnvironmentIntegration(),
  134. new ModulesIntegration(),
  135. ];
  137. if (null !== $options->getDsn()) {
  138. array_unshift($integrations, new ExceptionListenerIntegration(), new ErrorListenerIntegration(), new FatalErrorListenerIntegration());
  139. }
  141. return $integrations;
  142. }
  143. }