[HttpKernel] Add parameter kernel.runtime_mode, defined as %env(default:container.runtime_mode:APP_RUNTIME_MODE)%

nicolas-grekas · nicolas-grekas · commit 5e777ade602d · 2023-10-16T22:12:42.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1171,7 +1171,7 @@ private function registerDebugConfiguration(array $config, ContainerBuilder $con
             $container->setDefinition('debug.log_processor', $definition);
 
             $container->register('debug.debug_logger_configurator', DebugLoggerConfigurator::class)
-                ->setArguments([new Reference('debug.log_processor')]);
+                ->setArguments([new Reference('debug.log_processor'), new Reference('kernel.is_web_runtime_mode')]);
         }
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/debug_prod.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/debug_prod.php
@@ -32,6 +32,7 @@
             ->tag('monolog.logger', ['channel' => 'php'])
 
         ->set('debug.debug_handlers_listener', DebugHandlersListener::class)
+            ->args([null, service('kernel.is_web_runtime_mode')])
             ->tag('kernel.event_subscriber')
 
         ->set('debug.file_link_formatter', FileLinkFormatter::class)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php
@@ -241,5 +241,9 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
         ->set(Request::class)->abstract()->tag('container.excluded')
         ->set(Response::class)->abstract()->tag('container.excluded')
         ->set(SessionInterface::class)->abstract()->tag('container.excluded')
