node-schedule 1.2.5 → 1.3.0

package/README.md

@@ -58,7 +58,7 @@ The cron format consists of:
 ```
 *    *    *    *    *    *
 ┬    ┬    ┬    ┬    ┬    ┬
-│    │    │    │    │    |
+│    │    │    │    │    │
 │    │    │    │    │    └ day of week (0 - 7) (0 or 7 is Sun)
 │    │    │    │    └───── month (1 - 12)
 │    │    │    └────────── day of month (1 - 31)
@@ -89,6 +89,13 @@ var j = schedule.scheduleJob('0 17 ? * 0,4-6', function(){
 
 Execute a cron job every 5 Minutes = */5 * * * *
 
+You can also get when it is scheduled to run for every invocation of the job:
+```js
+var j = schedule.scheduleJob('0 1 * * *', function(fireDate){
+  console.log('This job was supposed to run at ' + fireDate + ', but actually ran at ' + new Date());
+});
+```
+This is useful when you need to check if there is a delay of the job invocation when the system is busy, or save a record of all invocations of a job for audit purpose.
 #### Unsupported Cron Features
 
 Currently, `W` (nearest weekday), `L` (last day of month/week), and `#` (nth weekday

package/lib/schedule.js

@@ -167,12 +167,12 @@ function Job(name, job, callback) {
 
 util.inherits(Job, events.EventEmitter);
 
-Job.prototype.invoke = function() {
+Job.prototype.invoke = function(fireDate) {
   if (typeof this.job == 'function') {
     this.setTriggeredJobs(this.triggeredJobs() + 1);
-    this.job();
+    this.job(fireDate);
   } else {
-    this.job.execute();
+    this.job.execute(fireDate);
   }
 };
 
@@ -491,10 +491,15 @@ function recurMatch(val, matcher) {
 
 /* Date-based scheduler */
 function runOnDate(date, job) {
-  var now = (new Date()).getTime();
+  var now = Date.now();
   var then = date.getTime();
   
-  return lt.setTimeout(job, (then < now ? 0 : then - now));
+  return lt.setTimeout(function() {
+    if (then > Date.now())
+      runOnDate(date, job);
+    else
+      job();
+  }, (then < now ? 0 : then - now));
 }
 
 var invocations = [];
@@ -535,7 +540,7 @@ function prepareNextInvocation() {
 
       job.stopTrackingInvocation(cinv);
 
-      job.invoke();
+      job.invoke(cinv.fireDate instanceof CronDate ? cinv.fireDate.toDate() : cinv.fireDate);
       job.emit('run');
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-schedule",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "A cron-like and not-cron-like job scheduler for Node.",
   "keywords": [
     "schedule",

package/test/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "quotes": ["off"]
+  }
+}

package/test/cancel-long-running-jobs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var schedule = require('../lib/schedule');
+
+module.exports = {
+  'Cancel Long Running Job': {
+    'should work even when recurring jobs are to be run on the past': function (test) {
+      var ok = true;
+      var job = schedule.scheduleJob('*/1 * * * * *', function () {
+        test.ok(ok);
+        var time = Date.now();
+        while (ok && (Date.now() - time < 2000)) {
+        }
+      });
+
+      test.ok(job);
+      setTimeout(function () {
+        job.cancel();
+        test.done();
+        ok = false;
+      }, 2100);
+    }
+  }
+};