feat(datatrakWeb): RN-1341: Repeating tasks

packages/central-server/src/apiV2/utilities/constructNewRecordValidationRules.js

@@ -450,50 +450,8 @@ export const constructForSingle = (models, recordType) => {
         entity_id: [constructRecordExistsWithId(models.entity)],
         survey_id: [constructRecordExistsWithId(models.survey)],
         assignee_id: [constructIsEmptyOr(constructRecordExistsWithId(models.user))],
-        due_date: [
-          (value, { repeat_schedule: repeatSchedule }) => {
-            if (repeatSchedule) {
-              if (value) {
-                throw new Error('Recurring tasks must not have a due date');
-              }
-              return true;
-            }
-            if (!value) throw new Error('Due date is required for non-recurring tasks');
-            return true;
-          },
-        ],
-        repeat_schedule: [
-          (value, { due_date: dueDate }) => {
-            // If the task has a due date, the repeat schedule is empty
-            if (dueDate) {
-              if (value) {
-                throw new Error('Non-recurring tasks must not have a repeat schedule');
-              }
-              return true;
-            }
-
-            if (!value) {
-              throw new Error('Repeat schedule is required for recurring tasks');
-            }
-            return true;
-          },
-        ],
-        status: [
-          (value, { repeat_schedule: repeatSchedule }) => {
-            // If the task is recurring, the status is empty
-            if (repeatSchedule) {
-              if (value) {
-                throw new Error('Recurring tasks cannot have a status');
-              }
-              return true;
-            }
-
-            if (!value) {
-              throw new Error('Status is required for non-recurring tasks');
-            }
-            return true;
-          },
-        ],
+        due_date: [hasContent],
+        status: [hasContent],
       };
 
     default:

packages/central-server/src/index.js

@@ -25,7 +25,7 @@ import { startSyncWithMs1 } from './ms1';
 import { startSyncWithKoBo } from './kobo';
 import { startFeedScraper } from './social';
 import { createApp } from './createApp';
-import { TaskOverdueChecker } from './scheduledTasks';
+import { TaskOverdueChecker, RepeatingTaskDueDateHandler } from './scheduledTasks';
 import winston from './log';
 import { configureEnv } from './configureEnv';
 
@@ -74,6 +74,7 @@ configureEnv();
    * Scheduled tasks
    */
   new TaskOverdueChecker(models).init();
+  new RepeatingTaskDueDateHandler(models).init();
 
   /**
    * Set up actual app with routes etc.

packages/central-server/src/scheduledTasks/RepeatingTaskDueDateHandler.js

@@ -0,0 +1,40 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+import winston from 'winston';
+import { getNextOccurrence } from '@tupaia/utils';
+import { ScheduledTask } from './ScheduledTask';
+
+export class RepeatingTaskDueDateHandler extends ScheduledTask {
+  constructor(models) {
+    // run RepeatingTaskDueDateHandler every hour
+    super(models, 'RepeatingTaskDueDateHandler', '0 * * * *');
+  }
+
+  async run() {
+    const { task } = this.models;
+    // find all repeating tasks that have passed their current due date
+    const repeatingTasks = await task.find({
+      task_status: 'repeating',
+      due_date: { comparator: '<', comparisonValue: new Date().getTime() },
+    });
+
+    winston.info(`Found ${repeatingTasks.length} repeating task(s)`);
+
+    // update the due date for each repeating task to the next occurrence
+    for (const repeatingTask of repeatingTasks) {
+      const { repeat_schedule: repeatSchedule } = repeatingTask;
+
+      const nextDueDate = getNextOccurrence({
+        ...repeatSchedule,
+        dtstart: new Date(repeatSchedule.dtstart), // convert string to date because rrule.js expects a Date object
+      });
+
+      repeatingTask.due_date = nextDueDate;
+      await repeatingTask.save();
+
+      winston.info(`Updated due date for task ${repeatingTask.id} to ${nextDueDate}`);
+    }
+  }
+}

packages/central-server/src/scheduledTasks/index.js

@@ -4,3 +4,4 @@
  */
 
 export { TaskOverdueChecker } from './TaskOverdueChecker';
+export { RepeatingTaskDueDateHandler } from './RepeatingTaskDueDateHandler';

packages/central-server/src/tests/apiV2/taskComments/CreateTaskComment.test.js

@@ -12,6 +12,7 @@ import {
 } from '@tupaia/database';
 import { TestableApp, resetTestData } from '../../testUtilities';
 import { BES_ADMIN_PERMISSION_GROUP } from '../../../permissions';
