[DependencyInjection] Add CheckAliasValidityPass to check interface compatibility

Author: n-valverde

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 7.1
 ---
 
+ * Add `CheckAliasValidityPass` to check service compatibility with aliased interface
  * Add argument `$prepend` to `ContainerConfigurator::extension()` to prepend the configuration instead of appending it
  * Have `ServiceLocator` implement `ServiceCollectionInterface`
  * Add `#[Lazy]` attribute as shortcut for `#[Autowire(lazy: [bool|string])]` and `#[Autoconfigure(lazy: [bool|string])]`

Compiler/CheckAliasValidityPass.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\RuntimeException;
+
+/**
+ * This pass validates aliases, it provides the following checks:
+ *
+ * - An alias which happens to be an interface must resolve to a service implementing this interface. This ensures injecting the aliased interface won't cause a type error at runtime.
+ */
+class CheckAliasValidityPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        foreach ($container->getAliases() as $id => $alias) {
+            try {
+                if (!$container->hasDefinition((string) $alias)) {
+                    continue;
+                }
+
+                $target = $container->getDefinition((string) $alias);
+                if (null === $target->getClass() || null !== $target->getFactory()) {
+                    continue;
+                }
+
+                $reflection = $container->getReflectionClass($id);
+                if (null === $reflection || !$reflection->isInterface()) {
+                    continue;
+                }
+
+                $targetReflection = $container->getReflectionClass($target->getClass());
+                if (null !== $targetReflection && !$targetReflection->implementsInterface($id)) {
+                    throw new RuntimeException(sprintf('Invalid alias definition: alias "%s" is referencing class "%s" but this class does not implement "%s". Because this alias is an interface, "%s" must implement "%s".', $id, $target->getClass(), $id, $target->getClass(), $id));
+                }
+            } catch (\ReflectionException) {
+                continue;
+            }
+        }
+    }
+}

Tests/Compiler/CheckAliasValidityPassTest.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Compiler;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Compiler\CheckAliasValidityPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\RuntimeException;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass\FooImplementing;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass\FooInterface;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass\FooNotImplementing;
+
+class CheckAliasValidityPassTest extends TestCase
+{
+    public function testProcessDetectsClassNotImplementingAliasedInterface()
+    {
+        $this->expectException(RuntimeException::class);
+        $container = new ContainerBuilder();
+        $container->register('a')->setClass(FooNotImplementing::class);
+        $container->setAlias(FooInterface::class, 'a');
+
+        $this->process($container);
+    }
+
+    public function testProcessAcceptsClassImplementingAliasedInterface()
+    {
+        $container = new ContainerBuilder();
+        $container->register('a')->setClass(FooImplementing::class);
+        $container->setAlias(FooInterface::class, 'a');
+
+        $this->process($container);
+        $this->addToAssertionCount(1);
+    }
+
+    public function testProcessIgnoresArbitraryAlias()
+    {
+        $container = new ContainerBuilder();
+        $container->register('a')->setClass(FooImplementing::class);
+        $container->setAlias('not_an_interface', 'a');
+
+        $this->process($container);
+        $this->addToAssertionCount(1);
+    }
+
+    public function testProcessIgnoresTargetWithFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('a')->setFactory(new Reference('foo'));
+        $container->setAlias(FooInterface::class, 'a');
+
+        $this->process($container);
+        $this->addToAssertionCount(1);
+    }
+
+    public function testProcessIgnoresTargetWithoutClass()
+    {
+        $container = new ContainerBuilder();
+        $container->register('a');
+        $container->setAlias(FooInterface::class, 'a');
+
+        $this->process($container);
+        $this->addToAssertionCount(1);
+    }
+
+    protected function process(ContainerBuilder $container): void
+    {
+        $pass = new CheckAliasValidityPass();
+        $pass->process($container);
+    }
+}

Tests/Fixtures/CheckAliasValidityPass/FooImplementing.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass;
+
+class FooImplementing implements FooInterface
+{
+
+}

Tests/Fixtures/CheckAliasValidityPass/FooInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass;
+
+interface FooInterface
+{
+
+}

Tests/Fixtures/CheckAliasValidityPass/FooNotImplementing.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\CheckAliasValidityPass;
+
+class FooNotImplementing
+{
+
+}