playov2-js-utilities 0.3.19 → 0.3.22

package/lib/index.js

@@ -10,5 +10,6 @@ module.exports = {
     NotificationConfig: require('./notification.config'),
     httpRequest: require('./request'),
     Cron: require('./cron'),
-    MessagePublisher: require('./message_publisher')
+    MessagePublisher: require('./message_publisher'),
+    middleware: require('./middleware')
 };

package/lib/logger.js

@@ -0,0 +1,115 @@
+const PLAYO_LOGGER = require("@playo/logger")
+
+const LOGGER = new PLAYO_LOGGER("playov2-activity")
+
+const ENV = process.env.NODE_ENV || 'staging';
+
+if (ENV === 'staging' || ENV === 'test') {
+    LOGGER.setSlack('# test');
+}
+
+if (ENV === "production") {
+    LOGGER.setMailer({
+        'receiverEmail': ["saurabh@playo.co", "umashankar@playo.co", "avish@playo.co"], // array of recievers, mandatory
+        'senderEmail': "logger@playo.co",// address of sender, mandatory
+        'senderName': 'Mail Logger - prod - Utitlies module', // default: Mail Logger, optional
+        'replyEmail': 'no-reply@mail.com', // default: no-reply@playo.co, optional
+        'region': "us-east-1", // default: 'us-east-1', optional
+    });
+
+    LOGGER.setSlack('# server_alerts');
+};
+
+/**
+ * Info log - use where some stack trace needs to be stored for later debug purpose
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} message
+ */
+const prepareInfoLog = (
+    id = "info-log",
+    data = {},
+    message = "info-message"
+) => {
+    LOGGER.info(id, data, message);
+};
+
+/**
+ * Error log - used to monitor error throughout the system
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} message
+ */
+const prepareErrorLog = (
+    id = "error-log",
+    data = {},
+    message = "error-message"
+) => {
+    if (data.stack) {
+        data = data.stack;
+    }
+    LOGGER.error(id, data, message);
+};
+
+/**
+ * Alert log - Sends alert on slack and email to notify to concerned people
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} message
+ * @param {Boolean} sendEmail
+ */
+const prepareAlertLog = (
+    id = "alert-log",
+    data = {},
+    message = "alert-message",
+    sendEmail = false
+) => {
+    LOGGER.alert(id, data, message, sendEmail);
+};
+
+/**
+ * Use this to debug , ideally only on staging env
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} message
+ */
+const prepareDebugLog = (
+    id = "alert log",
+    data = {},
+    message = "debug-log"
+) => {
+    LOGGER.debug(id, data, message);
+};
+
+/**
+ * Use this to print error or failure that do not need to fixed on an urgent basis but need to later analyzed later
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} message
+ */
+const prepareWarnLog = (
+    id = "warn log",
+    data = {},
+    message = "warn-log",
+    topic = 'warn-topic'
+) => {
+    LOGGER.warn(id, data, message, topic);
+};
+
+/**
+ * Set module name for your module to be observed in logs
+ * @param {String} moduleName
+ * @returns
+ */
+const setModule = (moduleName) => {
+    return LOGGER.setModule(moduleName);
+};
+
+module.exports = {
+    prepareInfoLog,
+    prepareErrorLog,
+    prepareAlertLog,
+    prepareDebugLog,
+    prepareWarnLog,
+    setModule,
+};

package/lib/middleware.js

@@ -0,0 +1,39 @@
+
+const { v4: uuidv4, v4 } = require('uuid');
+const Logger = require('./logger')
+
+const playoServiceRequestInterceptor = (req, res, next, service = 'microservice-name') => {
+    const id = req.headers["x-request-id"] || uuidv4();
+    const start = Date.now();
+
+    const requestDetails = {
+        method: req.method,
+        params: req.params,
+        query: req.query,
+        url: req.url,
+        originalUrl: req.originalUrl,
+        service
+    };
+    if (req.body.length < 1000) {
+        requestDetails['body'] = req.body || {};
+    }
+
+    Logger.prepareInfoLog(id, requestDetails, "Incoming request");
+
+    res.on('finish', function () {
+        const duration = Date.now() - start;
+        const status = res.statusCode;
+        Logger.prepareInfoLog(id, { res, status, duration, service }, "Outgoing request - finish event");
+    });
+
+    res.on('close', function () {
+        const duration = Date.now() - start;
+        const status = res.statusCode;
+        Logger.prepareInfoLog(id, { res, status, duration, service }, "Outgoing request - close event");
+    });
+    next();
+};
+
+module.exports = {
+    playoServiceRequestInterceptor
+}

package/lib/notification.config.js

@@ -100,7 +100,7 @@ const config = {
         target: "group",
         path: "manage",
         title: "Group Invitation",
-        type: ["push"],
+        type: ["push", "drawer"],
         buttons: [],
         android_channel_id: notificationChannels.groups_manage_requests
     },

package/package.json

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