Scheduler (on event loop)

Простой планировщик на стеке двух технологий: revolt/event-loop и symfony/process

Цели и задачи:

независимый от cron планировщик задач
возможность запускать как отдельное приложение
контроль повторного запуска команды - не более одного активного экземпляра команды
контроль за временем выполнения - возможность задать timeout

Get started

<?php

declare(strict_types=1);

use kuaukutsu\poc\cron\tools\ProcessDecorator;
use kuaukutsu\poc\cron\SchedulerCommand;
use kuaukutsu\poc\cron\Scheduler;
use kuaukutsu\poc\cron\SchedulerTimer;

require dirname(__DIR__) . '/vendor/autoload.php';

$scheduler = new Scheduler(
    new SchedulerCommand(
        new ProcessDecorator(['pwd']),
        SchedulerTimer::everyMinute()
    ),
    new SchedulerCommand(
        new ProcessDecorator(['sleep', '10'], 10.),
        SchedulerTimer::everyFiveMinutes()
    ),
);

$scheduler->run();

Custom Options

Возможность управлять настойками запуска:

interval: интервал обхода списка команд и запуск согласно планировщику. По умолчанию 1 минута.
keeperInterval: интевал опроса состояния запущенных команд. По умолчанию 5 секунд. Если активных команд нет, то данный процесс в режиме сна.
timeout: позволяет указать через какое время запущенный экземпляр event loop должен быть завершен. По умолчанию значения не задано.

<?php

declare(strict_types=1);

use kuaukutsu\poc\cron\Scheduler;
use kuaukutsu\poc\cron\SchedulerOptions;

require dirname(__DIR__) . '/vendor/autoload.php';

$scheduler = new Scheduler(...);
$scheduler->run(
    new SchedulerOptions(
        interval: 30,
        keeperInterval: 5,
        timeout: 86400,
    )
);

Позволяет получить вывод событий обработки в потоки (STDOUT, STDERR). Так же является примером того, что можно огранизовать свой обработчик событий, например вывод ошибок в sentry или отладочной информации в logstash.

<?php

declare(strict_types=1);

use kuaukutsu\poc\cron\Scheduler;
use kuaukutsu\poc\cron\tools\SchedulerOutput;

require dirname(__DIR__) . '/vendor/autoload.php';

$scheduler = new Scheduler(...);
$scheduler->on(new SchedulerOutput());
$scheduler->run();

Docker

docker pull ghcr.io/kuaukutsu/php:8.1-cli

Container:

ghcr.io/kuaukutsu/php:${PHP_VERSION}-cli (default)
jakzal/phpqa:php${PHP_VERSION}

shell

docker run --init -it --rm -v "$(pwd):/app" -w /app ghcr.io/kuaukutsu/php:8.1-cli sh

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

make phpunit

Static analysis

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

make psalm

Code Sniffer

make phpcs

Rector

make rector

kuaukutsu / poc-cron