📦 Avoid deprecation by using compiler pass which is compatible with all supported symfony versions (4/5)

> Since symfony/dependency-injection 5.1: The signature of method "Symfony\Component\DependencyInjection\Alias::setDeprecated()" requires 3 arguments: "string $package, string $version, string $message", not defining them is deprecated

Author: andrew-demb

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];
+    }
+}

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());
     }
 }

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
+