✨ Implement resetting state interfaces from symfony/service-contracts and declare DI tags to ensure state resetted always, not only if event system properly handled it

Author: andrew-demb

composer.json

@@ -14,7 +14,8 @@
     "symfony/dependency-injection": "^4.4|^5.4|^6.0",
     "symfony/event-dispatcher": "^4.4|^5.4|^6.0",
     "symfony/http-kernel": "^4.4|^5.4|^6.0",
-    "symfony/yaml": "^4.4|^5.4|^6.0"
+    "symfony/yaml": "^4.4|^5.4|^6.0",
+    "symfony/service-contracts": "^2|^3"
   },
   "minimum-stability": "dev",
   "prefer-stable": true

src/Bridge/BackgroundSpanHandler.php

@@ -12,8 +12,9 @@
 use Jaeger\Tag\SpanKindServerTag;
 use Jaeger\Tracer\TracerInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Contracts\Service\ResetInterface;
 
-class BackgroundSpanHandler
+class BackgroundSpanHandler implements ResetInterface
 {
     private ?SpanInterface $span = null;
 
@@ -47,8 +48,13 @@ public function flush(): BackgroundSpanHandler
             return $this;
         }
         $this->span->finish();
-        $this->span = null;
+        $this->reset();
 
         return $this;
     }
+
+    public function reset(): void
+    {
+        $this->span = null;
+    }
 }

src/Bridge/MainSpanHandler.php

@@ -12,8 +12,9 @@
 use Jaeger\Tag\SpanKindServerTag;
 use Jaeger\Tracer\TracerInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Contracts\Service\ResetInterface;
 
