initial bulk message developemnt.

Author: Sachin Maheshwari

config/default.js

@@ -58,7 +58,7 @@ module.exports = {
           {
             id: 0, /** challengeid or projectid  */
             name: '', /** challenge name */
-            group: 'Challenge',
+            group: 'challenge',
             title: 'Challenge specification is modified.',
           },
         },
@@ -75,7 +75,7 @@ module.exports = {
           {
             id: 0, /** challengeid or projectid  */
             name: '', /** challenge name */
-            group: 'Challenge',
+            group: 'challenge',
             title: 'Challenge checkpoint review.',
           },
         },
@@ -92,7 +92,7 @@ module.exports = {
           {
             id: 0, /** challengeid or projectid  */
             name: '', /** challenge name */
-            group: 'Submission',
+            group: 'submission',
             title: 'A new submission is uploaded.',
           },
         },
@@ -108,4 +108,5 @@ module.exports = {
   ENABLE_DEV_MODE: process.env.ENABLE_DEV_MODE ? Boolean(process.env.ENABLE_DEV_MODE) : true,
   DEV_MODE_EMAIL: process.env.DEV_MODE_EMAIL,
   DEFAULT_REPLY_EMAIL: process.env.DEFAULT_REPLY_EMAIL,
+  ENABLE_HOOK_BULK_NOTIFICATION : process.env.ENABLE_HOOK_BULK_NOTIFICATION || false,
 };

src/hooks/hookBulkMessage.js

@@ -0,0 +1,137 @@
+/**
+ * Hook to insert broadcast notification into database for a user.
+ */
+
+'use strict'
+
+const _ = require('lodash')
+//const Joi = require('joi')
+//const errors = require('../common/errors')
+const logger = require('../common/logger')
+const models = require('../models')
+const logPrefix = "BulkNotificationHook: "
+
+models.BulkMessages.sync()
+models.BulkMessageUserRefs.sync()
+
+/**
+ * Main function 
+ * @param {Integer} userId 
+ */
+function checkBulkMessageForUser(userId) {
+    models.BulkMessages.count().then(function (tBulkMessages) {
+        if (tBulkMessages > 0) {
+            // the condition can help to optimize the execution 
+            models.BulkMessageUserRefs.count({
+                where: {
+                    user_id: userId
+                }
+            }).then(function (tUserRefs) {
+                if (tUserRefs < tBulkMessages) {
+                    logger.info(`${logPrefix} Need to sync broadcast message for current user ${userId}`)
+                    syncBulkMessageForUser(userId)
+                }
+            }).catch((e) => {
+                logger.error(`${logPrefix} Failed to check total userRefs condition. Error: `, e)
+            })
+        }
+    }).catch((e) => {
+        logger.error(`${logPrefix} Failed to check total broadcast message condition. Error: `, e)
+    })
+}
+
+/**
+ * Helper function 
+ * @param {Integer} userId 
+ */
+function syncBulkMessageForUser(userId) {
+
+    /**
+     * Check if all bulk mesaages processed for current user or not 
+     */
+    let q = "SELECT a.* FROM bulk_messages AS a " +
+        " LEFT OUTER JOIN (SELECT id as refid, bulk_message_id " +
+        " FROM bulk_message_user_refs AS bmur WHERE bmur.user_id=$1)" +
+        " AS b ON a.id=b.bulk_message_id WHERE b.refid IS NULL"
+    models.sequelize.query(q, { bind: [userId] })
+        .then(function (res) {
+            _.map(res[0], async (r) => {
+                logger.info(`${logPrefix} need to process for bulk message id: `, r.id)
+                // call function to check if current user in reciepent group
+                // insert row in userRef table 
+                if (isBroadCastMessageForUser(userId, r)) {
+                    // current user in reciepent group
+                    createNotificationForUser(userId, r)
+                } else {
+                    /**
+                     * Insert row in userRef with notification-id null value 
+                     * It means - broadcast message in not for current user
+                     */
+                    insertUserRefs(userId, r.id, null)
+                }
+            })
+        }).catch((e) => {
+            logger.error(`${logPrefix} Failed to check bulk message condition: `, err)
+        })
+}
+
+/**
+ * Helper function 
+ * Check if current user in broadcast recipent group 
+ * @param {Integer} userId 
+ * @param {Object} bulkMessage 
+ */
+function isBroadCastMessageForUser(userId, bulkMessage) {
+    // TODO  
+    return true;
+}
+
+/**
+ * Helper function 
+ * @param {Integer} userId 
+ * @param {Integer} bulkMessageId 
+ * @param {Integer} notificationId 
+ */
+function insertUserRefs(userId, bulkMessageId, notificationId) {
+    models.BulkMessageUserRefs.create({
+        bulk_message_id: bulkMessageId,
+        user_id: userId,
+        notification_id: notificationId,
+    }).then((b) => {
+        logger.info(`${logPrefix} Inserted userRef record ${b.id} for current user ${userId}`)
+    }).catch((e) => {
+        logger.error(`${logPrefix} Failed to insert userRef record for user: ${userId}, error: `, e)
+    })
+}
+
+/**
+ * Helper function 
+ * @param {Integer} userId 
+ * @param {Object} bulkMessage 
+ */
+function createNotificationForUser(userId, bulkMessage) {
+    models.Notification.create({
+        userId: userId,
+        type: bulkMessage.type,
+        contents: {
+            id: bulkMessage.id, /** broadcast message id  */
+            name: bulkMessage.contents, /** broadcast message */
+            group: 'broadcast',
+            title: 'Broadcast Message',
+        },
+        read: false,
+        seen: false,
+        version: null,
+    }).then((n) => {
+        logger.info(`${logPrefix} Inserted notification record ${n.id} for current user ${userId}`)
+        insertUserRefs(userId, bulkMessage.id, n.id)
+    }).catch((err) => {
+        logger.error(`${logPrefix} Error in inserting broadcast message `, err)
+    })
+}
+
+
+// Exports
+module.exports = {
+    checkBulkMessageForUser,
+};

