feature #562 Deprecate routing annotation of FrameworkExtraBundle in …

…favor of Symfony Core (Tobion) This PR was merged into the 5.1.x-dev branch. Discussion ---------- Deprecate routing annotation of FrameworkExtraBundle in favor of Symfony Core Since symfony/symfony#23044 routing annotation is part of Symfony Core. The only extra features that the routing annotation from SensioFrameworkExtraBundle has are - service config for `@Route` which we don't need anymore - Either you use class-named services, then you don't need the "service" property at all. - Or you don't use class-named services. In this case the better solution to me, is for people to create a alias in the container from the controller class to to service id instead of specifying the service id in the routing. Then you're set as well and that is already common practice with autowiring. - `@Method` does not provide real value as people agree in symfony/symfony#25103 This resolves symfony/symfony#25103 Commits ------- 444683c Deprecate routing annotation of FrameworkExtraBundle in favor of Symfony Core
sensiolabs · Feb 24, 2018 · 848ebb1 · 848ebb1
2 parents bf49405 + 444683c
commit 848ebb1
Show file tree

Hide file tree

Showing 20 changed files with 69 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,21 @@
 CHANGELOG
 =========
 
+5.2
+---
+
+ * Deprecated routing annotations as this is included in symfony/framework-bundle.
+   Disable the feature with
+
+   ```
+   sensio_framework_extra:
+       router:
+           annotations: false
+   ```
+
+   Also replace the annotations `Sensio\Bundle\FrameworkExtraBundle\Configuration\Route`
+   and `Sensio\Bundle\FrameworkExtraBundle\Configuration\Method` with `Symfony\Component\Routing\Annotation\Route`
+
 5.1
 ---
 

diff --git a/Configuration/Method.php b/Configuration/Method.php
@@ -11,11 +11,14 @@
 
 namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
 
