playov2-js-utilities 0.3.2 → 0.3.6

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,13 @@
 
-//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')
 };

package/lib/notification-templates.js

@@ -39,10 +39,10 @@ const host_response_to_query = {
  * @param {String} date - Activity's date
  */
 const activity_join_request = {
-    heading: 'You have a new game request! 🙌',
+    heading: 'New game request! 🙌',
     text: '{{user_first_name}} has requested to join your {{sport_name}} game happening on {{date}}.',
     additional_message_text: {
-        text: 'They have a message for you! Tap to read',
+        text: 'They have a message for you! Tap to read.',
         default: 'Let them know if you\'re game.'
     },
     buttons: [],
@@ -58,7 +58,7 @@ const activity_join_request = {
  * @param {String} date - Activity's date
  */
 const activity_request_accepted = {
-    heading: '{{host_first_name}} has accepted your request! 🥳',
+    heading: 'Request accepted! 🥳',
     text: 'You\'re on for the {{sport_name}} game on {{date}}. You can now chat with your game squad.',
     buttons: [],
     notificationId: notificationIds.ACTIVITY_REQUEST_RESPONSE
@@ -73,11 +73,11 @@ const activity_request_accepted = {
  * @param {String} date - Activity's date
  */
 const activity_request_declined = {
-    heading: 'Your request has been declined. 😟',
+    heading: 'Request declined. 😟',
     text: '{{host_first_name}} declined your request to join the {{sport_name}} game on {{date}}.',
     additional_message_text: {
-        text: 'They have a message for you! Tap to read',
-        default: 'No worries, other games are waiting for you to join! Join them now. 😀'
+        text: 'They have a message for you! Tap to read.',
+        default: 'No worries, other games are waiting for you! Join them now. 😀'
     },
     buttons: [],
     notificationId: notificationIds.HOST_RETIRED
@@ -92,7 +92,7 @@ const activity_request_declined = {
  * @param {String} date - Activity's date
  */
 const user_invited_by_host = {
-    heading: 'You have a new invite! 📩',
+    heading: 'New game invite! 📩',
     text: '{{host_first_name}} has invited you to the {{sport_name}} game on {{date}}. Are you game? 💪',
     buttons: [],
     notificationId: notificationIds.ACTIVITY_INVITATION
@@ -107,8 +107,8 @@ const user_invited_by_host = {
  * @param {String} date - Activity's date
  */
 const user_accepted_invite = {
-    heading: 'Your invite has been accepted! 🤝',
-    text: '{{user_first_name}} has accepted your request for the {{sport_name}} game on {{date}}.',
+    heading: 'Game invite accepted! 🤝',
+    text: '{{user_first_name}} has accepted your invite for the {{sport_name}} game on {{date}}.',
     buttons: [],
     notificationId: notificationIds.ACTIVITY_INVITATION_RESPONSE
 };
@@ -122,11 +122,11 @@ const user_accepted_invite = {
  * @param {String} date - Activity's date
  */
 const user_declined_invite = {
-    heading: 'Your invite has been declined. 😟',
-    text: '{{user_first_name}} has declined your request for the {{sport_name}} game on {{date}}.',
+    heading: 'Game invite declined. 😟',
+    text: '{{user_first_name}} has declined your invite for the {{sport_name}} game on {{date}}.',
     additional_message_text: {
-        text: 'They have a message for you! Tap to read',
-        default: ''
+        text: 'They have a message for you! Tap to read.',
+        default: 'Tap to invite other players.'
     },
     buttons: [],
     notificationId: notificationIds.HOST_RETIRED
@@ -141,10 +141,10 @@ const user_declined_invite = {
  * @param {String} date - Activity's date
  */
 const host_revoked_invite = {
-    heading: 'Your invite has been cancelled 😕 ',
+    heading: 'Game invite cancelled 😕',
     text: '{{host_first_name}} has cancelled your invitation to the {{sport_name}} game on {{date}}.',
     additional_message_text: {
-        text: 'They have a message for you! Tap to read',
+        text: 'They have a message for you! Tap to read.',
         default: 'But, you can always join another game!'
     },
     buttons: [],
@@ -160,7 +160,7 @@ const host_revoked_invite = {
  * @param {String} date - Activity's date
  */
 const host_retired_user = {
-    heading: 'You have been made to retire. 😕 ',
+    heading: 'You have been made to retire.😕',
     text: 'You are no longer a part of {{sport_name}} game on {{date}}.',
     additional_message_text: {
         text: '{{host_first_name}} has a message for you! Tap to read',
@@ -182,8 +182,8 @@ const user_left_game = {
     heading: 'Player has left the game.',
     text: '{{user_first_name}} has left {{date}}\'s  {{sport_name}} game.',
     additional_message_text: {
-        text: '{{user_first_name}} has a message for you! Tap to read',
-        default: ''
+        text: 'They have a message for you! Tap to read.',
+        default: 'Tap to invite other players.'
     },
     buttons: [],
     notificationId: notificationIds.HOST_RETIRED
@@ -204,6 +204,16 @@ const host_cancelled_activity = {
     notificationId: notificationIds.ACTIVITY_CANCEL
 };
 
+/**
+ * 
+ */
+const activity_reminder = {
+    heading: '⏰, Activity reminder!',
+    text: 'You have a {sport_name}} game coming up on {{date}}. Best of luck!',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_REMINDER 
+};
+
 const host_updated_activity_details = {
     // ??
 };
@@ -228,5 +238,6 @@ module.exports = {
     host_revoked_invite,
     host_retired_user,
     user_left_game,
-    host_cancelled_activity
+    host_cancelled_activity,
+    activity_reminder
 }

package/lib/notification.config.js

@@ -17,7 +17,8 @@ const notificationChannels = {
     'activity_suggestions': '3ab98c37-b93c-4d39-ab55-bb2cc6279cb8', // done - 1 notifications tagged
     'expenses': '1eb30f33-2b3b-40ce-8798-fce55c1275e2', // done - 6 notifications tagged
     'groups_manage_requests': '83c024d1-2cb7-47fa-989d-1d8ef343a51c', // done - 6 notifications tagged
-    'group_updates': '9e023a20-deab-4bc4-bd33-08a8d9316322' // done - 3 notifications tagged 
+    'group_updates': '9e023a20-deab-4bc4-bd33-08a8d9316322', // done - 3 notifications tagged 
+    'activity_reminders': '53c55399-a73c-4800-b824-3c750ac57b98'
 };
 
 // ------------------------------------------ Exported (public) -----------------------------------------//
@@ -78,7 +79,8 @@ const notificationIds = {
     SPLIT_EXPENSE_DELETED: 'split-expense-deleted',
     HOST_ACTIVITY_PAYOUT: 'host-activity-payout',
     KARMA_CASHBACK: 'karma-cashback',
-    ACTIVITY_QUERY_ANSWERED: 'activity-query-answered'
+    ACTIVITY_QUERY_ANSWERED: 'activity-query-answered',
+    ACTIVITY_REMINDER: 'activity-reminder'
 };
 
 // TODO - Check targets against current value
@@ -432,6 +434,14 @@ const config = {
         type: ["push", "drawer"],
         buttons: [],
         android_channel_id: notificationChannels.activity_query
+    },
+    [notificationIds.ACTIVITY_REMINDER] : {
+        category: notificationCategories.ACTIVITY,
+        target: "match",
+        title: "Activity Reminder",
+        type: ["push", "drawer"],
+        buttons: [],
+        android_channel_id: notificationChannels.activity_reminders
     }
 };
 

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/util.js

@@ -1,7 +1,7 @@
 /**\
  * 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
  */
 
 /**
@@ -121,11 +121,16 @@ const getCategoricalBreakUpFromRecentUserRatings = (palRatingDict, levelCategori
     }
 
     return categoricalBreakUp;
+};
+
+const noop = () => {
+    return undefined;
 }
 
 module.exports = {
     getRatingsFromPlaypalDocs,
     findAverage,
     getRecentRatingDictOfPals,
-    getCategoricalBreakUpFromRecentUserRatings
+    getCategoricalBreakUpFromRecentUserRatings,
+    noop
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.3.2",
+  "version": "0.3.6",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {
@@ -22,6 +22,7 @@
   },
   "dependencies": {
     "@playo/logger": "^0.9.18",
-    "axios": "^0.24.0"
+    "axios": "^0.24.0",
+    "cron": "^1.8.2"
   }
 }

package/test.js

@@ -1,219 +0,0 @@
-const data =[
-      {
-        "_id": "619b64773f930c6f90778f93",
-        "location": "Indiranagar",
-        "hostId": "1b7887d3-8255-409b-9efe-89b64b701862",
-        "matchHappened": true,
-        "matchRating": -1,
-        "userPlayed": true,
-        "expired": false,
-        "cancelled": false,
-        "noshow": false,
-        "removed": false,
-        "userId": "1b7887d3-8255-409b-9efe-89b64b701862",
-        "activityId": "9a8942e0-9778-4c43-befd-c8f7de4d3985",
-        "sportId": "SP5",
-        "date": "2021-11-22T00:00:00.000Z",
-        "timing": 2,
-        "pals": [
-          {
-            "noshow": false,
-            "noshowSwitch": false,
-            "rating": 5,
-            "newPlaypal": false,
-            "firstRatedOn": "2021-11-22T09:36:09.000Z",
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "2537e208-35f2-4b38-ac65-081ab1a249be",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": -1
-              },
-              {
-                "reputationId": 1,
-                "value": -1
-              },
-              {
-                "reputationId": 2,
-                "value": -1
-              }
-            ],
-            "timestamp": "2021-11-22T09:59:37.000Z"
-          }
-        ],
-        "createdTS": "2021-11-22T09:35:51.009Z",
-        "modTS": "2021-11-22T09:59:37.512Z",
-        "__v": 0
-      },
-      {
-        "_id": "619b6c5b8fff1950a20adae1",
-        "location": "Jayanagar, Bengaluru",
-        "hostId": "a458fa2e-37e8-4e9d-beb1-3b4e68e5d56e",
-        "matchHappened": true,
-        "matchRating": -1,
-        "userPlayed": true,
-        "expired": true,
-        "cancelled": false,
-        "noshow": false,
-        "removed": false,
-        "userId": "1b7887d3-8255-409b-9efe-89b64b701862",
-        "activityId": "5161229a-e82d-498a-beed-8e2bc50bcaf7",
-        "sportId": "SP5",
-        "date": "2021-11-22T00:00:00.000Z",
-        "timing": 1,
-        "pals": [
-          {
-            "noshow": false,
-            "noshowSwitch": false,
-            "rating": 0,
-            "newPlaypal": false,
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "a458fa2e-37e8-4e9d-beb1-3b4e68e5d56e",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": -1
-              },
-              {
-                "reputationId": 1,
-                "value": -1
-              },
-              {
-                "reputationId": 2,
-                "value": -1
-              }
-            ],
-            "timestamp": "2021-11-22T10:09:31.718Z"
-          },
-          {
-            "noshow": false,
-            "noshowSwitch": false,
-            "rating": 4,
-            "newPlaypal": false,
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "2537e208-35f2-4b38-ac65-081ab1a249be",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": -1
-              },
-              {
-                "reputationId": 1,
-                "value": -1
-              },
-              {
-                "reputationId": 2,
-                "value": -1
-              }
-            ],
-            "timestamp": "2021-11-22T11:22:05.000Z"
-          }
-        ],
-        "createdTS": "2021-11-22T10:09:31.718Z",
-        "modTS": "2021-11-22T11:26:49.742Z",
-        "__v": 0
-      },
-      {
-        "_id": "619b85378fff1950a20adaed",
-        "location": "Indiranagar",
-        "hostId": "1b7887d3-8255-409b-9efe-89b64b701862",
-        "matchHappened": true,
-        "matchRating": -1,
-        "userPlayed": true,
-        "expired": false,
-        "cancelled": false,
-        "noshow": false,
-        "removed": false,
-        "userId": "1b7887d3-8255-409b-9efe-89b64b701862",
-        "activityId": "00f9ff64-214c-470d-b7fb-760a6a3af8e0",
-        "sportId": "SP5",
-        "date": "2021-11-22T00:00:00.000Z",
-        "timing": 2,
-        "pals": [
-          {
-            "noshow": true,
-            "noshowSwitch": false,
-            "rating": 0,
-            "newPlaypal": false,
-            "firstRatedOn": null,
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "a458fa2e-37e8-4e9d-beb1-3b4e68e5d56e",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": -1
-              },
-              {
-                "reputationId": 1,
-                "value": -1
-              },
-              {
-                "reputationId": 2,
-                "value": -1
-              }
-            ],
-            "timestamp": "2021-11-22T11:55:35.341Z"
-          },
-          {
-            "noshow": false,
-            "noshowSwitch": false,
-            "rating": 0,
-            "newPlaypal": false,
-            "firstRatedOn": null,
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "88d8e6ed-207a-4b98-ace7-73a7bd6bc900",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": -1
-              },
-              {
-                "reputationId": 1,
-                "value": -1
-              },
-              {
-                "reputationId": 2,
-                "value": -1
-              }
-            ],
-            "timestamp": "2021-11-22T11:55:35.341Z"
-          },
-          {
-            "noshow": true,
-            "noshowSwitch": false,
-            "rating": 0,
-            "newPlaypal": false,
-            "firstRatedOn": null,
-            "isRemoved": false,
-            "userPresent": null,
-            "palId": "2537e208-35f2-4b38-ac65-081ab1a249be",
-            "reputation": [
-              {
-                "reputationId": 0,
-                "value": 1
-              },
-              {
-                "reputationId": 1,
-                "value": 1
-              },
-              {
-                "reputationId": 2,
-                "value": 1
-              }
-            ],
-            "timestamp": "2021-11-22T11:55:35.341Z"
-          }
-        ]
-    }
-];
-    const ratingTest = require('./lib/ratings/index');
-
-
-    const test = ratingTest.getUserRecentRatings(data, undefined, 4);
-
-    console.log(test);