feature #32598 [FrameworkBundle][Routing] Private service route loaders (fancyweb)

fabpot · fabpot · commit 43a79f543e54 · 2019-08-09T08:48:02.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [FrameworkBundle][Routing] Private service route loaders | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#30402 | License | MIT | Doc PR | symfony/symfony-docs#11337 Continuation of symfony/symfony#30926. ~Please review only the 2nd commit, I'm building this on top of symfony/symfony#32582 Commits ------- 64aa2c8529 [FrameworkBundle][Routing] Private service route loaders
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
  * Added support for configuring chained cache pools
  * Deprecated booting the kernel before running `WebTestCase::createClient()`
  * Deprecated `routing.loader.service`, use `routing.loader.container` instead.
+ * Not tagging service route loaders with `routing.route_loader` has been deprecated.
 
 4.3.0
 -----
diff --git a/DependencyInjection/Compiler/UnusedTagsPass.php b/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -49,6 +49,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'proxy',
         'routing.expression_language_provider',
         'routing.loader',
+        'routing.route_loader',
         'security.expression_language_provider',
         'security.remember_me_aware',
         'security.voter',
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -24,6 +24,7 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\FrameworkBundle\Routing\AnnotatedRouteControllerLoader;
 use Symfony\Bundle\FrameworkBundle\Routing\RedirectableUrlMatcher;
+use Symfony\Bundle\FrameworkBundle\Routing\RouteLoaderInterface;
 use Symfony\Bundle\FullStack;
 use Symfony\Component\Asset\PackageInterface;
 use Symfony\Component\BrowserKit\AbstractBrowser;
@@ -447,6 +448,9 @@ public function load(array $configs, ContainerBuilder $container)
         if (!$config['disallow_search_engine_index'] ?? false) {
             $container->removeDefinition('disallow_search_engine_index_response_listener');
         }
