Add ability to disable ErrorListener

Author: HypeMC

src/DependencyInjection/Configuration.php

@@ -37,6 +37,10 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->ifString()
             ->then($this->getTrimClosure());
 
+        $rootNode->children()
+            ->booleanNode('register_error_listener')
+            ->defaultTrue();
+
         // Options array (to be passed to Sentry\Options constructor) -- please keep alphabetical order!
         $optionsNode = $rootNode->children()
             ->arrayNode('options')

src/DependencyInjection/SentryExtension.php

@@ -47,7 +47,7 @@ public function load(array $configs, ContainerBuilder $container): void
             $container->setParameter('sentry.listener_priorities.' . $key, $priority);
         }
 
-        $this->tagConsoleErrorListener($container);
+        $this->configureErrorListener($container, $processedConfiguration);
         $this->setLegacyVisibilities($container);
     }
 
@@ -134,6 +134,17 @@ private function valueToCallable($value)
         return $value;
     }
 
+    private function configureErrorListener(ContainerBuilder $container, array $processedConfiguration): void
+    {
+        if (! $processedConfiguration['register_error_listener']) {
+            $container->removeDefinition(ErrorListener::class);
+
+            return;
+        }
+
+        $this->tagConsoleErrorListener($container);
+    }
+
     /**
      * BC layer for Symfony < 3.3; see https://symfony.com/blog/new-in-symfony-3-3-better-handling-of-command-exceptions
      */
@@ -166,9 +177,12 @@ private function setLegacyVisibilities(ContainerBuilder $container): void
         if (Kernel::VERSION_ID < 30300) {
             $container->getDefinition(SentryTestCommand::class)->setPublic(true);
             $container->getDefinition(ConsoleListener::class)->setPublic(true);
-            $container->getDefinition(ErrorListener::class)->setPublic(true);
             $container->getDefinition(RequestListener::class)->setPublic(true);
             $container->getDefinition(SubRequestListener::class)->setPublic(true);
+
+            if ($container->hasDefinition(ErrorListener::class)) {
+                $container->getDefinition(ErrorListener::class)->setPublic(true);
+            }
         }
     }
 }

test/DependencyInjection/ConfigurationTest.php

@@ -48,6 +48,7 @@ public function testConfigurationDefaults(): void
         $processed = $this->processConfiguration([]);
         $expectedDefaults = [
             'dsn' => null,
+            'register_error_listener' => true,
             'listener_priorities' => [
                 'request' => 1,
                 'sub_request' => 1,

test/DependencyInjection/SentryExtensionTest.php

@@ -8,6 +8,7 @@
 use Sentry\Integration\IntegrationInterface;
 use Sentry\Options;
 use Sentry\SentryBundle\DependencyInjection\SentryExtension;
+use Sentry\SentryBundle\EventListener\ErrorListener;
 use Sentry\SentryBundle\Test\BaseTestCase;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Container;
@@ -20,6 +21,7 @@
 class SentryExtensionTest extends BaseTestCase
 {
     private const OPTIONS_TEST_PUBLIC_ALIAS = 'sentry.options.public_alias';
+    private const ERROR_LISTENER_TEST_PUBLIC_ALIAS = 'sentry.error_listener.public_alias';
 
     public function testDataProviderIsMappingTheRightNumberOfOptions(): void
     {
@@ -335,6 +337,26 @@ public function testIntegrations(): void
         $this->assertCount(1, $integrations);
     }
 
+    /**
+     * @dataProvider errorListenerConfigurationProvider
+     */
+    public function testErrorListenerIsRegistered(bool $registerErrorListener): void
+    {
+        $container = $this->getContainer([
+            'register_error_listener' => $registerErrorListener,
+        ]);
+
+        $this->assertEquals($registerErrorListener, $container->has(self::ERROR_LISTENER_TEST_PUBLIC_ALIAS));
+    }
+
+    public function errorListenerConfigurationProvider(): array
+    {
+        return [
+            [true],
+            [false],
+        ];
+    }
+
     private function getContainer(array $configuration = []): Container
     {
         $containerBuilder = new ContainerBuilder();
@@ -363,6 +385,10 @@ private function getContainer(array $configuration = []): Container
         $extension = new SentryExtension();
         $extension->load(['sentry' => $configuration], $containerBuilder);
 
+        if ($containerBuilder->hasDefinition(ErrorListener::class)) {
+            $containerBuilder->setAlias(self::ERROR_LISTENER_TEST_PUBLIC_ALIAS, new Alias(ErrorListener::class, true));
+        }
+
         $containerBuilder->compile();
 
         return $containerBuilder;