feature #60597 [DependencyInjection][FrameworkBundle] Use php-serialize to dump the container for debug/lint commands (nicolas-grekas)

This PR was merged into the 7.4 branch.

Discussion
----------

[DependencyInjection][FrameworkBundle] Use php-serialize to dump the container for debug/lint commands

| Q             | A
| ------------- | ---
| Branch?       | 7.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

To unlock #60568 this uses `serialize()` to dump the container, next to the XML dump.

Commits
-------

c128f55b842 [DependencyInjection][FrameworkBundle] Use php-serialize to dump the container for debug/lint commands

Author: nicolas-grekas

Command/BuildDebugContainerTrait.php

@@ -39,7 +39,9 @@ protected function getContainerBuilder(KernelInterface $kernel): ContainerBuilde
             return $this->container;
         }
 
-        if (!$kernel->isDebug() || !$kernel->getContainer()->getParameter('debug.container.dump') || !(new ConfigCache($kernel->getContainer()->getParameter('debug.container.dump'), true))->isFresh()) {
+        $file = $kernel->isDebug() ? $kernel->getContainer()->getParameter('debug.container.dump') : false;
+
+        if (!$file || !(new ConfigCache($file, true))->isFresh()) {
             $buildContainer = \Closure::bind(function () {
                 $this->initializeBundles();
 
@@ -57,13 +59,17 @@ protected function getContainerBuilder(KernelInterface $kernel): ContainerBuilde
                 return $containerBuilder;
             }, $kernel, $kernel::class);
             $container = $buildContainer();
-            (new XmlFileLoader($container, new FileLocator()))->load($kernel->getContainer()->getParameter('debug.container.dump'));
-            $locatorPass = new ServiceLocatorTagPass();
-            $locatorPass->process($container);
 
-            $container->getCompilerPassConfig()->setBeforeOptimizationPasses([]);
-            $container->getCompilerPassConfig()->setOptimizationPasses([]);
-            $container->getCompilerPassConfig()->setBeforeRemovingPasses([]);
+            if (str_ends_with($file, '.xml') && is_file(substr_replace($file, '.ser', -4))) {
+                $dumpedContainer = unserialize(file_get_contents(substr_replace($file, '.ser', -4)));
+                $container->setDefinitions($dumpedContainer->getDefinitions());
+                $container->setAliases($dumpedContainer->getAliases());
+                $container->__construct($dumpedContainer->getParameterBag());
+            } else {
+                (new XmlFileLoader($container, new FileLocator()))->load($file);
+                $locatorPass = new ServiceLocatorTagPass();
+                $locatorPass->process($container);
+            }
         }
 
         return $this->container = $container;

Command/ContainerLintCommand.php

@@ -79,9 +79,10 @@ private function getContainerBuilder(): ContainerBuilder
         }
 
         $kernel = $this->getApplication()->getKernel();
-        $kernelContainer = $kernel->getContainer();
+        $container = $kernel->getContainer();
+        $file = $container->isDebug() ? $container->getParameter('debug.container.dump') : false;
 
-        if (!$kernel->isDebug() || !$kernelContainer->getParameter('debug.container.dump') || !(new ConfigCache($kernelContainer->getParameter('debug.container.dump'), true))->isFresh()) {
+        if (!$file || !(new ConfigCache($file, true))->isFresh()) {
             if (!$kernel instanceof Kernel) {
                 throw new RuntimeException(\sprintf('This command does not support the application kernel: "%s" does not extend "%s".', get_debug_type($kernel), Kernel::class));
             }
@@ -93,12 +94,17 @@ private function getContainerBuilder(): ContainerBuilder
             }, $kernel, $kernel::class);
             $container = $buildContainer();
         } else {
-            if (!$kernelContainer instanceof Container) {
-                throw new RuntimeException(\sprintf('This command does not support the application container: "%s" does not extend "%s".', get_debug_type($kernelContainer), Container::class));
+            if (str_ends_with($file, '.xml') && is_file(substr_replace($file, '.ser', -4))) {
+                $container = unserialize(file_get_contents(substr_replace($file, '.ser', -4)));
+            } else {
+                (new XmlFileLoader($container = new ContainerBuilder(new EnvPlaceholderParameterBag()), new FileLocator()))->load($file);
             }
 
-            (new XmlFileLoader($container = new ContainerBuilder($parameterBag = new EnvPlaceholderParameterBag()), new FileLocator()))->load($kernelContainer->getParameter('debug.container.dump'));
+            if (!$container instanceof ContainerBuilder) {
+                throw new RuntimeException(\sprintf('This command does not support the application container: "%s" is not a "%s".', get_debug_type($container), ContainerBuilder::class));
+            }
 
+            $parameterBag = $container->getParameterBag();
             $refl = new \ReflectionProperty($parameterBag, 'resolved');
             $refl->setValue($parameterBag, true);
 

DependencyInjection/Compiler/ContainerBuilderDebugDumpPass.php

@@ -13,8 +13,11 @@
 
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\ResolveEnvPlaceholdersPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Dumper\XmlDumper;
+use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * Dumps the ContainerBuilder to a cache file so that it can be used by
@@ -31,9 +34,38 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $cache = new ConfigCache($container->getParameter('debug.container.dump'), true);
-        if (!$cache->isFresh()) {
-            $cache->write((new XmlDumper($container))->dump(), $container->getResources());
+        $file = $container->getParameter('debug.container.dump');
+        $cache = new ConfigCache($file, true);
+        if ($cache->isFresh()) {
+            return;
+        }
+        $cache->write((new XmlDumper($container))->dump(), $container->getResources());
+
+        if (!str_ends_with($file, '.xml')) {
+            return;
+        }
+
+        $file = substr_replace($file, '.ser', -4);
+
+        try {
+            $dump = new ContainerBuilder(clone $container->getParameterBag());
+            $dump->setDefinitions(unserialize(serialize($container->getDefinitions())));
+            $dump->setAliases($container->getAliases());
+
+            if (($bag = $container->getParameterBag()) instanceof EnvPlaceholderParameterBag) {
+                (new ResolveEnvPlaceholdersPass(null))->process($dump);
+                $dump->__construct(new EnvPlaceholderParameterBag($container->resolveEnvPlaceholders($bag->all())));
+            }
+
+            $fs = new Filesystem();
+            $fs->dumpFile($file, serialize($dump));
+            $fs->chmod($file, 0666, umask());
+        } catch (\Throwable $e) {
+            $container->getCompiler()->log($this, $e->getMessage());
+            // ignore serialization and file-system errors
+            if (file_exists($file)) {
+                @unlink($file);
+            }
         }
     }
 }