A simple jobs queue that just works (for Meteor.js)
Clone or download
Latest commit 62ea7bb Jan 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
package Delete .DS_Store Jan 13, 2019
tests Cleanup, bug fix, and test functions Feb 28, 2018
CHANGES.md Updated documentation for 3.0 Jun 24, 2018
DOCUMENTATION.md Improve README + documentation Jan 13, 2019
GUI.png Add files via upload Jan 23, 2018
ICON.png Bolder Feb 9, 2018
LICENSE.md Refinement 🧐 Mar 6, 2018
PATENTS.md v2 🎉 Jan 12, 2018
README.md Update README.md Jan 15, 2019

README.md

Steve Jobs

The Simple Jobs Queue That Just Works

Run scheduled tasks with Steve Jobs, the simple jobs queue made just for Meteor. With tight MongoDB integration and fibers-based timing functions, this package is quick, reliable and effortless to use.

  • Jobs run on one server at a time
  • Jobs run predictably and consecutively
  • Jobs and their history are stored in MongoDB
  • Failed jobs are retried on server restart
  • No third party dependencies

The new 3.1 features repeating jobs and more improvements. It can run hundreds of jobs in seconds with minimal CPU impact, making it a reasonable choice for many applications. To get started, check out the documentation and the quick start below.

Developer Friendly GUI and API

In addition to a simple API, the Steve Jobs package offers an in-app development tool. After installing the main package, run the package command below and press Control + J in your app to open it.

meteor add msavin:sjobs-ui-blaze

Note: this package may be a little bit flakey, and might not work if audit-argument-checks is present. Unfortunately, I had lost the source code, and will probably rebuild the package once there is a good reason to do so.

Quick Start

First, install the package, and import if necessary:

meteor add msavin:sjobs
import { Jobs } from 'meteor/msavin:sjobs'

Then, write your background jobs like you would write your methods:

Jobs.register({
    "sendReminder": function (to, message) {
        var instance = this;

        var call = HTTP.put("http://www.magic.com/sendEmail", {
            to: to,
            message: message
        })

        if (call.statusCode === 200) {
            instance.success(call.result);
        } else {
            instance.reschedule({
                in: {
                    minutes: 5
                }
            });
        }
    }
});

Finally, schedule a background job like you would call a method:

Jobs.run("sendReminder", "jony@apple.com", "The future is here!");

One more thing: the function above will schedule the job to run on the moment that the function was called, however, you can delay it by passing in a special configuration object at the end:

Jobs.run("sendReminder", "jony@apple.com", "The future is here!", {
    in: {
        days: 3,
    }, 
    on: {
        hour: 9,
        minute: 42
    },
    priority: 9999999999
});

The configuration object supports date, in, on, priority, singular, unique, and data, all of which are completely optional. For more information, see the Jobs.run documentation.

Repeating Jobs

Compared to a CRON Job, the Steve Jobs package gives you much more control over how and when the job runs. To get started, you just need to create a job that replicates itself.

Jobs.register({
    "syncData": function () {
        var instance = this;

        var call = HTTP.put("http://www.magic.com/syncData")

        if (call.statusCode === 200) {
            instance.replicate({
                in: {
                    hours: 1
                }
            });
            
            // alternatively, you can use instance.remove to save storage
            instance.success(call.result);
        } else {
            instance.reschedule({
                in: {
                    minutes: 5
                }
            });
        }
    }
});

Then, you need to "kickstart" the queue by creating the first job to run. By using the singular flag, you can ensure that Meteor will only create the job if there is no pending or failed instance of it.

Meteor.startup(function () {
    Jobs.run("syncData", {
        singular: true
    })    
})

Documentation

Jobs.register and Jobs.run are all you need to get started, but that's only the beginning of what the package can do. To explore the rest of the functionality, jump into the documentation:


Steve Jobs is an MIT-licensed project, brought to you by Meteor Candy.