refactor

xxcxy · xxcxy · commit b6bff7e9e4e8 · 2021-08-13T22:07:10.000+08:00
diff --git a/config/default.js b/config/default.js
@@ -274,5 +274,7 @@ module.exports = {
   RESOURCE_BOOKING_EXPIRY_TIME: process.env.RESOURCE_BOOKING_EXPIRY_TIME || 'P21D',
   // The Stripe
   STRIPE_SECRET_KEY: process.env.STRIPE_SECRET_KEY,
-  CURRENCY: process.env.CURRENCY || 'usd'
+  CURRENCY: process.env.CURRENCY || 'usd',
+  // The slack webhook url to send slack notifications
+  SLACK_WEBHOOK_URL: process.env.SLACK_WEBHOOK_URL
 }
diff --git a/data/notifications-email-template.html b/data/notifications-email-template.html
@@ -242,7 +242,7 @@
                           {{/if}}
                           {{#if notificationType.newTeamCreated}}
                           <span style="font-weight:bold;">Team Name:</span>
-                          {{teamName}}
+                          <a href={{teamURL}} target="_blank" rel="noopener noreferrer">{{teamName}}</a>
                           <table style="font-size:13px;border:1px solid black;border-collapse:collapse;width:95%;">
                             <tr style="font-weight:bold;border:1px solid black;border-collapse:collapse">
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job Title</td>
@@ -251,7 +251,7 @@
                             </tr>
                             {{#each jobList}}
                             <tr>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.title}}</td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{this.jobUrl}} target="_blank" rel="noopener noreferrer">{{this.title}}</a></td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.duration}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.startDate}}</td>
                             </tr>
@@ -267,8 +267,8 @@
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Start Date</td>
                             </tr>
                             <tr>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{teamName}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobTitle}}</td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{teamURL}} target="_blank" rel="noopener noreferrer">{{teamName}}</a></td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{jobURL}} target="_blank" rel="noopener noreferrer">{{jobTitle}}</a></td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobDuration}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobStartDate}}</td>
                             </tr>
@@ -278,19 +278,15 @@
                           <table style="font-size:13px;border:1px solid black;border-collapse:collapse;width:95%;">
                             <tr style="font-weight:bold;border:1px solid black;border-collapse:collapse">
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Team Name</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Team URL</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job title</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job URL</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job Candidate</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Interview Start Date</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Interview End Date</td>
                             </tr>
                             {{#each interviews}}
                             <tr>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.teamName}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.teamURL}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.jobTitle}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.jobURL}}</td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{this.teamURL}} target="_blank" rel="noopener noreferrer">{{this.teamName}}</a></td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{this.jobURL}} target="_blank" rel="noopener noreferrer">{{this.jobTitle}}</a></td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.candidateUserHandle}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.startTime}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{this.endTime}}</td>
@@ -303,15 +299,13 @@
                             <tr style="font-weight:bold;border:1px solid black;border-collapse:collapse">
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Team Name</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job title</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job URL</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job Start Date</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Job Duration</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Candidate User Handle</td>
                             </tr>
                             <tr>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{teamName}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobTitle}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobUrl}}</td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{teamUrl}} target="_blank" rel="noopener noreferrer">{{teamName}}</a></td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{jobUrl}} target="_blank" rel="noopener noreferrer">{{jobTitle}}</a></td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobStartDate}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobDuration}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{userHandle}}</td>
@@ -328,8 +322,8 @@
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">Resource Bookings End Date</td>
                             </tr>
                             <tr>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{teamName}}</td>
-                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{jobTitle}}</td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{teamUrl}} target="_blank" rel="noopener noreferrer">{{teamName}}</a></td>
+                              <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;"><a href={{jobUrl}} target="_blank" rel="noopener noreferrer">{{jobTitle}}</a></td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{userHandle}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{startDate}}</td>
                               <td style="border:1px solid black;border-collapse:collapse;text-align:center;line-height:1.5;">{{endDate}}</td>
diff --git a/scripts/demo-email-notifications/README.md b/scripts/demo-email-notifications/README.md
@@ -18,19 +18,24 @@ This script does 2 things:
     INTERVIEW_COMING_UP_MATCH_WINDOW=PT1M
     INTERVIEW_COMPLETED_MATCH_WINDOW=PT1M
     ```
+2. Config `SLACK_WEBHOOK_URL` env, if you want to send slack notifications
 
-2. Recreate demo data by:
+    ```sh
+    SLACK_WEBHOOK_URL=https://hooks.slack.com/services/***
+    ```
+
+3. Recreate demo data by:
 
     ```sh
     npm run local:init`
 
-3. Run TaaS API by:
+4. Run TaaS API by:
 
     ```sh
     npm run dev
     ```
 
-4. Run this demo script:
+5. Run this demo script:
 
    ```sh
    node scripts/demo-email-notifications
