[Runtime] Add environment variable APP_RUNTIME_MODE #51408

BaptisteContreras · 2023-08-16T20:20:24Z

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #51340
License	MIT
Doc PR	TODO

Based on #51340 (comment) I added the envvar APP_RUNTIME_MODE in the autoload_runtime.php

Its purpose is to indicate in which mode the application is running (cli or web).

I had a hard time figuring out how to test this. I finally decided to only test the priority to set the value ($_ENV > $_SERVER > default guessing).

During my test, I noticed that if I define a value for APP_RUNTIME_MODE in $_ENV, and another value in $_SERVER, the output of $context['APP_RUNTIME_MODE'] in my application callable will be the value defined in $_SERVER, and the value $_ENV['APP_RUNTIME_MODE'] is untouched (which is normal). This is due to the way DotEnv loads and override envvars.

You can check this behavior in src/Symfony/Component/Runtime/Tests/phpt/runtime_mode_from_env_with_server_set.php.

For me it seems OK because I can't see a way of having $_SERVER['APP_RUNTIME_MODE'] different from $_ENV['APP_RUNTIME_MODE']

I did not do the Doc PR, I first want to check if my implementation if OK for you

BaptisteContreras · 2023-08-21T17:56:13Z

APP_RUNTIME_TYPE could also be a good fit. I'd rather keep APP_RUNTIME_MODE but I don't mind to change it if you, or others, want :)

dunglas

This would be nice to have in 6.4.

dunglas · 2023-10-14T09:21:06Z

src/Symfony/Component/Runtime/Internal/autoload_runtime.template

@@ -12,6 +12,8 @@ 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']));
 }

+$_ENV['APP_RUNTIME_MODE'] = $_ENV['APP_RUNTIME_MODE'] ?? $_SERVER['APP_RUNTIME_MODE'] ?? (in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? 'cli' : 'web');


Suggested change

$_ENV['APP_RUNTIME_MODE'] = $_ENV['APP_RUNTIME_MODE'] ?? $_SERVER['APP_RUNTIME_MODE'] ?? (in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? 'cli' : 'web');

$_ENV['APP_RUNTIME_MODE'] ??= $_SERVER['APP_RUNTIME_MODE'] ?? (in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? 'cli' : 'web');

dunglas · 2023-10-14T09:34:37Z

For #51661, we can add worker mode detection like that:

if (null === ($_ENV['APP_RUNTIME_MODE'] ??= $_ENV['APP_RUNTIME_MODE'] ?? $_SERVER['APP_RUNTIME_MODE'] ?? null)) {
    if ($_ENV['FRANKENPHP_WORKER'] ?? $_SERVER['FRANKENPHP_WORKER']) {
        $_ENV['APP_RUNTIME_MODE'] = 'worker';
    } elseif (\PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg') {
        $_ENV['APP_RUNTIME_MODE'] = 'cli';
    } else {
        $_ENV['APP_RUNTIME_MODE'] = 'web';
    }
}

Support for other workers engine like RoadRunner will have to be done in the runtime themselves, because AFAIK they don't provide a way to detect if they are used at this point.

BaptisteContreras · 2023-10-14T17:50:44Z

Hi @dunglas ! Thanks for the review. I updated the PR with your suggestions.

I slightly modified :

if ($_ENV['FRANKENPHP_WORKER'] ?? $_SERVER['FRANKENPHP_WORKER']) {

to

if ($_ENV['FRANKENPHP_WORKER'] ?? $_SERVER['FRANKENPHP_WORKER'] ?? false) {

For the case when $_SERVER['FRANKENPHP_WORKER'] does not exists.

GromNaN · 2023-10-14T19:31:04Z

src/Symfony/Component/Runtime/Internal/autoload_runtime.template

@@ -12,6 +12,16 @@ 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']));
 }

+if (null === ($_ENV['APP_RUNTIME_MODE'] ??= $_SERVER['APP_RUNTIME_MODE'] ?? null)) {
+    if ($_ENV['FRANKENPHP_WORKER'] ?? $_SERVER['FRANKENPHP_WORKER'] ?? false) {


Do you really need to have this specific check? Wouldn't that be something to put in FrankenPHP instead?

Or in https://github.com/php-runtime/frankenphp-symfony?

We could do that also for CLI and SAPI. The main benefit of doing it here is to not have to duplicate this code in every runtime supporting FrankenPHP worker mode.

Setting APP_RUNTIME_MODE in the bridge would be a better demonstration of how this have to be configured. Otherwise we'll receive PR to add Bref or React support in this file.

nicolas-grekas · 2023-10-16T17:29:45Z

While reviewing this PR, I thought another approach might be preferable, see #52079.

BaptisteContreras · 2023-10-16T19:21:41Z

While reviewing this PR, I thought another approach might be preferable, see #52079.

Your implementation seems indeed more flexible !

nicolas-grekas · 2023-10-16T20:08:58Z

Thanks for pushing this forward @BaptisteContreras!

…`kernel.runtime_mode.*`, all set from env var `APP_RUNTIME_MODE` (nicolas-grekas) This PR was merged into the 6.4 branch. Discussion ---------- [HttpKernel] Add parameters `kernel.runtime_mode` and `kernel.runtime_mode.*`, all set from env var `APP_RUNTIME_MODE` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #51340 | License | MIT | Doc PR | TODO Alternative to #51408. I think this approach is simpler and more powerful. Here, we ensure that the kernel always provides a new `kernel.runtime_mode` parameter. This parameter is an array derived by default from the `APP_RUNTIME_MODE` env var, using the `query_string` processor. This also creates 3 new parameters that should be the most common: `kernel.runtime_mode.web`, `kernel.runtime_mode.cli`, and `kernel.runtime_mode.worker`. A long-running server would typically set `APP_RUNTIME_MODE` to `web=1&worker=1` or `web=0&worker=1` when appropriate (eg https://github.com/php-runtime/frankenphp-symfony/ should do so when `FRANKENPHP_WORKER` is set.) I screened the codebase and updated them all except cache pools (where the SAPI is used to enable/disable locking) and error renderers (where the SAPI is used to turn html-rendering on/off.) These require more work that could be done later on. There are a few other remaining usages of `PHP_SAPI` but these look not appropriate for the new flag. Commits ------- 7c70aec [HttpKernel] Add parameters `kernel.runtime_mode` and `kernel.runtime_mode.*`, all set from env var `APP_RUNTIME_MODE`

rustatian · 2023-10-29T23:01:40Z

For #51661, we can add worker mode detection like that:
if (null === ($_ENV['APP_RUNTIME_MODE'] ??= $_ENV['APP_RUNTIME_MODE'] ?? $_SERVER['APP_RUNTIME_MODE'] ?? null)) {
    if ($_ENV['FRANKENPHP_WORKER'] ?? $_SERVER['FRANKENPHP_WORKER']) {
        $_ENV['APP_RUNTIME_MODE'] = 'worker';
    } elseif (\PHP_SAPI === 'cli' || \PHP_SAPI === 'phpdbg') {
        $_ENV['APP_RUNTIME_MODE'] = 'cli';
    } else {
        $_ENV['APP_RUNTIME_MODE'] = 'web';
    }
}
Support for other workers engine like RoadRunner will have to be done in the runtime themselves, because AFAIK they don't provide a way to detect if they are used at this point.

Hey 👋🏻
RR provides a way to detect (inside a worker) if it is used, per-plugin. For instance, if HTTP plugin is used -> RR_MODE env variable would be set to HTTP: https://roadrunner.dev/docs/php-environment/current#default-env-values-in-php-workers

dunglas · 2023-10-30T06:04:34Z

Hi @rustatian, thanks for the hint!

We decided to move this part in the dedicated adapters provided by php-runtime. If you mind son't hesitate to open a PR for RoadRunner! https://github.com/php-runtime/runtime

rustatian · 2023-10-30T08:10:21Z

With pleasure, @dunglas 😄
I'll ask our PHP team to do that, since I'm not a PHP dev 😢

carsonbot added Status: Needs Review Feature Runtime labels Aug 16, 2023

carsonbot added this to the 6.4 milestone Aug 16, 2023

This comment was marked as resolved.

Sign in to view

nicolas-grekas mentioned this pull request Sep 15, 2023

Doctrine left in non-operable state when used with Swoole/FrankenPHP #51661

Closed

dunglas approved these changes Oct 14, 2023

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 14, 2023

nicolas-grekas added the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Oct 14, 2023

BaptisteContreras force-pushed the add-app-runtime-mode-env-var branch from 54b121b to fd124f6 Compare October 14, 2023 17:46

[Runtime] Add environment variable APP_RUNTIME_MODE

b491d0d

BaptisteContreras force-pushed the add-app-runtime-mode-env-var branch from fd124f6 to b491d0d Compare October 14, 2023 17:58

BaptisteContreras requested a review from dunglas October 14, 2023 18:03

carsonbot added Status: Needs Review and removed Status: Reviewed labels Oct 14, 2023

GromNaN reviewed Oct 14, 2023

View reviewed changes

dunglas approved these changes Oct 14, 2023

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 14, 2023

nicolas-grekas mentioned this pull request Oct 16, 2023

[HttpKernel] Add parameters kernel.runtime_mode and kernel.runtime_mode.*, all set from env var APP_RUNTIME_MODE #52079

Merged

nicolas-grekas closed this Oct 16, 2023

	$_ENV['APP_RUNTIME_MODE'] = $_ENV['APP_RUNTIME_MODE'] ?? $_SERVER['APP_RUNTIME_MODE'] ?? (in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? 'cli' : 'web');
	$_ENV['APP_RUNTIME_MODE'] ??= $_SERVER['APP_RUNTIME_MODE'] ?? (in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? 'cli' : 'web');

Uh oh!

[Runtime] Add environment variable APP_RUNTIME_MODE #51408

[Runtime] Add environment variable APP_RUNTIME_MODE #51408

Uh oh!

Conversation

BaptisteContreras commented Aug 16, 2023

Uh oh!

This comment was marked as resolved.

BaptisteContreras commented Aug 21, 2023

Uh oh!

dunglas left a comment

Choose a reason for hiding this comment

Uh oh!

dunglas Oct 14, 2023

Choose a reason for hiding this comment

Uh oh!

dunglas commented Oct 14, 2023

Uh oh!

BaptisteContreras commented Oct 14, 2023

Uh oh!

GromNaN Oct 14, 2023

Choose a reason for hiding this comment

Uh oh!

chalasr Oct 14, 2023

Choose a reason for hiding this comment

Uh oh!

dunglas Oct 14, 2023

Choose a reason for hiding this comment

Uh oh!

GromNaN Oct 15, 2023

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Oct 16, 2023

Uh oh!

BaptisteContreras commented Oct 16, 2023

Uh oh!

nicolas-grekas commented Oct 16, 2023

Uh oh!

rustatian commented Oct 29, 2023

Uh oh!

dunglas commented Oct 30, 2023

Uh oh!

rustatian commented Oct 30, 2023

Uh oh!

Uh oh!