playov2-js-utilities 0.3.11 → 0.3.15

package/lib/message_publisher/index.js

@@ -1,11 +1,14 @@
-
+/*
+ Read this and associated queue configs before deploying a new queue
+ https://cloud.google.com/tasks/docs/reference/rest/v2beta3/projects.locations.queues.tasks#resource:-task
+*/
 
 const { CloudTasksClient } = require('@google-cloud/tasks');
+const { v4: uuidv4 } = require('uuid');
 
 const PLAYO_LOGGER = require("@playo/logger");
 const LOGGER = new PLAYO_LOGGER("playo-message-publisher");
 
-// Instantiates a client.
 const client = new CloudTasksClient();
 
 const PROJECT = process.env.GCP_PROJECT;
@@ -22,15 +25,17 @@ if (!PROJECT || !LOCATION) {
  *                              url: String,
  *                              headers: Object,
  *                              body: Object, // not needed if GET request
+ *                              ttl: Optional, date in utc format, consumer will check if the ttl has been exceeded or not and then will respond accordingly
  *                              ...
  *                                                       
  *                           }
  * @param {Object} messageProcessingProperties - {
  *                                                  delay 
  *                                                }
+ * @param {String} taskId -used as de-duplication key
  * @param {String} requestId 
  */
-async function createHttpTask(queueId, payload, messageProcessingProperties, requestId) {
+async function createHttpTask(queueId, payload, messageProcessingProperties, taskId, requestId) {
 
     try {
         const project = PROJECT;
@@ -41,7 +46,12 @@ async function createHttpTask(queueId, payload, messageProcessingProperties, req
 
         const parent = client.queuePath(project, location, queue);
 
-        const task = { httpRequest: payload };
+        const task = {
+            httpRequest: payload,
+            name: ''
+        };
+
+        task.name = getTaskId(project, location, queue, taskId);
 
         if (payload.body) {
             task.httpRequest.body = Buffer.from(payload.body).toString('base64');
@@ -52,19 +62,32 @@ async function createHttpTask(queueId, payload, messageProcessingProperties, req
             task.scheduleTime = {
                 seconds: delay + Date.now() / 1000,
             };
-        }
+        };
 
-        // Send create task request.
         LOGGER.info(requestId, task, `Sending task to queue ${queueId}}`)
 
         const request = { parent: parent, task: task };
         const [response] = await client.createTask(request);
-        LOGGER.info(requestId, { name: response.name }, `Added task to queue ${queueId}}`)
+
+        LOGGER.info(requestId, { name: response.name, response }, `Added task to queue ${queueId}}`)
     } catch (err) {
         LOGGER.error(requestId, err, err.message)
     }
 };
 
+/**
+ * Returns a unique string for name of a task in task queues, to be used for task de-duplication purpose.
+ * @param {String} projectId 
+ * @param {String} locationId 
+ * @param {String} queueId 
+ * @param {String} taskId 
+ * @returns {String}
+ */
+const getTaskId = (projectId, locationId, queueId, taskId = uuidv4()) => {
+    return `projects/${projectId}/locations/${locationId}/queues/${queueId}/tasks/${taskId}`;
+};
+
 module.exports = {
-    createHttpTask
+    createHttpTask,
+    getTaskId
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.3.11",
+  "version": "0.3.15",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {
@@ -25,6 +25,7 @@
     "@playo/logger": "^0.9.18",
     "axios": "^0.24.0",
     "cron": "^1.8.2",
-    "handlebars": "^4.7.7"
+    "handlebars": "^4.7.7",
+    "uuid": "^8.3.2"
   }
 }