feat(#577): recurring tasks

package.json

@@ -35,7 +35,6 @@
   },
   "homepage": "https://github.com/medic/cht-conf#readme",
   "dependencies": {
-    "joi": "^17.9.2",
     "@medic/translation-checker": "^1.0.1",
     "@parcel/watcher": "^2.0.5",
     "@xmldom/xmldom": "^0.8.2",
@@ -46,9 +45,11 @@
     "eslint-loader": "^3.0.4",
     "googleapis": "^84.0.0",
     "iso-639-1": "^2.1.9",
+    "joi": "^17.9.2",
     "json-diff": "^0.5.4",
     "json-stringify-safe": "^5.0.1",
     "json2csv": "^4.5.4",
+    "luxon": "^3.4.3",
     "mime-types": "^2.1.32",
     "minimist": "^1.2.5",
     "mkdirp": "^1.0.4",

src/lib/compilation/validate-declarative-schema.js

@@ -82,10 +82,10 @@ const TargetSchema = joi.array().items(
   .unique('id')
   .required();
 
-const EventSchema = idPresence => joi.object({
+const NonRecurringEventSchema = idPresence => joi.object({
     id: joi.string().presence(idPresence),
     days: joi.alternatives().conditional('dueDate', { is: joi.exist(), then: joi.forbidden(), otherwise: joi.number().required() })
-      .error(taskError('"event.days" is a required integer field only when "event.dueDate" is absent')),
+      .error(taskError('"event.days" is a required integer field but only when "event.dueDate" is absent')),
     dueDate: joi.alternatives().conditional('days', { is: joi.exist(), then: joi.forbidden(), otherwise: joi.function().required() })
       .error(taskError('"event.dueDate" is required to be "function(event, contact, report)" only when "event.days" is absent')),
     start: joi.number().min(0).required(),
@@ -117,11 +117,22 @@ const TaskSchema = joi.array().items(
           'should define property "resolvedIf" as: function(contact, report) { ... }.'
         )
       ),
-    events: joi.alternatives().conditional('events', {
-      is: joi.array().length(1),
-      then: joi.array().items(EventSchema('optional')).min(1).required(),
-      otherwise: joi.array().items(EventSchema('required')).unique('id').required(),
-    }),
+    events: joi.alternatives().try(
+      joi.object({
+        recurringStartDate: joi.alternatives().conditional('period', { is: joi.number().greater(1), then: joi.date().required(), otherwise: joi.date().optional() })
+          .error(taskError('"event.recurringStartDate" is a required date field when "event.period" is longer than daily')),
+        recurringEndDate: joi.date().optional(),
+        start: joi.number().min(0).optional(),
+        end: joi.number().min(0).optional(),
+        period: joi.number().min(1).optional(),
+        periodUnit: joi.string().valid('day', 'days', 'month', 'months').optional(),
+      }),
+      joi.alternatives().conditional('events', {
+        is: joi.array().length(1),
+        then: joi.array().items(NonRecurringEventSchema('optional')).min(1).required(),
+        otherwise: joi.array().items(NonRecurringEventSchema('required')).unique('id').required(),
+      }),
+    ).required(),
     priority: joi.alternatives().try(
       joi.object({
         level: joi.string().valid('high', 'medium').optional(),

src/nools/.eslintrc

@@ -5,7 +5,7 @@
   },
   "root": true,
   "parserOptions": {
-    "ecmaVersion": 5
+    "ecmaVersion": 6
   },
   "extends": "eslint:recommended",
   "rules": {

src/nools/definition-preparation.js

@@ -1,3 +1,5 @@
+const luxon = require('luxon');
+
 /*
 Declarative tasks and targets (the elements exported by partner task.js and target.js files), are complex objects containing functions. 
 Definition-preparation.js binds a value for `this` in all the functions within a definition. 
@@ -16,7 +18,10 @@ function bindAllFunctionsToContext(obj, context) {
     var key = keys[i];
     switch(typeof obj[key]) {
       case 'object':
-        bindAllFunctionsToContext(obj[key], context);
+        var isLuxon = luxon.Duration.isDuration(obj[key]) || luxon.DateTime.isDateTime(obj[key]);
+        if (!isLuxon) {
+          bindAllFunctionsToContext(obj[key], context);
+        }
         break;
       case 'function':
         obj[key] = obj[key].bind(context);

src/nools/task-emitter.js

@@ -1,30 +1,38 @@
-var prepareDefinition = require('./definition-preparation');
-var taskDefaults = require('./task-defaults');
+const prepareDefinition = require('./definition-preparation');
+const taskDefaults = require('./task-defaults');
+const getRecurringTasks = require('./task-recurring');
 
 function taskEmitter(taskDefinitions, c, Utils, Task, emit) {
   if (!taskDefinitions) return;
 
-  var taskDefinition, r;
-  for (var idx1 = 0; idx1 < taskDefinitions.length; ++idx1) {
-    taskDefinition = Object.assign({}, taskDefinitions[idx1], taskDefaults);
+  for (let idx1 = 0; idx1 < taskDefinitions.length; ++idx1) {
+    const taskDefinition = Object.assign({}, taskDefinitions[idx1], taskDefaults);
     if (typeof taskDefinition.resolvedIf !== 'function') {
       taskDefinition.resolvedIf = function (contact, report, event, dueDate) {
         return taskDefinition.defaultResolvedIf(contact, report, event, dueDate, Utils);
       };
     }
     prepareDefinition(taskDefinition);
 
+    const emitterContext = {
+      taskDefinition,
+      c,
+      Utils,
+      Task,
+      emit,
+    };
+
     switch (taskDefinition.appliesTo) {
       case 'reports':
       case 'scheduled_tasks':
-        for (var idx2=0; idx2<c.reports.length; ++idx2) {
-          r = c.reports[idx2];
-          emitTasks(taskDefinition, Utils, Task, emit, c, r);
+        for (const report of c.reports) {
+          emitterContext.r = report;
+          emitTaskDefinition(emitterContext);
         }
         break;
       case 'contacts':
         if (c.contact) {
-          emitTasks(taskDefinition, Utils, Task, emit, c);
+          emitTaskDefinition(emitterContext);
         }
         break;
       default:
@@ -33,11 +41,11 @@ function taskEmitter(taskDefinitions, c, Utils, Task, emit) {
   }
 }
 
-function emitTasks(taskDefinition, Utils, Task, emit, c, r) {
-  var i;
+function emitTaskDefinition(emitterContext) {
+  const { taskDefinition, c, r } = emitterContext;
 
   if (taskDefinition.appliesToType) {
-    var type;
+    let type;
     if (taskDefinition.appliesTo === 'contacts') {
       if (!c.contact) {
         // no assigned contact - does not apply
@@ -67,18 +75,18 @@ function emitTasks(taskDefinition, Utils, Task, emit, c, r) {
         return;
       }
 
-      for (i = 0; i < r.scheduled_tasks.length; i++) {
+      for (let i = 0; i < r.scheduled_tasks.length; i++) {
         if (taskDefinition.appliesIf(c, r, i)) {
-          emitForEvents(i);
+          emitForEvents(emitterContext, i);
         }
       }
     }
   } else {
-    emitForEvents();
+    emitForEvents(emitterContext);
   }
 
   function obtainContactLabelFromSchedule(taskDefinition, c, r) {
-    var contactLabel;
+    let contactLabel;
     if (typeof taskDefinition.contactLabel === 'function') {
       contactLabel = taskDefinition.contactLabel(c, r);
     } else {
@@ -88,10 +96,29 @@ function emitTasks(taskDefinition, Utils, Task, emit, c, r) {
     return contactLabel ? { name: contactLabel } : c.contact;
   }
 
-  function emitForEvents(scheduledTaskIdx) {
-    var i, dueDate = null, event, priority, task;
-    for (i = 0; i < taskDefinition.events.length; i++) {
-      event = taskDefinition.events[i];
+  function emitForEvents(emitterContext, scheduledTaskIdx) {
+    let emissionInfo;
+    if (Array.isArray(taskDefinition.events)) {
+      emissionInfo = emitEventsArray(emitterContext, scheduledTaskIdx);
+    } else {
+      if (scheduledTaskIdx) {
+        throw Error('appliesTo: "scheduled_tasks" is not supported with recurring tasks');
+      }
+
+      emissionInfo = getRecurringTasks(emitterContext);
+    }
+
+    emissionInfo.forEach(emission => {
+      emitTaskEvent(emitterContext, emission);
+    });
+  }
+
+  function emitEventsArray(emitterContext, scheduledTaskIdx) {
+    const { Utils } = emitterContext;
+    const result = [];
+    let dueDate = null;
+    for (let i = 0; i < taskDefinition.events.length; i++) {
+      const event = taskDefinition.events[i];
 
       if (event.dueDate) {
         dueDate = event.dueDate(event, c, r, scheduledTaskIdx);
@@ -105,58 +132,84 @@ function emitTasks(taskDefinition, Utils, Task, emit, c, r) {
         if (event.dueDate) {
           dueDate = event.dueDate(event, c);
         } else {
-          var defaultDueDate = c.contact && c.contact.reported_date ? new Date(c.contact.reported_date) : new Date();
+          const defaultDueDate = c.contact && c.contact.reported_date ? new Date(c.contact.reported_date) : new Date();
           dueDate = new Date(Utils.addDate(defaultDueDate, event.days));
         }
       }
 
-      if (!Utils.isTimely(dueDate, event)) {
-        continue;
-      }
-
-      task = {
-        // One task instance for each event per form that triggers a task, not per contact
-        // Otherwise they collide when contact has multiple reports of the same form
-        _id: (r ? r._id : c.contact && c.contact._id) + '~' + (event.id || i) + '~' + taskDefinition.name,
-        deleted: !!((c.contact && c.contact.deleted) || r ? r.deleted : false),
-        doc: c,
-        contact: obtainContactLabelFromSchedule(taskDefinition, c, r),
-        icon: taskDefinition.icon,
+      const uuidPrefix = r ? r._id : c.contact && c.contact._id;
+      result.push({
+        _id: `${uuidPrefix}~${event.id || i}~${taskDefinition.name}`,
         date: dueDate,
-        readyStart: event.start || 0,
-        readyEnd: event.end || 0,
-        title: taskDefinition.title,
-        resolved: taskDefinition.resolvedIf(c, r, event, dueDate, scheduledTaskIdx),
-        actions: initActions(taskDefinition.actions, event),
-      };
+        event,
+      });
+    }
 
-      if (scheduledTaskIdx !== undefined) {
-        task._id += '-' + scheduledTaskIdx;
-      }
+    return result;
+  }
 
-      priority = taskDefinition.priority;
-      if (typeof priority === 'function') {
-        priority = priority(c, r);
-      }
+  function emitTaskEvent(emitterContext, emissionInfo, scheduledTaskIdx) {
+    const { taskDefinition, Utils, c, r, emit, Task } = emitterContext;
 
-      if (priority) {
-        task.priority = priority.level;
-        task.priorityLabel = priority.label;
-      }
+    if (!emissionInfo._id) {
+      throw 'emissionInfo._id';
+    }
+
+    if (!emissionInfo.date) {
+      throw 'emissionInfo.date';
+    }
 
-      emit('task', new Task(task));
+    if (!emissionInfo.event) {
+      throw 'emissionInfo.event';
+    }
+
+    const { event, date: dueDate } = emissionInfo;
+    if (!Utils.isTimely(dueDate, event)) {
+      return;
+    }
+
+    const defaultEmission = {
+      // One task instance for each event per form that triggers a task, not per contact
+      // Otherwise they collide when contact has multiple reports of the same form
+      deleted: !!((c.contact && c.contact.deleted) || r ? r.deleted : false),
+      doc: c,
+      contact: obtainContactLabelFromSchedule(taskDefinition, c, r),
+      icon: taskDefinition.icon,
+      readyStart: event.start || 0,
+      readyEnd: event.end || 0,
+      title: taskDefinition.title,
+      resolved: taskDefinition.resolvedIf(c, r, event, dueDate, scheduledTaskIdx),
+      actions: initActions(taskDefinition.actions, event),
+    };
+
+    if (scheduledTaskIdx !== undefined) {
+      defaultEmission._id += '-' + scheduledTaskIdx;
+    }
+
+    let priority = taskDefinition.priority;
+    if (typeof priority === 'function') {
+      priority = priority(c, r);
+    }
+
+    if (priority) {
+      defaultEmission.priority = priority.level;
+      defaultEmission.priorityLabel = priority.label;
     }
+
+    const emission = Object.assign({}, defaultEmission, emissionInfo);
+    delete emission.event;
+    emit('task', new Task(emission));
   }
 
   function initActions(actions, event) {
-    return taskDefinition.actions.map(function(action) {
+    return actions.map(function(action) {
       return initAction(action, event);
     });
   }
 
   function initAction(action, event) {
-    var appliesToReport = !!r;
-    var content = {
+    const appliesToReport = !!r;
+    const content = {
       source: 'task',
       source_id: appliesToReport ? r._id : c.contact && c.contact._id,
       contact: c.contact,