playov2-js-utilities 0.3.5 → 0.3.9

package/lib/constants.js

@@ -12,7 +12,10 @@ const RATINGS_WEIGHTAGE =  Object.freeze({
     'old': 0.1
 });
 
+const DEFAULT_TIME_ZONE = 'Asia/Kolkata';
+
 module.exports = {
     USER_INDIVIDUAL_RATINGS,
-    RATINGS_WEIGHTAGE
+    RATINGS_WEIGHTAGE,
+    DEFAULT_TIME_ZONE
 }

package/lib/cron.js

@@ -0,0 +1,43 @@
+/**
+ * This file will have all cron related utilities - (e.g. - schedulers etc.). 
+ * Try to contain service common utilities here.
+ */
+const Constants = require('./constants');
+const { CronJob } = require('cron');
+const Utils = require('./util')
+
+const cronner = (
+    cronTime,
+    onTime = Utils.noop,
+    onComplete = Utils.noop,
+    timeZone = Constants.DEFAULT_TIME_ZONE,
+    context = this,
+    runOnInit,
+    utcOffset,
+) => {
+    const job = new CronJob({
+        cronTime,
+        // when the time specified by pattern is matched
+        onTick: onTime,
+        // onComplete
+        onComplete,
+        // whether the cron should start on constructor invoke (or whether .start() needs to be called)
+        start: false,
+        // timezone -> defaults to Asia/Kolkata
+        timeZone,
+        // the context to bind the onTime method to
+        context,
+        // flat to start cron on invocation of the module
+        runOnInit,
+        // the utc offset to run the cron at
+        utcOffset
+    });
+    job.start();
+    return job;
+};
+
+module.exports = {
+    cronner
+};
+
+

package/lib/index.js

@@ -1,10 +1,14 @@
 
-//Naming terminology - While exporting constants use PascalCase while exporting functions/methods use camelCase
+/* 
+* Naming terminology - While exporting constants use PascalCase while exporting functions/methods use camelCase
+*/
 module.exports = {
-    ratings : require('./ratings/index'),
-    Constants : require('./constants'),
-    playoUtils : require('./util'),
-    NotificationTemplates : require('./notification-templates'),
+    ratings: require('./ratings/index'),
+    Constants: require('./constants'),
+    playoUtils: require('./util'),
+    NotificationTemplates: require('./notification-templates'),
     NotificationConfig: require('./notification.config'),
-    httpRequest: require('./request')
+    httpRequest: require('./request'),
+    Cron: require('./cron'),
+    MessagePublisher: require('./message_publisher')
 };

package/lib/message_publisher/index.js

@@ -0,0 +1,70 @@
+
+
+const { CloudTasksClient } = require('@google-cloud/tasks');
+
+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;
+
+if (!PROJECT || !LOCATION) {
+    console.warn('You need to pass - GCP_PROJECT, GCP_LOCATION in env for message queue to work!');
+}
+/**
+ *
+ * @param {String} queueId - Name of the queue being targeted
+ * @param {Object} payload - {
+ *                              httpMethod: String <POST, GET, PUT>
+ *                              url: String,
+ *                              headers: Object,
+ *                              body: Object, // not needed if GET request
+ *                              ...
+ *                                                       
+ *                           }
+ * @param {Object} messageProcessingProperties - {
+ *                                                  delay 
+ *                                                }
+ * @param {String} requestId 
+ */
+async function createHttpTask(queueId, payload, messageProcessingProperties, requestId) {
+
+    try {
+        const project = PROJECT;
+        const queue = queueId;
+        const location = LOCATION;
+
+        const { delay = 0 } = messageProcessingProperties
+
+        const parent = client.queuePath(project, location, queue);
+
+        const task = { httpRequest: payload };
+
+        if (payload.body) {
+            task.httpRequest.body = Buffer.from(payload.body).toString('base64');
+        }
+
+        if (delay) {
+            // The time when the task is scheduled to be attempted.
+            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}}`)
+    } catch (err) {
+        LOGGER.error(requestId, err, err.message)
+    }
+};
+
+module.exports = {
+    createHttpTask
+};

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!',
+    text: 'You have a {{sport_name}} game coming up on {{date}}. Best of luck!',
     buttons: [],
-    notificationId: notificationIds.ACTIVITY_REMINDER 
+    notificationId: notificationIds.ACTIVITY_REMINDER
 };
 
 const host_updated_activity_details = {

package/lib/ratings/index.js

@@ -77,7 +77,7 @@ const getUserAverageRatingForASport = (currentAvg, prevAvg) => {
     let oldAvg = prevAvg ? prevAvg * Constants.RATINGS_WEIGHTAGE.old : 0;
 
     // If for any reason any player doesn't have any old rating/ new rating, send back both ratings with 100% weightage (as one of them will be zero)
-    if (!prevAvg || !currentAvg) { 
+    if (!prevAvg || !currentAvg) {
         latest25Avg = currentAvg;
         oldAvg = prevAvg;
     }

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

@@ -1,9 +1,11 @@
 /**\
  * This module is not imported in PlayoLib directly as there are already many imports in individual repositories 
  * named util/utils and importing this alongside might cause unforeseen errors or poor readability
- * Ideally new repositories should import utils from here only. Todo- look for a workaround
+ * 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 
@@ -121,11 +123,30 @@ const getCategoricalBreakUpFromRecentUserRatings = (palRatingDict, levelCategori
     }
 
     return categoricalBreakUp;
-}
+};
+
+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
-}
+    getCategoricalBreakUpFromRecentUserRatings,
+    noop,
+    renderTemplate
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.3.5",
+  "version": "0.3.9",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,10 @@
     "jest": "^27.1.0"
   },
   "dependencies": {
+    "@google-cloud/tasks": "^2.5.0",
     "@playo/logger": "^0.9.18",
-    "axios": "^0.24.0"
+    "axios": "^0.24.0",
+    "cron": "^1.8.2",
+    "handlebars": "^4.7.7"
   }
 }