diff --git a/scripts/demo-email-notifications/index.js b/scripts/demo-email-notifications/index.js
@@ -10,7 +10,6 @@ const { Interview, JobCandidate, ResourceBooking } = require('../../src/models')
 const { Interviews } = require('../../app-constants')
 
 const consumer = new Kafka.GroupConsumer({ connectionString: process.env.KAFKA_URL, groupId: 'test-render-email' })
-const slackURL = null
 
 const localLogger = {
   debug: message => logger.debug({ component: 'render email content', context: 'test', message }),
@@ -72,8 +71,8 @@ async function initConsumer () {
               fs.writeFileSync(`./out/${notification.details.data.subject}-${Date.now()}.html`, email)
             })
             for (const notification of _.filter(message.payload.notifications, ['serviceId', 'slack'])) {
-              if (slackURL) {
-                await axios.post(slackURL, { text: notification.details.text, blocks: notification.details.blocks })
+              if (config.SLACK_WEBHOOK_URL) {
+                await axios.post(config.SLACK_WEBHOOK_URL, { text: notification.details.text, blocks: notification.details.blocks })
               }
             }
           }
diff --git a/src/common/helper.js b/src/common/helper.js
@@ -1914,13 +1914,7 @@ async function getTags (description) {
  * @returns {Object} the project created
  */
 async function createProject (currentUser, data) {
-  let token
-  if (currentUser.hasManagePermission || currentUser.isMachine) {
-    const m2mToken = await getM2MToken()
-    token = `Bearer ${m2mToken}`
-  } else {
-    token = currentUser.jwtToken
-  }
+  const token = currentUser.jwtToken
   const res = await request
     .post(`${config.TC_API}/projects/`)
     .set('Authorization', token)
@@ -2047,6 +2041,19 @@ function getEmailTemplatesForKey (key) {
   })
 }
 
