[FrameworkBundle] Deprecate some public services to private

fancyweb · fancyweb · commit fa9959184d3d · 2020-05-07T12:47:21.000+02:00
diff --git a/UPGRADE-5.2.md b/UPGRADE-5.2.md
@@ -0,0 +1,8 @@
+UPGRADE FROM 5.1 to 5.2
+=======================
+
+FrameworkBundle
+---------------
+
+ * Deprecated the public `form.factory`, `form.type.file`, `translator`, `security.csrf.token_manager`, `serializer`,
+   `cache_clearer`, `filesystem` and `validator` services to private.
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -53,6 +53,8 @@ FrameworkBundle
  * `MicroKernelTrait::configureRoutes()` is now always called with a `RoutingConfigurator`
  * The "framework.router.utf8" configuration option defaults to `true`
  * Removed `session.attribute_bag` service and `session.flash_bag` service.
+ * The `form.factory`, `form.type.file`, `translator`, `security.csrf.token_manager`, `serializer`,
+   `cache_clearer`, `filesystem` and `validator` services are now private.
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+5.2.0
+-----
+
+ * Deprecated the public `form.factory`, `form.type.file`, `translator`, `security.csrf.token_manager`, `serializer`,
+   `cache_clearer`, `filesystem` and `validator` services to private.
+
 5.1.0
 -----
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/form.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/form.xml
@@ -28,6 +28,7 @@
 
         <!-- FormFactory -->
         <service id="form.factory" class="Symfony\Component\Form\FormFactory" public="true">
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
             <argument type="service" id="form.registry" />
         </service>
         <service id="Symfony\Component\Form\FormFactoryInterface" alias="form.factory" />
@@ -72,6 +73,7 @@
         </service>
         <service id="form.type.file" class="Symfony\Component\Form\Extension\Core\Type\FileType" public="true">
             <tag name="form.type" />
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
             <argument type="service" id="translator" on-invalid="ignore" />
         </service>
         <service id="form.type.color" class="Symfony\Component\Form\Extension\Core\Type\ColorType">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/identity_translator.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/identity_translator.xml
@@ -6,7 +6,9 @@
     <services>
         <defaults public="false" />
 
-        <service id="translator" class="Symfony\Component\Translation\IdentityTranslator" public="true" />
+        <service id="translator" class="Symfony\Component\Translation\IdentityTranslator" public="true">
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
+        </service>
         <service id="Symfony\Contracts\Translation\TranslatorInterface" alias="translator" />
 
         <service id="identity_translator" class="Symfony\Component\Translation\IdentityTranslator" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/security_csrf.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/security_csrf.xml
@@ -19,6 +19,7 @@
             <argument type="service" id="security.csrf.token_generator" />
             <argument type="service" id="security.csrf.token_storage" />
             <argument type="service" id="request_stack" on-invalid="ignore" />
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
         </service>
         <service id="Symfony\Component\Security\Csrf\CsrfTokenManagerInterface" alias="security.csrf.token_manager" />
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml
@@ -15,6 +15,7 @@
         <service id="serializer" class="Symfony\Component\Serializer\Serializer" public="true">
             <argument type="collection" />
             <argument type="collection" />
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
         </service>
         <service id="Symfony\Component\Serializer\SerializerInterface" alias="serializer" />
         <service id="Symfony\Component\Serializer\Normalizer\NormalizerInterface" alias="serializer" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml
@@ -74,12 +74,15 @@
 
         <service id="cache_clearer" class="Symfony\Component\HttpKernel\CacheClearer\ChainCacheClearer" public="true">
             <argument type="tagged_iterator" tag="kernel.cache_clearer" />
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
         </service>
 
         <service id="kernel" synthetic="true" public="true" />
         <service id="Symfony\Component\HttpKernel\KernelInterface" alias="kernel" />
 
-        <service id="filesystem" class="Symfony\Component\Filesystem\Filesystem" public="true" />
+        <service id="filesystem" class="Symfony\Component\Filesystem\Filesystem" public="true">
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
+        </service>
         <service id="Symfony\Component\Filesystem\Filesystem" alias="filesystem" />
 
         <service id="file_locator" class="Symfony\Component\HttpKernel\Config\FileLocator">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.xml
@@ -14,6 +14,7 @@
 
         <service id="validator" class="Symfony\Component\Validator\Validator\ValidatorInterface" public="true">
             <factory service="validator.builder" method="getValidator" />
+            <tag name="container.private" package="symfony/framework-bundle" version="5.2" />
         </service>
         <service id="Symfony\Component\Validator\Validator\ValidatorInterface" alias="validator" />
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_annotations.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/validation_annotations.php
@@ -7,3 +7,5 @@
         'enable_annotations' => true,
     ],
 ]);
+
+$container->setAlias('validator.alias', 'validator')->setPublic(true);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_annotations.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/validation_annotations.xml
@@ -9,4 +9,8 @@
     <framework:config secret="s3cr3t">
         <framework:validation enabled="true" enable-annotations="true" />
     </framework:config>
+
+    <services>
+        <service id="validator.alias" alias="validator" public="true" />
+    </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_annotations.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/validation_annotations.yml
@@ -3,3 +3,8 @@ framework:
     validation:
         enabled:     true
         enable_annotations: true
