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

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 (self::$instance === null) {
  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 = [];
  54. $installed = [];
  56. foreach ($this->getIntegrationsToSetup($options) as $integration) {
  57. $integrationName = \get_class($integration);
  59. $integrations[$integrationName] = $integration;
  61. if ($this->setupIntegration($integration, $options)) {
  62. $installed[] = $integrationName;
  63. }
  64. }
  66. if (\count($installed) > 0) {
  67. $logger->debug(\sprintf('The "%s" integration(s) have been installed.', implode(', ', $installed)));
  68. }
  70. return $integrations;
  71. }
  73. private function setupIntegration(IntegrationInterface $integration, Options $options): bool
  74. {
  75. $integrationName = \get_class($integration);
  77. if (isset($this->integrations[$integrationName])) {
  78. return false;
  79. }
  81. if ($integration instanceof OptionAwareIntegrationInterface) {
  82. $integration->setOptions($options);
  83. }
  85. $integration->setupOnce();
  87. $this->integrations[$integrationName] = true;
  89. return true;
  90. }
  92. /**
  93. * @return IntegrationInterface[]
  94. */
  95. private function getIntegrationsToSetup(Options $options): array
  96. {
  97. $integrations = [];
  98. $defaultIntegrations = $this->getDefaultIntegrations($options);
  99. $userIntegrations = $options->getIntegrations();
  101. if (\is_array($userIntegrations)) {
  102. $userIntegrationsClasses = array_map('get_class', $userIntegrations);
  103. $pickedIntegrationsClasses = [];
  105. foreach ($defaultIntegrations as $defaultIntegration) {
  106. $integrationClassName = \get_class($defaultIntegration);
  108. if (!\in_array($integrationClassName, $userIntegrationsClasses, true) && !isset($pickedIntegrationsClasses[$integrationClassName])) {
  109. $integrations[] = $defaultIntegration;
  110. $pickedIntegrationsClasses[$integrationClassName] = true;
  111. }
  112. }
  114. foreach ($userIntegrations as $userIntegration) {
  115. $integrationClassName = \get_class($userIntegration);
  117. if (!isset($pickedIntegrationsClasses[$integrationClassName])) {
  118. $integrations[] = $userIntegration;
  119. $pickedIntegrationsClasses[$integrationClassName] = true;
  120. }
  121. }
  122. } else {
  123. $integrations = $userIntegrations($defaultIntegrations);
  125. if (!\is_array($integrations)) {
  126. throw new \UnexpectedValueException(\sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', get_debug_type($integrations)));
  127. }
  128. }
  130. return $integrations;
  131. }
  133. /**
  134. * @return IntegrationInterface[]
  135. */
  136. private function getDefaultIntegrations(Options $options): array
  137. {
  138. if (!$options->hasDefaultIntegrations()) {
  139. return [];
  140. }
  142. $integrations = [
  143. new RequestIntegration(),
  144. new TransactionIntegration(),
  145. new FrameContextifierIntegration(),
  146. new EnvironmentIntegration(),
  147. new ModulesIntegration(),
  148. ];
  150. if ($options->getDsn() !== null || $options->isSpotlightEnabled()) {
  151. array_unshift($integrations, new ExceptionListenerIntegration(), new ErrorListenerIntegration(), new FatalErrorListenerIntegration());
  152. }
  154. return $integrations;
  155. }
  156. }