A schedule plugin for egg, has been built-in plugin for egg enabled by default.
It's fully extendable for a developer and provides a simple built-in TimerStrategy.
Usage
Just add your job file to {app_root}/app/schedule.
// {app_root}/app/schedule/cleandb.jsconst Subscription = require('egg').Subscription;class CleanDB extends Subscription { /** * @property {Object} schedule * - {String} type - schedule type, `worker` or `all` or your custom types. * - {String} [cron] - cron expression, see [below](#cron-style-scheduling) * - {Object} [cronOptions] - cron options, see [cron-parser#options](https://github.com/harrisiirak/cron-parser#options) * - {String | Number} [interval] - interval expression in millisecond or express explicitly like '1h'. see [below](#interval-style-scheduling) * - {Boolean} [immediate] - To run a scheduler at startup * - {Boolean} [disable] - whether to disable a scheduler, usually use in dynamic schedule * - {Array} [env] - only enable scheduler when match env list */ static get schedule() { return { type: 'worker', cron: '0 0 3 * * *',
egg-schedule supports both cron-based scheduling and interval-based scheduling.
Schedule decision is being made by agent process. agent triggers a task and sends a message to worker process. Then, one or all worker process(es) execute the task based on schedule type.
To setup a schedule task, simply create a job file in {app_root}/app/schedule. A file contains one job and exports schedule and task properties.
The rule of thumbs is one job per file.
Task
Task is a class which will be instantiated with every schedule, and a subscribe method will be invoked.
To create a task, subscribe can be a generator function or async function. For example:
// A simple logger exampleconst Subscription = require('egg').Subscription;class LoggerExample extends Subscription { async subscribe() { this.ctx.logger.info('Info about your task'); }}
// A real world example: wipe out your database.// Use it with caution. :)const Subscription = require('egg').Subscription;class CleanDB extends Subscription { async subscribe() { await this.ctx.service.db.cleandb(); }}
Scheduling
schedule is an object that contains one required property, type, and optional properties, { cron, cronOptions, interval, immediate, disable, env }.
To use setInterval, and support ms conversion style
Example:
// To execute task every 3 hoursexports.schedule = { type: 'worker', interval: '3h',};
Notice: Egg built-in TimerStrategy will schedule each execution at a fix rate, regardless of its execution time. So you have to make sure that your actual execution time of your task/subscribe must be smaller than your delay time.
Schedule Type
Build-in support is:
worker: will be executed in one random worker when a schedule runs.
all: will be executed in all workers when a schedule runs.
Custom schedule:
To create a custom schedule, simply extend agent.ScheduleStrategy and register it by agent.schedule.use(type, clz).
You can schedule the task to be executed by one random worker or all workers with the built-in method this.sendOne(...args) or this.sendAll(...args) which support params, it will pass to subscribe(...args) or task(ctx, ...args).
// {app_root}/agent.jsmodule.exports = function(agent) { class CustomStrategy extends agent.ScheduleStrategy { start() { // such as mq / redis subscribe agent.notify.subscribe('remote_task', data => { this.sendOne(data); }); } } agent.schedule.use('custom', CustomStrategy);};