-class MainSpanHandler
+class MainSpanHandler implements ResetInterface
 {
     /**
      * @var Span
@@ -72,6 +73,12 @@ public function flush(): void
             return;
         }
         $this->span->finish((int)$this->durationUsec);
-        $this->span = $this->durationUsec = null;
+        $this->reset();
+    }
+
+    public function reset(): void
+    {
+        $this->span = null;
+        $this->durationUsec = null;
     }
 }

src/Context/Extractor/HeaderContextExtractor.php

@@ -10,8 +10,9 @@
 use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Contracts\Service\ResetInterface;
 
-class HeaderContextExtractor implements ContextExtractorInterface, EventSubscriberInterface
+class HeaderContextExtractor implements ContextExtractorInterface, EventSubscriberInterface, ResetInterface
 {
     /**
      * @var CodecInterface[]
@@ -49,7 +50,8 @@ public function onTerminate(TerminateEvent $event): void
         if (false === $this->isMainRequestEvent($event)) {
             return;
         }
-        $this->context = null;
+
+        $this->reset();
     }
 
     public function onRequest(RequestEvent $event): void
@@ -79,4 +81,9 @@ private function isMainRequestEvent(KernelEvent $event): bool
 
         return $event->isMasterRequest();
     }
+
+    public function reset(): void
+    {
+        $this->context = null;
+    }
 }

src/Debug/Extractor/CookieDebugExtractor.php

@@ -7,8 +7,9 @@
 use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Contracts\Service\ResetInterface;
 
-class CookieDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface
+class CookieDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface, ResetInterface
 {
     private $debugId = '';
 
@@ -36,6 +37,12 @@ public function onTerminate(TerminateEvent $event): void
         if (false === $this->isMainRequestEvent($event)) {
             return;
         }
+
+        $this->reset();
+    }
+
+    public function reset(): void
+    {
         $this->debugId = '';
     }
 

src/Debug/Extractor/EnvDebugExtractor.php

@@ -5,8 +5,9 @@
 
 use Symfony\Component\Console\ConsoleEvents;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
-class EnvDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface
+class EnvDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface, ResetInterface
 {
     private $envName;
 
@@ -27,11 +28,16 @@ public static function getSubscribedEvents(): array
 
     public function onTerminate()
     {
-        $this->debugId = '';
+        $this->reset();
 
         return $this;
     }
 
+    public function reset(): void
+    {
+        $this->debugId = '';
+    }
+
     public function getDebug(): string
     {
         return $this->debugId;

src/Name/Generator/ControllerNameGenerator.php

@@ -6,8 +6,9 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Contracts\Service\ResetInterface;
 
-class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface, ResetInterface
 {
     private string $controller = '';
 
@@ -26,6 +27,11 @@ public function onRequest(RequestEvent $event): void
     }
 
     public function onTerminate(): void
+    {
+        $this->reset();
+    }
+
+    public function reset(): void
     {
         $this->controller = '';
     }

src/Name/Generator/DefaultNameGenerator.php

@@ -8,8 +8,9 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Contracts\Service\ResetInterface;
 
-class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface, ResetInterface
 {
     private string $name = '';
 
@@ -48,6 +49,11 @@ public function onRequest(RequestEvent $event): void
     }
 
     public function onTerminate(): void
+    {
+        $this->reset();
+    }
+
+    public function reset(): void
     {
         $this->name = '';
     }

src/Name/Generator/RequestNameGenerator.php

@@ -6,8 +6,9 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Contracts\Service\ResetInterface;
 
-class RequestNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
+class RequestNameGenerator implements NameGeneratorInterface, EventSubscriberInterface, ResetInterface
 {
     /**
      * @var NameGeneratorInterface[] Key - regexp, value - name generator
@@ -47,11 +48,16 @@ public function onRequest(RequestEvent $event): void
 
     public function onTerminate(): RequestNameGenerator
     {
-        $this->route = '';
+        $this->reset();
 
         return $this;
     }
 
+    public function reset(): void
+    {
+        $this->route = '';
+    }
+
     public function generate(): string
     {
         foreach ($this->generators as $regexp => $generator) {

src/Resources/services.yml

@@ -103,6 +103,7 @@ services:
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.context.extractor'}
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.context.extractor.chain:
     class: Jaeger\Symfony\Context\Extractor\ContextExtractorChain
     arguments:
@@ -116,13 +117,15 @@ services:
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.debug.extractor'}
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.debug.extractor.cookie:
     class: Jaeger\Symfony\Debug\Extractor\CookieDebugExtractor
     arguments:
       - '%env(JAEGER_DEBUG_COOKIE)%'
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.debug.extractor'}
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.debug.extractor.chain:
     class: Jaeger\Symfony\Debug\Extractor\DebugExtractorChain
     arguments:
@@ -133,16 +136,19 @@ services:
     class: Jaeger\Symfony\Name\Generator\ControllerNameGenerator
     tags:
       - {name: 'kernel.event_subscriber' }
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.name.generator.default:
     class: Jaeger\Symfony\Name\Generator\DefaultNameGenerator
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.name.generator', priority: -16384}
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.name.generator.request:
     class: Jaeger\Symfony\Name\Generator\RequestNameGenerator
     tags:
       - {name: 'kernel.event_subscriber' }
       - {name: 'jaeger.name.generator', priority: -1024}
+      - {name: 'kernel.reset', method: 'reset'}
   jaeger.name.generator.command:
     class: Jaeger\Symfony\Name\Generator\CommandNameGenerator
     tags:
@@ -157,9 +163,13 @@ services:
   jaeger.span.handler.background:
     class: Jaeger\Symfony\Bridge\BackgroundSpanHandler
     arguments: ['@jaeger.tracer']
+    tags:
+      - { name: 'kernel.reset', method: 'reset' }
   jaeger.span.handler.main:
     class: Jaeger\Symfony\Bridge\MainSpanHandler
     arguments: ['@jaeger.tracer', '@jaeger.name.generator']
+    tags:
+      - { name: 'kernel.reset', method: 'reset' }
   jaeger.span.handler.global: '@jaeger.span.handler.main'
   jaeger.debug.listener:
     class: Jaeger\Symfony\Bridge\DebugListener