+@trigger_error(sprintf('The "%s" annotation is deprecated since version 5.2. Use "%s" instead.', Method::class, \Symfony\Component\Routing\Annotation\Route::class), E_USER_DEPRECATED);
+
 /**
  * The Method class handles the Method annotation parts.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @Annotation
+ * @deprecated since version 5.2
  */
 class Method extends ConfigurationAnnotation
 {

diff --git a/Configuration/Route.php b/Configuration/Route.php
@@ -13,9 +13,12 @@
 
 use Symfony\Component\Routing\Annotation\Route as BaseRoute;
 
+@trigger_error(sprintf('The "%s" annotation is deprecated since version 5.2. Use "%s" instead.', Route::class, BaseRoute::class), E_USER_DEPRECATED);
+
 /**
  * @author Kris Wallsmith <kris@symfony.com>
  * @Annotation
+ * @deprecated since version 5.2
  */
 class Route extends BaseRoute
 {

diff --git a/DependencyInjection/SensioFrameworkExtraExtension.php b/DependencyInjection/SensioFrameworkExtraExtension.php
@@ -38,6 +38,8 @@ public function load(array $configs, ContainerBuilder $container)
         $definitionsToRemove = [];
 
         if ($config['router']['annotations']) {
+            @trigger_error(sprintf('Enabling the "sensio_framework_extra.router.annotations" configuration is deprecated since version 5.2. Set it to false and use the "%s" annotation from Symfony itself.', \Symfony\Component\Routing\Annotation\Route::class), E_USER_DEPRECATED);
+
             $annotationsToLoad[] = 'routing.xml';
 
             if (PHP_VERSION_ID < 70000) {

diff --git a/Resources/config/routing.xml b/Resources/config/routing.xml
@@ -8,18 +8,21 @@
         <service id="sensio_framework_extra.routing.loader.annot_class" class="Sensio\Bundle\FrameworkExtraBundle\Routing\AnnotatedRouteControllerLoader" public="false">
             <tag name="routing.loader" />
             <argument type="service" id="annotation_reader" />
+            <deprecated>The "%service_id%" service is deprecated since version 5.2</deprecated>
         </service>
 
         <service id="sensio_framework_extra.routing.loader.annot_dir" class="Symfony\Component\Routing\Loader\AnnotationDirectoryLoader" public="false">
             <tag name="routing.loader" />
             <argument type="service" id="file_locator" />
             <argument type="service" id="sensio_framework_extra.routing.loader.annot_class" />
+            <deprecated>The "%service_id%" service is deprecated since version 5.2</deprecated>
         </service>
 
         <service id="sensio_framework_extra.routing.loader.annot_file" class="Symfony\Component\Routing\Loader\AnnotationFileLoader" public="false">
             <tag name="routing.loader" />
             <argument type="service" id="file_locator" />
             <argument type="service" id="sensio_framework_extra.routing.loader.annot_class" />
+            <deprecated>The "%service_id%" service is deprecated since version 5.2</deprecated>
         </service>
     </services>
 </container>
diff --git a/Routing/AnnotatedRouteControllerLoader.php b/Routing/AnnotatedRouteControllerLoader.php
@@ -16,13 +16,17 @@
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route as FrameworkExtraBundleRoute;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 
+@trigger_error(sprintf('The "%s" class is deprecated since version 5.2. Use "%s" instead.', AnnotatedRouteControllerLoader::class, \Symfony\Bundle\FrameworkBundle\Routing\AnnotatedRouteControllerLoader::class), E_USER_DEPRECATED);
+
 /**
  * AnnotatedRouteControllerLoader is an implementation of AnnotationClassLoader
  * that sets the '_controller' default based on the class and method names.
  *
  * It also parse the @Method annotation.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since version 5.2
  */
 class AnnotatedRouteControllerLoader extends AnnotationClassLoader
 {

diff --git a/Tests/Configuration/RouteTest.php b/Tests/Configuration/RouteTest.php
@@ -15,6 +15,8 @@
 
 /**
  * @author Iltar van der Berg <ivanderberg@hostnet.nl>
+ *
+ * @group legacy
  */
 class RouteTest extends \PHPUnit\Framework\TestCase
 {

diff --git a/Tests/DependencyInjection/SensioFrameworkExtraExtensionTest.php b/Tests/DependencyInjection/SensioFrameworkExtraExtensionTest.php
@@ -22,7 +22,13 @@ public function testDefaultExpressionLanguageConfig()
         $container = new ContainerBuilder();
 
         $extension = new SensioFrameworkExtraExtension();
-        $extension->load([], $container);
+        $config = [
+            'router' => [
+                'annotations' => false,
+            ],
+        ];
+
+        $extension->load([$config], $container);
 
         $this->assertAlias($container, 'sensio_framework_extra.security.expression_language.default', 'sensio_framework_extra.security.expression_language');
     }
@@ -33,6 +39,9 @@ public function testOverrideExpressionLanguageConfig()
 
         $extension = new SensioFrameworkExtraExtension();
         $config = [
+            'router' => [
+                'annotations' => false,
+            ],
             'security' => [
                 'expression_language' => 'acme.security.expression_language',
             ],
@@ -51,6 +60,9 @@ public function testTemplatingControllerPatterns()
 
         $extension = new SensioFrameworkExtraExtension();
         $config = [
+            'router' => [
+                'annotations' => false,
+            ],
             'templating' => [
                 'controller_patterns' => $patterns = ['/foo/', '/bar/', '/foobar/'],
             ],

diff --git a/Tests/Fixtures/ActionArgumentsBundle/Controller/ActionArgumentsController.php b/Tests/Fixtures/ActionArgumentsBundle/Controller/ActionArgumentsController.php
@@ -14,11 +14,11 @@
 use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ServerRequestInterface;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 /**
- * @Route("/action-arguments", service="test.action_arguments")
+ * @Route("/action-arguments")
  */
 class ActionArgumentsController
 {

diff --git a/Tests/Fixtures/ActionArgumentsBundle/Controller/NullableArgumentsController.php b/Tests/Fixtures/ActionArgumentsBundle/Controller/NullableArgumentsController.php
@@ -5,8 +5,8 @@
 use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ServerRequestInterface;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 /**
  * @Route("/nullable-arguments")

diff --git a/Tests/Fixtures/FooBundle/Controller/InvokableClassLevelController.php b/Tests/Fixtures/FooBundle/Controller/InvokableClassLevelController.php
@@ -11,11 +11,10 @@
 
 namespace Tests\Fixtures\FooBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Component\Routing\Annotation\Route;
 
 /**
- * @Route(service="test.invokable_class_level.predefined")
  * @Template("@Foo/invokable/predefined.html.twig")
  */
 class InvokableClassLevelController

diff --git a/Tests/Fixtures/FooBundle/Controller/InvokableContainerController.php b/Tests/Fixtures/FooBundle/Controller/InvokableContainerController.php
@@ -11,9 +11,9 @@
 
 namespace Tests\Fixtures\FooBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
 
 class InvokableContainerController extends Controller
 {

diff --git a/Tests/Fixtures/FooBundle/Controller/InvokableController.php b/Tests/Fixtures/FooBundle/Controller/InvokableController.php
@@ -11,12 +11,9 @@
 
 namespace Tests\Fixtures\FooBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Component\Routing\Annotation\Route;
 
-/**
- * @Route(service="test.invokable.predefined")
- */
 class InvokableController
 {
     /**

diff --git a/Tests/Fixtures/FooBundle/Controller/IsGrantedController.php b/Tests/Fixtures/FooBundle/Controller/IsGrantedController.php
@@ -12,10 +12,10 @@
 namespace Tests\Fixtures\FooBundle\Controller;
 
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 class IsGrantedController
 {

diff --git a/Tests/Fixtures/FooBundle/Controller/MultipleActionsClassLevelTemplateController.php b/Tests/Fixtures/FooBundle/Controller/MultipleActionsClassLevelTemplateController.php
@@ -11,9 +11,9 @@
 
 namespace Tests\Fixtures\FooBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Routing\Annotation\Route;
 
 /**
  * @Template("@Foo/invokable/predefined.html.twig")

diff --git a/Tests/Fixtures/FooBundle/Controller/OptionalArgumentsController.php b/Tests/Fixtures/FooBundle/Controller/OptionalArgumentsController.php
@@ -3,8 +3,8 @@
 namespace Tests\Fixtures\FooBundle\Controller;
 
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 /**
  * @Route("/optional-arguments")

diff --git a/Tests/Fixtures/FooBundle/Controller/SimpleController.php b/Tests/Fixtures/FooBundle/Controller/SimpleController.php
@@ -11,13 +11,10 @@
 
 namespace Tests\Fixtures\FooBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
-/**
- * @Route(service="test.simple.multiple")
- */
 class SimpleController
 {
     /**

diff --git a/Tests/Fixtures/config/config.yml b/Tests/Fixtures/config/config.yml
@@ -11,25 +11,24 @@ doctrine:
     orm:
         auto_mapping: true
 
+sensio_framework_extra:
+    router:
+        annotations: false
+
 services:
-    test.invokable.predefined:
-        class:  Tests\Fixtures\FooBundle\Controller\InvokableController
+    Tests\Fixtures\FooBundle\Controller\InvokableController:
         public: true
 
-    test.invokable_class_level.predefined:
-        class:  Tests\Fixtures\FooBundle\Controller\InvokableClassLevelController
+    Tests\Fixtures\FooBundle\Controller\InvokableClassLevelController:
         public: true
 
-    test.simple.multiple:
-        class:  Tests\Fixtures\FooBundle\Controller\SimpleController
+    Tests\Fixtures\FooBundle\Controller\SimpleController:
         public: true
 
-    test.action_arguments:
-        class:  Tests\Fixtures\ActionArgumentsBundle\Controller\ActionArgumentsController
+    Tests\Fixtures\ActionArgumentsBundle\Controller\ActionArgumentsController:
         public: true
 
-    test.is_granted_voter:
-        class: Tests\Fixtures\FooBundle\Security\IsGrantedVoter
+    Tests\Fixtures\FooBundle\Security\IsGrantedVoter:
         public: false
         tags:
             - { name: security.voter }

diff --git a/Tests/Routing/AnnotatedRouteControllerLoaderTest.php b/Tests/Routing/AnnotatedRouteControllerLoaderTest.php
@@ -16,6 +16,9 @@
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Routing\AnnotatedRouteControllerLoader;
 
+/**
+ * @group legacy
+ */
 class AnnotatedRouteControllerLoaderTest extends \PHPUnit\Framework\TestCase
 {
     public function testServiceOptionIsAllowedOnClass()

diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     ],
     "require": {
         "symfony/config": "^3.3|^4.0",
-        "symfony/framework-bundle": "^3.3|^4.0",
+        "symfony/framework-bundle": "^3.4|^4.0",
         "symfony/dependency-injection": "^3.3|^4.0",
         "symfony/http-kernel": "^3.3|^4.0",
         "doctrine/common": "^2.2"
@@ -45,7 +45,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "5.1.x-dev"
+            "dev-master": "5.2.x-dev"
         }
     },
     "minimum-stability": "dev"