openclerk / jobs
There is no license information available for the latest version (0.1.0) of this package.
Simple PHP job queueing, execution and management
0.1.0
2017-09-11 07:38 UTC
Requires
- monolog/monolog: ~1.11
- openclerk/config: ^0.1
- openclerk/db: ^0.1
- openclerk/events: ^0.2
Requires (Dev)
- soundasleep/component-tests: dev-master
This package is auto-updated.
Last update: 2024-10-14 10:24:58 UTC
README
A library for simple PHP job queueing, execution and management, used by Openclerk and live on CryptFolio.
While cron jobs are a simple approach to running regular tasks,
openclerk/jobs
allows tasks to be defined, executed and managed in reliable ways.
Installing
Include openclerk/jobs
as a requirement in your project composer.json
,
and run composer update
to install it into your project:
{ "require": { "openclerk/jobs": "dev-master" } }
Features
- Queue up jobs immediately for execution later
- Jobs can return success or failure (by throwing exceptions)
- Repeatedly failing jobs can be removed from the job execution queue
- Define your own job selection algorithms
- Any exceptions thrown during job execution are stored in the
job_exceptions
table
Using
Define a job class
use \Openclerk\Jobs\Job; use \Db\Connection; use \Monolog\Logger; class MyJob implements Job { /** * @param $job the `job` instance, an array of `job_type`, `arg_id` and optionally `user_id` */ function __construct($job) { $this->job = $job; } function run(Connection $db, Logger $logger) { $q = $db->prepare("SELECT * FROM table WHERE id=?"); $q->execute(array($this->job['arg_id'])); if (!$q->fetch()) { throw new \Exception("Could not find that instance"); } } function passed(Connection $db, Logger $logger) { // (optional) the job passed } function failed(\Exception $runtime_exception, Connection $db, Logger $logger) { // (optional) the job failed } }
Define a job queuer
use \Openclerk\Jobs\JobQueuer; use \Openclerk\Jobs\Job; use \Db\Connection; use \Monolog\Logger; class MyJobQueuer extends JobQueuer { /** * Get a list of all jobs that need to be queued, as an array of associative * arrays with (job_type, arg_id, [user_id]). */ function findJobs(Connection $db, Logger $logger) { $result = array(); $q = $db->prepare("SELECT * FROM table WHERE is_queued=0"); $q->execute(); while ($r = $q->fetch()) { $result[] = array( 'job_type' => 'table', 'arg_id' => $r['id'], // optional: user_id ); } return $result; } /** * The given job has been queued up, so we can mark it as successfully queued. */ function jobQueued(Connection $db, Logger $logger, $job) { $q = $db->prepare("UPDATE table SET is_queued=1 WHERE id=?"); $q->execute(array($job['arg_id'])); } }
Define a job runner
use \Openclerk\Jobs\JobRunner; use \Openclerk\Jobs\Job; use \Db\Connection; use \Monolog\Logger; class MyJobRunner extends JobRunner { /** * Get the {@link Job} to run for this job type. */ function createJob($job, Connection $db, Logger $logger) { switch ($job['job_type']) { case 'table': return new MyJob($job); } } }
Write batch scripts to execute the queuer and runner
For example, a batch script to queue up new jobs:
$logger = new \Monolog\Logger("batch_queue"); $logger->pushHandler(new \Core\MyLogger()); $runner = new MyJobQueuer(); $runner->queue(db(), $logger);
Or, a batch script to run a single job:
$logger = new \Monolog\Logger("batch_run"); $logger->pushHandler(new \Core\MyLogger()); $runner = new MyJobRunner(); $runner->runOne(db(), $logger);
These batch scripts can then be setup with cron, etc.
Extensions
- Using
require()
for running jobs instead of classes - Run jobs only of a certain type
- Run jobs only of users with particular properties
- Run jobs only with a particular job ID
- Run jobs from a web admin interface
Donate
TODO
- Capture jobs that timeout
- job_failed events through openclerk/events
- More tests