fix: Reset the PHP script filename in PHARs (#1246)

This fixes the issue with the Symfony runtime with (hopefully) no side-effects.
box-project · Dec 10, 2023 · c91e793 · c91e793
1 parent 2bec15e
commit c91e793
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 98 deletions.
diff --git a/README.md b/README.md
@@ -99,7 +99,6 @@ For the full documentation see https://box-project.github.io/box.
    1. [Project files](doc/symfony.md#project-files)
    1. [Project directory](doc/symfony.md#project-directory)
    2. [Cache](doc/symfony.md#cache)
-   3. [Runtime component](doc/symfony.md#runtime-component)
 1. [Reproducible builds](doc/reproducible-builds.md#reproducible-builds)
    1. [Creating a reproducible PHAR](doc/reproducible-builds.md#creating-a-reproducible-phar)
       1. [PHP-Scoper](doc/reproducible-builds.md#php-scoper)

diff --git a/doc/symfony.md b/doc/symfony.md
@@ -3,7 +3,6 @@
 1. [Project files](#project-files)
 1. [Project directory](#project-directory)
 2. [Cache](#cache)
-3. [Runtime component](#runtime-component)
 
 Examples of Symfony applications can be found in the project under `fixtures/build/dir012` (Symfony5) and
 `fixtures/build/dir018` (Symfony6 with the Runtime component).
@@ -99,56 +98,6 @@ I.e.:
 This last part takes advantage of Box [dumping the autoloader][composer-autoloader-dump] by default.
 
 
-## Runtime component
-
-If you are using [`symfony/runtime`][symfony-runtime], you may end up into some errors (see https://github.com/symfony/symfony/issues/49443).
-
-To fix the issue, you need to create your own `autoload_runtime.template` file, for example:
-
-```php
-<?php
-
-// autoload_runtime.php @generated by Symfony Runtime
-
-if (true === (require_once __DIR__.'/autoload.php') || empty($_SERVER['SCRIPT_FILENAME'])) {
-    return;
-}
-
-$pharPath = Phar::running();
-if (strlen($pharPath) > 0 && !str_starts_with($scriptFileName, 'phar://')) {
-    $scriptFileName = $pharPath.DIRECTORY_SEPARATOR.$scriptFileName;
-} else {
-    $scriptFileName = $_SERVER['SCRIPT_FILENAME'];
-}
-
-$app = require $scriptFileName;
-
-if (!is_object($app)) {
-    throw new TypeError(sprintf('Invalid return value: callable object expected, "%s" returned from "%s".', get_debug_type($app), $_SERVER['SCRIPT_FILENAME']));
-}
-
-$runtime = $_SERVER['APP_RUNTIME'] ?? $_ENV['APP_RUNTIME'] ?? %runtime_class%;
-$runtime = new $runtime(($_SERVER['APP_RUNTIME_OPTIONS'] ?? $_ENV['APP_RUNTIME_OPTIONS'] ?? []) + %runtime_options%);
-
-[$app, $args] = $runtime
-    ->getResolver($app)
-    ->resolve();
-
-$app = $app(...$args);
-
-exit(
-    $runtime
-        ->getRunner($app)
-        ->run()
-);
-```
-
-Notice the `Phar::running()` section: this is the key of the fix.
-
-If you ended up changing the location of the `console` file (which is `bin/console`), you will need to further customize
-this in order to fix the problem.
-
-
 <br />
 <hr />
 

diff --git a/fixtures/build/dir018/autoload_runtime.template b/fixtures/build/dir018/autoload_runtime.template
diff --git a/fixtures/build/dir018/box.json.dist b/fixtures/build/dir018/box.json.dist
@@ -1,7 +1,6 @@
 {
     "files-bin": [
         ".env.local.php",
-        "autoload_runtime.template",
         "src/Controller/.gitignore"
     ],
     "directories": [

diff --git a/fixtures/build/dir018/composer.json b/fixtures/build/dir018/composer.json
@@ -60,9 +60,6 @@
         "symfony": {
             "allow-contrib": false,
             "require": "6.2.*"
-        },
-        "runtime": {
-            "autoload_template": "autoload_runtime.template"
         }
     }
 }
diff --git a/fixtures/build/dir018/composer.lock b/fixtures/build/dir018/composer.lock
diff --git a/requirement-checker/fixtures/fail-complete/expected-skipped-stdout b/requirement-checker/fixtures/fail-complete/expected-skipped-stdout
@@ -1,6 +1,6 @@
 
 Fatal error: Uncaught Exception: Should not be executed! in phar:///opt/box/index.phar/index.php:13
 Stack trace:
-#0 /opt/box/index.phar(14): require()
+#0 /opt/box/index.phar(15): require()
 #1 {main}
   thrown in phar:///opt/box/index.phar/index.php on line 13
diff --git a/src/StubGenerator.php b/src/StubGenerator.php
@@ -156,9 +156,12 @@ private static function generatePharConfigStmt(
                 $stub[] = '';
             }
 
-            $stub[] = null === $alias
-                ? "require 'phar://' . __FILE__ . '/{$index}';"
-                : "require 'phar://{$alias}/{$index}';";
+            $indexPath = null === $alias
+                ? "'phar://' . __FILE__ . '/{$index}';"
+                : "'phar://{$alias}/{$index}';";
+
+            $stub[] = "\$_SERVER['SCRIPT_FILENAME'] = {$indexPath}";
+            $stub[] = "require {$indexPath}";
         }
 
         if ([] === $stub) {

diff --git a/tests/Console/Command/CompileTest.php b/tests/Console/Command/CompileTest.php
@@ -320,6 +320,7 @@ public function test_it_can_build_a_phar_file(): void
 
             require 'phar://alias-test.phar/.box/bin/check-requirements.php';
 
+            \$_SERVER['SCRIPT_FILENAME'] = 'phar://alias-test.phar/run.php';
             require 'phar://alias-test.phar/run.php';
 
             __HALT_COMPILER(); ?>
@@ -499,6 +500,7 @@ public function test_it_can_build_a_phar_without_any_configuration(): void
 
             require 'phar://box-auto-generated-alias-__uniqid__.phar/.box/bin/check-requirements.php';
 
+            \$_SERVER['SCRIPT_FILENAME'] = 'phar://box-auto-generated-alias-__uniqid__.phar/index.php';
             require 'phar://box-auto-generated-alias-__uniqid__.phar/index.php';
 
             __HALT_COMPILER(); ?>
@@ -674,6 +676,7 @@ public function test_it_can_build_a_phar_with_complete_mapping(): void
 
             Phar::mapPhar('alias-test.phar');
 
+            \$_SERVER['SCRIPT_FILENAME'] = 'phar://alias-test.phar/run.php';
             require 'phar://alias-test.phar/run.php';
 
             __HALT_COMPILER(); ?>
@@ -772,6 +775,7 @@ public function test_it_can_build_a_phar_with_complete_mapping_without_an_alias(
 
             Phar::mapPhar('box-auto-generated-alias-__uniqid__.phar');
 
+            \$_SERVER['SCRIPT_FILENAME'] = 'phar://box-auto-generated-alias-__uniqid__.phar/run.php';
             require 'phar://box-auto-generated-alias-__uniqid__.phar/run.php';
 
             __HALT_COMPILER(); ?>

diff --git a/tests/StubGeneratorTest.php b/tests/StubGeneratorTest.php
@@ -194,6 +194,7 @@ public static function valuesProvider(): iterable
 
                 require 'phar://' . __FILE__ . '/.box/bin/check-requirements.php';
 
+                $_SERVER['SCRIPT_FILENAME'] = 'phar://' . __FILE__ . '/acme.php';
                 require 'phar://' . __FILE__ . '/acme.php';
 
                 __HALT_COMPILER(); ?>
@@ -209,6 +210,7 @@ public static function valuesProvider(): iterable
             <<<'STUB'
                 <?php
 
+                $_SERVER['SCRIPT_FILENAME'] = 'phar://' . __FILE__ . '/acme.php';
                 require 'phar://' . __FILE__ . '/acme.php';
 
                 __HALT_COMPILER(); ?>
@@ -273,6 +275,7 @@ public static function valuesProvider(): iterable
 
                 require 'phar://test.phar/.box/bin/check-requirements.php';
 
+                $_SERVER['SCRIPT_FILENAME'] = 'phar://test.phar/index.php';
                 require 'phar://test.phar/index.php';
 
                 __HALT_COMPILER(); ?>
@@ -306,6 +309,7 @@ public static function valuesProvider(): iterable
                 Phar::mapPhar('test.phar');
                 Phar::interceptFileFuncs();
 
+                $_SERVER['SCRIPT_FILENAME'] = 'phar://test.phar/index.php';
                 require 'phar://test.phar/index.php';
 
                 __HALT_COMPILER(); ?>