[DI] generate preload.php file for PHP 7.4 in cache folder

nicolas-grekas · nicolas-grekas · commit 8aa4acab27e7 · 2019-06-17T14:53:51.000+02:00
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -81,6 +81,7 @@ class PhpDumper extends Dumper
     private $locatedIds = [];
     private $serviceLocatorTag;
     private $exportedVariables = [];
+    private $baseClass;
 
     /**
      * @var ProxyDumper
@@ -148,11 +149,11 @@ public function dump(array $options = [])
 
         if (0 !== strpos($baseClass = $options['base_class'], '\\') && 'Container' !== $baseClass) {
             $baseClass = sprintf('%s\%s', $options['namespace'] ? '\\'.$options['namespace'] : '', $baseClass);
-            $baseClassWithNamespace = $baseClass;
+            $this->baseClass = $baseClass;
         } elseif ('Container' === $baseClass) {
-            $baseClassWithNamespace = Container::class;
+            $this->baseClass = Container::class;
         } else {
-            $baseClassWithNamespace = $baseClass;
+            $this->baseClass = $baseClass;
         }
 
         $this->initializeMethodNamesMap('Container' === $baseClass ? Container::class : $baseClass);
@@ -216,7 +217,7 @@ public function dump(array $options = [])
         }
 
         $code =
-            $this->startClass($options['class'], $baseClass, $baseClassWithNamespace).
+            $this->startClass($options['class'], $baseClass, $preload).
             $this->addServices($services).
             $this->addDeprecatedAliases().
             $this->addDefaultParametersMethod()
@@ -277,6 +278,104 @@ public function dump(array $options = [])
             $time = $options['build_time'];
             $id = hash('crc32', $hash.$time);
 
+            if ($preload) {
+                $code[$options['class'].'.preload.php'] = <<<EOF
+<?php
+
+// This file has been auto-generated by the Symfony Dependency Injection Component
+// You can reference it in the "opcache.preload" php.ini setting on PHP >= 7.4 when preloading is desired
+
+require dirname(__DIR__, 3).'/vendor/autoload.php';
+require __DIR__.'/Container{$hash}/{$options['class']}.php';
+
+EOF;
+
+                $code[$options['class'].'.preload.php'] .= <<<'EOF'
+
+set_error_handler(function ($t, $m, $f, $l) {
+    if (error_reporting() & $t) {
+        if (__FILE__ !== $f) {
+            throw new \ErrorException($m, 0, $t, $f, $l);
+        }
+
+        throw new \ReflectionException($m);
+    }
+});
+
+$preload = function ($class) use (&$preloaded, &$preload) {
+    if (isset($preloaded[$class]) || \in_array($class, ['self', 'static', 'parent'], true)) {
+        return;
+    }
+
+    $preloaded[$class] = true;
+
+    try {
+        $r = new \ReflectionClass($class);
+
+        if ($r->isInternal()) {
+            return;
+        }
+
+        $r->getConstants();
+        $r->getDefaultProperties();
+
+        if (\PHP_VERSION_ID >= 70400) {
+            foreach ($r->getProperties() as $p) {
+                if (($t = $p->getType()) && !$t->isBuiltin()) {
+                    $preload($t->getName());
+                }
+            }
+        }
+
+        foreach ($r->getMethods() as $m) {
+            foreach ($m->getParameters() as $p) {
+                if ($p->isDefaultValueAvailable() && $p->isDefaultValueConstant()) {
+                    $c = $p->getDefaultValueConstantName();
+
+                    if ($i = strpos($c, '::')) {
+                        $preload(substr($c, 0, $i));
+                    }
+                }
+
+                if (($t = $p->getType()) && !$t->isBuiltin()) {
+                    $preload($t->getName());
+                }
+            }
+
+            if (($t = $m->getReturnType()) && !$t->isBuiltin()) {
+                $preload($t->getName());
+            }
+        }
+    } catch (\ReflectionException $e) {
+        // ignore missing classes
+    }
+};
+
+
+EOF;
+
+                foreach ($preload as $class) {
+                    $code[$options['class'].'.preload.php'] .= sprintf("\$preload('%s');\n", $class);
+                }
+
+                $code[$options['class'].'.preload.php'] .= <<<'EOF'
+
+$prev = [];
+$classes = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
+
+while ($prev !== $classes) {
+    $prev = $classes;
+    foreach ($classes as $c) {
+        $preload($c);
+    }
+    $classes = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
+}
+
+restore_error_handler();
+
+EOF;
+            }
+
             $code[$options['class'].'.php'] = <<<EOF
 <?php
 {$namespaceLine}
@@ -399,14 +498,16 @@ private function collectLineage($class, array &$lineage)
         if (!$r = $this->container->getReflectionClass($class, false)) {
             return;
         }
-        if ($this->container instanceof $class) {
+        if (is_a($class, $this->baseClass, true)) {
             return;
         }
         $file = $r->getFileName();
         if (!$file || $this->doExport($file) === $exportedFile = $this->export($file)) {
             return;
         }
 
+        $lineage[$class] = substr($exportedFile, 1, -1);
+
         if ($parent = $r->getParentClass()) {
             $this->collectLineage($parent->name, $lineage);
         }
@@ -419,6 +520,7 @@ private function collectLineage($class, array &$lineage)
             $this->collectLineage($parent->name, $lineage);
         }
 
+        unset($lineage[$class]);
         $lineage[$class] = substr($exportedFile, 1, -1);
     }
 
@@ -474,13 +576,16 @@ private function addServiceInclude(string $cId, Definition $definition): string
             }
 
             foreach (array_diff_key(array_flip($lineage), $this->inlinedRequires) as $file => $class) {
+                $file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
                 $code .= sprintf("        include_once %s;\n", $file);
             }
         }
 
         foreach ($this->inlinedDefinitions as $def) {
             if ($file = $def->getFile()) {
-                $code .= sprintf("        include_once %s;\n", $this->dumpValue($file));
+                $file = $this->dumpValue($file);
+                $file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
+                $code .= sprintf("        include_once %s;\n", $file);
             }
         }
 
@@ -958,7 +1063,7 @@ private function addNewInstance(Definition $definition, string $return = '', str
         return $return.sprintf('new %s(%s)', $this->dumpLiteralClass($this->dumpValue($class)), implode(', ', $arguments)).$tail;
     }
 
-    private function startClass(string $class, string $baseClass, string $baseClassWithNamespace): string
+    private function startClass(string $class, string $baseClass, ?array &$preload): string
     {
         $namespaceLine = !$this->asFiles && $this->namespace ? "\nnamespace {$this->namespace};\n" : '';
 
@@ -1005,8 +1110,8 @@ public function __construct()
             $code .= "        \$this->containerDir = \$containerDir;\n";
         }
 
-        if (Container::class !== $baseClassWithNamespace) {
-            $r = $this->container->getReflectionClass($baseClassWithNamespace, false);
+        if (Container::class !== $this->baseClass) {
+            $r = $this->container->getReflectionClass($this->baseClass, false);
             if (null !== $r
                 && (null !== $constructor = $r->getConstructor())
                 && 0 === $constructor->getNumberOfRequiredParameters()
@@ -1026,7 +1131,7 @@ public function __construct()
         $code .= $this->addMethodMap();
         $code .= $this->asFiles ? $this->addFileMap() : '';
         $code .= $this->addAliases();
-        $code .= $this->addInlineRequires();
+        $code .= $this->addInlineRequires($preload);
         $code .= <<<EOF
     }
 
@@ -1227,7 +1332,7 @@ protected function {$methodNameAlias}()
         return $code;
     }
 
-    private function addInlineRequires(): string
+    private function addInlineRequires(?array &$preload): string
     {
         if (!$this->hotPathTag || !$this->inlineRequires) {
             return '';
@@ -1241,6 +1346,7 @@ private function addInlineRequires(): string
 
             foreach ($inlinedDefinitions as $def) {
                 if (\is_string($class = \is_array($factory = $def->getFactory()) && \is_string($factory[0]) ? $factory[0] : $def->getClass())) {
+                    $preload[$class] = $class;
                     $this->collectLineage($class, $lineage);
                 }
             }
@@ -1251,11 +1357,12 @@ private function addInlineRequires(): string
         foreach ($lineage as $file) {
             if (!isset($this->inlinedRequires[$file])) {
                 $this->inlinedRequires[$file] = true;
+                $file = preg_replace('#^\\$this->targetDirs\[(\d++)\]#', sprintf('\dirname(__DIR__, %d + $1)', $this->asFiles), $file);
                 $code .= sprintf("\n            include_once %s;", $file);
             }
         }
 
-        return $code ? sprintf("\n        \$this->privates['service_container'] = function () {%s\n        };\n", $code) : '';
+        return $code ? sprintf("\n        \$this->privates['service_container'] = static function () {%s\n        };\n", $code) : '';
     }
 
     private function addDefaultParametersMethod(): string
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_inline_requires.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_inline_requires.php
@@ -36,11 +36,11 @@ public function __construct()
 
         $this->aliases = [];
 
-        $this->privates['service_container'] = function () {
-            include_once $this->targetDirs[1].'/includes/HotPath/I1.php';
-            include_once $this->targetDirs[1].'/includes/HotPath/P1.php';
-            include_once $this->targetDirs[1].'/includes/HotPath/T1.php';
-            include_once $this->targetDirs[1].'/includes/HotPath/C1.php';
+        $this->privates['service_container'] = static function () {
+            include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/I1.php';
+            include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/P1.php';
+            include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/T1.php';
+            include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C1.php';
         };
     }
 
@@ -90,8 +90,8 @@ protected function getC1Service()
      */
     protected function getC2Service()
     {
-        include_once $this->targetDirs[1].'/includes/HotPath/C2.php';
-        include_once $this->targetDirs[1].'/includes/HotPath/C3.php';
+        include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C2.php';
+        include_once \dirname(__DIR__, 0 + 1).'/includes/HotPath/C3.php';
 
         return $this->services['Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\includes\\HotPath\\C2'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C2(new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3());
     }
