Merge pull request #196 from getsentry/add-integrations

Add integrations

Author: Jean85

src/DependencyInjection/Configuration.php

@@ -83,7 +83,20 @@ public function getConfigTreeBuilder()
             ->end()
             ->scalarNode('http_proxy')
             ->end()
-            // TODO -- integrations
+            ->arrayNode('integrations')
+                ->prototype('scalar')
+                    ->validate()
+                        ->ifTrue(function ($value): bool {
+                            if (! is_string($value)) {
+                                return true;
+                            }
+
+                            return '@' !== substr($value, 0, 1);
+                        })
+                    ->thenInvalid('Expecting service reference, got %s')
+                    ->end()
+                ->end()
+            ->end()
             ->scalarNode('logger')
             ->end()
             ->integerNode('max_breadcrumbs')

src/DependencyInjection/SentryExtension.php

@@ -94,6 +94,15 @@ private function passConfigurationToOptions(ContainerBuilder $container, array $
         if (\array_key_exists('before_breadcrumb', $processedOptions)) {
             $this->mapCallableValue($options, 'setBeforeBreadcrumbCallback', $processedOptions['before_breadcrumb']);
         }
+
+        if (\array_key_exists('integrations', $processedOptions)) {
+            $integrations = [];
+            foreach ($processedOptions['integrations'] as $integrationName) {
+                $integrations[] = new Reference(substr($integrationName, 1));
+            }
+
+            $options->addMethodCall('setIntegrations', [$integrations]);
+        }
     }
 
     /**

test/DependencyInjection/ConfigurationTest.php

@@ -11,7 +11,7 @@
 
 class ConfigurationTest extends TestCase
 {
-    public const SUPPORTED_SENTRY_OPTIONS_COUNT = 22;
+    public const SUPPORTED_SENTRY_OPTIONS_COUNT = 23;
 
     public function testDataProviderIsMappingTheRightNumberOfOptions(): void
     {
@@ -53,6 +53,7 @@ public function testConfigurationDefaults(): void
                     '%kernel.cache_dir%',
                     '%kernel.root_dir%/../vendor',
                 ],
+                'integrations' => $defaultSdkValues->getIntegrations(),
                 'excluded_exceptions' => $defaultSdkValues->getExcludedExceptions(),
                 'prefixes' => $defaultSdkValues->getPrefixes(),
                 'project_root' => '%kernel.root_dir%/..',
@@ -95,6 +96,7 @@ public function optionValuesProvider(): array
             ['error_types', E_ALL],
             ['http_proxy', '1.2.3.4:5678'],
             ['in_app_exclude', ['some/path']],
+            ['integrations', []],
             ['excluded_exceptions', [\Throwable::class]],
             ['logger', 'some-logger'],
             ['max_breadcrumbs', 15],
@@ -144,9 +146,11 @@ public function invalidValuesProvider(): array
             ['enable_compression', 'string'],
             ['environment', ''],
             ['error_types', []],
+            ['excluded_exceptions', 'some-string'],
             ['http_proxy', []],
             ['in_app_exclude', 'some/single/path'],
-            ['excluded_exceptions', 'some-string'],
+            ['integrations', [1]],
+            ['integrations', 'a string'],
             ['logger', []],
             ['max_breadcrumbs', -1],
             ['max_breadcrumbs', 'string'],

test/DependencyInjection/SentryExtensionTest.php

@@ -5,6 +5,7 @@
 use PHPUnit\Framework\TestCase;
 use Sentry\Breadcrumb;
 use Sentry\Event;
+use Sentry\Integration\IntegrationInterface;
 use Sentry\Options;
 use Sentry\SentryBundle\DependencyInjection\SentryExtension;
 use Sentry\SentryBundle\EventListener\ConsoleListener;
@@ -28,8 +29,9 @@ public function testDataProviderIsMappingTheRightNumberOfOptions(): void
         $providerData = $this->optionsValueProvider();
         $supportedOptions = \array_unique(\array_column($providerData, 0));
 
+        // subtracted one is `integration`, which cannot be tested with the provider
         $this->assertCount(
-            ConfigurationTest::SUPPORTED_SENTRY_OPTIONS_COUNT,
+            ConfigurationTest::SUPPORTED_SENTRY_OPTIONS_COUNT - 1,
             $supportedOptions,
             'Provider for configuration options mismatch: ' . PHP_EOL . print_r($supportedOptions, true)
         );
@@ -281,6 +283,19 @@ public function testBeforeBreadcrumbWithInvalidServiceReference(): void
         $this->getOptionsFrom($container)->getBeforeBreadcrumbCallback();
     }
 
+    public function testIntegrations(): void
+    {
+        $container = $this->getContainer([
+            'options' => [
+                'integrations' => ['@integration_mock'],
+            ],
+        ]);
+
+        $integrations = $this->getOptionsFrom($container)->getIntegrations();
+        $this->assertContainsOnlyInstancesOf(IntegrationMock::class, $integrations);
+        $this->assertCount(1, $integrations);
+    }
+
     private function getContainer(array $configuration = []): Container
     {
         $containerBuilder = new ContainerBuilder();
@@ -291,11 +306,9 @@ private function getContainer(array $configuration = []): Container
         }
         $containerBuilder->setParameter('kernel.environment', 'test');
 
-        $mockEventDispatcher = $this
-            ->createMock(EventDispatcherInterface::class);
+        $mockEventDispatcher = $this->createMock(EventDispatcherInterface::class);
 
-        $mockRequestStack = $this
-            ->createMock(RequestStack::class);
+        $mockRequestStack = $this->createMock(RequestStack::class);
 
         $containerBuilder->set('request_stack', $mockRequestStack);
         $containerBuilder->set('event_dispatcher', $mockEventDispatcher);
@@ -307,6 +320,9 @@ private function getContainer(array $configuration = []): Container
         $beforeSend->setFactory([CallbackMock::class, 'createCallback']);
         $containerBuilder->setDefinition('callable_mock', $beforeSend);
 
+        $integration = new Definition(IntegrationMock::class);
+        $containerBuilder->setDefinition('integration_mock', $integration);
+
         $extension = new SentryExtension();
         $extension->load(['sentry' => $configuration], $containerBuilder);
 
@@ -348,3 +364,10 @@ public static function createCallback(): callable
         return [new self(), 'callback'];
     }
 }
+
+class IntegrationMock implements IntegrationInterface
+{
+    public function setupOnce(): void
+    {
+    }
+}