Make the request tracing enableable

ste93cry · ste93cry · commit 39891a447d9c · 2021-02-27T02:46:16.000+01:00
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -11,7 +11,7 @@ parameters:
 			path: src/DependencyInjection/Configuration.php
 
 		-
-			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:end\\(\\)\\.$#"
+			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:arrayNode\\(\\)\\.$#"
 			count: 1
 			path: src/DependencyInjection/Configuration.php
 
@@ -106,17 +106,17 @@ parameters:
 			path: src/aliases.php
 
 		-
-			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterResponseEvent not found\\.$#"
+			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterControllerEvent not found\\.$#"
 			count: 1
 			path: src/aliases.php
 
 		-
-			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\PostResponseEvent not found\\.$#"
+			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterResponseEvent not found\\.$#"
 			count: 1
 			path: src/aliases.php
 
 		-
-			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterControllerEvent not found\\.$#"
+			message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\PostResponseEvent not found\\.$#"
 			count: 1
 			path: src/aliases.php
 
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -153,6 +153,9 @@ private function addDistributedTracingSection(ArrayNodeDefinition $rootNode): vo
                 ->arrayNode('tracing')
                     ->addDefaultsIfNotSet()
                     ->children()
+                        ->arrayNode('request')
+                            ->canBeEnabled()
+                        ->end()
                         ->arrayNode('dbal')
                             ->canBeEnabled()
                             ->fixXmlConfig('connection')
diff --git a/src/DependencyInjection/SentryExtension.php b/src/DependencyInjection/SentryExtension.php
@@ -16,6 +16,8 @@
 use Sentry\Options;
 use Sentry\SentryBundle\EventListener\ErrorListener;
 use Sentry\SentryBundle\EventListener\MessengerListener;
+use Sentry\SentryBundle\EventListener\TracingRequestListener;
+use Sentry\SentryBundle\EventListener\TracingSubRequestListener;
 use Sentry\SentryBundle\SentryBundle;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
@@ -62,8 +64,9 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $this->registerConfiguration($container, $mergedConfig);
         $this->registerErrorListenerConfiguration($container, $mergedConfig);
         $this->registerMessengerListenerConfiguration($container, $mergedConfig['messenger']);
-        $this->registerTracingConfiguration($container, $mergedConfig['tracing']);
-        $this->registerTracingTwigExtensionConfiguration($container, $mergedConfig['tracing']);
+        $this->registerRequestTracingConfigurtion($container, $mergedConfig['tracing']);
+        $this->registerDbalTracingConfiguration($container, $mergedConfig['tracing']);
+        $this->registerTwigTracingConfiguration($container, $mergedConfig['tracing']);
     }
 
     /**
@@ -159,7 +162,20 @@ private function registerMessengerListenerConfiguration(ContainerBuilder $contai
     /**
      * @param array<string, mixed> $config
      */
-    private function registerTracingConfiguration(ContainerBuilder $container, array $config): void
+    private function registerRequestTracingConfigurtion(ContainerBuilder $container, array $config): void
+    {
+        $isConfigEnabled = $this->isConfigEnabled($container, $config['request']);
+
+        if (!$isConfigEnabled) {
+            $container->removeDefinition(TracingRequestListener::class);
+            $container->removeDefinition(TracingSubRequestListener::class);
+        }
+    }
+
+    /**
+     * @param array<string, mixed> $config
+     */
+    private function registerDbalTracingConfiguration(ContainerBuilder $container, array $config): void
     {
         $isConfigEnabled = $this->isConfigEnabled($container, $config['dbal']);
 
@@ -178,7 +194,7 @@ private function registerTracingConfiguration(ContainerBuilder $container, array
     /**
      * @param array<string, mixed> $config
      */
-    private function registerTracingTwigExtensionConfiguration(ContainerBuilder $container, array $config): void
+    private function registerTwigTracingConfiguration(ContainerBuilder $container, array $config): void
     {
         $isConfigEnabled = $this->isConfigEnabled($container, $config['twig']);
 
diff --git a/src/Resources/config/schema/sentry-1.0.xsd b/src/Resources/config/schema/sentry-1.0.xsd
@@ -83,11 +83,16 @@
 
     <xsd:complexType name="tracing">
         <xsd:choice maxOccurs="unbounded">
+            <xsd:element name="request" type="tracing-request" minOccurs="0" maxOccurs="1" />
             <xsd:element name="dbal" type="tracing-dbal" minOccurs="0" maxOccurs="1" />
             <xsd:element name="twig" type="tracing-twig" minOccurs="0" maxOccurs="1" />
         </xsd:choice>
     </xsd:complexType>
 
+    <xsd:complexType name="tracing-request">
+        <xsd:attribute name="enabled" type="xsd:boolean" />
+    </xsd:complexType>
+
     <xsd:complexType name="tracing-dbal">
         <xsd:sequence maxOccurs="unbounded">
             <xsd:element name="connection" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -37,6 +37,9 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
                 'capture_soft_fails' => true,
             ],
             'tracing' => [
+                'request' => [
+                    'enabled' => false,
+                ],
                 'dbal' => [
                     'enabled' => false,
                     'connections' => class_exists(DoctrineBundle::class) ? ['%doctrine.default_connection%'] : [],
diff --git a/tests/DependencyInjection/Fixtures/php/full.php b/tests/DependencyInjection/Fixtures/php/full.php
@@ -43,6 +43,9 @@
         'capture_soft_fails' => false,
     ],
     'tracing' => [
+        'request' => [
+            'enabled' => false,
+        ],
         'dbal' => [
             'enabled' => false,
             'connections' => ['default'],
diff --git a/tests/DependencyInjection/Fixtures/php/request_tracing_enabled.php b/tests/DependencyInjection/Fixtures/php/request_tracing_enabled.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/** @var ContainerBuilder $container */
+$container->loadFromExtension('sentry', [
+    'tracing' => [
+        'request' => [
+            'enabled' => true,
+        ],
+    ],
+]);
diff --git a/tests/DependencyInjection/Fixtures/xml/full.xml b/tests/DependencyInjection/Fixtures/xml/full.xml
@@ -38,6 +38,7 @@
         </sentry:options>
         <sentry:messenger enabled="true" capture-soft-fails="false" />
         <sentry:tracing>
+            <sentry:request enabled="false" />
             <sentry:dbal enabled="false">
                 <sentry:connection>default</sentry:connection>
             </sentry:dbal>
diff --git a/tests/DependencyInjection/Fixtures/xml/request_tracing_enabled.xml b/tests/DependencyInjection/Fixtures/xml/request_tracing_enabled.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xmlns:sentry="https://sentry.io/schema/dic/sentry-symfony"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+                               https://sentry.io/schema/dic/sentry-symfony https://sentry.io/schema/dic/sentry-symfony/sentry-1.0.xsd">
+
+    <sentry:config>
+        <sentry:tracing>
+            <sentry:request enabled="true" />
+        </sentry:tracing>
+    </sentry:config>
+</container>
diff --git a/tests/DependencyInjection/Fixtures/yml/full.yml b/tests/DependencyInjection/Fixtures/yml/full.yml
@@ -38,9 +38,11 @@ sentry:
         enabled: true
         capture_soft_fails: false
     tracing:
+        request:
+            enabled: false
         dbal:
             enabled: false
             connections:
-                - enabled
+                - default
         twig:
             enabled: false
diff --git a/tests/DependencyInjection/Fixtures/yml/request_tracing_enabled.yml b/tests/DependencyInjection/Fixtures/yml/request_tracing_enabled.yml
@@ -0,0 +1,4 @@
+sentry:
+    tracing:
+        request:
+            enabled: true
diff --git a/tests/DependencyInjection/SentryExtensionTest.php b/tests/DependencyInjection/SentryExtensionTest.php
@@ -16,6 +16,8 @@
 use Sentry\SentryBundle\EventListener\MessengerListener;
 use Sentry\SentryBundle\EventListener\RequestListener;
 use Sentry\SentryBundle\EventListener\SubRequestListener;
+use Sentry\SentryBundle\EventListener\TracingRequestListener;
+use Sentry\SentryBundle\EventListener\TracingSubRequestListener;
 use Sentry\SentryBundle\SentryBundle;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
@@ -265,6 +267,22 @@ public function testIgnoreErrorsIntegrationIsNotAddedTwiceIfAlreadyConfigured():
         $this->assertSame(1, $ignoreErrorsIntegrationsCount);
     }
 
+    public function testRequestTracingEventListenersAreConfiguredWhenRequestTracingIsEnabled(): void
+    {
+        $container = $this->createContainerFromFixture('request_tracing_enabled');
+
+        $this->assertTrue($container->hasDefinition(TracingRequestListener::class));
+        $this->assertTrue($container->hasDefinition(TracingSubRequestListener::class));
+    }
+
+    public function testRequestTracingEventListenersAreRemovedWhenRequestTracingIsDisabled(): void
+    {
+        $container = $this->createContainerFromFixture('full');
+
+        $this->assertFalse($container->hasDefinition(TracingRequestListener::class));
+        $this->assertFalse($container->hasDefinition(TracingSubRequestListener::class));
+    }
+
     public function testTracingDriverMiddlewareIsConfiguredWhenDbalTracingIsEnable(): void
     {
         if (!class_exists(DoctrineBundle::class)) {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ parameters:`
`11`	`11`	`path: src/DependencyInjection/Configuration.php`
`12`	`12`
`13`	`13`	`-`
`14`		`- message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:end\\(\\)\\.$#"`
	`14`	`+ message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:arrayNode\\(\\)\\.$#"`
`15`	`15`	`count: 1`
`16`	`16`	`path: src/DependencyInjection/Configuration.php`
`17`	`17`
`@@ -106,17 +106,17 @@ parameters:`
`106`	`106`	`path: src/aliases.php`
`107`	`107`
`108`	`108`	`-`
`109`		`- message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterResponseEvent not found\\.$#"`
	`109`	`+ message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterControllerEvent not found\\.$#"`
`110`	`110`	`count: 1`
`111`	`111`	`path: src/aliases.php`
`112`	`112`
`113`	`113`	`-`
`114`		`- message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\PostResponseEvent not found\\.$#"`
	`114`	`+ message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterResponseEvent not found\\.$#"`
`115`	`115`	`count: 1`
`116`	`116`	`path: src/aliases.php`
`117`	`117`
`118`	`118`	`-`
`119`		`- message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\FilterControllerEvent not found\\.$#"`
	`119`	`+ message: "#^Class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\PostResponseEvent not found\\.$#"`
`120`	`120`	`count: 1`
`121`	`121`	`path: src/aliases.php`
`122`	`122`