+
+        $container->registerForAutoconfiguration(RouteLoaderInterface::class)
+            ->addTag('routing.route_loader');
     }
 
     /**
diff --git a/Kernel/MicroKernelTrait.php b/Kernel/MicroKernelTrait.php
@@ -64,14 +64,20 @@ public function registerContainerConfiguration(LoaderInterface $loader)
                 ],
             ]);
 
-            if ($this instanceof EventSubscriberInterface) {
+            if (!$container->hasDefinition('kernel')) {
                 $container->register('kernel', static::class)
                     ->setSynthetic(true)
                     ->setPublic(true)
-                    ->addTag('kernel.event_subscriber')
                 ;
             }
 
+            $kernelDefinition = $container->getDefinition('kernel');
+            $kernelDefinition->addTag('routing.route_loader');
+
+            if ($this instanceof EventSubscriberInterface) {
+                $kernelDefinition->addTag('kernel.event_subscriber');
+            }
+
             $this->configureContainer($container, $loader);
 
             $container->addObjectResource($this);
diff --git a/Resources/config/routing.xml b/Resources/config/routing.xml
@@ -47,7 +47,12 @@
 
         <service id="routing.loader.container" class="Symfony\Component\Routing\Loader\ContainerLoader">
             <tag name="routing.loader" />
-            <argument type="service" id="service_container" />
+            <argument type="service">
+                <service class="Symfony\Bundle\FrameworkBundle\Routing\LegacyRouteLoaderContainer">
+                    <argument type="service" id="service_container" />
+                    <argument type="tagged_locator" tag="routing.route_loader" />
+                </service>
+            </argument>
         </service>
 
         <service id="routing.loader" class="Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader" public="true">
diff --git a/Routing/LegacyRouteLoaderContainer.php b/Routing/LegacyRouteLoaderContainer.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Routing;
+
+use Psr\Container\ContainerInterface;
+
+/**
+ * @internal to be removed in Symfony 5.0
+ */
+class LegacyRouteLoaderContainer implements ContainerInterface
+{
+    private $container;
+    private $serviceLocator;
+
+    public function __construct(ContainerInterface $container, ContainerInterface $serviceLocator)
+    {
+        $this->container = $container;
+        $this->serviceLocator = $serviceLocator;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get($id)
+    {
+        if ($this->serviceLocator->has($id)) {
+            return $this->serviceLocator->get($id);
+        }
+
+        @trigger_error(sprintf('Registering the service route loader "%s" without tagging it with the "routing.route_loader" tag is deprecated since Symfony 4.4 and will be required in Symfony 5.0.', $id), E_USER_DEPRECATED);
+
+        return $this->container->get($id);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function has($id)
+    {
+        return $this->serviceLocator->has($id) || $this->container->has($id);
+    }
+}
diff --git a/Routing/RouteLoaderInterface.php b/Routing/RouteLoaderInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Routing;
+
+/**
+ * Marker interface for service route loaders.
+ */
+interface RouteLoaderInterface
+{
+}
diff --git a/Tests/Kernel/MicroKernelTraitTest.php b/Tests/Kernel/MicroKernelTraitTest.php
@@ -12,6 +12,9 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Kernel;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
 use Symfony\Component\HttpFoundation\Request;
 
 class MicroKernelTraitTest extends TestCase
@@ -39,4 +42,18 @@ public function testAsEventSubscriber()
 
         $this->assertSame('It\'s dangerous to go alone. Take this ⚔', $response->getContent());
     }
+
+    public function testRoutingRouteLoaderTagIsAdded()
+    {
+        $frameworkExtension = $this->createMock(ExtensionInterface::class);
+        $frameworkExtension
+            ->expects($this->atLeastOnce())
+            ->method('getAlias')
+            ->willReturn('framework');
+        $container = new ContainerBuilder();
+        $container->registerExtension($frameworkExtension);
+        $kernel = new ConcreteMicroKernel('test', false);
+        $kernel->registerContainerConfiguration(new ClosureLoader($container));
+        $this->assertTrue($container->getDefinition('kernel')->hasTag('routing.route_loader'));
+    }
 }
diff --git a/Tests/Routing/LegacyRouteLoaderContainerTest.php b/Tests/Routing/LegacyRouteLoaderContainerTest.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Routing;
+
+use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface;
+use Symfony\Bundle\FrameworkBundle\Routing\LegacyRouteLoaderContainer;
+use Symfony\Component\DependencyInjection\Container;
+
+/**
+ * @group legacy
+ */
+class LegacyRouteLoaderContainerTest extends TestCase
+{
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    /**
+     * @var ContainerInterface
+     */
+    private $serviceLocator;
+
+    /**
+     * @var LegacyRouteLoaderContainer
+     */
+    private $legacyRouteLoaderContainer;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setUp()
+    {
+        $this->container = new Container();
+        $this->container->set('foo', new \stdClass());
+
+        $this->serviceLocator = new Container();
+        $this->serviceLocator->set('bar', new \stdClass());
+
+        $this->legacyRouteLoaderContainer = new LegacyRouteLoaderContainer($this->container, $this->serviceLocator);
+    }
+
+    /**
+     * @expectedDeprecation Registering the service route loader "foo" without tagging it with the "routing.route_loader" tag is deprecated since Symfony 4.4 and will be required in Symfony 5.0.
+     */
+    public function testGet()
+    {
+        $this->assertSame($this->container->get('foo'), $this->legacyRouteLoaderContainer->get('foo'));
+        $this->assertSame($this->serviceLocator->get('bar'), $this->legacyRouteLoaderContainer->get('bar'));
+    }
+
+    public function testHas()
+    {
+        $this->assertTrue($this->legacyRouteLoaderContainer->has('foo'));
+        $this->assertTrue($this->legacyRouteLoaderContainer->has('bar'));
+        $this->assertFalse($this->legacyRouteLoaderContainer->has('ccc'));
+    }
+}
