[DependencyInjection][VarExporter] Fix support for lazy withers

nicolas-grekas · nicolas-grekas · commit 28c3300482a0 · 2022-07-13T16:52:16.000+02:00
diff --git a/ContainerBuilder.php b/ContainerBuilder.php
@@ -1040,12 +1040,8 @@ private function createService(Definition $definition, array &$inlineServices, b
         if (null !== $factory) {
             $service = $factory(...$arguments);
 
-            if (\is_object($tryProxy)) {
-                if (\get_class($service) !== $parameterBag->resolveValue($definition->getClass())) {
-                    throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', $definition->getClass(), get_debug_type($service)));
-                }
-
-                $tryProxy = Hydrator::hydrate($tryProxy, (array) $service);
+            if (\is_object($tryProxy) && \get_class($service) !== $parameterBag->resolveValue($definition->getClass())) {
+                throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', $definition->getClass(), get_debug_type($service)));
             }
 
             if (!$definition->isDeprecated() && \is_array($factory) && \is_string($factory[0])) {
@@ -1117,6 +1113,10 @@ private function createService(Definition $definition, array &$inlineServices, b
             $callable($service);
         }
 
+        if (\is_object($tryProxy) && $tryProxy !== $service) {
+            return Hydrator::hydrate($tryProxy, (array) $service);
+        }
+
         return $service;
     }
 
diff --git a/Dumper/PhpDumper.php b/Dumper/PhpDumper.php
@@ -676,6 +676,9 @@ private function addServiceInstance(string $id, Definition $definition, bool $is
 
         $return = '';
         if ($isSimpleInstance) {
+            if ($asGhostObject && null !== $definition->getFactory()) {
+                $instantiation .= '$this->hydrateProxy($lazyLoad, ';
+            }
             $return = 'return ';
         } else {
             $instantiation .= ' = ';
@@ -1058,7 +1061,7 @@ private function addInlineService(string $id, Definition $definition, Definition
             if ('instance' === $name) {
                 $code .= $this->addServiceInstance($id, $definition, $isSimpleInstance);
             } else {
-                $code .= $this->addNewInstance($inlineDef, '        $'.$name.' = ', $id, $asGhostObject);
+                $code .= $this->addNewInstance($inlineDef, '        $'.$name.' = ', $id);
             }
 
             if ('' !== $inline = $this->addInlineVariables($id, $definition, $arguments, false)) {
@@ -1072,11 +1075,15 @@ private function addInlineService(string $id, Definition $definition, Definition
             $code .= $this->addServiceConfigurator($inlineDef, $name);
         }
 
-        if ($isRootInstance && !$isSimpleInstance) {
-            $code .= "\n        return \$instance;\n";
+        if (!$isRootInstance || $isSimpleInstance) {
+            return $code;
         }
 
-        return $code;
+        if (!$asGhostObject) {
+            return $code."\n        return \$instance;\n";
+        }
+
+        return $code."\n        return \$this->hydrateProxy(\$lazyLoad, \$instance);\n";
     }
 
     private function addServices(array &$services = null): string
@@ -1123,7 +1130,7 @@ private function generateServiceFiles(array $services): iterable
 
     private function addNewInstance(Definition $definition, string $return = '', string $id = null, bool $asGhostObject = false): string
     {
-        $tail = $return ? ";\n" : '';
+        $tail = $return ? str_repeat(')', substr_count($return, '(') - substr_count($return, ')')).";\n" : '';
 
         if (BaseServiceLocator::class === $definition->getClass() && $definition->hasTag($this->serviceLocatorTag)) {
             $arguments = [];
@@ -1142,11 +1149,6 @@ private function addNewInstance(Definition $definition, string $return = '', str
         if (null !== $definition->getFactory()) {
             $callable = $definition->getFactory();
 
-            if ($asGhostObject) {
-                $return .= '$this->hydrateProxy($lazyLoad, ';
-                $tail = ')'.$tail;
-            }
-
             if (['Closure', 'fromCallable'] === $callable && [0] === array_keys($definition->getArguments())) {
                 $callable = $definition->getArgument(0);
                 $arguments = ['...'];
@@ -1202,7 +1204,7 @@ private function addNewInstance(Definition $definition, string $return = '', str
             return $return.sprintf('new %s(%s)', $this->dumpLiteralClass($this->dumpValue($class)), implode(', ', $arguments)).$tail;
         }
 
-        if (!method_exists($class, '__construct')) {
+        if (!method_exists($this->container->getParameterBag()->resolveValue($class), '__construct')) {
             return $return.'$lazyLoad'.$tail;
         }
 
@@ -1329,6 +1331,10 @@ protected function createProxy(\$class, \Closure \$factory)
 
     protected function hydrateProxy(\$proxy, \$instance)
     {
+        if (\$proxy === \$instance) {
+            return \$proxy;
+        }
+
         if (!\in_array(\get_class(\$instance), [\get_class(\$proxy), get_parent_class(\$proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1\$s".', get_parent_class(\$proxy), get_debug_type(\$instance)));
         }
@@ -1880,10 +1886,7 @@ private function dumpValue(mixed $value, bool $interpolate = true): string
                 throw new RuntimeException('Cannot dump definitions which have a configurator.');
             }
 
-            $asGhostObject = false;
-            $this->isProxyCandidate($value, $asGhostObject);
-
-            return $this->addNewInstance($value, '', null, $asGhostObject);
+            return $this->addNewInstance($value);
         } elseif ($value instanceof Variable) {
             return '$'.$value;
         } elseif ($value instanceof Reference) {
diff --git a/Tests/ContainerBuilderTest.php b/Tests/ContainerBuilderTest.php
@@ -1681,6 +1681,24 @@ public function testWither()
         $this->assertInstanceOf(Foo::class, $wither->foo);
     }
 
+    public function testLazyWither()
+    {
+        $container = new ContainerBuilder();
+        $container->register(Foo::class);
+
+        $container
+            ->register('wither', Wither::class)
+            ->setLazy(true)
+            ->setPublic(true)
+            ->setAutowired(true);
+
+        $container->compile();
+
+        $wither = $container->get('wither');
+        $this->assertInstanceOf(Foo::class, $wither->foo);
+        $this->assertTrue($wither->resetLazyGhostObject());
+    }
+
     public function testWitherWithStaticReturnType()
     {
         $container = new ContainerBuilder();
diff --git a/Tests/Dumper/PhpDumperTest.php b/Tests/Dumper/PhpDumperTest.php
@@ -1434,6 +1434,30 @@ public function testWither()
         $this->assertInstanceOf(Foo::class, $wither->foo);
     }
 
+    public function testLazyWither()
+    {
+        $container = new ContainerBuilder();
+        $container->register(Foo::class);
+
+        $container
+            ->register('wither', Wither::class)
+            ->setLazy(true)
+            ->setPublic(true)
+            ->setAutowired(true);
+
+        $container->compile();
+        $dumper = new PhpDumper($container);
+        $dump = $dumper->dump(['class' => 'Symfony_DI_PhpDumper_Service_Wither_Lazy']);
+        $this->assertStringEqualsFile(self::$fixturesPath.'/php/services_wither_lazy.php', $dump);
+        eval('?>'.$dump);
+
+        $container = new \Symfony_DI_PhpDumper_Service_Wither_Lazy();
+
+        $wither = $container->get('wither');
+        $this->assertInstanceOf(Foo::class, $wither->foo);
+        $this->assertTrue($wither->resetLazyGhostObject());
+    }
+
     public function testWitherWithStaticReturnType()
     {
         $container = new ContainerBuilder();
diff --git a/Tests/Fixtures/php/services9_lazy_inlined_factories.txt b/Tests/Fixtures/php/services9_lazy_inlined_factories.txt
@@ -72,6 +72,10 @@ class ProjectServiceContainer extends Container
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_dedup_lazy_ghost.php b/Tests/Fixtures/php/services_dedup_lazy_ghost.php
@@ -44,6 +44,10 @@ protected function createProxy($class, \Closure $factory)
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_dedup_lazy_proxy.php b/Tests/Fixtures/php/services_dedup_lazy_proxy.php
@@ -44,6 +44,10 @@ protected function createProxy($class, \Closure $factory)
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_non_shared_lazy.php b/Tests/Fixtures/php/services_non_shared_lazy.php
@@ -50,6 +50,10 @@ protected function createProxy($class, \Closure $factory)
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_non_shared_lazy_as_files.txt b/Tests/Fixtures/php/services_non_shared_lazy_as_files.txt
@@ -126,6 +126,10 @@ class ProjectServiceContainer extends Container
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_non_shared_lazy_ghost.php b/Tests/Fixtures/php/services_non_shared_lazy_ghost.php
@@ -50,6 +50,10 @@ protected function createProxy($class, \Closure $factory)
 
     protected function hydrateProxy($proxy, $instance)
     {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
         if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
             throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
         }
diff --git a/Tests/Fixtures/php/services_wither_lazy.php b/Tests/Fixtures/php/services_wither_lazy.php
@@ -0,0 +1,92 @@
+<?php
+
+use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
+use Symfony\Component\DependencyInjection\Exception\RuntimeException;
+use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+/**
+ * @internal This class has been auto-generated by the Symfony Dependency Injection Component.
+ */
+class Symfony_DI_PhpDumper_Service_Wither_Lazy extends Container
+{
+    protected $parameters = [];
+
+    public function __construct()
+    {
+        $this->services = $this->privates = [];
+        $this->methodMap = [
+            'wither' => 'getWitherService',
+        ];
+
+        $this->aliases = [];
+    }
+
+    public function compile(): void
+    {
+        throw new LogicException('You cannot compile a dumped container that was already compiled.');
+    }
+
+    public function isCompiled(): bool
+    {
+        return true;
+    }
+
+    public function getRemovedIds(): array
+    {
+        return [
+            'Symfony\\Component\\DependencyInjection\\Tests\\Compiler\\Foo' => true,
+        ];
+    }
+
+    protected function createProxy($class, \Closure $factory)
+    {
+        return $factory();
+    }
+
+    protected function hydrateProxy($proxy, $instance)
+    {
+        if ($proxy === $instance) {
+            return $proxy;
+        }
+
+        if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {
+            throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));
+        }
+
+        return \Symfony\Component\VarExporter\Hydrator::hydrate($proxy, (array) $instance);
+    }
+
+    /**
+     * Gets the public 'wither' shared autowired service.
+     *
+     * @return \Symfony\Component\DependencyInjection\Tests\Compiler\Wither
+     */
+    protected function getWitherService($lazyLoad = true)
+    {
+        if (true === $lazyLoad) {
+            return $this->services['wither'] = $this->createProxy('Wither_94fa281', function () {
+                return \Wither_94fa281::createLazyGhostObject($this->getWitherService(...));
+            });
+        }
+
+        $instance = $lazyLoad;
+
+        $a = new \Symfony\Component\DependencyInjection\Tests\Compiler\Foo();
+
+        $instance = $instance->withFoo1($a);
+        $instance = $instance->withFoo2($a);
+        $instance->setFoo($a);
+
+        return $this->hydrateProxy($lazyLoad, $instance);
+    }
+}
+
+class Wither_94fa281 extends \Symfony\Component\DependencyInjection\Tests\Compiler\Wither implements \Symfony\Component\VarExporter\LazyGhostObjectInterface
+{
+    use \Symfony\Component\VarExporter\LazyGhostObjectTrait;
+}

Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,10 @@ class ProjectServiceContainer extends Container`
`72`	`72`
`73`	`73`	`protected function hydrateProxy($proxy, $instance)`
`74`	`74`	`{`
	`75`	`+ if ($proxy === $instance) {`
	`76`	`+ return $proxy;`
	`77`	`+ }`
	`78`	`+`
`75`	`79`	`if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {`
`76`	`80`	`throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));`
`77`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,10 @@ protected function createProxy($class, \Closure $factory)`
`44`	`44`
`45`	`45`	`protected function hydrateProxy($proxy, $instance)`
`46`	`46`	`{`
	`47`	`+ if ($proxy === $instance) {`
	`48`	`+ return $proxy;`
	`49`	`+ }`
	`50`	`+`
`47`	`51`	`if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {`
`48`	`52`	`throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));`
`49`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ protected function createProxy($class, \Closure $factory)`
`50`	`50`
`51`	`51`	`protected function hydrateProxy($proxy, $instance)`
`52`	`52`	`{`
	`53`	`+ if ($proxy === $instance) {`
	`54`	`+ return $proxy;`
	`55`	`+ }`
	`56`	`+`
`53`	`57`	`if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {`
`54`	`58`	`throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));`
`55`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,10 @@ class ProjectServiceContainer extends Container`
`126`	`126`
`127`	`127`	`protected function hydrateProxy($proxy, $instance)`
`128`	`128`	`{`
	`129`	`+ if ($proxy === $instance) {`
	`130`	`+ return $proxy;`
	`131`	`+ }`
	`132`	`+`
`129`	`133`	`if (!\in_array(\get_class($instance), [\get_class($proxy), get_parent_class($proxy)], true)) {`
`130`	`134`	`throw new LogicException(sprintf('Lazy service of type "%s" cannot be hydrated because its factory returned an unexpected instance of "%s". Try adding the "proxy" tag to the corresponding service definition with attribute "interface" set to "%1$s".', get_parent_class($proxy), get_debug_type($instance)));`
`131`	`135`	`}`