Remove the listener priorities configuration options (#407)

* Remove the listener priorities configuration options

* Fix CR issues

* Require the PHP8 polyfill only as dev package

Author: ste93cry

.github/workflows/tests.yaml

@@ -53,7 +53,7 @@ jobs:
           php-version: ${{ matrix.php }}
           coverage: xdebug
       - run: |
-          sed -ri '/symfony\/(monolog-bundle|phpunit-bridge|messenger|psr-http-message-bridge)/! s/"symfony\/(.+)": "(.+)"/"symfony\/\1": "'${{ matrix.symfony_constraint }}'"/' composer.json;
+          sed -ri '/symfony\/(monolog-bundle|phpunit-bridge|messenger|psr-http-message-bridge|polyfill-php80)/! s/"symfony\/(.+)": "(.+)"/"symfony\/\1": "'${{ matrix.symfony_constraint }}'"/' composer.json;
         if: matrix.symfony_constraint
       - run: composer remove --dev symfony/messenger --no-update
         if: matrix.symfony_constraint == '3.4.*' || matrix.composer_option == '--prefer-lowest'

CHANGELOG.md

@@ -3,18 +3,19 @@
 ## Unreleased
 
 - Enable back all error listeners from base SDK integration (#322)
-- Added `options.traces_sampler` and `options.traces_sample_rate` configuration options (#385)
-- [BC BREAK] Removed the `options.project_root` configuration option. Instead of setting it, use a combination of `options.in_app_include` and `options.in_app_exclude` (#385)
-- [BC BREAK] Removed the `options.excluded_exceptions` configuration option. Instead of setting it, configure the `IgnoreErrorsIntegration` integration (#385)
-- [BC BREAK] Refactorized the `ConsoleCommandListener`, `ErrorListener`, `RequestListener` and `SubRequestListener` event listeners (#387)
+- Add `options.traces_sampler` and `options.traces_sample_rate` configuration options (#385)
+- [BC BREAK] Remove the `options.project_root` configuration option. Instead of setting it, use a combination of `options.in_app_include` and `options.in_app_exclude` (#385)
+- [BC BREAK] Remove the `options.excluded_exceptions` configuration option. Instead of setting it, configure the `IgnoreErrorsIntegration` integration (#385)
+- [BC BREAK] Refactorize the `ConsoleCommandListener`, `ErrorListener`, `RequestListener` and `SubRequestListener` event listeners (#387)
 - Registered the CLI commands as lazy services (#373)
-- [BC BREAK] Refactorized the configuration tree and the definitions of some container services (#401)
+- [BC BREAK] Refactorize the configuration tree and the definitions of some container services (#401)
 - Support the XML format for the bundle configuration (#401)
 - PHP 8 support (#399, thanks to @Yozhef)
 - Retrieve the request from the `RequestStack` when using the `RequestIntegration` integration (#361)
 - Reorganize the folder structure and change CS standard (#405)
-- [BC BREAK] Removed the `monolog` configuration option. Instead, register the service manually (#406)
-  
+- [BC BREAK] Remove the `monolog` configuration option. Instead, register the service manually (#406)
+- [BC BREAK] Remove the `listener_priorities` configuration option. Instead, use a compiler pass to change the priority of the listeners (#407)
+
 ## 3.5.3 (2020-10-13)
 
 - Refactors and fixes class aliases for more robustness (#315 #359, thanks to @guilliamxavier)

UPGRADE-4.0.md

@@ -11,6 +11,42 @@
 - Renamed the `SubRequestListener::onKernelRequest` method to `SubRequestListener::handleKernelRequestEvent`.
 - Renamed the `SubRequestListener::onKernelFinishRequest` method to `SubRequestListener::handleKernelFinishRequestEvent`.
 - Removed the `Sentry\FlushableClientInterface` service alias.
+- Removed the `sentry.listener_priorities` configuration option.
+
+  Before:
+
+  ```yaml
+  sentry:
+      listener_priorities:
+          request: 10
+  ```
+
+  After:
+
+  ```php
+  use Sentry\SentryBundle\EventListener\RequestListener;
+  use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+  use Symfony\Component\DependencyInjection\ContainerBuilder;
+  use Symfony\Component\HttpKernel\KernelEvents;
+
+  final class ChangeSentryListenerPriorityPass implements CompilerPassInterface
+  {
+      public function process(ContainerBuilder $container)
+      {
+          $definition = $container->getDefinition(RequestListener::class);
+          $definitionTags = $definition->getTags();
+
+          foreach ($definitionTags['kernel.event_listener'] as &$tags) {
+              if (KernelEvents::REQUEST === $tags['event']) {
+                  $tags['priority'] = 10;
+              }
+          }
+
+          $definition->setTags($definitionTags);
+      }
+  }
+  ```
+
 - Removed the `sentry.options.excluded_exceptions` configuration option.
 
   Before:
@@ -38,9 +74,9 @@
                       - RuntimeException
   ```
 
-- Changed the default value of the `sentry.listener_priorities.console_error` configuration option to `-64`.
-- Changed the default value of the `sentry.listener_priorities.console` configuration option to `128`.
-- Changed the default value of the `sentry.listener_priorities.worker_error` configuration option to `50`.
+- Changed the priority of the `ConsoleCommandListener::handleConsoleErrorEvent` listener to `-64`.
+- Changed the priority of the `ConsoleCommandListener::::handleConsoleCommandEvent` listener to `128`.
+- Changed the priority of the `MessengerListener::handleWorkerMessageFailedEvent` listener to `50`.
 - Changed the type of the `sentry.options.before_send` configuration option from `scalar` to `string`. The value must always be the name of the container service to call without the `@` prefix.
 
   Before

composer.json

@@ -46,6 +46,7 @@
         "symfony/messenger": "^4.4.11||^5.0.11",
         "symfony/monolog-bundle": "^3.4",
         "symfony/phpunit-bridge": "^5.0",
+        "symfony/polyfill-php80": "^1.22",
         "symfony/yaml": "^3.4.43||^4.4.11||^5.0.11"
     },
     "suggest": {

phpstan-baseline.neon

@@ -6,8 +6,8 @@ parameters:
 			path: src/DependencyInjection/Configuration.php
 
 		-
-			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:arrayNode\\(\\)\\.$#"
-			count: 2
+			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:booleanNode\\(\\)\\.$#"
+			count: 1
 			path: src/DependencyInjection/Configuration.php
 
 		-

src/DependencyInjection/Configuration.php

@@ -36,6 +36,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->thenUnset()
                     ->end()
                 ->end()
+                ->booleanNode('register_error_listener')->defaultTrue()->end()
                 ->arrayNode('options')
                     ->addDefaultsIfNotSet()
                     ->fixXmlConfig('integration')
@@ -127,7 +128,6 @@ public function getConfigTreeBuilder(): TreeBuilder
         ;
 
         $this->addMessengerSection($rootNode);
-        $this->addListenerSection($rootNode);
 
         return $treeBuilder;
     }
@@ -144,24 +144,4 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode): void
                 ->end()
             ->end();
     }
-
-    private function addListenerSection(ArrayNodeDefinition $rootNode): void
-    {
-        $rootNode
-            ->children()
-                ->booleanNode('register_error_listener')->defaultTrue()->end()
-                ->arrayNode('listener_priorities')
-                    ->addDefaultsIfNotSet()
-                    ->children()
-                        ->scalarNode('request')->defaultValue(1)->end()
-                        ->scalarNode('sub_request')->defaultValue(1)->end()
-                        ->scalarNode('console')->defaultValue(128)->end()
-                        ->scalarNode('request_error')->defaultValue(128)->end()
-                        ->scalarNode('console_error')->defaultValue(-64)->end()
-                        ->scalarNode('console_terminate')->defaultValue(-64)->end()
-                        ->scalarNode('worker_error')->defaultValue(50)->end()
-                    ->end()
-                ->end()
-            ->end();
-    }
 }

src/DependencyInjection/SentryExtension.php

@@ -52,10 +52,6 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');
 
-        foreach ($mergedConfig['listener_priorities'] as $key => $priority) {
-            $container->setParameter('sentry.listener_priorities.' . $key, $priority);
-        }
-
         $this->registerConfiguration($container, $mergedConfig);
         $this->registerErrorListenerConfiguration($container, $mergedConfig);
         $this->registerMessengerListenerConfiguration($container, $mergedConfig['messenger']);

src/EventListener/RequestListener.php

@@ -58,7 +58,7 @@ public function handleKernelRequestEvent(RequestListenerRequestEvent $event): vo
             $token = $this->tokenStorage->getToken();
         }
 
-        if (null !== $token && $token->isAuthenticated() && $token->getUser()) {
+        if (null !== $token && $token->isAuthenticated() && null !== $token->getUser()) {
             $userData->setUsername($this->getUsername($token->getUser()));
         }
 
@@ -91,7 +91,7 @@ public function handleKernelControllerEvent(RequestListenerControllerEvent $even
     }
 
     /**
-     * @param UserInterface | object | string $user
+     * @param UserInterface|object|string $user
      */
     private function getUsername($user): ?string
     {

src/Resources/config/schema/sentry-1.0.xsd

@@ -11,7 +11,6 @@
         <xsd:choice maxOccurs="unbounded">
             <xsd:element name="options" type="options" minOccurs="0" maxOccurs="1" />
             <xsd:element name="messenger" type="messenger" minOccurs="0" maxOccurs="1" />
-            <xsd:element name="listener-priorities" type="listeners-priorities" minOccurs="0" maxOccurs="1" />
         </xsd:choice>
 
         <xsd:attribute name="register-error-listener" type="xsd:boolean" />
@@ -79,14 +78,4 @@
     <xsd:complexType name="messenger">
         <xsd:attribute name="enabled" type="xsd:boolean" />
     </xsd:complexType>
-
-    <xsd:complexType name="listeners-priorities">
-        <xsd:attribute name="request" type="xsd:integer" />
-        <xsd:attribute name="sub-request" type="xsd:integer" />
-        <xsd:attribute name="console" type="xsd:integer" />
-        <xsd:attribute name="request-error" type="xsd:integer" />
-        <xsd:attribute name="console-error" type="xsd:integer" />
-        <xsd:attribute name="console-terminate" type="xsd:integer" />
-        <xsd:attribute name="worker-error" type="xsd:integer" />
-    </xsd:complexType>
 </xsd:schema>

src/Resources/config/services.xml

@@ -26,37 +26,37 @@
         <service id="Sentry\SentryBundle\EventListener\ConsoleCommandListener" class="Sentry\SentryBundle\EventListener\ConsoleCommandListener">
             <argument type="service" id="Sentry\State\HubInterface" />
 
-            <tag name="kernel.event_listener" event="console.command" method="handleConsoleCommandEvent" priority="%sentry.listener_priorities.console%" />
-            <tag name="kernel.event_listener" event="console.terminate" method="handleConsoleTerminateEvent" priority="%sentry.listener_priorities.console_terminate%" />
-            <tag name="kernel.event_listener" event="console.error" method="handleConsoleErrorEvent" priority="%sentry.listener_priorities.console_error%" />
+            <tag name="kernel.event_listener" event="console.command" method="handleConsoleCommandEvent" priority="128" />
+            <tag name="kernel.event_listener" event="console.terminate" method="handleConsoleTerminateEvent" priority="-64" />
+            <tag name="kernel.event_listener" event="console.error" method="handleConsoleErrorEvent" priority="-64" />
         </service>
 
         <service id="Sentry\SentryBundle\EventListener\ErrorListener" class="Sentry\SentryBundle\EventListener\ErrorListener">
             <argument type="service" id="Sentry\State\HubInterface" />
 
-            <tag name="kernel.event_listener" event="kernel.exception" method="handleExceptionEvent" priority="%sentry.listener_priorities.request_error%" />
+            <tag name="kernel.event_listener" event="kernel.exception" method="handleExceptionEvent" priority="128" />
         </service>
 
         <service id="Sentry\SentryBundle\EventListener\RequestListener" class="Sentry\SentryBundle\EventListener\RequestListener">
             <argument type="service" id="Sentry\State\HubInterface" />
             <argument type="service" id="security.token_storage" on-invalid="ignore" />
 
-            <tag name="kernel.event_listener" event="kernel.request" method="handleKernelRequestEvent" priority="%sentry.listener_priorities.request%" />
-            <tag name="kernel.event_listener" event="kernel.controller" method="handleKernelControllerEvent" priority="%sentry.listener_priorities.request%" />
+            <tag name="kernel.event_listener" event="kernel.request" method="handleKernelRequestEvent" priority="1" />
+            <tag name="kernel.event_listener" event="kernel.controller" method="handleKernelControllerEvent" priority="1" />
         </service>
 
         <service id="Sentry\SentryBundle\EventListener\SubRequestListener" class="Sentry\SentryBundle\EventListener\SubRequestListener">
             <argument type="service" id="Sentry\State\HubInterface" />
 
-            <tag name="kernel.event_listener" event="kernel.request" method="handleKernelRequestEvent" priority="%sentry.listener_priorities.sub_request%" />
-            <tag name="kernel.event_listener" event="kernel.finish_request" method="handleKernelFinishRequestEvent" priority="%sentry.listener_priorities.sub_request%" />
+            <tag name="kernel.event_listener" event="kernel.request" method="handleKernelRequestEvent" priority="1" />
+            <tag name="kernel.event_listener" event="kernel.finish_request" method="handleKernelFinishRequestEvent" priority="1" />
         </service>
 
         <service id="Sentry\SentryBundle\EventListener\MessengerListener" class="Sentry\SentryBundle\EventListener\MessengerListener">
             <argument type="service" id="Sentry\State\HubInterface" />
 
-            <tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageFailedEvent" method="handleWorkerMessageFailedEvent" priority="%sentry.listener_priorities.worker_error%" />
-            <tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageHandledEvent" method="handleWorkerMessageHandledEvent" priority="%sentry.listener_priorities.worker_error%" />
+            <tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageFailedEvent" method="handleWorkerMessageFailedEvent" priority="50" />
+            <tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageHandledEvent" method="handleWorkerMessageHandledEvent" priority="50" />
         </service>
 
         <service id="Sentry\SentryBundle\Command\SentryTestCommand" class="Sentry\SentryBundle\Command\SentryTestCommand">

tests/DependencyInjection/ConfigurationTest.php

@@ -16,6 +16,7 @@ final class ConfigurationTest extends TestCase
     public function testProcessConfigurationWithDefaultConfiguration(): void
     {
         $expectedBundleDefaultConfig = [
+            'register_error_listener' => true,
             'options' => [
                 'integrations' => [],
                 'prefixes' => [],
@@ -34,16 +35,6 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
                 'enabled' => interface_exists(MessageBusInterface::class),
                 'capture_soft_fails' => true,
             ],
-            'register_error_listener' => true,
-            'listener_priorities' => [
-                'request' => 1,
-                'sub_request' => 1,
-                'console' => 128,
-                'request_error' => 128,
-                'console_error' => -64,
-                'console_terminate' => -64,
-                'worker_error' => 50,
-            ],
         ];
 
         $this->assertSame($expectedBundleDefaultConfig, $this->processConfiguration([]));