src/hooks/index.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright (C) 2020 TopCoder Inc., All Rights Reserved.
+ */
+
+/**
+ * Hook implementation 
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+const hookBulkMessage = require("./hookBulkMessage")
+
+
+module.exports = {
+  hookBulkMessage,
+};

src/models/BulkMessageUserRefs.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (C) 2020 TopCoder Inc., All Rights Reserved.
+ */
+
+/**
+ * The Bulk Message User Reference schema
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+
+module.exports = (sequelize, DataTypes) => sequelize.define('bulk_message_user_refs', {
+    id: { type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true },
+    bulk_message_id: {
+        type: DataTypes.BIGINT,
+        allowNull: false,
+        references: {
+            model: 'bulk_messages',
+            key: 'id'
+        }
+    },
+    notification_id: {
+        type: DataTypes.BIGINT,
+        allowNull: true,
+        references: {
+            model: 'Notifications',
+            key: 'id'
+        }
+    },
+    user_id: { type: DataTypes.BIGINT, allowNull: false }
+}, {});
+
+  // sequelize will generate and manage createdAt, updatedAt fields

src/models/BulkMessages.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright (C) 2020 TopCoder Inc., All Rights Reserved.
+ */
+
+/**
+ * The Bulk Message Store schema
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+
+module.exports = (sequelize, DataTypes) => sequelize.define('bulk_messages', {
+    id: { type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true },
+    type: { type: DataTypes.STRING, allowNull: false },
+    contents: { type: DataTypes.JSONB, allowNull: false },
+    recipient_group: { type: DataTypes.STRING, allowNull: false }
+  }, {});
+  
+  // sequelize will generate and manage createdAt, updatedAt fields
+  

src/models/index.js

@@ -16,11 +16,17 @@ const Notification = require('./Notification')(sequelize, DataTypes);
 const NotificationSetting = require('./NotificationSetting')(sequelize, DataTypes);
 const ServiceSettings = require('./ServiceSettings')(sequelize, DataTypes);
 const ScheduledEvents = require('./ScheduledEvents')(sequelize, DataTypes);
+const BulkMessages = require('./BulkMessages')(sequelize, DataTypes);
+const BulkMessageUserRefs = require('./BulkMessageUserRefs')(sequelize, DataTypes);
+
 
 module.exports = {
   Notification,
   NotificationSetting,
   ServiceSettings,
   ScheduledEvents,
+  BulkMessages,
+  BulkMessageUserRefs,
+  sequelize,
   init: () => sequelize.sync(),
 };

src/services/NotificationService.js

@@ -9,6 +9,8 @@ const Joi = require('joi');
 const errors = require('../common/errors');
 const logger = require('../common/logger');
 const models = require('../models');
+const config = require('config');
+const hooks = require('../hooks');
 
 const DEFAULT_LIMIT = 10;
 
@@ -202,6 +204,10 @@ function* listNotifications(query, userId) {
       break;
   }
 
+  if (config.ENABLE_HOOK_BULK_NOTIFICATION){
+     hooks.hookBulkMessage.checkBulkMessageForUser(userId)
+  }
+
   if (_.keys(notificationSettings).length > 0) {
     // only filter out notifications types which were explicitly set to 'no' - so we return notification by default
     const notifications = _.keys(notificationSettings).filter((notificationType) =>

test/checkHooks.js

@@ -0,0 +1,3 @@
+const bulkhook = require("../src/hooks/hookBulkMessage")
+
+bulkhook.checkBulkMessageForUser(123)