hapi-cron-cluster

A Hapi plugin to setup cron jobs that will call predefined server routes at specified times with leader election (cluster mode)

Based and fork from (credits)

https://github.com/antonsamper/hapi-cron

Requirements

This plugin is compatible with hapi v17+ and requires Node v8+. If you need a version compatible with hapi v16 please install version 1.1.1. The plugin need to connect to mongo or redis (for leader election) hapi-cron-cluster@1.1.1

Installation

Add hapi-cron-cluster as a dependency to your project:

1$ npm install --save hapi-cron-cluster
2or
3$ npm install --save hapi-cron-cluster@1.1.1  (for hapi v16)

Usage

1const Hapi = require('hapi');
2const HapiCron = require('hapi-cron-cluster');
3
4const server = new Hapi.Server();
5
6async function allSystemsGo() {
7
8    try {
9        await server.register({
10            plugin: HapiCron,
11            options: {
12                lock: {
13                    url: 'mongodb://localhost/test', // 'redis://localhost'
14                    key: 'lockTest',
15                    ttl: 5000,
16                    retry: 1000
17                },
18                jobs: [{
19                    name: 'testcron',
20                    time: '*/10 * * * * *',
21                    timezone: 'Europe/London',
22                    request: {
23                        method: 'GET',
24                        url: '/test-url'
25                    },
26                    onComplete: (res) => {
27                        console.info('hapi cron has run');
28                    }
29                }]
30            }
31        });
32
33        server.route({
34            method: 'GET',
35            path: '/test-url',
36            handler: function (request, h) {
37                return 'hello world'
38            }
39        });
40
41        await server.start();
42    }
43    catch (err) {
44        console.info('there was an error');
45    }
46}
47
48allSystemsGo();

Options

• lock - object that contains params for cluster leader election
• lock.url - mongodb or redis url
• lock.key - group key for leader election
• lock.ttl - time to live when lock acquire
• lock.retry - wait time brefore retrying to get the lock
• jobs.name - A unique name for the cron job
• jobs.time - A valid cron value. See cron configuration
• jobs.timezone - A valid timezone
• jobs.request - The request object containing the route url path. Other options can also be passed into the request object
  • url - Route path to request
  • method - Request method (defaults to GET) - optional
• onComplete - Function to run after the route has been requested. The function will contain the response from the request - optional

Cron configuration

This plugin uses the node-cron module to setup the cron job.

Available cron patterns:

Asterisk. E.g. *
Ranges. E.g. 1-3,5
Steps. E.g. */2

Read up on cron patterns here. Note the examples in the link have five fields, and 1 minute as the finest granularity, but the node cron module allows six fields, with 1 second as the finest granularity.

Cron Ranges

When specifying your cron values you'll need to make sure that your values fall within the ranges. For instance, some cron's use a 0-7 range for the day of week where both 0 and 7 represent Sunday. We do not.

• Seconds: 0-59
• Minutes: 0-59
• Hours: 0-23
• Day of Month: 1-31
• Months: 0-11
• Day of Week: 0-6