+import { RRULE_FREQUENCIES } from '@tupaia/utils';
 
 describe('Permissions checker for CreateTaskComment', async () => {
   const BES_ADMIN_POLICY = {
@@ -101,7 +102,9 @@ describe('Permissions checker for CreateTaskComment', async () => {
         entity_id: facilities[1].id,
         assignee_id: assignee.id,
         due_date: null,
-        repeat_schedule: '{}',
+        repeat_schedule: {
+          freq: RRULE_FREQUENCIES.DAILY,
+        },
         status: null,
       },
     ];

packages/central-server/src/tests/apiV2/tasks/EditTask.test.js

@@ -10,6 +10,7 @@ import {
   findOrCreateDummyRecord,
   generateId,
 } from '@tupaia/database';
+import { RRULE_FREQUENCIES } from '@tupaia/utils';
 import { TestableApp, resetTestData } from '../../testUtilities';
 import { BES_ADMIN_PERMISSION_GROUP } from '../../../permissions';
 
@@ -100,6 +101,7 @@ describe('Permissions checker for EditTask', async () => {
         survey_id: surveys[0].survey.id,
         entity_id: facilities[0].id,
         due_date: dueDate,
+        repeat_schedule: null,
         status: 'to_do',
       },
       {
@@ -108,6 +110,7 @@ describe('Permissions checker for EditTask', async () => {
         entity_id: facilities[1].id,
         assignee_id: assignee.id,
         due_date: dueDate,
+        repeat_schedule: null,
         status: 'to_do',
       },
     ];
@@ -212,20 +215,21 @@ describe('Permissions checker for EditTask', async () => {
 
     describe('System generated comments', () => {
       it('Adds a comment when the due date changes on a task', async () => {
+        const newDate = new Date('2025-11-30').getTime();
         await app.grantAccess({
           DL: ['Donor'],
           TO: ['Donor'],
         });
         await app.put(`tasks/${tasks[1].id}`, {
           body: {
-            due_date: new Date('2021-11-30').getTime(),
+            due_date: newDate,
           },
         });
 
         const comment = await models.taskComment.findOne({
           task_id: tasks[1].id,
           type: models.taskComment.types.System,
-          message: 'Changed due date from 31 December 21 to 30 November 21',
+          message: 'Changed due date from 31 December 21 to 30 November 25',
         });
         expect(comment).not.to.be.null;
       });
@@ -240,7 +244,7 @@ describe('Permissions checker for EditTask', async () => {
             // this is currently null when setting a task to repeat
             due_date: null,
             repeat_schedule: {
-              frequency: 'daily',
+              freq: RRULE_FREQUENCIES.DAILY,
             },
           },
         });
@@ -269,7 +273,7 @@ describe('Permissions checker for EditTask', async () => {
         await app.put(`tasks/${tasks[1].id}`, {
           body: {
             repeat_schedule: {
-              frequency: 'daily',
+              freq: RRULE_FREQUENCIES.DAILY,
             },
           },
         });

packages/central-server/src/tests/apiV2/tasks/GETTasks.test.js

@@ -10,6 +10,7 @@ import {
   findOrCreateDummyRecord,
   generateId,
 } from '@tupaia/database';
+import { RRULE_FREQUENCIES } from '@tupaia/utils';
 import { TestableApp, resetTestData } from '../../testUtilities';
 import { BES_ADMIN_PERMISSION_GROUP } from '../../../permissions';
 
@@ -104,7 +105,9 @@ describe('Permissions checker for GETTasks', async () => {
         entity_id: facilities[1].id,
         assignee_id: assignee.id,
         due_date: null,
-        repeat_schedule: '{}',
+        repeat_schedule: {
+          freq: RRULE_FREQUENCIES.DAILY,
+        },
         status: null,
       },
       {
@@ -113,7 +116,9 @@ describe('Permissions checker for GETTasks', async () => {
         entity_id: facilities[0].id,
         assignee_id: assignee.id,
         due_date: null,
-        repeat_schedule: '{}',
+        repeat_schedule: {
+          freq: RRULE_FREQUENCIES.DAILY,
+        },
         status: null,
       },
     ];

packages/database/src/__tests__/changeHandlers/TaskCompletionHandler.test.js

@@ -141,9 +141,11 @@ describe('TaskCompletionHandler', () => {
         entity_id: samoa.id,
         survey_id: SURVEY.id,
         created_at: '2024-07-08',
+        due_date: new Date('2024-07-25').getTime(),
         status: null,
         repeat_schedule: {
-          frequency: 'daily',
+          freq: 1,
+          dtstart: '2024-07-08',
         },
       });
 
@@ -155,6 +157,11 @@ describe('TaskCompletionHandler', () => {
         survey_response_id: responses[0],
         entity_id: samoa.id,
         parent_task_id: repeatTask.id,
+        due_date: new Date('2024-07-25').getTime(),
+        repeat_schedule: {
+          freq: 1,
+          dtstart: '2024-07-08',
+        },
       });
       await assertTaskStatus(newTask.id, 'completed', responses[0]);
     });
@@ -166,8 +173,10 @@ describe('TaskCompletionHandler', () => {
         survey_id: SURVEY.id,
         created_at: '2024-07-08',
         status: 'to_do',
+        due_date: new Date('2024-07-08').getTime(),
         repeat_schedule: {
-          frequency: 'daily',
+          freq: 1,
+          dtstart: '2024-07-08',
         },
       });
 
@@ -178,6 +187,11 @@ describe('TaskCompletionHandler', () => {
         survey_response_id: responses[0],
         entity_id: fiji.id,
         parent_task_id: repeatTask.id,
+        due_date: new Date('2024-07-08').getTime(),
+        repeat_schedule: {
+          freq: 1,
+          dtstart: '2024-07-08',
+        },
       });
       await assertTaskStatus(newTask.id, 'completed', responses[0]);
     });

packages/database/src/modelClasses/Task.js

@@ -4,6 +4,7 @@
  */
 
 import { format } from 'date-fns';
+import { RRULE_FREQUENCIES } from '@tupaia/utils';
 import { DatabaseModel } from '../DatabaseModel';
 import { DatabaseRecord } from '../DatabaseRecord';
 import { RECORDS } from '../records';
@@ -47,17 +48,21 @@ const formatValue = async (field, value, models) => {
       return assignee.full_name;
     }
     case 'repeat_schedule': {
-      if (!value || !value?.frequency) {
+      if (!value || value.freq === undefined || value.freq === null) {
         return "Doesn't repeat";
       }
 
-      return `${value.frequency.charAt(0).toUpperCase()}${value.frequency.slice(1)}`;
+      const frequency = Object.keys(RRULE_FREQUENCIES).find(
+        key => RRULE_FREQUENCIES[key] === value.freq,
+      );
+
+      if (!frequency) {
+        return "Doesn't repeat";
+      }
+
+      return `${frequency.charAt(0)}${frequency.slice(1).toLowerCase()}`;
     }
     case 'due_date': {
-      // TODO: Currently repeating tasks don't have a due date, so we need to handle null values. In RN-1341 we will add a due date to repeating tasks overnight, so this will need to be updated then
-      if (!value) {
-        return 'No due date';
-      }
       // Format the date as 'd MMMM yy' (e.g. 1 January 21). This is so that there is no ambiguity between US and other date formats
       return format(new Date(value), 'd MMMM yy');
     }
@@ -126,6 +131,7 @@ export class TaskRecord extends DatabaseRecord {
       entity_id: entityId,
       repeat_schedule: repeatSchedule,
       assignee_id: assigneeId,
+      due_date: dueDate,
       id,
     } = this;
 
@@ -144,35 +150,36 @@ export class TaskRecord extends DatabaseRecord {
         repeat_schedule: repeatSchedule,
         status: 'completed',
         survey_response_id: surveyResponseId,
+        due_date: dueDate,
         parent_task_id: id,
       };
 
       // Check for an existing task so that multiple tasks aren't created for the same survey response
       const existingTask = await this.model.findOne(where);
-      if (!existingTask) {
-        const newTask = await this.model.create(where);
-        await newTask.addComment(
-          'Completed this task',
-          commentUserId,
-          this.otherModels.taskComment.types.System,
-        );
-        await this.addComment(
-          `Completed task ${newTask.id}`,
-          commentUserId,
-          this.otherModels.taskComment.types.System,
-        );
-      }
-    } else {
-      await this.model.updateById(id, {
-        status: 'completed',
-        survey_response_id: surveyResponseId,
-      });
+
+      if (existingTask) return;
+      const newTask = await this.model.create(where);
+      await newTask.addComment(
+        'Completed this task',
+        commentUserId,
+        this.otherModels.taskComment.types.System,
+      );
       await this.addComment(
         'Completed this task',
         commentUserId,
         this.otherModels.taskComment.types.System,
       );
+      return;
     }
+    await this.model.updateById(id, {
+      status: 'completed',
+      survey_response_id: surveyResponseId,
+    });
+    await this.addComment(
+      'Completed this task',
+      commentUserId,
+      this.otherModels.taskComment.types.System,
+    );
   }
 
   /**
@@ -242,12 +249,10 @@ export class TaskRecord extends DatabaseRecord {
       const originalValue = this[field];
       // If the field hasn't actually changed, don't add a comment
       if (originalValue === newValue) continue;
-
-      // If the due date is changed and the task is repeating, don't add a comment, because this just means that the repeat schedule is being updated, not that the due date is being changed. This will likely change as part of RN-1341
-      // TODO: re-evaulate this when RN-1341 is implemented
-      if (field === 'due_date' && updatedFields.repeat_schedule) {
-        continue;
-      }
+      // Don't add a comment when repeat schedule is updated and the frequency is the same
+      if (field === 'repeat_schedule' && originalValue?.freq === newValue?.freq) continue;
+      // Don't add a comment when due date is updated for repeat schedule
+      if (field === 'due_date' && this.repeat_schedule) continue;
 
       const friendlyFieldName = getFriendlyFieldName(field);
       const formattedOriginalValue = await formatValue(field, originalValue, this.otherModels);