+/**
+ * Format date to be used in email
+ *
+ * @param {Date} date date to be formatted
+ * @returns {String} formatted date
+ */
+function formatDate (date) {
+  if (date) {
+    const tzName = date.toLocaleString('en', { timeZoneName: 'short' }).split(' ').pop()
+    return `${moment(date).format('MMM D, YYYY, h:mm:ss a')} ${tzName}`
+  }
+}
+
 module.exports = {
   encodeQueryString,
   getParamFromCliArgs,
@@ -2110,5 +2117,6 @@ module.exports = {
   getMemberGroups,
   removeTextFormatting,
   getMembersSuggest,
-  getEmailTemplatesForKey
+  getEmailTemplatesForKey,
+  formatDate
 }
diff --git a/src/eventHandlers/InterviewEventHandler.js b/src/eventHandlers/InterviewEventHandler.js
@@ -9,6 +9,7 @@ const models = require('../models')
 const logger = require('../common/logger')
 const helper = require('../common/helper')
 const teamService = require('../services/TeamService')
+const Constants = require('../../app-constants')
 
 /**
  * Once we request Interview for a JobCandidate, the invitation emails to be sent out.
@@ -45,27 +46,34 @@ async function sendInvitationEmail (payload) {
  */
 async function checkOverlapping (payload) {
   const interview = payload.value
+  if (_.includes([Constants.Interviews.Status.Cancelled, Constants.Interviews.Status.Completed], interview.status)) {
+    return
+  }
   const overlappingInterview = await models.Interview.findAll({
     where: {
-      [Op.or]: [{
-        startTimestamp: {
-          [Op.lt]: interview.endTimestamp,
-          [Op.gte]: interview.startTimestamp
-        }
-      }, {
-        endTimestamp: {
-          [Op.lte]: interview.endTimestamp,
-          [Op.gt]: interview.startTimestamp
-        }
+      [Op.and]: [{
+        status: _.values(_.omit(Constants.Interviews.Status, 'Completed', 'Cancelled'))
       }, {
-        [Op.and]: [{
+        [Op.or]: [{
           startTimestamp: {
-            [Op.lt]: interview.startTimestamp
+            [Op.lt]: interview.endTimestamp,
+            [Op.gte]: interview.startTimestamp
           }
         }, {
           endTimestamp: {
-            [Op.gt]: interview.endTimestamp
+            [Op.lte]: interview.endTimestamp,
+            [Op.gt]: interview.startTimestamp
           }
+        }, {
+          [Op.and]: [{
+            startTimestamp: {
+              [Op.lt]: interview.startTimestamp
+            }
+          }, {
+            endTimestamp: {
+              [Op.gt]: interview.endTimestamp
+            }
+          }]
         }]
       }]
     }
@@ -87,8 +95,8 @@ async function checkOverlapping (payload) {
         jobTitle: job.title,
         jobURL: `${config.TAAS_APP_URL}/${project.id}/positions/${job.id}`,
         candidateUserHandle: user.handle,
-        startTime: oli.startTimestamp,
-        endTime: oli.endTimestamp
+        startTime: helper.formatDate(oli.startTimestamp),
+        endTime: helper.formatDate(oli.endTimestamp)
       })
     }
 
@@ -104,7 +112,7 @@ async function checkOverlapping (payload) {
           notificationType: {
             overlappingInterview: true
           },
-          description: 'Send notification if there is a new Interview created which overlaps existent interview by time (from "startTimestamp" till "endTimestamp"). Do the same if we update start/end timestamp for Some Interview and now it overlaps with another one'
+          description: 'Overlapping Interview Invites'
         },
         sendgridTemplateId: template.sendgridTemplateId,
         version: 'v3'
@@ -120,25 +128,19 @@ async function checkOverlapping (payload) {
           type: 'context',
           elements: [{
             type: 'mrkdwn',
-            text: `teamName: *${iv.teamName}*`
-          }, {
-            type: 'mrkdwn',
-            text: `teamURL: ${iv.teamURL}`
-          }, {
-            type: 'mrkdwn',
-            text: `jobTitle: *${iv.jobTitle}*`
+            text: `teamName: <${iv.teamURL}|*${iv.teamName}*>`
           }, {
             type: 'mrkdwn',
-            text: `jobURL: ${iv.jobURL}`
+            text: `jobTitle: <${iv.jobURL}|*${iv.jobTitle}*>`
           }, {
             type: 'mrkdwn',
             text: `candidateUserHandle: *${iv.candidateUserHandle}*`
           }, {
             type: 'mrkdwn',
-            text: `startTime: *${iv.startTime.toISOString()}*`
+            text: `startTime: *${helper.formatDate(iv.startTime)}*`
           }, {
             type: 'mrkdwn',
-            text: `endTime: *${iv.endTime.toISOString()}*`
+            text: `endTime: *${helper.formatDate(iv.endTime)}*`
           }]
         }, { type: 'divider' }])
       }
diff --git a/src/eventHandlers/JobCandidateEventHandler.js b/src/eventHandlers/JobCandidateEventHandler.js
@@ -154,6 +154,7 @@ async function sendJobCandidateSelectedNotification (payload) {
   const template = helper.getEmailTemplatesForKey('notificationEmailTemplates')['taas.notification.job-candidate-selected']
   const project = await helper.getProjectById({ isMachine: true }, job.projectId)
   const jobUrl = `${config.TAAS_APP_URL}/${project.id}/positions/${job.id}`
+  const teamUrl = `${config.TAAS_APP_URL}/${project.id}`
   const emailData = {
     serviceId: 'email',
     type: 'taas.notification.job-candidate-selected',
@@ -163,15 +164,16 @@ async function sendJobCandidateSelectedNotification (payload) {
       data: {
         subject: template.subject,
         teamName: project.name,
+        teamUrl,
         jobTitle: job.title,
         jobDuration: job.duration,
-        jobStartDate: job.startDate,
+        jobStartDate: helper.formatDate(job.startDate),
         userHandle: user.handle,
         jobUrl,
         notificationType: {
           candidateSelected: true
         },
-        description: 'Send notification if Job Candidate status has been change to "selected" or Job Candidate has been created with "selected" status'
+        description: 'Job Candidate is Selected'
       },
       sendgridTemplateId: template.sendgridTemplateId,
       version: 'v3'
@@ -187,22 +189,19 @@ async function sendJobCandidateSelectedNotification (payload) {
         type: 'context',
         elements: [{
           type: 'mrkdwn',
-          text: `teamName: *${project.name}*`
+          text: `teamName: <${teamUrl}|*${project.name}*>`
         }, {
           type: 'mrkdwn',
-          text: `jobTitle: *${job.title}*`
+          text: `jobTitle: <${jobUrl}|*${job.title}*>`
         }, {
           type: 'mrkdwn',
           text: `jobDuration: *${job.duration}*`
         }, {
           type: 'mrkdwn',
-          text: `jobStartDate: *${job.startDate.toISOString()}*`
+          text: `jobStartDate: *${helper.formatDate(job.startDate)}*`
         }, {
           type: 'mrkdwn',
           text: `userHandle: *${user.handle}*`
-        }, {
-          type: 'mrkdwn',
-          text: `jobUrl: ${jobUrl}`
         }]
       }]
     }
diff --git a/src/eventHandlers/JobEventHandler.js b/src/eventHandlers/JobEventHandler.js
@@ -68,12 +68,12 @@ async function processUpdate (payload) {
 }
 
 /**
- * Process job create event.
+ * When Job is created, send notification to user.
  *
  * @param {Object} payload the event payload
  * @returns {undefined}
  */
-async function processCreate (payload) {
+async function sendNotifications (payload) {
   if (payload.options.onTeamCreating) {
     logger.debug({
       component: 'JobEventHandler',
@@ -93,13 +93,15 @@ async function processCreate (payload) {
       data: {
         subject: template.subject,
         teamName: project.name,
+        teamURL: `${config.TAAS_APP_URL}/${project.id}`,
         jobTitle: payload.value.title,
+        jobURL: `${config.TAAS_APP_URL}/${project.id}/positions/${payload.value.id}`,
         jobDuration: payload.value.duration,
-        jobStartDate: payload.value.startDate,
+        jobStartDate: helper.formatDate(payload.value.startDate),
         notificationType: {
           newJobCreated: true
         },
-        description: 'Send notification a new Job was created'
+        description: 'New Job created'
       },
       sendgridTemplateId: template.sendgridTemplateId,
       version: 'v3'
@@ -115,6 +117,16 @@ async function processCreate (payload) {
   })
 }
 
+/**
+ * Process job create event.
+ *
+ * @param {Object} payload the event payload
+ * @returns {undefined}
+ */
+async function processCreate (payload) {
+  await sendNotifications(payload)
+}
+
 module.exports = {
   processUpdate,
   processCreate
diff --git a/src/eventHandlers/ResourceBookingEventHandler.js b/src/eventHandlers/ResourceBookingEventHandler.js
diff --git a/src/eventHandlers/TeamEventHandler.js b/src/eventHandlers/TeamEventHandler.js

Original file line number	Diff line number	Diff line change
`@@ -274,5 +274,7 @@ module.exports = {`
`274`	`274`	`RESOURCE_BOOKING_EXPIRY_TIME: process.env.RESOURCE_BOOKING_EXPIRY_TIME \|\| 'P21D',`
`275`	`275`	`// The Stripe`
`276`	`276`	`STRIPE_SECRET_KEY: process.env.STRIPE_SECRET_KEY,`
`277`		`- CURRENCY: process.env.CURRENCY \|\| 'usd'`
	`277`	`+ CURRENCY: process.env.CURRENCY \|\| 'usd',`
	`278`	`+ // The slack webhook url to send slack notifications`
	`279`	`+ SLACK_WEBHOOK_URL: process.env.SLACK_WEBHOOK_URL`
`278`	`280`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ const { Interview, JobCandidate, ResourceBooking } = require('../../src/models')`
`10`	`10`	`const { Interviews } = require('../../app-constants')`
`11`	`11`
`12`	`12`	`const consumer = new Kafka.GroupConsumer({ connectionString: process.env.KAFKA_URL, groupId: 'test-render-email' })`
`13`		`-const slackURL = null`
`14`	`13`
`15`	`14`	`const localLogger = {`
`16`	`15`	`debug: message => logger.debug({ component: 'render email content', context: 'test', message }),`
`@@ -72,8 +71,8 @@ async function initConsumer () {`
`72`	`71`	fs.writeFileSync(`./out/${notification.details.data.subject}-${Date.now()}.html`, email)
`73`	`72`	`})`
`74`	`73`	`for (const notification of _.filter(message.payload.notifications, ['serviceId', 'slack'])) {`
`75`		`- if (slackURL) {`
`76`		`- await axios.post(slackURL, { text: notification.details.text, blocks: notification.details.blocks })`
	`74`	`+ if (config.SLACK_WEBHOOK_URL) {`
	`75`	`+ await axios.post(config.SLACK_WEBHOOK_URL, { text: notification.details.text, blocks: notification.details.blocks })`
`77`	`76`	`}`
`78`	`77`	`}`
`79`	`78`	`}`