Utilisation des workers FrankenPHP

Démarrez votre application une fois et gardez-la en mémoire. FrankenPHP traitera les requêtes entrantes en quelques millisecondes.

Définissez la valeur de la variable d’environnement FRANKENPHP_CONFIG à worker /path/to/your/worker/script.php :

docker run \
    -e FRANKENPHP_CONFIG="worker /app/path/to/your/worker/script.php" \
    -v $PWD:/app \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

Utilisez l’option –worker de la commande php-server pour servir le contenu du répertoire courant en utilisant un worker :

frankenphp php-server --worker /path/to/your/worker/script.php

Si votre application PHP est intégrée dans le binaire, vous pouvez également ajouter un Caddyfile personnalisé dans le répertoire racine de l’application. Il sera utilisé automatiquement.

Il est également possible de redémarrer le worker en cas de changement de fichier avec l’option --watch. La commande suivante déclenchera un redémarrage si un fichier se terminant par .php dans le répertoire /path/to/your/app/ ou ses sous-répertoires est modifié :

frankenphp php-server --worker /path/to/your/worker/script.php --watch "/path/to/your/app/**/*.php"

Le mode worker de FrankenPHP est pris en charge par le Composant Runtime de Symfony. Pour démarrer une application Symfony dans un worker, installez le package FrankenPHP de PHP Runtime :

composer require runtime/frankenphp-symfony

Démarrez votre serveur d’application en définissant la variable d’environnement APP_RUNTIME pour utiliser le Runtime Symfony de FrankenPHP :

docker run \
    -e FRANKENPHP_CONFIG="worker ./public/index.php" \
    -e APP_RUNTIME=Runtime\\FrankenPhpSymfony\\Runtime \
    -v $PWD:/app \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

Voir la documentation dédiée.

L’exemple suivant montre comment créer votre propre script worker sans dépendre d’une bibliothèque tierce :

<?php
// public/index.php

// Empêcher la terminaison du script worker lorsqu'une connexion client est interrompue
ignore_user_abort(true);

// Démarrer votre application
require __DIR__.'/vendor/autoload.php';

$myApp = new \App\Kernel();
$myApp->boot();

// En dehors de la boucle pour de meilleures performances (moins de travail effectué)
$handler = static function () use ($myApp) {
    // Appelé lorsqu'une requête est reçue,
    // les superglobales, php://input, etc., sont réinitialisés
    echo $myApp->handle($_GET, $_POST, $_COOKIE, $_FILES, $_SERVER);
};

$maxRequests = (int)($_SERVER['MAX_REQUESTS'] ?? 0);
for ($nbRequests = 0; !$maxRequests || $nbRequests < $maxRequests; ++$nbRequests) {
    $keepRunning = \frankenphp_handle_request($handler);

    // Faire quelque chose après l'envoi de la réponse HTTP
    $myApp->terminate();

    // Exécuter le ramasse-miettes pour réduire les chances qu'il soit déclenché au milieu de la génération d'une page
    gc_collect_cycles();

    if (!$keepRunning) break;
}

// Nettoyage
$myApp->shutdown();

Ensuite, démarrez votre application et utilisez la variable d’environnement FRANKENPHP_CONFIG pour configurer votre worker :

docker run \
    -e FRANKENPHP_CONFIG="worker ./public/index.php" \
    -v $PWD:/app \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

Par défaut, 2 workers par CPU sont démarrés. Vous pouvez également configurer le nombre de workers à démarrer :

docker run \
    -e FRANKENPHP_CONFIG="worker ./public/index.php 42" \
    -v $PWD:/app \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

Comme PHP n’a pas été initialement conçu pour des processus de longue durée, de nombreuses bibliothèques et codes anciens présentent encore des fuites de mémoire. Une solution pour utiliser ce type de code en mode worker est de redémarrer le script worker après avoir traité un certain nombre de requêtes :

Le code du worker précédent permet de configurer un nombre maximal de requêtes à traiter en définissant une variable d’environnement nommée MAX_REQUESTS.

Bien qu’il soit possible de redémarrer les workers en cas de changement de fichier, il est également possible de redémarrer tous les workers de manière élégante via l’API Admin de Caddy. Si l’administration est activée dans votre Caddyfile, vous pouvez envoyer un ping à l’endpoint de redémarrage avec une simple requête POST comme celle-ci :

curl -X POST http://localhost:2019/frankenphp/workers/restart

Note

C’est une fonctionnalité expérimentale et peut être modifiée ou supprimée dans le futur.

Si un script de worker se plante avec un code de sortie non nul, FrankenPHP le redémarre avec une stratégie de backoff exponentielle. Si le script worker reste en place plus longtemps que le dernier backoff * 2, FrankenPHP ne pénalisera pas le script et le redémarrera à nouveau. Toutefois, si le script de worker continue d’échouer avec un code de sortie non nul dans un court laps de temps (par exemple, une faute de frappe dans un script), FrankenPHP plantera avec l’erreur : too many consecutive failures (trop d’échecs consécutifs).

Les superglobales PHP ($_SERVER, $_ENV, $_GET…) se comportent comme suit :

• avant le premier appel à frankenphp_handle_request(), les superglobales contiennent des valeurs liées au script worker lui-même
• pendant et après l’appel à frankenphp_handle_request(), les superglobales contiennent des valeurs générées à partir de la requête HTTP traitée, chaque appel à frankenphp_handle_request() change les valeurs des superglobales

Pour accéder aux superglobales du script worker à l’intérieur de la fonction de rappel, vous devez les copier et importer la copie dans le scope de la fonction :

<?php
// Copier la superglobale $_SERVER du worker avant le premier appel à frankenphp_handle_request()
$workerServer = $_SERVER;

$handler = static function () use ($workerServer) {
    var_dump($_SERVER); // $_SERVER lié à la requête
    var_dump($workerServer); // $_SERVER du script worker
};

// ...