node-schedule 1.2.4 → 1.3.2

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
@@ -158,13 +165,13 @@ var j = schedule.scheduleJob(rule, function(){
 
 #### RecurrenceRule properties
 
-- `second`
-- `minute`
-- `hour`
-- `date`
-- `month`
+- `second (0-59)`
+- `minute (0-59)`
+- `hour  (0-23)`
+- `date  (1-31)`
+- `month (0-11)`
 - `year`
-- `dayOfWeek`
+- `dayOfWeek (0-6) Starting with Sunday`
 
 > **Note**: It's worth noting that the default value of a component of a recurrence rule is
 > `null` (except for second, which is 0 for familiarity with cron). *If we did not
@@ -197,11 +204,11 @@ var j = schedule.scheduleJob({ start: startTime, end: endTime, rule: '*/1 * * *
 
 ### Handle Jobs and Job Invocations
 
-There are some function to get informations for a Job and to handle the Job and
+There are some function to get information for a Job and to handle the Job and
 Invocations.
 
 
-#### job.cancel(reshedule)
+#### job.cancel(reschedule)
 You can invalidate any job with the `cancel()` method:
 
 ```js
@@ -210,7 +217,7 @@ j.cancel();
 All planned invocations will be canceled. When you set the parameter ***reschedule***
 to true then the Job is newly scheduled afterwards.
 
-#### job.cancelNext(reshedule)
+#### job.cancelNext(reschedule)
 This method invalidates the next planned invocation or the job.
 When you set the parameter ***reschedule*** to true then the Job is newly scheduled
 afterwards.

package/lib/schedule.js

@@ -90,7 +90,7 @@ function Job(name, job, callback) {
 
       cancelInvocation(inv);
 
-      if (reschedule && inv.recurrenceRule.recurs) {
+      if (reschedule && (inv.recurrenceRule.recurs || inv.recurrenceRule.next)) {
         newInv = scheduleNextRecurrence(inv.recurrenceRule, this, inv.fireDate, inv.endDate);
         if (newInv !== null) {
           newInvs.push(newInv);
@@ -125,7 +125,7 @@ function Job(name, job, callback) {
 
     cancelInvocation(nextInv);
 
-    if (reschedule && nextInv.recurrenceRule.recurs) {
+      if (reschedule && (nextInv.recurrenceRule.recurs || nextInv.recurrenceRule.next)) {
       newInv = scheduleNextRecurrence(nextInv.recurrenceRule, this, nextInv.fireDate, nextInv.endDate);
       if (newInv !== null) {
         this.trackInvocation(newInv);
@@ -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);
   }
 };
 
@@ -188,10 +188,14 @@ Job.prototype.schedule = function(spec) {
   var end;
   var tz;
 
+  // save passed-in value before 'spec' is replaced
+  if (typeof spec === 'object' && 'tz' in spec) {
+    tz = spec.tz;
+  }
+
   if (typeof spec === 'object' && spec.rule) {
     start = spec.start || undefined;
     end = spec.end || undefined;
-    tz = spec.tz;
     spec = spec.rule;
 
     if (start) {
@@ -398,6 +402,11 @@ RecurrenceRule.prototype.isValid = function() {
 };
 
 RecurrenceRule.prototype.nextInvocationDate = function(base) {
+  var next = this._nextInvocationDate(base);
+  return next ? next.toDate() : null;
+};
+
+RecurrenceRule.prototype._nextInvocationDate = function(base) {
   base = ((base instanceof CronDate) || (base instanceof Date)) ? base : (new Date());
   if (!this.recurs) {
     return null;
@@ -464,7 +473,7 @@ RecurrenceRule.prototype.nextInvocationDate = function(base) {
     break;
   }
 
-  return next ? next.toDate() : null;
+  return next;
 };
 
 function recurMatch(val, matcher) {
@@ -491,15 +500,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();
 
-  if (then < now) {
-    setImmediate(job);
-    return null;
-  }
-
-  return lt.setTimeout(job, (then - now));
+  return lt.setTimeout(function() {
+    if (then > Date.now())
+      runOnDate(date, job);
+    else
+      job();
+  }, (then < now ? 0 : then - now));
 }
 
 var invocations = [];
@@ -540,7 +549,7 @@ function prepareNextInvocation() {
 
       job.stopTrackingInvocation(cinv);
 
-      job.invoke();
+      job.invoke(cinv.fireDate instanceof CronDate ? cinv.fireDate.toDate() : cinv.fireDate);
       job.emit('run');
     });
   }
@@ -574,7 +583,7 @@ function scheduleNextRecurrence(rule, job, prevDate, endDate) {
 
   prevDate = (prevDate instanceof CronDate) ? prevDate : new CronDate();
 
-  var date = (rule instanceof RecurrenceRule) ? rule.nextInvocationDate(prevDate) : rule.next();
+  var date = (rule instanceof RecurrenceRule) ? rule._nextInvocationDate(prevDate) : rule.next();
   if (date === null) {
     return null;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-schedule",
-  "version": "1.2.4",
+  "version": "1.3.2",
   "description": "A cron-like and not-cron-like job scheduler for Node.",
   "keywords": [
     "schedule",
@@ -24,7 +24,7 @@
     "url": "https://github.com/node-schedule/node-schedule.git"
   },
   "dependencies": {
-    "cron-parser": "^2.4.0",
+    "cron-parser": "^2.7.3",
     "long-timeout": "0.1.1",
     "sorted-array-functions": "^1.0.0"
   },

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);
+    }
+  }
+};

package/test/job-test.js

@@ -381,6 +381,44 @@ module.exports = {
 
       clock.tick(2250);
     },
+    "Cancelled job reschedules": function(test) {
+      test.expect(1);
+      var ok = false;
+
+      var job = schedule.scheduleJob('*/1 * * * * *', function () {});
+
+      setTimeout(function() {
+        job.cancel(true);
+        if (job.nextInvocation() !== null) ok = true;
+      }, 1250);
+
+      setTimeout(function() {
+        job.cancel();
+        test.ok(ok);
+        test.done();
+      }, 2250);
+
+      clock.tick(2250);
+    },
+    "CancelNext job reschedules": function(test) {
+      test.expect(1);
+      var ok = false;
+
+      var job = schedule.scheduleJob('*/1 * * * * *', function () {});
+
+      setTimeout(function() {
+        job.cancelNext();
+        if (job.nextInvocation() !== null) ok = true;
+      }, 1250);
+
+      setTimeout(function() {
+        job.cancel();
+        test.ok(ok);
+        test.done();
+      }, 2250);
+
+      clock.tick(2250);
+    },
     "Job emits 'canceled' event": function(test) {
       test.expect(1);
 
@@ -484,6 +522,29 @@ module.exports = {
         test.done();
       }, 2250);
 
+      clock.tick(2250);
+    },
+    "Job gets invoked with the fire date": function (test) {
+      test.expect(2);
+      var prevFireDate;
+      var job = new schedule.Job(function (fireDate) {
+        if (!prevFireDate) {
+          test.ok(fireDate instanceof Date);
+        } else {
+          test.equal(fireDate.getTime() - prevFireDate.getTime(), 1000);
+        }
+        prevFireDate = fireDate;
+      });
+
+      job.schedule({
+        second: null // fire every second
+      });
+
+      setTimeout(function () {
+        job.cancel();
+        test.done();
+      }, 2250);
+
       clock.tick(2250);
     }
   },

package/test/start-end-test.js

@@ -28,6 +28,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -49,6 +50,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -70,6 +72,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -91,6 +94,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -113,6 +117,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -133,6 +138,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -151,6 +157,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -169,6 +176,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -187,6 +195,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -206,6 +215,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -226,6 +236,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -244,6 +255,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -262,6 +274,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -280,6 +293,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -299,6 +313,7 @@ module.exports = {
       });
 
       setTimeout(function () {
+        job.cancel();
         test.done();
       }, 3250);
 
@@ -309,4 +324,4 @@ module.exports = {
     clock.restore();
     cb();
   }
-};
+};