Update bug fixes - fix lost context in helper functions (#38)

* started bug fix for [issue #37](#37)

* Just commiting what I have which is borked.

* finally fixed undefined ref exception.

* Fixed tests

* test update tab as well

* Removed unecessary files

* add back the original update tests

* bugfixes:

* start / stop workflow for update fixed.
* preserved additional options.

* Don't need to preserve start options. preserved in job.

Author: cfurst

.gitignore

@@ -4,4 +4,4 @@ node_modules*
 *.ipr
 *.iws
 *.suo
-.vs
+.vs*

.vscode/settings.json

@@ -22,12 +22,19 @@
  */
 
 var CronJob = require('cron').CronJob;
+var cronJobOptionalKeys = [
+    "cronTime", //this preserves the crontab itself, timeZone, utcOffset.
+    "context",
+    "unrefTimeout",
+    "onComplete"
+]
 
 function CrontabManager(key, tab, task, options) {
   this.jobs = {};
   if (key && tab && task) {
     this.add(key, tab, task, options);
   }
+  return this
 }
 
 CrontabManager.prototype.add = function (key, tab, task, options) {
@@ -129,20 +136,14 @@ CrontabManager.prototype.stopAll = function () {
 CrontabManager.prototype.toString = function () {
   var manString = "{\n";
   for (jobKey in this.jobs) {
-    manString += `'${jobKey}': ${this.jobs[jobKey].cronTime.source}: ${this.jobs[jobKey]._callbacks[0]}: ${this.jobs[jobKey].running ? "Running" : "Stopped"}`
+    manString += `'${jobKey}': ${this.jobs[jobKey].cronTime.source}: ${this.jobs[jobKey]._callbacks[0]}: ${this.jobs[jobKey].running ? "Running" : "Stopped"}\n`
   }
-  manString += "\n}";
+  manString += "}";
   return manString;
 }
 
-CrontabManager.prototype.listCrons = function () {
-  var manString = "{\n";
-  for (jobKey in this.jobs) {
-    manString += `'${jobKey}': ${this.jobs[jobKey].cronTime.source} status: ${this.jobs[jobKey].running ? "Running" : "Stopped"} \n`;
-  }
-  manString += "\n}";
-  return manString;
-}
+CrontabManager.prototype.listCrons = CrontabManager.prototype.toString
+
 
 CrontabManager.prototype.exists = function (tabKey) {
   if (this.jobs[tabKey]) {
@@ -175,7 +176,9 @@ function updateTab(key, cronstring) {
     var running = this.jobs[key].running;
     this.jobs[key].stop()
     if (typeof cronstring === 'string' || cronstring instanceof Date) {
-      this.jobs[key] = new CronJob(cronstring, this.jobs[key]._callbacks[0], this.jobs[key].onComplete, running, this.jobs[key].zone)
+        var preservedOptions = getAdditionalOptions.call(this, key)
+        this.jobs[key] = new CronJob(combineOptions(cronstring, this.jobs[key]._callbacks[0], preservedOptions))
+        if (running) this.jobs[key].start()
     } else {
       throw new Error(`The cron definition passed was not a string or a Date object! ${key} was stopped and not updated`);
     }
@@ -187,15 +190,37 @@ function updateTab(key, cronstring) {
 function updateTask(key, task) {
   try {
     var running = this.jobs[key].running;
-    this.jobs[key].stop()
+    if (running) this.jobs[key].stop()
     if (!(task instanceof Function)) {
       console.error(`can't update with something that is not a function: ${typeof(task)}`)
       return
     }
-    this.jobs[key] = new CronJob(this.jobs[key].cronTime.source, task, this.jobs[key].onComplete, running, this.jobs[key].zone)
+    var preservedOptions = getAdditionalOptions.call(this, key)
+    this.jobs[key] = new CronJob(combineOptions(this.jobs[key].cronTime.source, task, preservedOptions))
+    if (running) this.jobs[key].start()
   } catch (tabErr) {
     console.error(`error updating task: ${key}  - ${tabErr.message}`);
   }
 }
 
+function getAdditionalOptions(key) {
+    var additionalOptions = {}
+    var job = this.jobs[key]
+    function getOptionsFromCronTime() {
+        if (job.cronTime) {
+          additionalOptions.timeZone =job.cronTime.timeZone
+          additionalOptions.utcOffset = job.cronTime.utcOffset
+          additionalOptions.start = job.cronTime.start || job.cronTime.startJob || job.cronTime.startNow
+        }
+        
+    }
+    cronJobOptionalKeys.forEach((key) => {
+        if (key === "cronTime") getOptionsFromCronTime()
+        else additionalOptions[key] = job[key]
+    })
+    return additionalOptions
+
+}
+
+
 module.exports = CrontabManager;

lib/crontab_manager.js

@@ -1,6 +1,6 @@
 {
   "name": "cron-job-manager",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "A wrapper Object for node-cron that allows you to manage multiple cron jobs at once.",
   "author": "Carl Yamamoto-Furst",
   "main": "lib/crontab_manager.js",

package.json

@@ -5,31 +5,59 @@ const CronJobManager = require('../lib/crontab_manager'),
 cronTab = new CronJobManager();
 
 exports.test = () => {
-    let currDate = new Date();
+  let currDate = new Date();
   cronTab.add('updateTest', currDate, () => {console.log("update Cron... wooo!")});
+
   //update the tab - string
   let tabString = '0 */2 * * * *';
   cronTab.update('updateTest', tabString);
   console.assert(/0 \*\/2 \* \* \* \*/.test(cronTab), `Could not find updated crontab String! ${cronTab}`);
-  
+
   //update the tab - Date;
   let testDate = new Date('2018-08-24T09:57:22-0400');
   cronTab.update('updateTest', testDate);
   console.assert(/Fri Aug 24 2018 09\:57\:22 GMT-0400/.test(cronTab), `Could not find updated Crontab date! ${cronTab}`);
-  
+
   //update the task
   let newFunc = function() {
-      
+
       console.log("you can now doo a double wooo... wooo wooo....");
   }
-  
+
   cronTab.update('updateTest', newFunc);
-  console.assert(`${cronTab}`.search("double wooo"), "coulnd't the update task when updating just the task!");
-  
+  console.assert(`${cronTab}`.search("double wooo") !== -1, "coulnd't the update task when updating just the task!");
+
   //update the tab and the task - we know the update tab works. We just need to make sure the task gets updated.
   cronTab.update('updateTest', testDate, () => {console.log("A New Task!")});
-  
-  console.assert(`${cronTab}`.search("A New Task!"), "could't find the updated task when updating tab and task!");
+
+  console.assert(`${cronTab}`.search("A New Task!") !== -1, "could't find the updated task when updating tab and task!");
+
+  let thirtyOne = 31
+  cronTab.add(thirtyOne.toString(),new Date(), () => {console.log("new Job...")})
+  cronTab.update(thirtyOne.toString(), new Date(), () => {console.log("updated 31...")})
+
+  console.assert(`${cronTab}`.search("updated 31...") !== -1, "couldn't the update task when updating a task with a number literal coerced to string.");
+
+   let additionalOptions = {utcOffset: "-5", onComplete: () => {console.log("I'm done working")},start: true}
 
+   function testAdditionalOptions() {
+    [
+      "cronTime",
+      "context",
+      "onComplete",
+     "unrefTimeout",
+     "start"
+    ].forEach( (key) => {
+                                 if (key === "cronTime" && cronTab.jobs["test update with additional"][key] !== undefined && cronTab.jobs["test update with additional"][key].hasOwnProperty('utcOffset')) console.assert(cronTab.jobs["test update with additional"][key].utcOffset === additionalOptions.utcOffset, `${key} did not pass jobs value: ${cronTab.jobs["test update with additional"][key].utcOffset} additionalOptions: ${additionalOptions.utcOffset}`)
+                                 else if (key ==="start" && ! (cronTab.jobs["test update with additional"].hasOwnProperty("running") && cronTab.jobs["test update with additional"].running)) console.assert(false, "Started Job did not restart after update!")
+                                 else if (cronTab.jobs["test update with additional"].hasOwnProperty(key) && additionalOptions.hasOwnProperty(key)) console.assert(cronTab.jobs["test update with additional"][key] === additionalOptions[key], `${key} did not pass: jobs value: ${cronTab.jobs["test update with additional"][key]}, additionalOptions valud: ${additionalOptions[key]}`)
+                               })
+   }
+   cronTab.add("test update with additional", "* * * * * *", () => {console.log("shhh.. I'm working!")}, additionalOptions )
+   cronTab.update("test update with additional", () => {console.log("shh... I'm still working!")});
+   testAdditionalOptions()
+   cronTab.update("test update with additional", "*/2 * * * * *")
+   testAdditionalOptions()
+   cronTab.stopAll()
 
-};
+};