Merge pull request #18 from andrew-demb/deprecation-free

allflame · web-flow · commit 5cf21a4d5fbd · 2021-06-29T12:28:25.000+03:00
Deprecation free
diff --git a/src/Bridge/AppStartSpanListener.php b/src/Bridge/AppStartSpanListener.php
@@ -8,6 +8,7 @@
 use Jaeger\Tag\SpanKindServerTag;
 use Jaeger\Tracer\TracerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 class AppStartSpanListener implements EventSubscriberInterface
@@ -27,7 +28,7 @@ public static function getSubscribedEvents(): array
     public function onRequest(RequestEvent $event)
     {
         $request = $event->getRequest();
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return $this;
         }
         $this->tracer
@@ -40,4 +41,20 @@ public function onRequest(RequestEvent $event)
 
         return $this;
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Bridge/ContextListener.php b/src/Bridge/ContextListener.php
@@ -7,6 +7,7 @@
 use Jaeger\Tracer\InjectableInterface;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 class ContextListener implements EventSubscriberInterface
@@ -46,9 +47,25 @@ public function inject(): void
 
     public function onRequest(RequestEvent $event): void
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $this->inject();
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Bridge/DebugListener.php b/src/Bridge/DebugListener.php
@@ -8,6 +8,7 @@
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 
@@ -48,12 +49,28 @@ public function onCommand(): void
 
     public function onRequest(RequestEvent $event)
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         if ('' === ($debugId = $this->extractor->getDebug())) {
             return;
         }
         $this->debuggable->enable($debugId);
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Bridge/GlobalSpanListener.php b/src/Bridge/GlobalSpanListener.php
@@ -4,6 +4,7 @@
 namespace Jaeger\Symfony\Bridge;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 
@@ -33,11 +34,27 @@ public function onTerminate()
 
     public function onRequest(RequestEvent $event)
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return $this;
         }
         $this->handler->start($event->getRequest());
 
         return $this;
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Bridge/RequestSpanListener.php b/src/Bridge/RequestSpanListener.php
@@ -15,6 +15,7 @@
 use Jaeger\Tracer\TracerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\ResponseEvent;
 
@@ -44,7 +45,7 @@ public static function getSubscribedEvents(): array
 
     public function onResponse(ResponseEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         if ($this->spans->isEmpty()) {
@@ -55,7 +56,7 @@ public function onResponse(ResponseEvent $event): void
 
     public function onRequest(RequestEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $request = $event->getRequest();
@@ -86,4 +87,20 @@ public function onKernelException(ExceptionEvent $event): void
             ->addLog(new ErrorLog($exception->getMessage(), $exception->getTraceAsString()))
         ;
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Context/Extractor/HeaderContextExtractor.php b/src/Context/Extractor/HeaderContextExtractor.php
@@ -7,6 +7,7 @@
 use Jaeger\Codec\CodecRegistry;
 use Jaeger\Span\Context\SpanContext;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 
@@ -45,15 +46,15 @@ public function extract(): ?SpanContext
 
     public function onTerminate(TerminateEvent $event): void
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $this->context = null;
     }
 
     public function onRequest(RequestEvent $event): void
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $request = $event->getRequest();
@@ -62,4 +63,20 @@ public function onRequest(RequestEvent $event): void
             $this->context = $context;
         }
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/Debug/Extractor/CookieDebugExtractor.php b/src/Debug/Extractor/CookieDebugExtractor.php
@@ -4,6 +4,7 @@
 namespace Jaeger\Symfony\Debug\Extractor;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 
@@ -20,7 +21,7 @@ public function __construct(string $cookieName)
 
     public function onRequest(RequestEvent $event): void
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $request = $event->getRequest();
@@ -32,7 +33,7 @@ public function onRequest(RequestEvent $event): void
 
     public function onTerminate(TerminateEvent $event): void
     {
-        if (false === $event->isMasterRequest()) {
+        if (false === $this->isMainRequestEvent($event)) {
             return;
         }
         $this->debugId = '';
@@ -50,4 +51,20 @@ public static function getSubscribedEvents(): array
             TerminateEvent::class => ['onTerminate'],
         ];
     }
+
+    /**
+     * Use non-deprecated check method if availble
+     *
+     * @param KernelEvent $event
+     *
+     * @return bool
+     */
+    private function isMainRequestEvent(KernelEvent $event): bool
+    {
+        if (\method_exists($event, 'isMainRequest')) {
+            return $event->isMainRequest();
+        }
+
+        return $event->isMasterRequest();
+    }
 }
