job-runner/job-runner

1.2.0 2023-09-06 07:36 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• dragonmantank/cron-expression: ^3.3.3
• symfony/clock: ^6.3
• symfony/lock: ^6.1
• symfony/process: ^6.3.4

Requires (Dev)

• doctrine/coding-standard: ^12.0
• phpunit/phpunit: ^10.3.3
• psalm/plugin-phpunit: ^0.18.4
• vimeo/psalm: ^5.15

MIT

• Stéphane Demonchaux

README

Install

composer require job-runner/job-runner

This cron job manager is inspired by https://github.com/jobbyphp/jobby but with various improvements

• It use symfony/locker so you can use the power of it
• It use symfony/process instead of exec
• It lock by task and not for all task
• It has an event manager

Simple Sample

<?php

declare(strict_types=1);

use JobRunner\JobRunner\Job\CliJob;
use JobRunner\JobRunner\Job\JobList;
use JobRunner\JobRunner\CronJobRunner;

require 'vendor/autoload.php';


$jobList = new JobList();
$jobList->push(new CliJob('php ' . __DIR__ . '/tutu.php', '* * * * *'));
$jobList->push(new CliJob('php ' . __DIR__ . '/tutu2.php', '* * * * *'));

CronJobRunner::create()->run($jobList);

// or

CronJobRunner::create()->run(JobList::fromArray([
    [
        'command' => 'php ' . __DIR__ . '/tutu.php',
        'cronExpression' => '* * * * *',
    ],[
    [
        'command' => 'php ' . __DIR__ . '/tutu2.php',
        'cronExpression' => '* * * * *',
    ]
]));

Using you own locker storage

<?php

declare(strict_types=1);

use JobRunner\JobRunner\Job\CliJob;
use JobRunner\JobRunner\Job\JobList;
use JobRunner\JobRunner\CronJobRunner;

require 'vendor/autoload.php';


$mySymfonyLockerStore = new \Symfony\Component\Lock\Store\MongoDbStore();
$jobList = new JobList();
$jobList->push(new CliJob('php ' . __DIR__ . '/tutu.php', '* * * * *'));

CronJobRunner::create()->withPersistingStore($mySymfonyLockerStore)->run($jobList);

Listening to events

there is various of event you can listen

• JobRunner\JobRunner\Event\JobSuccessEvent
• JobRunner\JobRunner\Event\JobFailEvent
• JobRunner\JobRunner\Event\JobIsLockedEvent
• JobRunner\JobRunner\Event\JobNotDueEvent
• JobRunner\JobRunner\Event\JobStartEvent

Adding logs with psr/log

composer require job-runner/psr-log-adapter

<?php

declare(strict_types=1);

use JobRunner\JobRunner\Job\CliJob;
use JobRunner\JobRunner\Job\JobList;
use JobRunner\JobRunner\CronJobRunner;
use JobRunner\JobRunner\PsrLog\PsrLogEventListener;

require 'vendor/autoload.php';


$myLogger = new \Psr\Log\NullLogger();
$jobList = new JobList();
$jobList->push(new CliJob('php ' . __DIR__ . '/tutu.php', '* * * * *'));

CronJobRunner::create()->withEventListener(new PsrLogEventListener($myLogger));->run($jobList);

Adding console output with symfony/console

composer require job-runner/symfony-console-adapter

<?php

declare(strict_types=1);

use JobRunner\JobRunner\Job\CliJob;
use JobRunner\JobRunner\Job\JobList;
use JobRunner\JobRunner\CronJobRunner;
use JobRunner\JobRunner\SymfonyConsole\SymfonyConsoleEventListener;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\SingleCommandApplication;

require 'vendor/autoload.php';

(new SingleCommandApplication())
    ->setName('My Super Command') // Optional
    ->setVersion('1.0.0') // Optional
    ->addOption('bar', null, InputOption::VALUE_REQUIRED)
    ->setCode(function (InputInterface $input, OutputInterface $output) {
        $jobCollection = new JobList();
        $jobCollection->push(new CliJob('php ' . __DIR__ . '/tutu.php', '* * * * *'));
        $jobCollection->push(new CliJob('php ' . __DIR__ . '/titi.php', '* * * * *', 'sample'));
        $jobCollection->push(new CliJob('php ' . __DIR__ . '/titi.php', '1 1 1 1 1', 'hehe'));
        $jobCollection->push(new CliJob('php ' . __DIR__ . '/arg.php', '* * * * *'));

        $section = $output->section();

        CronJobRunner::create()
            ->withEventListener(new SymfonyConsoleEventListener($section, new Table($section)))
            ->run($jobCollection);

    })
    ->run();

Adding notification output with symfony/notifier

composer require job-runner/symfony-notifier-adapter

<?php

declare(strict_types=1);

use JobRunner\JobRunner\Job\CliJob;
use JobRunner\JobRunner\Job\JobList;
use JobRunner\JobRunner\CronJobRunner;
use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransport;
use Symfony\Component\Notifier\Channel\ChatChannel;
use Symfony\Component\Notifier\Notifier;

require 'vendor/autoload.php';


$rocket = new RocketChatTransport('mytoken', '#mychannel');
$rocket->setHost('chat.myhost.com');
$chat     = new ChatChannel($rocket);
$notifier = new Notifier(['chat' => $chat]);

$jobCollection = new JobList();
$jobCollection->push(new CliJob('php ' . __DIR__ . '/tutu.php', '* * * * *'));

CronJobRunner::create()
    ->withEventListener((new \JobRunner\JobRunner\SymfonyNotifier\SymfonyNotifierEventListener($notifier))->withNotificationChannelFail(['chat']))
    ->run($jobCollection);