[DI] deprecate short callables in yaml

nicolas-grekas · nicolas-grekas · commit ec906b6fc257 · 2019-05-20T13:22:35.000+02:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -0,0 +1,21 @@
+UPGRADE FROM 4.2 to 4.3
+=======================
+
+DependencyInjection
+-------------------
+
+ * Deprecated support for short factories and short configurators in Yaml
+
+   Before:
+   ```yaml
+   services:
+     my_service:
+       factory: factory_service:method
+   ```
+
+   After:
+   ```yaml
+   services:
+     my_service:
+       factory: ['@factory_service', method]
+   ```
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -69,6 +69,22 @@ DependencyInjection
         env(NAME): '1.5'
    ```
 
+ * Removed support for short factories and short configurators in Yaml
+
+   Before:
+   ```yaml
+   services:
+     my_service:
+       factory: factory_service:method
+   ```
+
+   After:
+   ```yaml
+   services:
+     my_service:
+       factory: ['@factory_service', method]
+   ```
+
 DoctrineBridge
 --------------
 
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * deprecated support for short factories and short configurators in Yaml
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -574,28 +574,29 @@ private function parseDefinition($id, $service, $file, array $defaults)
     /**
      * Parses a callable.
      *
-     * @param string|array $callable  A callable
-     * @param string       $parameter A parameter (e.g. 'factory' or 'configurator')
-     * @param string       $id        A service identifier
-     * @param string       $file      A parsed file
+     * @param string|array $callable  A callable reference
+     * @param string       $parameter The type of callable (e.g. 'factory' or 'configurator')
      *
      * @throws InvalidArgumentException When errors occur
      *
      * @return string|array|Reference A parsed callable
      */
-    private function parseCallable($callable, $parameter, $id, $file)
+    private function parseCallable($callable, string $parameter, string $id, string $file)
     {
         if (\is_string($callable)) {
             if ('' !== $callable && '@' === $callable[0]) {
                 if (false === strpos($callable, ':')) {
                     return [$this->resolveServices($callable, $file), '__invoke'];
                 }
-                throw new InvalidArgumentException(sprintf('The value of the "%s" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s").', $parameter, $id, $callable, substr($callable, 1)));
+
+                throw new InvalidArgumentException(sprintf('The value of the "%s" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s" in "%s").', $parameter, $id, $callable, substr($callable, 1), $file));
             }
 
             if (false !== strpos($callable, ':') && false === strpos($callable, '::')) {
                 $parts = explode(':', $callable);
 
+                @trigger_error(sprintf('Using short %s syntax for service "%s" is deprecated since Symfony 4.4, use "[\'@%s\', \'%s\']" instead.', $parameter, $id, ...$parts), E_USER_DEPRECATED);
+
                 return [$this->resolveServices('@'.$parts[0], $file), $parts[1]];
             }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php
@@ -191,6 +191,9 @@ public function testDeprecatedAliases()
         $this->assertSame($message, $container->getAlias('alias_for_foobar')->getDeprecationMessage('alias_for_foobar'));
     }
 
+    /**
+     * @group legacy
+     */
     public function testLoadFactoryShortSyntax()
     {
         $container = new ContainerBuilder();
@@ -208,10 +211,13 @@ public function testFactorySyntaxError()
         $container = new ContainerBuilder();
         $loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('The value of the "factory" option for the "invalid_factory" service must be the id of the service without the "@" prefix (replace "@factory:method" with "factory:method").');
+        $this->expectExceptionMessage('The value of the "factory" option for the "invalid_factory" service must be the id of the service without the "@" prefix (replace "@factory:method" with "factory:method"');
         $loader->load('bad_factory_syntax.yml');
     }
 
+    /**
+     * @group legacy
+     */
     public function testLoadConfiguratorShortSyntax()
     {
         $container = new ContainerBuilder();

Original file line number	Diff line number	Diff line change
`@@ -574,28 +574,29 @@ private function parseDefinition($id, $service, $file, array $defaults)`
`574`	`574`	`/**`
`575`	`575`	`* Parses a callable.`
`576`	`576`	`*`
`577`		`- * @param string\|array $callable A callable`
`578`		`- * @param string $parameter A parameter (e.g. 'factory' or 'configurator')`
`579`		`- * @param string $id A service identifier`
`580`		`- * @param string $file A parsed file`
	`577`	`+ * @param string\|array $callable A callable reference`
	`578`	`+ * @param string $parameter The type of callable (e.g. 'factory' or 'configurator')`
`581`	`579`	`*`
`582`	`580`	`* @throws InvalidArgumentException When errors occur`
`583`	`581`	`*`
`584`	`582`	`* @return string\|array\|Reference A parsed callable`
`585`	`583`	`*/`
`586`		`- private function parseCallable($callable, $parameter, $id, $file)`
	`584`	`+ private function parseCallable($callable, string $parameter, string $id, string $file)`
`587`	`585`	`{`
`588`	`586`	`if (\is_string($callable)) {`
`589`	`587`	`if ('' !== $callable && '@' === $callable[0]) {`
`590`	`588`	`if (false === strpos($callable, ':')) {`
`591`	`589`	`return [$this->resolveServices($callable, $file), '__invoke'];`
`592`	`590`	`}`
`593`		`- throw new InvalidArgumentException(sprintf('The value of the "%s" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s").', $parameter, $id, $callable, substr($callable, 1)));`
	`591`	`+`
	`592`	`+ throw new InvalidArgumentException(sprintf('The value of the "%s" option for the "%s" service must be the id of the service without the "@" prefix (replace "%s" with "%s" in "%s").', $parameter, $id, $callable, substr($callable, 1), $file));`
`594`	`593`	`}`
`595`	`594`
`596`	`595`	`if (false !== strpos($callable, ':') && false === strpos($callable, '::')) {`
`597`	`596`	`$parts = explode(':', $callable);`
`598`	`597`
	`598`	`+ @trigger_error(sprintf('Using short %s syntax for service "%s" is deprecated since Symfony 4.4, use "[\'@%s\', \'%s\']" instead.', $parameter, $id, ...$parts), E_USER_DEPRECATED);`
	`599`	`+`
`599`	`600`	`return [$this->resolveServices('@'.$parts[0], $file), $parts[1]];`
`600`	`601`	`}`
`601`	`602`
Original file line number	Diff line number	Diff line change
`@@ -191,6 +191,9 @@ public function testDeprecatedAliases()`
`191`	`191`	`$this->assertSame($message, $container->getAlias('alias_for_foobar')->getDeprecationMessage('alias_for_foobar'));`
`192`	`192`	`}`
`193`	`193`
	`194`	`+ /**`
	`195`	`+ * @group legacy`
	`196`	`+ */`
`194`	`197`	`public function testLoadFactoryShortSyntax()`
`195`	`198`	`{`
`196`	`199`	`$container = new ContainerBuilder();`
`@@ -208,10 +211,13 @@ public function testFactorySyntaxError()`
`208`	`211`	`$container = new ContainerBuilder();`
`209`	`212`	`$loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));`
`210`	`213`	`$this->expectException(InvalidArgumentException::class);`
`211`		`- $this->expectExceptionMessage('The value of the "factory" option for the "invalid_factory" service must be the id of the service without the "@" prefix (replace "@factory:method" with "factory:method").');`
	`214`	`+ $this->expectExceptionMessage('The value of the "factory" option for the "invalid_factory" service must be the id of the service without the "@" prefix (replace "@factory:method" with "factory:method"');`
`212`	`215`	`$loader->load('bad_factory_syntax.yml');`
`213`	`216`	`}`
`214`	`217`
	`218`	`+ /**`
	`219`	`+ * @group legacy`
	`220`	`+ */`
`215`	`221`	`public function testLoadConfiguratorShortSyntax()`
`216`	`222`	`{`
`217`	`223`	`$container = new ContainerBuilder();`