+
+        ->set('kernel.is_web_runtime_mode', 'bool')
+            ->factory('str_starts_with')
+            ->args(['%kernel.runtime_mode%', 'web']);
     ;
 };
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -388,6 +388,7 @@ class %s extends {$options['class']}
     'container.build_hash' => '$hash',
     'container.build_id' => '$id',
     'container.build_time' => $time,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\\DIRECTORY_SEPARATOR.'Container{$hash}');
 
 EOF;
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services10_as_files.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services10_as_files.txt
@@ -154,6 +154,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => %d,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_as_files.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_as_files.txt
@@ -787,6 +787,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => %d,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_inlined_factories.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_inlined_factories.txt
@@ -604,6 +604,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => 1563381341,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_inlined_factories_with_tagged_iterrator.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_inlined_factories_with_tagged_iterrator.txt
@@ -119,6 +119,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => %d,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_lazy_inlined_factories.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_lazy_inlined_factories.txt
@@ -187,6 +187,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => 1563381341,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_deprecated_parameters_as_files.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_deprecated_parameters_as_files.txt
@@ -195,6 +195,7 @@ return new \Container%s\ProjectServiceContainer([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => %d,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_non_shared_lazy_as_files.txt b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_non_shared_lazy_as_files.txt
@@ -164,6 +164,7 @@ return new \Container%s\Symfony_DI_PhpDumper_Service_Non_Shared_Lazy_As_File([
     'container.build_hash' => '%s',
     'container.build_id' => '%s',
     'container.build_time' => %d,
+    'container.runtime_mode' => \PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',
 ], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');
 
 )
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -11,6 +11,7 @@ CHANGELOG
  * Add argument `$validationFailedStatusCode` to `#[MapQueryString]` and `#[MapRequestPayload]`
  * Add argument `$debug` to `Logger`
  * Add class `DebugLoggerConfigurator`
+ * Add parameter `kernel.runtime_mode`, defined as `%env(default:container.runtime_mode:APP_RUNTIME_MODE)%`
  * Deprecate `Kernel::stripComments()`
  * Support the `!` character at the beginning of a string as a negation operator in the url filter of the profiler
  * Deprecate `UriSigner`, use `UriSigner` from the HttpFoundation component instead
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php
@@ -42,15 +42,17 @@ class DumpDataCollector extends DataCollector implements DataDumperInterface
     private ?RequestStack $requestStack;
     private DataDumperInterface|Connection|null $dumper;
     private mixed $sourceContextProvider;
+    private bool $webMode;
 
-    public function __construct(Stopwatch $stopwatch = null, string|FileLinkFormatter $fileLinkFormat = null, string $charset = null, RequestStack $requestStack = null, DataDumperInterface|Connection $dumper = null)
+    public function __construct(Stopwatch $stopwatch = null, string|FileLinkFormatter $fileLinkFormat = null, string $charset = null, RequestStack $requestStack = null, DataDumperInterface|Connection $dumper = null, bool $webMode = null)
     {
         $fileLinkFormat = $fileLinkFormat ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
         $this->stopwatch = $stopwatch;
         $this->fileLinkFormat = $fileLinkFormat instanceof FileLinkFormatter && false === $fileLinkFormat->format('', 0) ? false : $fileLinkFormat;
         $this->charset = $charset ?: \ini_get('php.output_encoding') ?: \ini_get('default_charset') ?: 'UTF-8';
         $this->requestStack = $requestStack;
         $this->dumper = $dumper;
+        $this->webMode = $webMode ?? !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true);
 
         // All clones share these properties by reference:
         $this->rootRefs = [
@@ -231,7 +233,7 @@ public function __destruct()
                 --$i;
             }
 
-            if (!\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) && stripos($h[$i], 'html')) {
+            if ($this->webMode) {
                 $dumper = new HtmlDumper('php://output', $this->charset);
                 $dumper->setDisplayOptions(['fileLinkFormat' => $this->fileLinkFormat]);
             } else {
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php
@@ -38,16 +38,11 @@ public function process(ContainerBuilder $container)
         }
 
         if ($debug = $container->getParameter('kernel.debug')) {
-            // Build an expression that will be equivalent to `!in_array(PHP_SAPI, ['cli', 'phpdbg'])`
-            $debug = (new Definition('bool'))
-                ->setFactory('in_array')
-                ->setArguments([
-                    (new Definition('string'))->setFactory('constant')->setArguments(['PHP_SAPI']),
-                    ['cli', 'phpdbg'],
-                ]);
-            $debug = (new Definition('bool'))
-                ->setFactory('in_array')
-                ->setArguments([$debug, [false]]);
+            $debug = $container->hasDefinition('kernel.is_web_runtime_mode')
+                ? new Reference('kernel.is_web_runtime_mode')
+                : (new Definition('bool'))
+                    ->setFactory('str_starts_with')
+                    ->setArguments(['%kernel.runtime_mode%', 'web']);
         }
 
         $container->register('logger', Logger::class)
diff --git a/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php b/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php
@@ -32,27 +32,29 @@ class DebugHandlersListener implements EventSubscriberInterface
 {
     private string|object|null $earlyHandler;
     private ?\Closure $exceptionHandler;
+    private bool $webMode;
     private bool $firstCall = true;
     private bool $hasTerminatedWithException = false;
 
     /**
      * @param callable|null $exceptionHandler A handler that must support \Throwable instances that will be called on Exception
      */
-    public function __construct(callable $exceptionHandler = null)
+    public function __construct(callable $exceptionHandler = null, bool $webMode = null)
     {
         $handler = set_exception_handler('is_int');
         $this->earlyHandler = \is_array($handler) ? $handler[0] : null;
         restore_exception_handler();
 
         $this->exceptionHandler = null === $exceptionHandler ? null : $exceptionHandler(...);
+        $this->webMode = $webMode ?? !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true);
     }
 
     /**
      * Configures the error handler.
      */
     public function configure(object $event = null): void
     {
-        if ($event instanceof ConsoleEvent && !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
+        if ($event instanceof ConsoleEvent && $this->webMode) {
             return;
         }
         if (!$event instanceof KernelEvent ? !$this->firstCall : !$event->isMainRequest()) {
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -570,6 +570,7 @@ protected function getKernelParameters(): array
             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
             'kernel.environment' => $this->environment,
             'kernel.runtime_environment' => '%env(default:kernel.environment:APP_RUNTIME_ENV)%',
+            'kernel.runtime_mode' => '%env(default:container.runtime_mode:APP_RUNTIME_MODE)%',
             'kernel.debug' => $this->debug,
             'kernel.build_dir' => realpath($buildDir = $this->warmupDir ?: $this->getBuildDir()) ?: $buildDir,
             'kernel.cache_dir' => realpath($cacheDir = ($this->getCacheDir() === $this->getBuildDir() ? ($this->warmupDir ?: $this->getCacheDir()) : $this->getCacheDir())) ?: $cacheDir,

Original file line number	Diff line number	Diff line change
`@@ -1171,7 +1171,7 @@ private function registerDebugConfiguration(array $config, ContainerBuilder $con`
`1171`	`1171`	`$container->setDefinition('debug.log_processor', $definition);`
`1172`	`1172`
`1173`	`1173`	`$container->register('debug.debug_logger_configurator', DebugLoggerConfigurator::class)`
`1174`		`- ->setArguments([new Reference('debug.log_processor')]);`
	`1174`	`+ ->setArguments([new Reference('debug.log_processor'), new Reference('kernel.is_web_runtime_mode')]);`
`1175`	`1175`	`}`
`1176`	`1176`	`}`
`1177`	`1177`
Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,7 @@ return new \Container%s\ProjectServiceContainer([`
`154`	`154`	`'container.build_hash' => '%s',`
`155`	`155`	`'container.build_id' => '%s',`
`156`	`156`	`'container.build_time' => %d,`
	`157`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`157`	`158`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`158`	`159`
`159`	`160`	`)`
Original file line number	Diff line number	Diff line change
`@@ -787,6 +787,7 @@ return new \Container%s\ProjectServiceContainer([`
`787`	`787`	`'container.build_hash' => '%s',`
`788`	`788`	`'container.build_id' => '%s',`
`789`	`789`	`'container.build_time' => %d,`
	`790`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`790`	`791`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`791`	`792`
`792`	`793`	`)`
Original file line number	Diff line number	Diff line change
`@@ -604,6 +604,7 @@ return new \Container%s\ProjectServiceContainer([`
`604`	`604`	`'container.build_hash' => '%s',`
`605`	`605`	`'container.build_id' => '%s',`
`606`	`606`	`'container.build_time' => 1563381341,`
	`607`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`607`	`608`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`608`	`609`
`609`	`610`	`)`
Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,7 @@ return new \Container%s\ProjectServiceContainer([`
`119`	`119`	`'container.build_hash' => '%s',`
`120`	`120`	`'container.build_id' => '%s',`
`121`	`121`	`'container.build_time' => %d,`
	`122`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`122`	`123`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`123`	`124`
`124`	`125`	`)`
Original file line number	Diff line number	Diff line change
`@@ -187,6 +187,7 @@ return new \Container%s\ProjectServiceContainer([`
`187`	`187`	`'container.build_hash' => '%s',`
`188`	`188`	`'container.build_id' => '%s',`
`189`	`189`	`'container.build_time' => 1563381341,`
	`190`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`190`	`191`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`191`	`192`
`192`	`193`	`)`
Original file line number	Diff line number	Diff line change
`@@ -195,6 +195,7 @@ return new \Container%s\ProjectServiceContainer([`
`195`	`195`	`'container.build_hash' => '%s',`
`196`	`196`	`'container.build_id' => '%s',`
`197`	`197`	`'container.build_time' => %d,`
	`198`	`+ 'container.runtime_mode' => \PHP_SAPI === 'cli' \|\| \PHP_SAPI === 'phpdbg' ? 'cli' : 'web',`
`198`	`199`	`], __DIR__.\DIRECTORY_SEPARATOR.'Container%s');`
`199`	`200`
`200`	`201`	`)`