feat(datatrak): RN-1398: Setup task scheduler

packages/central-server/package.json

@@ -18,6 +18,7 @@
     "build-dev": "npm run build",
     "lint": "yarn package:lint",
     "lint:fix": "yarn lint --fix",
+    "scheduled-task": "babel-node ./scripts/scheduledTask.js --config-file '../../babel.config.json'",
     "start": "node dist",
     "start-dev": "yarn package:start:backend-start-dev 9999",
     "start-verbose": "LOG_LEVEL=debug yarn start-dev",
@@ -47,6 +48,7 @@
     "compare-versions": "^6.1.0",
     "cors": "^2.8.5",
     "countrynames": "^0.1.1",
+    "date-fns": "^2.29.2",
     "del": "^2.2.2",
     "express": "^4.19.2",
     "form-data": "^2.3.3",
@@ -62,6 +64,7 @@
     "moment-timezone": "^0.5.45",
     "morgan": "^1.9.0",
     "multer": "^1.4.3",
+    "node-schedule": "^2.1.1",
     "public-ip": "^2.5.0",
     "react-autobind": "^1.0.6",
     "react-native-uuid": "^1.4.9",
@@ -72,6 +75,7 @@
     "xlsx": "^0.10.9"
   },
   "devDependencies": {
+    "@babel/node": "^7.10.5",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",

packages/central-server/scripts/scheduledTask.js

@@ -0,0 +1,48 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+import '@babel/polyfill';
+import { configureEnv } from '../src/configureEnv';
+import { ModelRegistry, TupaiaDatabase } from '@tupaia/database';
+import winston from '../src/log';
+import { TaskOverdueChecker } from '../src/scheduledTasks';
+import * as modelClasses from '../src/database/models';
+
+const TASKS = {
+  TaskOverdueChecker,
+};
+
+configureEnv();
+
+const getTaskArg = argv => {
+  const taskAgr = argv[4];
+  if (!taskAgr || !Object.keys(TASKS).find(t => t === taskAgr)) {
+    const availableOptions = Object.keys(TASKS).join(', ');
+    throw new Error(`You need to specify one of the following tasks to run: ${availableOptions}`);
+  }
+
+  return argv[4];
+};
+
+(async () => {
+  const database = new TupaiaDatabase();
+  try {
+    winston.info('Starting scheduled task script');
+    const start = Date.now();
+    const taskArg = getTaskArg(process.argv);
+    const taskKey = Object.keys(TASKS).find(t => t === taskArg);
+    const taskModule = taskKey && TASKS[taskKey];
+    winston.info(`Running ${taskArg} module`);
+    const models = new ModelRegistry(database, modelClasses, true);
+    const taskInstance = new taskModule(models);
+    await taskInstance.run();
+    const end = Date.now();
+    winston.info(`Completed in ${end - start}ms`);
+  } catch (error) {
+    winston.error(error.message);
+    winston.error(error.stack);
+  } finally {
+    await database.closeConnections();
+  }
+})();

packages/central-server/src/createApp.js

@@ -14,7 +14,6 @@ import { buildBasicBearerAuthMiddleware } from '@tupaia/server-boilerplate';
 import { handleError } from './apiV2/middleware';
 
 import { apiV2 } from './apiV2';
-
 /**
  * Set up express server with middleware,
  */

packages/central-server/src/index.js

@@ -5,6 +5,7 @@
 
 import '@babel/polyfill';
 import http from 'http';
+import nodeSchedule from 'node-schedule';
 import {
   AnalyticsRefresher,
   EntityHierarchyCacher,
@@ -24,7 +25,7 @@ import { startSyncWithMs1 } from './ms1';
 import { startSyncWithKoBo } from './kobo';
 import { startFeedScraper } from './social';
 import { createApp } from './createApp';
-
+import { TaskOverdueChecker } from './scheduledTasks';
 import winston from './log';
 import { configureEnv } from './configureEnv';
 
@@ -69,6 +70,11 @@ configureEnv();
   const taskAssigneeEmailer = new TaskAssigneeEmailer(models);
   taskAssigneeEmailer.listenForChanges();
 
+  /**
+   * Scheduled tasks
+   */
+  new TaskOverdueChecker(models).init();
+
   /**
    * Set up actual app with routes etc.
    */
@@ -117,4 +123,11 @@ configureEnv();
       winston.error(error.message);
     }
   }
+
+  /**
+   * Gracefully handle shutdown of ChangeHandlers and ScheduledTasks
+   */
+  process.on('SIGINT', function () {
+    nodeSchedule.gracefulShutdown().then(() => process.exit(0));
+  });
 })();

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

@@ -0,0 +1,70 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+
+import { scheduleJob } from 'node-schedule';
+import winston from 'winston';
+
+/**
+ * Base class for scheduled tasks. Uses 'node-schedule' for scheduling based on cron tab syntax
+ * Subclasses should implement the run method and need to be initialised by instantiating the
+ * class and calling init in the central-server index.js file
+ */
+export class ScheduledTask {
+  getSchedule() {
+    throw new Error(`ScheduledTask::getSchedule not overridden for ${this.constructor.name}`);
+  }
+
+  getName() {
+    throw new Error(`ScheduledTask::getName not overridden for ${this.constructor.name}`);
+  }
+
+  constructor(models, lockKey) {
+    winston.info(`Initialising scheduled task ${this.getName()}`);
+    this.models = models;
+    this.lockKey = lockKey;
+    this.schedule = this.getSchedule();
+    this.name = this.getName();
+    this.job = null;
+    this.start = null;
+  }
+
+  async run() {
+    throw new Error('Any subclass of ScheduledTask must implement the "run" method');
+  }
+
+  async runTask() {
+    this.start = Date.now();
+
+    try {
+      await this.models.wrapInTransaction(async transactingModels => {
+        // Acquire a database advisory lock for the transaction
+        // Ensures no other server instance can execute its change handler at the same time
+        await transactingModels.database.acquireAdvisoryLockForTransaction(this.lockKey);
+        await this.run();
+        const durationMs = Date.now() - this.start;
+        winston.info(`ScheduledTask: ${this.name}: Succeeded in ${durationMs}`);
+        return true;
+      });
+    } catch (e) {
+      const durationMs = Date.now() - this.start;
+      winston.error(`ScheduledTask: ${this.name}: Failed`, { id: runId, durationMs });
+      winston.error(e.stack);
+
+      return false;
+    } finally {
+      this.start = null;
+    }
+  }
+
+  init() {
+    if (!this.job) {
+      const name = this.getName();
+      winston.info(`ScheduledTask: ${name}: Scheduled for ${this.schedule}`);
+      this.job = scheduleJob(this.schedule, async () => {
+        await this.runTask();
+      });
+    }
+  }
+}

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

@@ -0,0 +1,47 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+import { sendEmail } from '@tupaia/server-utils';
+import { format } from 'date-fns';
+import winston from 'winston';
+import { ScheduledTask } from './ScheduledTask';
+
+export class TaskOverdueChecker extends ScheduledTask {
+  getSchedule() {
+    return '0 * * * *'; // every hour
+  }
+
+  getName() {
+    return 'TaskOverdueChecker';
+  }
+
+  constructor(models) {
+    super(models, 'task-overdue-checker');
+  }
+
+  async run() {
+    const { task, user } = this.models;
+    const overdueTasks = await task.find({
+      task_status: 'overdue',
+    });
+
+    winston.info(`Found ${overdueTasks.length} overdue task(s)`);
+
+    for (const task of overdueTasks) {
+      const assignee = await user.findById(task.assignee_id);
+
+      const result = await sendEmail(assignee.email, {
+        subject: 'Task overdue on Tupaia.org',
+        templateName: 'overdueTask',
+        templateContext: {
+          userName: assignee.first_name,
+          surveyName: task.survey_name,
+          entityName: task.entity_name,
+          dueDate: format(new Date(task.due_date), 'do MMMM yyyy'),
+        },
+      });
+      winston.info(`Email sent to ${assignee.email} with status: ${result.response}`);
+    }
+  }
+}

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

@@ -0,0 +1,6 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
+ */
+
+export { TaskOverdueChecker } from './TaskOverdueChecker';

packages/server-utils/src/email/templates/content/overdueTask.html

@@ -0,0 +1,18 @@
+<div>
+  <p>Hi {{userName}},</p>
+  <p>
+   Oh no! Looks like you have an overdue task.
+  </p>
+  <p>
+    This is just to let you know that you have an overdue task. The task is {{surveyName}} for {{entityName}} and was due on the {{dueDate}}. To view and complete your tasks head to DataTrak.
+  </p>
+  <p>
+    Have fun using the platform and feel free to get in touch if you have any questions.
+  </p>
+  <p>
+    Cheers
+  </p>
+  <p>
+    The Tupaia Team
+  </p>
+</div>