Yii RoadRunner Runner

The package contains a bootstrap for running Yii3 applications using RoadRunner.

Requirements

• PHP 8.0 or higher.

Installation

The package could be installed with composer:

composer require yiisoft/yii-runner-roadrunner --prefer-dist

General usage

Get RoadRunner:

./vendor/bin/rr get

Create worker.php in your application root directory:

<?php

declare(strict_types=1);

use Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner;

ini_set('display_errors', 'stderr');

require_once __DIR__ . '/autoload.php';

(new RoadRunnerApplicationRunner(__DIR__, $_ENV['YII_DEBUG'], $_ENV['YII_ENV']))->run();

Specify it in your .rr.yaml:

server:
    command: "php /worker.php"

rpc:
    listen: tcp://127.0.0.1:6001

http:
    address: :8082
    pool:
        num_workers: 4
        max_jobs: 64
    middleware: ["static", "headers"]
    static:
        dir:   "/public"
        forbid: [".php", ".htaccess"]
    headers:
        response:
            "Cache-Control": "no-cache"

reload:
    interval: 1s
    patterns: [ ".php" ]
    services:
        http:
            recursive: true
            dirs: [ "/" ]

logs:
    mode: production
    level: warn

Run RoadRunner with the config specified:

./vendor/bin/rr serve -c ./.rr.yaml

Additional configuration

By default, the RoadRunnerApplicationRunner is configured to work with Yii application templates. You can override the default configuration using immutable setters.

Override the name of the bootstrap configuration group as follows:

/**
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

// Bootstrap configuration group name by default is "bootstrap-web".
$runner = $runner->withBootstrap('my-bootstrap-config-group-name');

// Disables the use of bootstrap configuration group.
$runner = $runner->withoutBootstrap();

In debug mode, event configurations are checked, to override, use the following setters:

/**
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

// Configuration group name of events by default is "events-web".
$runner = $runner->withCheckingEvents('my-events-config-group-name');

// Disables checking of the event configuration group.
$runner = $runner->withoutCheckingEvents();

If the configuration instance settings differ from the default, such as configuration group names, you can specify a customized configuration instance:

/**
 * @var Yiisoft\Config\ConfigInterface $config
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

$runner = $runner->withConfig($config);

The default container is Yiisoft\Di\Container. But you can specify any implementation of the Psr\Container\ContainerInterface:

/**
 * @var Psr\Container\ContainerInterface $container
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

$runner = $runner->withContainer($container);

In addition to the error handler that is defined in the container, the runner uses a temporary error handler. A temporary error handler is needed to handle the creation of configuration and container instances, then the error handler configured in your application configuration will be used.

By default, the temporary error handler uses HTML renderer and logging to a file. You can override this as follows:

/**
 * @var Psr\Log\LoggerInterface $logger
 * @var Yiisoft\ErrorHandler\Renderer\PlainTextRenderer $renderer
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

$runner = $runner->withTemporaryErrorHandler(
    new Yiisoft\ErrorHandler\ErrorHandler($logger, $renderer),
);

You can also use your own implementation of the Spiral\RoadRunner\Http\PSR7WorkerInterface (default is a Spiral\RoadRunner\Http\PSR7Worker):

/**
 * @var Spiral\RoadRunner\Http\PSR7WorkerInterface $psr7Worker
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerApplicationRunner $runner
 */

$runner = $runner->withPsr7Worker($psr7Worker);

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates