playov2-js-utilities 0.3.31 → 0.3.33

package/lib/index.js

@@ -11,5 +11,6 @@ module.exports = {
     httpRequest: require('./request'),
     Cron: require('./cron'),
     MessagePublisher: require('./message_publisher'),
-    middleware: require('./middleware')
+    middleware: require('./middleware'),
+    taskScheduler: require('./taskscheduler')
 };

package/lib/message_publisher/index.js

@@ -17,6 +17,10 @@ const LOCATION = process.env.GCP_LOCATION;
 if (!PROJECT || !LOCATION) {
     console.warn('You need to pass - GCP_PROJECT, GCP_LOCATION in env for message queue to work!');
 }
+
+const { google } = require('googleapis');
+const cloudtasks = google.cloudtasks('v2');
+
 /**
  *
  * @param {String} queueId - Name of the queue being targeted
@@ -89,7 +93,38 @@ const getTaskId = (projectId, locationId, queueId, taskId = uuidv4()) => {
     return `projects/${projectId}/locations/${locationId}/queues/${queueId}/tasks/${taskId}`;
 };
 
+/**
+ * https://cloud.google.com/tasks/docs/reference/rest/v2/projects.locations.queues.tasks/delete
+ * 
+ */
+
+const authClient = await authorize();
+
+const deleteHttpTask = async (queueId, taskId) => {
+    if (!queueId || !taskId) {
+        throw new Error('Both queueId, and taskId are required to delete a task!;')
+    }
+    const requestData = {
+        name: getTaskId(PROJECT, LOCATION, queueId, taskId),
+        auth: authClient
+    };
+
+    try {
+        await cloudtasks.projects.locations.queues.tasks.delete(requestData);
+    } catch (err) {
+        throw err;
+    }
+};
+
+async function authorize() {
+    const auth = new google.auth.GoogleAuth({
+        scopes: ['https://www.googleapis.com/auth/cloud-platform']
+    });
+    return await auth.getClient();
+};
+
 module.exports = {
     createHttpTask,
-    getTaskId
+    getTaskId,
+    deleteHttpTask
 };

package/lib/models/scheduled.tasks.js

@@ -0,0 +1,30 @@
+const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
+
+// compound index on queuId and taskId and status, so that a task is saved only once per queue
+const scheduledTaskSchema = new Schema({
+    taskId: { type: String, required: true },
+    queueId: { type: String, required: true },
+    payload: {
+
+    },
+    activationTime: {
+        type: Date, required: true
+    },
+    cloudProvider: {
+        type: String,
+        enum: ['GCP', 'AWS'],
+        required: true
+    },
+    status: {
+        type: String,
+        enum: ['saved', 'executed', 'failed', 'cancelled'],
+        default: 'saved',
+        required: true  
+    },
+    lastExecutionDetails: {
+
+    }
+});
+
+module.exports = mongoose.model('scheduledtasks', scheduledTaskSchema);

package/lib/taskscheduler/index.js

@@ -0,0 +1,97 @@
+
+// methods - save future task  - producers
+// push future task to queue  -- from cron service
+// cancel future task -- producers
+
+const SCHEDULED_TASK = require("../models/scheduled.tasks");
+const CloudTask = require("../message_publisher/index");
+const Moment = require("moment");
+const Logger = require('../logger');
+
+const MAX_RETRY_COUNT = 5;
+
+/**
+ * 
+ * @param {String} message 
+ * @param {String} name - Optional - If "RetryableException", then function will be retried till MAX_RETRY_COUNT
+ */
+function CTException(message, name) {
+    this.message = message;
+    this.name = name;
+};
+
+/**
+ * Currently, for cloudtask - 
+ * Maximum schedule time for a task	 - 30 days, that means any task that is to be executed after 30 days
+ * can't be scheduled by GCP cloudtask queues.
+ * This function will provide a way for every microservices to save  a task to mongo scheduledtasks model,
+ * from which tasks will be pushed via cron service to cloud task push queue on an every day basis.
+ * RetryableException - Network exceptions
+ */
+const saveFutureTask = async (queueId, taskId, payload, eta, count = MAX_RETRY_COUNT, requestId) => {
+    try {
+        if (!queueId || !taskId || !payload || !eta) {
+            throw CTException('Parameter validation failed!', 'ValidationException')
+        }
+
+        if (Moment(eta).isBefore(Moment().add(30, 'days'))) {
+            throw CTException('eta can not be before 30 days from now. Schedule directly!', 'ValidationException')
+        }
+
+        const taskData = {
+            taskId,
+            payload,
+            queueId,
+            activationTime: eta,
+            status: 'saved',
+            cloudProvider: 'GCP'
+        }
+
+        const task = new SCHEDULED_TASK(taskData);
+
+        await task.save();
+
+    } catch (err) {
+        if (err.message !== "RetryableException") {
+            throw err;
+        }
+
+        if (count === 0) {
+            Logger.prepareAlertLog(requestId, { func: 'saveFutureTask', queueId, taskId, payload, eta, err }, 'saving future task failed!');
+            throw err;
+        }
+
+        return saveFutureTask(queueId, taskId, payload, eta, count--, requestId);
+    }
+};
+
+
+const deleteScheduledTask = async (queueId, taskId, count = MAX_RETRY_COUNT, requestId) => {
+    try {
+        if (!queueId || !taskId) {
+            throw CTException('Parameter validation failed!', 'ValidationException')
+        }
+
+        await Promise.all([
+            SCHEDULED_TASK.findOneAndUpdate({ queueId, taskId }, { $set: { status: 'cancelled' } }),
+            CloudTask.deleteHttpTask(queueId, taskId)
+        ]);
+
+    } catch (err) {
+        if (err.message !== "RetryableException") {
+            throw err;
+        }
+        if (count === 0) {
+            Logger.prepareAlertLog(requestId, { func: 'deleteScheduledTask', queueId, taskId, payload, eta, err }, 'saving future task failed!');
+            throw err;
+        }
+
+        return deleteScheduledTask(queueId, taskId, count--, requestId);
+    }
+}
+
+module.exports = {
+    saveFutureTask,
+    // pushScheduledTaskToQueue,
+    deleteScheduledTask
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.3.31",
+  "version": "0.3.33",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {
@@ -26,7 +26,10 @@
     "@playo/logger": "^0.9.24",
     "axios": "^0.24.0",
     "cron": "^1.8.2",
+    "googleapis": "^109.0.1",
     "handlebars": "^4.7.7",
+    "moment": "^2.29.4",
+    "mongoose": "^6.7.4",
     "uuid": "^8.3.2"
   }
 }