Skip to content

[Runtime] Automatically use FrankenPHP runner when its worker mode is detected #60503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 7.3
Choose a base branch
from

Conversation

alexandre-daubois
Copy link
Member

@alexandre-daubois alexandre-daubois commented May 21, 2025

Q A
Branch? 7.3
Bug fix? no
New feature? yes
Deprecations? no
Issues -
License MIT

Currently, to use FrankenPHP worker mode, you have to install the runtime/frankenphp-symfony package and set the APP_RUNTIME env var to the correct FQCN.

@dunglas and I would like to move the runtime and the runner classes to the Symfony core now that The PHP Foundation officially supports FrakenPHP.

This PR adds FrankenPHP worker mode detection and registers the correct runner to use it. This specific runner is only used when using the worker mode. When using FrankenPHP in classic mode, HttpKernelRunner is still used.

The DX would be greatly improved, given that it works out of the box with this PR.

Classes and tests are coming from this repo with a few tweaks to stick to Symfony CS.

@carsonbot carsonbot added this to the 7.3 milestone May 21, 2025
@alexandre-daubois alexandre-daubois added the DX DX = Developer eXperience (anything that improves the experience of using Symfony) label May 21, 2025
*
* @author Kévin Dunglas <kevin@dunglas.dev>
*/
class FrankenPhpRuntime extends SymfonyRuntime
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for a separate runtime if we do the merge
providing FrankenPHP support should work without configuring any runtime IMHO

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, I'm having a look to integrate it in SymfonyRuntime

Copy link
Member Author

@alexandre-daubois alexandre-daubois May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both runtimes are now merged


$handler = function () use ($server, &$sfRequest, &$sfResponse, $xdebugConnectToClient): void {
// Connect to the Xdebug client if it's available
if ($xdebugConnectToClient) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use if (\extension_loaded('xdebug') && \function_exists('xdebug_connect_to_client')) inline instead ?

OPCache will resolve those \extension_loaded will be resolved at compile time:

  • when the extension is indeed loaded
  • when the extension is not loaded and enable_dl is false (which is probably the case in frankenphp)

function_exists is also resolved at compile time when the function is defined built-in (a false value is not cached as it could exist in userland).

This might have even less overhead than caching the function_exists check in a variable and checking the variable each time. The only thing that would not work anymore is polyfilling xdebug_connect_to_client in userland, but I don't think this can be polyfilled anyway (userland cannot emulate connecting the Xdebug debugger)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me, I updated accordingly.

@alexandre-daubois alexandre-daubois changed the title [Runtime] Automatically enable FrankenPHP runtime when its worker mode is detected [Runtime] Automatically use FrankenPHP runner when its worker mode is detected May 21, 2025
@@ -142,13 +145,18 @@ public function __construct(array $options = [])
}

$options['error_handler'] ??= SymfonyErrorHandler::class;
$options['frankenphp_loop_max'] = (int) ($options['frankenphp_loop_max'] ?? $_SERVER['FRANKENPHP_LOOP_MAX'] ?? $_ENV['FRANKENPHP_LOOP_MAX'] ?? 500);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we find a more explicit name? More generic also?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: worker_loop_max as it's specific to worker mode.


parent::__construct($options);
}

public function getRunner(?object $application): RunnerInterface
{
if ($application instanceof HttpKernelInterface) {
if ($_SERVER['FRANKENPHP_WORKER'] ?? false) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should check $_ENV also, and use filter_var to read the boolean

@@ -88,6 +90,7 @@ class SymfonyRuntime extends GenericRuntime
* debug_var_name?: string,
* dotenv_overload?: ?bool,
* dotenv_extra_paths?: ?string[],
* frankenphp_loop_max?: int,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to improve a bit the phpdoc of the class in relation to this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DX DX = Developer eXperience (anything that improves the experience of using Symfony) Feature Runtime Status: Needs Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants