Simple package with similar API to native setTimeout
and setInterval
methods, but synced between all running NodeJS instances via MongoDB Collection.
Multi-instance task manager for Node.js. This package has the support of cluster or multi-thread NodeJS instances. This package will help you to make sure only one process of each task is running.
This is a server-only package.
- Install as NPM package
- Install Meteor as Atmosphere package
- API
- Constructor
- setInterval
- setTimeout
- setImmediate
- clearInterval
- clearTimeout
- ~90% tests coverage
- π·ββοΈ ~90% tests coverage
- π¦ Zero dependencies, written from scratch for top performance
- π Synchronize single task across multiple servers
- πͺ Bulletproof design, built-in retries, and "zombie" task recovery π§π«
# for node@>=8.9.0
npm install josk --save
# for node@<8.9.0
npm install josk@=1.1.0 --save
const JoSk = require('josk');
//ES6 Style:
import JoSk from 'josk';
meteor add ostrio:cron-jobs
import JoSk from 'meteor/ostrio:cron-jobs';
Error: Can't wait without a fiber
Can be easily solved via "bounding to Fiber":
const bound = Meteor.bindEnvironment((callback) => {
callback();
});
const db = Collection.rawDatabase();
const job = new JoSk({db: db});
const task = (ready) => {
bound(() => { // <-- use "bound" inside of a task
ready();
});
};
job.setInterval(task, 60 * 60 * 1000, 'task');
This package is perfect when you have multiple servers for load-balancing, durability, an array of micro-services or any other solution with multiple running copies of code when you need to run repeating tasks, and you need to run it only once per app, not per server.
Limitation - task must be run not often than once per two seconds (from 2 to β seconds). Example tasks: Email, SMS queue, Long-polling requests, Periodical application logic operations or Periodical data fetch and etc.
Accuracy - Delay of each task depends on MongoDB and "de-synchronization delay". Trusted time-range of execution period is task_delay Β± (256 + MongoDB_Connection_And_Request_Delay)
. That means this package won't fit when you need to run a task with very certain delays. For other cases, if Β±256 ms
delays are acceptable - this package is the great solution.
new JoSk({opts})
:
opts.db
{Object} - [Required] Connection to MongoDB, like returned as argument fromMongoClient.connect()
opts.prefix
{String} - [Optional] use to create multiple named instancesopts.autoClear
{Boolean} - [Optional] Remove (Clear) obsolete tasks (any tasks which are not found in the instance memory (runtime), but exists in the database). Obsolete tasks may appear in cases when it wasn't cleared from the database on process shutdown, and/or was removed/renamed in the app. Obsolete tasks may appear if multiple app instances running different codebase within the same database, and the task may not exist on one of the instances. Default:false
opts.resetOnInit
{Boolean} - [Optional] make sure all old tasks is completed before set new one. Useful when you run only one instance of app, or multiple app instances on one machine, in case machine was reloaded during running task and task is unfinishedopts.zombieTime
{Number} - [Optional] time in milliseconds, after this time - task will be interpreted as "zombie". This parameter allows to rescue task from "zombie mode" in case when:ready()
wasn't called, exception during runtime was thrown, or caused by bad logic. WhileresetOnInit
option helps to make sure tasks aredone
on startup,zombieTime
option helps to solve same issue, but during runtime. Default value is900000
(15 minutes). It's not recommended to set this value to less than a minute (60000ms)opts.onError
{Function} - [Optional] Informational hook, called instead of throwing exceptions. Default:false
. Called with two arguments:title
{String}details
{Object}details.description
{String}details.error
{Mix}details.uid
{String} - Internaluid
, suitable for.clearInterval()
and.clearTimeout()
opts.onExecuted
{Function} - [Optional] Informational hook, called when task is finished. Default:false
. Called with two arguments:uid
{String} -uid
passed into.setImmediate()
,.setTimeout()
, orsetInterval()
methodsdetails
{Object}details.uid
{String} - Internaluid
, suitable for.clearInterval()
and.clearTimeout()
details.date
{Date} - Execution timestamp as JS Datedetails.timestamp
{Number} - Execution timestamp as unix Number
MongoClient.connect('url', (error, client) => {
// To avoid "DB locks" β it's a good idea to use separate DB from "main" application DB
const db = client.db('dbName');
const job = new JoSk({db: db});
});
// Meteor.users.rawDatabase() is available in most Meteor setups
// If this is not your case, you can use `rawDatabase` form any other collection
const db = Meteor.users.rawDatabase();
const job = new JoSk({db: db});
Note: This library relies on job ID, so you can not pass same job (with the same ID). Always use different uid
, even for the same task:
const task = function (ready) {
//...some code here
ready();
};
job.setInterval(task, 60 * 60 * 1000, 'task-1000');
job.setInterval(task, 60 * 60 * 2000, 'task-2000');
Passing arguments (not really fancy solution, sorry):
const job = new JoSk({db: db});
let globalVar = 'Some top level or env.variable (can be changed over time)';
const task = function (arg1, arg2, ready) {
//...some code here
ready();
};
const taskB = function (ready) {
task(globalVar, 'b', ready);
};
const task1 = function (ready) {
task(1, globalVar, ready);
};
job.setInterval(taskB, 60 * 60 * 1000, 'taskB');
job.setInterval(task1, 60 * 60 * 1000, 'task1');
Note: To clean up old tasks via MongoDB use next query pattern:
// Run directly in MongoDB console:
db.getCollection('__JobTasks__').remove({});
// If you're using multiple JoSk instances with prefix:
db.getCollection('__JobTasks__PrefixHere').remove({});
func
{Function} - Function to call on scheduledelay
{Number} - Delay for first run and interval between further executions in millisecondsuid
{String} - Unique app-wide task id
Set task into interval execution loop. ready()
is passed as the first argument into task function.
In this example, next task will not be scheduled until the current is ready:
const syncTask = function (ready) {
//...run sync code
ready();
};
const asyncTask = function (ready) {
asyncCall(function () {
//...run more async code
ready();
});
};
job.setInterval(syncTask, 60 * 60 * 1000, 'syncTask');
job.setInterval(asyncTask, 60 * 60 * 1000, 'asyncTask');
In this example, next task will not wait for the current task to finish:
const syncTask = function (ready) {
ready();
//...run sync code
};
const asyncTask = function (ready) {
ready();
asyncCall(function () {
//...run more async code
});
};
job.setInterval(syncTask, 60 * 60 * 1000, 'syncTask');
job.setInterval(asyncTask, 60 * 60 * 1000, 'asyncTask');
In this example, we're assuming to have long running task, executed in a loop without delay, but after full execution:
const longRunningAsyncTask = function (ready) {
asyncCall((error, result) => {
if (error) {
ready(); // <-- Always run `ready()`, even if call was unsuccessful
} else {
anotherCall(result.data, ['param'], (error, response) => {
waitForSomethingElse(response, () => {
ready(); // <-- End of full execution
});
});
}
});
};
job.setInterval(longRunningAsyncTask, 0, 'longRunningAsyncTask');
func
{Function} - Function to call on scheduledelay
{Number} - Delay in millisecondsuid
{String} - Unique app-wide task id
Set task into timeout execution. setTimeout
is useful for cluster - when you need to make sure task was executed only once. ready()
is passed as the first argument into task function.
const syncTask = function (ready) {
//...run sync code
ready();
};
const asyncTask = function (ready) {
asyncCall(function () {
//...run more async code
ready();
});
};
job.setTimeout(syncTask, 60 * 60 * 1000, 'syncTask');
job.setTimeout(asyncTask, 60 * 60 * 1000, 'asyncTask');
func
{Function} - Function to call on scheduledate
{Date} - Date to executeuid
{String} - Unique app-wide task id
Set task at some date execution. setTimeat
is useful for cluster - when you need to make sure task was executed only once at some date. ready()
is passed as the first argument into task function.
const syncTask = function (ready) {
//...run sync code
ready();
};
const asyncTask = function (ready) {
asyncCall(function () {
//...run more async code
ready();
});
};
job.setTimeat(syncTask, new Date('2020/8/20 00:00:00'), 'syncTask');
job.setTimeat(asyncTask, new Date('2020/8/20 00:00:00'), 'asyncTask');
func
{Function} - Function to executeuid
{String} - Unique app-wide task id
Immediate execute the function, and only once. setImmediate
is useful for cluster - when you need to execute function immediately and only once across all servers. ready()
is passed as the first argument into the task function.
const syncTask = function (ready) {
//...run sync code
ready();
};
const asyncTask = function (ready) {
asyncCall(function () {
//...run more async code
ready();
});
};
job.setImmediate(syncTask, 'syncTask');
job.setImmediate(asyncTask, 'asyncTask');
Cancel (abort) current interval timer. Must be called in a separate event loop from setInterval
.
const timer = job.setInterval(func, 34789, 'unique-taskid');
job.clearInterval(timer);
Cancel (abort) current timeout timer. Should be called in a separate event loop from setTimeout
.
const timer = job.setTimeout(func, 34789, 'unique-taskid');
job.clearTimeout(timer);
- Clone this package
- In Terminal (Console) go to directory where package is cloned
- Then run:
# Before run tests make sure NODE_ENV === development
# Install NPM dependencies
npm install --save-dev
# Before run tests you need to have running MongoDB
MONGO_URL="mongodb://127.0.0.1:27017/npm-josk-test-001" npm test
# Be patient, tests are taking around 2 mins
# Default
meteor test-packages ./ --driver-package=meteortesting:mocha
# With custom port
meteor test-packages ./ --driver-package=meteortesting:mocha --port 8888
# With local MongoDB and custom port
MONGO_URL="mongodb://127.0.0.1:27017/meteor-josk-test-001" meteor test-packages ./ --driver-package=meteortesting:mocha --port 8888
# Be patient, tests are taking around 2 mins
JoSk
is Job-Task - Is randomly generated name by "uniq" project
- Become a patron β support my open source contributions with monthly donation
- Use ostr.io β Monitoring, Analytics, WebSec, Web-CRON and Pre-rendering for a website