✨ 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

andrew-demb · andrew-demb · commit f3821dfebbea · 2023-11-22T23:39:56.000+02:00
diff --git a/composer.json b/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
diff --git a/src/Bridge/BackgroundSpanHandler.php b/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;
+    }
 }
diff --git a/src/Bridge/MainSpanHandler.php b/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;
     }
 }
diff --git a/src/Context/Extractor/HeaderContextExtractor.php b/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;
+    }
 }
diff --git a/src/Debug/Extractor/CookieDebugExtractor.php b/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 = '';
     }
 
diff --git a/src/Debug/Extractor/EnvDebugExtractor.php b/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;
diff --git a/src/Name/Generator/ControllerNameGenerator.php b/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 = '';
     }
diff --git a/src/Name/Generator/DefaultNameGenerator.php b/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 = '';
     }
diff --git a/src/Name/Generator/RequestNameGenerator.php b/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) {
diff --git a/src/Resources/services.yml b/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

Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,9 @@`
`12`	`12`	`use Jaeger\Tag\SpanKindServerTag;`
`13`	`13`	`use Jaeger\Tracer\TracerInterface;`
`14`	`14`	`use Symfony\Component\HttpFoundation\Request;`
	`15`	`+use Symfony\Contracts\Service\ResetInterface;`
`15`	`16`
`16`		`-class BackgroundSpanHandler`
	`17`	`+class BackgroundSpanHandler implements ResetInterface`
`17`	`18`	`{`
`18`	`19`	`private ?SpanInterface $span = null;`
`19`	`20`
`@@ -47,8 +48,13 @@ public function flush(): BackgroundSpanHandler`
`47`	`48`	`return $this;`
`48`	`49`	`}`
`49`	`50`	`$this->span->finish();`
`50`		`- $this->span = null;`
	`51`	`+ $this->reset();`
`51`	`52`
`52`	`53`	`return $this;`
`53`	`54`	`}`
	`55`	`+`
	`56`	`+ public function reset(): void`
	`57`	`+ {`
	`58`	`+ $this->span = null;`
	`59`	`+ }`
`54`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,9 @@`
`10`	`10`	`use Symfony\Component\HttpKernel\Event\KernelEvent;`
`11`	`11`	`use Symfony\Component\HttpKernel\Event\RequestEvent;`
`12`	`12`	`use Symfony\Component\HttpKernel\Event\TerminateEvent;`
	`13`	`+use Symfony\Contracts\Service\ResetInterface;`
`13`	`14`
`14`		`-class HeaderContextExtractor implements ContextExtractorInterface, EventSubscriberInterface`
	`15`	`+class HeaderContextExtractor implements ContextExtractorInterface, EventSubscriberInterface, ResetInterface`
`15`	`16`	`{`
`16`	`17`	`/**`
`17`	`18`	`* @var CodecInterface[]`
`@@ -49,7 +50,8 @@ public function onTerminate(TerminateEvent $event): void`
`49`	`50`	`if (false === $this->isMainRequestEvent($event)) {`
`50`	`51`	`return;`
`51`	`52`	`}`
`52`		`- $this->context = null;`
	`53`	`+`
	`54`	`+ $this->reset();`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`public function onRequest(RequestEvent $event): void`
`@@ -79,4 +81,9 @@ private function isMainRequestEvent(KernelEvent $event): bool`
`79`	`81`
`80`	`82`	`return $event->isMasterRequest();`
`81`	`83`	`}`
	`84`	`+`
	`85`	`+ public function reset(): void`
	`86`	`+ {`
	`87`	`+ $this->context = null;`
	`88`	`+ }`
`82`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,9 @@`
`5`	`5`
`6`	`6`	`use Symfony\Component\Console\ConsoleEvents;`
`7`	`7`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
	`8`	`+use Symfony\Contracts\Service\ResetInterface;`
`8`	`9`
`9`		`-class EnvDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface`
	`10`	`+class EnvDebugExtractor implements DebugExtractorInterface, EventSubscriberInterface, ResetInterface`
`10`	`11`	`{`
`11`	`12`	`private $envName;`
`12`	`13`
`@@ -27,11 +28,16 @@ public static function getSubscribedEvents(): array`
`27`	`28`
`28`	`29`	`public function onTerminate()`
`29`	`30`	`{`
`30`		`- $this->debugId = '';`
	`31`	`+ $this->reset();`
`31`	`32`
`32`	`33`	`return $this;`
`33`	`34`	`}`
`34`	`35`
	`36`	`+ public function reset(): void`
	`37`	`+ {`
	`38`	`+ $this->debugId = '';`
	`39`	`+ }`
	`40`	`+`
`35`	`41`	`public function getDebug(): string`
`36`	`42`	`{`
`37`	`43`	`return $this->debugId;`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,9 @@`
`6`	`6`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`7`	`7`	`use Symfony\Component\HttpKernel\Event\RequestEvent;`
`8`	`8`	`use Symfony\Component\HttpKernel\Event\TerminateEvent;`
	`9`	`+use Symfony\Contracts\Service\ResetInterface;`
`9`	`10`
`10`		`-class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface`
	`11`	`+class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface, ResetInterface`
`11`	`12`	`{`
`12`	`13`	`private string $controller = '';`
`13`	`14`
`@@ -26,6 +27,11 @@ public function onRequest(RequestEvent $event): void`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`public function onTerminate(): void`
	`30`	`+ {`
	`31`	`+ $this->reset();`
	`32`	`+ }`
	`33`	`+`
	`34`	`+ public function reset(): void`
`29`	`35`	`{`
`30`	`36`	`$this->controller = '';`
`31`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,9 @@`
`8`	`8`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`9`	`9`	`use Symfony\Component\HttpKernel\Event\RequestEvent;`
`10`	`10`	`use Symfony\Component\HttpKernel\Event\TerminateEvent;`
	`11`	`+use Symfony\Contracts\Service\ResetInterface;`
`11`	`12`
`12`		`-class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface`
	`13`	`+class DefaultNameGenerator implements NameGeneratorInterface, EventSubscriberInterface, ResetInterface`
`13`	`14`	`{`
`14`	`15`	`private string $name = '';`
`15`	`16`
`@@ -48,6 +49,11 @@ public function onRequest(RequestEvent $event): void`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`public function onTerminate(): void`
	`52`	`+ {`
	`53`	`+ $this->reset();`
	`54`	`+ }`
	`55`	`+`
	`56`	`+ public function reset(): void`
`51`	`57`	`{`
`52`	`58`	`$this->name = '';`
`53`	`59`	`}`