node-schedule 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Master (Unreleased)
 
+# 2.1.0 - 28 November, 2021
+
+### New features:
+
+- Implement support for graceful shutdown #583
+- Emit a success event after a successful job invocation. #643
+
 # 2.0.0 - 01 February, 2021
 
 ### Breaking changes:

package/README.md

@@ -57,6 +57,9 @@ or use the convenience function `scheduleJob()` as demonstrated below.
   Note that `canceled` is the single-L American spelling.
 * An `error` event when a job invocation triggered by a schedule throws or returns
   a rejected `Promise`.
+* A `success` event when a job invocation triggered by a schedule returns successfully or
+  returns a resolved `Promise`. In any case, the `success` event receives the value returned
+  by the callback or in case of a promise, the resolved value.
 
 (Both the `scheduled` and `canceled` events receive a JavaScript date object as
 a parameter).  
@@ -230,6 +233,22 @@ const job = schedule.scheduleJob({ start: startTime, end: endTime, rule: '*/1 *
 });
 ```
 
+### Graceful Shutdown.
+You can shutdown jobs gracefully.  
+`gracefulShutdown()` will cancel all jobs and return Promise.  
+It will wait until all jobs are terminated.  
+```js
+schedule.gracefulShutdown();
+```
+
+You can also gracefully shutdown jobs when a system interrupt occurs.
+```
+process.on('SIGINT', function () { 
+  schedule.gracefulShutdown()
+  .then(() => process.exit(0))
+}
+```
+
 ### Handle Jobs and Job Invocations
 
 There are some function to get information for a Job and to handle the Job and
@@ -272,7 +291,7 @@ Before jumping in, check out our [Contributing] page guide!
 
 Copyright 2015 Matt Patenaude.
 
-Licensed under the **[MIT License] [license]**.
+Licensed under the **[MIT License](https://github.com/node-schedule/node-schedule/blob/master/LICENSE)**.
 
 
 [cron]: http://unixhelp.ed.ac.uk/CGI/man-cgi?crontab+5
@@ -280,7 +299,5 @@ Licensed under the **[MIT License] [license]**.
 [Matt Patenaude]: https://github.com/mattpat
 [Tejas Manohar]: http://tejas.io
 [Igor Savin]: https://twitter.com/kibertoad
-[license]: https://github.com/node-schedule/node-schedule/blob/master/LICENSE
-[Tejas Manohar]: https://github.com/tejasmanohar
 [our amazing community]: https://github.com/node-schedule/node-schedule/graphs/contributors
 [cron-parser]: https://github.com/harrisiirak/cron-parser

package/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { cancelJob, rescheduleJob, scheduledJobs, scheduleJob} = require('./lib/schedule')
+const { cancelJob, rescheduleJob, scheduledJobs, scheduleJob, gracefulShutdown} = require('./lib/schedule')
 const { Invocation, RecurrenceRule, Range} = require('./lib/Invocation')
 const { Job } = require('./lib/Job')
 
@@ -12,5 +12,6 @@ module.exports = {
   cancelJob,
   rescheduleJob,
   scheduledJobs,
-  scheduleJob
+  scheduleJob,
+  gracefulShutdown,
 }

package/lib/Invocation.js

@@ -267,14 +267,23 @@ function prepareNextInvocation() {
       try {
         const result = job.invoke(cinv.fireDate instanceof CronDate ? cinv.fireDate.toDate() : cinv.fireDate);
         job.emit('run');
+        job.running += 1;
 
         if (result instanceof Promise) {
-          result.catch(function (err) {
+          result.then(function (value) {
+            job.emit('success', value);
+            job.running -= 1;
+          }).catch(function (err) {
             job.emit('error', err);
+            job.running -= 1;
           });
+        } else {
+          job.emit('success', result);
+          job.running -= 1;
         }
       } catch (err) {
         job.emit('error', err);
+        job.running -= 1;
       }
 
       if (job.isOneTimeJob) {

package/lib/Job.js

@@ -41,6 +41,9 @@ function Job(name, job, callback) {
     this.callback = typeof callback === 'function' ? callback : false;
   }
 
+  // task count
+  this.running = 0;
+
   // Check for generator
   if (typeof this.job === 'function' &&
     this.job.prototype &&

package/lib/schedule.js

@@ -49,7 +49,7 @@ function rescheduleJob(job, spec) {
       return job;
     }
   } else if (typeof job === 'string') {
-    if (scheduledJobs.hasOwnProperty(job)) {
+    if (Object.prototype.hasOwnProperty.call(scheduledJobs, job)) {
       if (scheduledJobs[job].reschedule(spec)) {
         return scheduledJobs[job];
       }
@@ -65,7 +65,7 @@ function cancelJob(job) {
   if (job instanceof Job) {
     success = job.cancel();
   } else if (typeof job == 'string' || job instanceof String) {
-    if (job in scheduledJobs && scheduledJobs.hasOwnProperty(job)) {
+    if (job in scheduledJobs && Object.prototype.hasOwnProperty.call(scheduledJobs, job)) {
       success = scheduledJobs[job].cancel();
     }
   }
@@ -73,10 +73,42 @@ function cancelJob(job) {
   return success;
 }
 
+function gracefulShutdown() {
+  const jobs = Object.keys(scheduledJobs).map(key => scheduledJobs[key]);
+  jobs.forEach(function (job) {
+    job.cancel();
+  });
+
+  let running = false;
+  for (let i = 0; i < jobs.length; i++) {
+    if (jobs[i].running > 0) {
+      running = true;
+      break;
+    }
+  }
+
+  return new Promise(function (resolve) {
+    if (running) {
+      setInterval(function () {
+        for (let i = 0; i < jobs.length; i++) {
+          if (jobs[i].running > 0) {
+            return;
+          }
+        }
+
+        resolve();
+      }, 500);
+    } else {
+      resolve();
+    }
+  });
+}
+
 /* Public API */
 module.exports = {
   scheduleJob,
   rescheduleJob,
   scheduledJobs,
-  cancelJob
+  cancelJob,
+  gracefulShutdown,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-schedule",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A cron-like and not-cron-like job scheduler for Node.",
   "keywords": [
     "schedule",
@@ -36,16 +36,16 @@
     "url": "https://github.com/node-schedule/node-schedule.git"
   },
   "dependencies": {
-    "cron-parser": "^3.1.0",
+    "cron-parser": "^3.5.0",
     "long-timeout": "0.1.1",
     "sorted-array-functions": "^1.3.0"
   },
   "devDependencies": {
-    "airtap": "^4.0.1",
-    "eslint": "^7.18.0",
+    "airtap": "^4.0.4",
+    "eslint": "^8.3.0",
     "nyc": "^15.1.0",
     "sinon": "^9.2.4",
-    "tape": "^5.1.1"
+    "tape": "^5.3.2"
   },
   "engines": {
     "node": ">=6"