+
+services:
+    validator.alias:
+        alias: validator
+        public: true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -839,7 +839,7 @@ public function testValidationService()
     {
         $container = $this->createContainerFromFile('validation_annotations', ['kernel.charset' => 'UTF-8'], false);
 
-        $this->assertInstanceOf('Symfony\Component\Validator\Validator\ValidatorInterface', $container->get('validator'));
+        $this->assertInstanceOf('Symfony\Component\Validator\Validator\ValidatorInterface', $container->get('validator.alias'));
     }
 
     public function testAnnotations()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/BundlePathsTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/BundlePathsTest.php
@@ -53,7 +53,7 @@ public function testBundleTwigTemplatesDir()
     public function testBundleTranslationsDir()
     {
         static::bootKernel(['test_case' => 'BundlePaths']);
-        $translator = static::$container->get('translator');
+        $translator = static::$container->get('translator.alias');
 
         $this->assertSame('OK', $translator->trans('ok_label', [], 'legacy'));
         $this->assertSame('OK', $translator->trans('ok_label', [], 'modern'));
@@ -62,7 +62,7 @@ public function testBundleTranslationsDir()
     public function testBundleValidationConfigDir()
     {
         static::bootKernel(['test_case' => 'BundlePaths']);
-        $validator = static::$container->get('validator');
+        $validator = static::$container->get('validator.alias');
 
         $this->assertTrue($validator->hasMetadataFor(LegacyPerson::class));
         $this->assertCount(1, $constraintViolationList = $validator->validate(new LegacyPerson('john', 5)));
@@ -76,7 +76,7 @@ public function testBundleValidationConfigDir()
     public function testBundleSerializationConfigDir()
     {
         static::bootKernel(['test_case' => 'BundlePaths']);
-        $serializer = static::$container->get('serializer');
+        $serializer = static::$container->get('serializer.alias');
 
         $this->assertEquals(['full_name' => 'john', 'age' => 5], $serializer->normalize(new LegacyPerson('john', 5), 'json'));
         $this->assertEquals(['full_name' => 'john', 'age' => 5], $serializer->normalize(new ModernPerson('john', 5), 'json'));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolsTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolsTest.php
@@ -96,7 +96,7 @@ private function doTestCachePools($options, $adapterClass)
         $pool2 = $container->get('cache.pool2');
         $pool2->save($item);
 
-        $container->get('cache_clearer')->clear($container->getParameter('kernel.cache_dir'));
+        $container->get('cache_clearer.alias')->clear($container->getParameter('kernel.cache_dir'));
         $item = $pool1->getItem($key);
         $this->assertFalse($item->isHit());
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SerializerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SerializerTest.php
@@ -20,7 +20,7 @@ public function testDeserializeArrayOfObject()
     {
         static::bootKernel(['test_case' => 'Serializer']);
 
-        $result = static::$container->get('serializer')->deserialize('{"bars": [{"id": 1}, {"id": 2}]}', Foo::class, 'json');
+        $result = static::$container->get('serializer.alias')->deserialize('{"bars": [{"id": 1}, {"id": 2}]}', Foo::class, 'json');
 
         $bar1 = new Bar();
         $bar1->id = 1;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/BundlePaths/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/BundlePaths/config.yml
@@ -8,3 +8,16 @@ framework:
 
 twig:
     strict_variables: '%kernel.debug%'
+
+services:
+    validator.alias:
+        alias: validator
+        public: true
+
+    serializer.alias:
+        alias: serializer
+        public: true
+
+    translator.alias:
+        alias: translator
+        public: true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/CachePools/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/CachePools/config.yml
@@ -24,3 +24,8 @@ framework:
             cache.pool7:
                 adapter: cache.pool4
                 public: true
+
+services:
+    cache_clearer.alias:
+        alias: cache_clearer
+        public: true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Serializer/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Serializer/config.yml
@@ -4,3 +4,8 @@ imports:
 framework:
     serializer: { enabled: true }
     property_info: { enabled: true }
+
+services:
+    serializer.alias:
+        alias: serializer
+        public: true
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/CsrfFormLoginBundle/Controller/LoginController.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/CsrfFormLoginBundle/Controller/LoginController.php
@@ -11,14 +11,21 @@
 
 namespace Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\CsrfFormLoginBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+use Symfony\Contracts\Service\ServiceSubscriberInterface;
+use Twig\Environment;
 
-class LoginController implements ContainerAwareInterface
+class LoginController implements ServiceSubscriberInterface
 {
-    use ContainerAwareTrait;
+    private $container;
+
+    public function __construct(ContainerInterface $container)
+    {
+        $this->container = $container;
+    }
 
     public function loginAction()
     {
@@ -43,4 +50,15 @@ public function secureAction()
     {
         throw new \Exception('Wrapper', 0, new \Exception('Another Wrapper', 0, new AccessDeniedException()));
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedServices()
+    {
+        return [
+            'form.factory' => FormFactoryInterface::class,
+            'twig' => Environment::class,
+        ];
+    }
 }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/CsrfFormLogin/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/CsrfFormLogin/config.yml
@@ -9,6 +9,11 @@ services:
         tags:
             - { name: form.type }
 
+    Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\CsrfFormLoginBundle\Controller\LoginController:
+        public: true
+        tags:
+            - { name: container.service_subscriber }
+
 security:
     encoders:
         Symfony\Component\Security\Core\User\User: plaintext
