playov2-js-utilities 0.3.7 → 0.3.12

package/lib/message_publisher/index.js

@@ -1,16 +1,21 @@
-
+/*
+ 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;
 const LOCATION = process.env.GCP_LOCATION;
 
+const MAX_HTTP_TASK_TTL = 1800000 // milliseconds - half an hour
+
 if (!PROJECT || !LOCATION) {
     console.warn('You need to pass - GCP_PROJECT, GCP_LOCATION in env for message queue to work!');
 }
@@ -28,9 +33,11 @@ if (!PROJECT || !LOCATION) {
  * @param {Object} messageProcessingProperties - {
  *                                                  delay 
  *                                                }
+ * @param {String} taskId -used as de-duplication key
+ * @param {Date} ttl - utc date format
  * @param {String} requestId 
  */
-async function createHttpTask(queueId, payload, messageProcessingProperties, requestId) {
+async function createHttpTask(queueId, payload, messageProcessingProperties, taskId, ttl, requestId) {
 
     try {
         const project = PROJECT;
@@ -41,7 +48,14 @@ 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);
+
+        task.dispatchDeadline = _getHTTPTaskTTL(ttl); // nano seconds
 
         if (payload.body) {
             task.httpRequest.body = Buffer.from(payload.body).toString('base64');
@@ -52,19 +66,49 @@ 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}`;
+};
+
+/**
+ * Returns ttl for http tasks in nanoseconds
+ * https://cloud.google.com/tasks/docs/reference/rest/v2beta3/projects.locations.queues.tasks#resource:-task
+ * @param {Date} ttl 
+ */
+const _getHTTPTaskTTL = (ttl) => {
+
+    const currentTimestamp = new Date().getTime()
+    const providedTTLTimestamp = new Date(ttl).getTime();
+
+    if (providedTTL > currentTimestamp) {
+        return Math.min(providedTTLTimestamp, MAX_HTTP_TASK_TTL) * 1000000
+    }
+
+    return MAX_HTTP_TASK_TTL * 1000000;
+}
+
 module.exports = {
-    createHttpTask
+    createHttpTask,
+    getTaskId
 };

package/lib/notification-templates.js

@@ -205,13 +205,17 @@ const host_cancelled_activity = {
 };
 
 /**
- * 
+ * Template for sending activity reminder.
+ * Notification is received by all the players of the activity.
+ * Text render only
+ * @param {String} sport_name
+ * @param {String} date
  */
 const activity_reminder = {
-    heading: '⏰, Activity reminder!',
-    text: 'You have a {sport_name}} game coming up on {{date}}. Best of luck!',
+    heading: 'Activity Reminder',
+    text: 'You have a {{sport_name}} game coming up at {{date}}. Gear up for some fun!',
     buttons: [],
-    notificationId: notificationIds.ACTIVITY_REMINDER 
+    notificationId: notificationIds.ACTIVITY_REMINDER
 };
 
 const host_updated_activity_details = {

package/lib/request.js

@@ -17,10 +17,14 @@ const playoResponseHandler = (resp, requestId) => {
     if (status === 200) {
         const { requestStatus } = data;
         LOGGER.info(requestId, data, `Api call to url to ${url} succeeded with status ${status}`);
-        return ({ requestStatus, data });
+        if (!requestStatus) {
+            data['requestStatus'] = 1; // assume request status  of 1 if any service doesn't provide requestStatus.
+        }
+        return data;
     } else {
         LOGGER.error(requestId, data, `Api call to url to ${url} failed with status : ${status}`);
-        return Promise.reject({ requestStatus: 0, data });
+        data['requestStatus'] = 0;
+        return Promise.reject(data);
     }
 };
 

package/lib/util.js

@@ -4,6 +4,8 @@
  * Ideally new repositories should import utils from here only. Todo- look for a workaround - named imports
  */
 
+const hbs = require('handlebars');
+
 /**
  * Finds rating given to a user for a sport by playpals <Assumes playpalDocs supplied are already filtered for a user>
  * @param {Array} playpalDocs 
@@ -125,12 +127,26 @@ const getCategoricalBreakUpFromRecentUserRatings = (palRatingDict, levelCategori
 
 const noop = () => {
     return undefined;
-}
+};
+
+/**
+ * 
+ * @param {String} template  - Handlebars compatible template
+ * @param {Object} data - Data points containing key value pairs of data required in template supplied
+ * @returns {String}
+ */
+const renderTemplate = (template, data) => {
+
+    const temp = hbs.compile(template);
+
+    return temp(data);
+};
 
 module.exports = {
     getRatingsFromPlaypalDocs,
     findAverage,
     getRecentRatingDictOfPals,
     getCategoricalBreakUpFromRecentUserRatings,
-    noop
-}
+    noop,
+    renderTemplate
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.3.7",
+  "version": "0.3.12",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {
@@ -24,6 +24,8 @@
     "@google-cloud/tasks": "^2.5.0",
     "@playo/logger": "^0.9.18",
     "axios": "^0.24.0",
-    "cron": "^1.8.2"
+    "cron": "^1.8.2",
+    "handlebars": "^4.7.7",
+    "uuid": "^8.3.2"
   }
 }