Merge pull request #29 from topcoder-platform/dev

[Production deployment] - Email notifications for connect events

Author: vikasrohit

.circleci/config.yml

@@ -82,7 +82,7 @@ workflows:
       - "build-dev":
           filters:
             branches:
-              only: dev
+              only: [dev, 'feature/discourseMigration']
       - "build-prod":
           filters:
             branches:

README.md

@@ -28,7 +28,12 @@ The following parameters can be set in config files or in env variables:
 - KAFKA_CLIENT_CERT_KEY: Kafka connection private key, optional;
     if not provided, then SSL connection is not used, direct insecure connection is used;
     if provided, it can be either path to private key file or private key content
-
+- BUS_API_BASE_URL: Bus API url
+- BUS_API_AUTH_TOKEN: Bus API auth token
+- REPLY_EMAIL_PREFIX: prefix of the genereated reply email address
+- REPLY_EMAIL_DOMAIN: email domain
+- DEFAULT_REPLY_EMAIL: default reply to email address, for example [email protected]
+- MENTION_EMAIL: recipient email used for email.project.post.mention event
 
 Configuration for the connect notification server is at `connect/config.js`.
 The following parameters can be set in config files or in env variables:

config/default.js

@@ -27,5 +27,20 @@ module.exports = {
   KAFKA_CLIENT_CERT: process.env.KAFKA_CLIENT_CERT ? process.env.KAFKA_CLIENT_CERT.replace('\\n', '\n') : null,
   KAFKA_CLIENT_CERT_KEY: process.env.KAFKA_CLIENT_CERT_KEY ?
     process.env.KAFKA_CLIENT_CERT_KEY.replace('\\n', '\n') : null,
-  API_CONTEXT_PATH: process.env.API_CONTEXT_PATH || '/v5/notifications',	
+
+  BUS_API_AUTH_TOKEN: process.env.BUS_API_AUTH_TOKEN,
+  MENTION_EMAIL: process.env.MENTION_EMAIL,
+  REPLY_EMAIL_PREFIX: process.env.REPLY_EMAIL_PREFIX,
+  REPLY_EMAIL_DOMAIN: process.env.REPLY_EMAIL_DOMAIN,
+
+  TC_ADMIN_TOKEN: process.env.TC_ADMIN_TOKEN,
+  TC_API_BASE_URL: process.env.TC_API_BASE_URL || 'https://api.topcoder-dev.com',
+  TC_API_V3_BASE_URL: process.env.TC_API_V3_BASE_URL || 'https://api.topcoder-dev.com/v3',
+  TC_API_V4_BASE_URL: process.env.TC_API_V4_BASE_URL || 'https://api.topcoder-dev.com/v4',
+  TC_API_V5_BASE_URL: process.env.TC_API_V5_BASE_URL || 'https://api.topcoder-dev.com/v5',
+  MESSAGE_API_BASE_URL: process.env.MESSAGE_API_BASE_URL || 'https://api.topcoder-dev.com/v4',
+  ENABLE_EMAILS: process.env.ENABLE_EMAILS || true,
+  ENABLE_DEV_MODE: process.env.ENABLE_DEV_MODE || true,
+  DEV_MODE_EMAIL: process.env.DEV_MODE_EMAIL,
+  API_CONTEXT_PATH: process.env.API_CONTEXT_PATH || '/v5/notifications',
 };

connect/config.js

