playov2-js-utilities 0.3.5 → 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/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.5",
+  "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"
   }
 }