diff --git a/src/DependencyInjection/DeprecatedAliasesCompilerPass.php b/src/DependencyInjection/DeprecatedAliasesCompilerPass.php
@@ -0,0 +1,50 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Symfony\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Dumper\Preloader;
+
+class DeprecatedAliasesCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        $container->getAlias('jaeger.span.handler.gloabal')
+            ->setDeprecated(
+                ...
+                $this->getDeprecationMsg(
+                    'The "%alias_id%" service is deprecated. Use "jaeger.span.handler.global".',
+                    '3.5.0'
+                )
+            );
+    }
+
+    /**
+     * Returns the correct deprecation param's as an array for setDeprecated.
+     *
+     * symfony/dependency-injection v5.1 introduces a deprecation notice when calling
+     * setDeprecation() with less than 3 args and the
+     * `Symfony\Component\DependencyInjection\Dumper\Preloader` class was
+     * introduced at the same time. By checking if this class exists,
+     * we can determine the correct param count to use when calling setDeprecated.
+     *
+     * @param string $message
+     * @param string $version
+     *
+     * @return array
+     */
+    private function getDeprecationMsg(string $message, string $version): array
+    {
+        if (class_exists(Preloader::class)) {
+            return [
+                'code-tool/jaeger-client-symfony-bridge',
+                $version,
+                $message,
+            ];
+        }
+
+        return [$message];
+    }
+}
diff --git a/src/JaegerBundle.php b/src/JaegerBundle.php
@@ -6,6 +6,7 @@
 use Jaeger\Symfony\DependencyInjection\CodecRegistryCompilerPass;
 use Jaeger\Symfony\DependencyInjection\ContextExtractorChainCompilerPass;
 use Jaeger\Symfony\DependencyInjection\DebugExtractorChainCompilerPass;
+use Jaeger\Symfony\DependencyInjection\DeprecatedAliasesCompilerPass;
 use Jaeger\Symfony\DependencyInjection\NameGeneratorChainCompilerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -19,6 +20,7 @@ public function build(ContainerBuilder $container)
             ->addCompilerPass(new CodecRegistryCompilerPass())
             ->addCompilerPass(new ContextExtractorChainCompilerPass())
             ->addCompilerPass(new DebugExtractorChainCompilerPass())
-            ->addCompilerPass(new NameGeneratorChainCompilerPass());
+            ->addCompilerPass(new NameGeneratorChainCompilerPass())
+            ->addCompilerPass(new DeprecatedAliasesCompilerPass());
     }
 }
diff --git a/src/Resources/services.yml b/src/Resources/services.yml
@@ -139,9 +139,6 @@ services:
   jaeger.span.handler.background:
     class: Jaeger\Symfony\Bridge\BackgroundSpanHandler
     arguments: ['@jaeger.tracer']
-  jaeger.span.handler.gloabal:
-    alias: jaeger.span.handler.global
-    deprecated: 'The "%alias_id%" service is deprecated. Use "jaeger.span.handler.global".'
   jaeger.span.handler.global:
     class: Jaeger\Symfony\Bridge\GlobalSpanHandler
     arguments: ['@jaeger.tracer', '@jaeger.name.generator']
@@ -198,3 +195,7 @@ services:
       - '@jaeger.span.manager'
     tags:
       - {name: 'kernel.event_subscriber'}
+  # deprecated since 3.5.0
+  jaeger.span.handler.gloabal:
+    alias: jaeger.span.handler.global
+

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`use Jaeger\Codec\CodecRegistry;`
`8`	`8`	`use Jaeger\Span\Context\SpanContext;`
`9`	`9`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
	`10`	`+use Symfony\Component\HttpKernel\Event\KernelEvent;`
`10`	`11`	`use Symfony\Component\HttpKernel\Event\RequestEvent;`
`11`	`12`	`use Symfony\Component\HttpKernel\Event\TerminateEvent;`
`12`	`13`
`@@ -45,15 +46,15 @@ public function extract(): ?SpanContext`
`45`	`46`
`46`	`47`	`public function onTerminate(TerminateEvent $event): void`
`47`	`48`	`{`
`48`		`- if (false === $event->isMasterRequest()) {`
	`49`	`+ if (false === $this->isMainRequestEvent($event)) {`
`49`	`50`	`return;`
`50`	`51`	`}`
`51`	`52`	`$this->context = null;`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`public function onRequest(RequestEvent $event): void`
`55`	`56`	`{`
`56`		`- if (false === $event->isMasterRequest()) {`
	`57`	`+ if (false === $this->isMainRequestEvent($event)) {`
`57`	`58`	`return;`
`58`	`59`	`}`
`59`	`60`	`$request = $event->getRequest();`
`@@ -62,4 +63,20 @@ public function onRequest(RequestEvent $event): void`
`62`	`63`	`$this->context = $context;`
`63`	`64`	`}`
`64`	`65`	`}`
	`66`	`+`
	`67`	`+ /**`
	`68`	`+ * Use non-deprecated check method if availble`
	`69`	`+ *`
	`70`	`+ * @param KernelEvent $event`
	`71`	`+ *`
	`72`	`+ * @return bool`
	`73`	`+ */`
	`74`	`+ private function isMainRequestEvent(KernelEvent $event): bool`
	`75`	`+ {`
	`76`	`+ if (\method_exists($event, 'isMainRequest')) {`
	`77`	`+ return $event->isMainRequest();`
	`78`	`+ }`
	`79`	`+`
	`80`	`+ return $event->isMasterRequest();`
	`81`	`+ }`
`65`	`82`	`}`