@@ -5,6 +5,7 @@
 module.exports = {
   TC_API_V3_BASE_URL: process.env.TC_API_V3_BASE_URL || 'https://api.topcoder-dev.com/v3',
   TC_API_V4_BASE_URL: process.env.TC_API_V4_BASE_URL || 'https://api.topcoder-dev.com/v4',
+  MESSAGE_API_BASE_URL: process.env.MESSAGE_API_BASE_URL || 'https://api.topcoder-dev.com/v4',
   // eslint-disable-next-line max-len
   TC_ADMIN_TOKEN: process.env.TC_ADMIN_TOKEN,
 

connect/connectNotificationServer.js

@@ -66,12 +66,12 @@ const getNotificationsForMentionedUser = (eventConfig, content) => {
   }
 
   let notifications = [];
+  // eslint-disable-next-line
   const regexUserHandle = /title=\"@([a-zA-Z0-9-_.{}\[\]]+)\"/g;
-  let handles=[];
-  let matches = regexUserHandle.exec(content); 
-  console.log(content)
+  const handles = [];
+  let matches = regexUserHandle.exec(content);
   while (matches) {
-    let handle = matches[1].toString();
+    const handle = matches[1].toString();
     notifications.push({
       userHandle: handle,
       newType: 'notifications.connect.project.post.mention',
@@ -85,13 +85,13 @@ const getNotificationsForMentionedUser = (eventConfig, content) => {
   // only one per userHandle
   notifications = _.uniqBy(notifications, 'userHandle');
 
-  return new Promise((resolve)=>{
-    service.getUsersByHandle(handles).then((users)=>{
-      _.map(notifications,(notification)=>{
-        notification.userId = _.find(users,{handle:notification.userHandle}).userId;
+  return new Promise((resolve) => {
+    service.getUsersByHandle(handles).then((users) => {
+      _.map(notifications, (notification) => {
+        notification.userId = _.find(users, { handle: notification.userHandle }).userId.toString();
       });
       resolve(notifications);
-    })
+    });
   });
 };
 
@@ -307,7 +307,7 @@ const handler = (topic, message, callback) => {
         project,
       })
     )).then((notifications) => {
-      allNotifications = _.filter(notifications,notification=>notification.userId!=message.initiatorUserId);
+      allNotifications = _.filter(notifications, notification => notification.userId !== message.initiatorUserId);
 
       // now let's retrieve some additional data
 
@@ -326,6 +326,7 @@ const handler = (topic, message, callback) => {
         if (users.length) {
           notification.contents.userHandle = users[0].handle;
           notification.contents.userFullName = `${users[0].firstName} ${users[0].lastName}`;
+          notification.contents.userEmail = users[0].email;
         }
       });
       callback(null, allNotifications);

connect/service.js

@@ -69,7 +69,7 @@ const getRoleMembers = (roleId) => request
 const getUsersById = (ids) => {
   const query = _.map(ids, (id) => 'userId:' + id).join(' OR ');
   return request
-    .get(`${config.TC_API_V3_BASE_URL}/members/_search?fields=userId,handle,firstName,lastName&query=${query}`)
+    .get(`${config.TC_API_V3_BASE_URL}/members/_search?fields=userId,email,handle,firstName,lastName&query=${query}`)
     .set('accept', 'application/json')
     .set('authorization', `Bearer ${config.TC_ADMIN_TOKEN}`)
     .then((res) => {
@@ -78,7 +78,6 @@ const getUsersById = (ids) => {
       }
 
       const users = _.get(res, 'body.result.content');
-
       return users;
     }).catch((err) => {
       const errorDetails = _.get(err, 'response.body.result.content.message');
@@ -126,8 +125,8 @@ const getUsersByHandle = (handles) => {
  *
  * @return {Promise}          promise resolved to topic details
  */
-const getTopic = (topicId) => request
-  .get(`${config.TC_API_V4_BASE_URL}/topics/${topicId}`)
+const getTopic = (topicId, logger) => request
+  .get(`${config.MESSAGE_API_BASE_URL}/topics/${topicId}/read`)
   .set('accept', 'application/json')
   .set('authorization', `Bearer ${config.TC_ADMIN_TOKEN}`)
   .then((res) => {
@@ -137,14 +136,16 @@ const getTopic = (topicId) => request
 
     return _.get(res, 'body.result.content');
   }).catch((err) => {
+    if (logger) {
+      logger.error(err, `Error while calling ${config.MESSAGE_API_BASE_URL}/topics/${topicId}/read`);
+    }
     const errorDetails = _.get(err, 'response.body.result.content.message');
     throw new Error(
       `Failed to get topic details of topic id: ${topicId}.` +
       (errorDetails ? ' Server response: ' + errorDetails : '')
     );
   });
 
-
 module.exports = {
   getProject,
   getRoleMembers,

deploy.sh

@@ -45,8 +45,19 @@ TC_ADMIN_TOKEN=$(eval "echo \$${ENV}_TC_ADMIN_TOKEN")
 LOG_LEVEL=$(eval "echo \$${ENV}_LOG_LEVEL")
 PORT=$(eval "echo \$${ENV}_PORT")
 
+# email notifications config
+ENABLE_EMAILS=$(eval "echo \$${ENV}_ENABLE_EMAILS")
+BUS_API_AUTH_TOKEN=$(eval "echo \$${ENV}_BUS_API_AUTH_TOKEN")
+MENTION_EMAIL=$(eval "echo \$${ENV}_MENTION_EMAIL")
+REPLY_EMAIL_PREFIX=$(eval "echo \$${ENV}_REPLY_EMAIL_PREFIX")
+REPLY_EMAIL_DOMAIN=$(eval "echo \$${ENV}_REPLY_EMAIL_DOMAIN")
+ENABLE_DEV_MODE=$(eval "echo \$${ENV}_ENABLE_DEV_MODE")
+DEV_MODE_EMAIL=$(eval "echo \$${ENV}_DEV_MODE_EMAIL")
+
 TC_API_V3_BASE_URL=$(eval "echo \$${ENV}_TC_API_V3_BASE_URL")
 TC_API_V4_BASE_URL=$(eval "echo \$${ENV}_TC_API_V4_BASE_URL")
+TC_API_V5_BASE_URL=$(eval "echo \$${ENV}_TC_API_V5_BASE_URL")
+MESSAGE_API_BASE_URL=$(eval "echo \$${ENV}_MESSAGE_API_BASE_URL")
 
 DB_USER=$(eval "echo \$${ENV}_DB_USER")
 DB_PASSWORD=$(eval "echo \$${ENV}_DB_PASSWORD")
@@ -159,10 +170,46 @@ make_task_def(){
 								"name": "TC_API_V4_BASE_URL",
 								"value": "%s"
 						},
+            {
+                "name": "TC_API_V5_BASE_URL",
+                "value": "%s"
+            },
+            {
+                "name": "MESSAGE_API_BASE_URL",
+                "value": "%s"
+            },
 						{
 								"name": "TC_ADMIN_TOKEN",
 								"value": "%s"
 						},
+            {
+                "name": "ENABLE_EMAILS",
+                "value": "%s"
+            },
+            {
+                "name": "MENTION_EMAIL",
+                "value": "%s"
+            },
+            {
+                "name": "REPLY_EMAIL_PREFIX",
+                "value": "%s"
+            },
+            {
+                "name": "REPLY_EMAIL_DOMAIN",
+                "value": "%s"
+            },
+            {
+                "name": "ENABLE_DEV_MODE",
+                "value": "%s"
+            },
+            {
+                "name": "DEV_MODE_EMAIL",
+                "value": "%s"
+            },
+            {
+                "name": "BUS_API_AUTH_TOKEN",
+                "value": "%s"
+            },
 						{
 								"name": "LOG_LEVEL",
 								"value": "%s"
@@ -198,7 +245,7 @@ make_task_def(){
 		}
 	]'
 
-	task_def=$(printf "$task_template" $AWS_ECS_CONTAINER_NAME $AWS_ACCOUNT_ID $AWS_REGION $AWS_REPOSITORY $TAG $ENV "$KAFKA_CLIENT_CERT" "$KAFKA_CLIENT_CERT_KEY" $KAFKA_GROUP_ID "$KAFKA_TOPIC_IGNORE_PREFIX" $KAFKA_URL $DATABASE_URL $AUTHSECRET "$AUTHDOMAIN" "$JWKSURI" $TC_API_BASE_URL $TC_API_V3_BASE_URL $TC_API_V4_BASE_URL $TC_ADMIN_TOKEN $LOG_LEVEL $VALID_ISSUERS $PORT "$API_CONTEXT_PATH" $AWS_ECS_CLUSTER $AWS_REGION $AWS_ECS_CLUSTER $ENV)
+	task_def=$(printf "$task_template" $AWS_ECS_CONTAINER_NAME $AWS_ACCOUNT_ID $AWS_REGION $AWS_REPOSITORY $TAG $ENV "$KAFKA_CLIENT_CERT" "$KAFKA_CLIENT_CERT_KEY" $KAFKA_GROUP_ID "$KAFKA_TOPIC_IGNORE_PREFIX" $KAFKA_URL $DATABASE_URL $AUTHSECRET "$AUTHDOMAIN" "$JWKSURI" $TC_API_BASE_URL $TC_API_V3_BASE_URL $TC_API_V4_BASE_URL $TC_API_V5_BASE_URL $MESSAGE_API_BASE_URL $TC_ADMIN_TOKEN $ENABLE_EMAILS $MENTION_EMAIL $REPLY_EMAIL_PREFIX $REPLY_EMAIL_DOMAIN $ENABLE_DEV_MODE $DEV_MODE_EMAIL $BUS_API_AUTH_TOKEN $LOG_LEVEL $VALID_ISSUERS $PORT "$API_CONTEXT_PATH" $AWS_ECS_CLUSTER $AWS_REGION $AWS_ECS_CLUSTER $ENV)
 }
 
 register_definition() {