Merge pull request topcoder-platform#625 from topcoder-platform/feature/interview-update-part-1

Fix specific issues related to Nylas webhooks & interviews - part 1

Author: maxceem

docs/swagger.yaml

@@ -4859,11 +4859,7 @@ components:
           type: string
           format: uuid
 
-    UpdateInterviewRequestBody:
-      required:
-        - duration
-        - timezone
-        - availableTime
+    UpdateInterviewByRequestBody:
       properties:
         duration:
           type: integer
@@ -4872,6 +4868,13 @@ components:
         timezone:
           type: string
           example: "Europe/London"
+        hostUserId:
+          type: string
+          description: "UUID of interview host user"
+        expireTimestamp:
+          type: string
+          format: date-time
+          description: "Interview expiry time stamp."
         availableTime:
           type: array
           items:
@@ -4894,6 +4897,20 @@ components:
                 type: string
                 example: "10:00"
                 pattern: "^[0-9]{1,2}:[0-9]{2}$"
+        startTimestamp:
+          type: string
+          format: date-time
+          description: "Interview start time."
+        endTimestamp:
+          type: string
+          format: date-time
+          description: "Interview end time."
+        status:
+          type: string
+          enum: ["Scheduling", "Scheduled", "Requested for reschedule", "Rescheduled", "Completed", "Cancelled", "Expired"]
+        deletedAt:
+          type: string
+          format: date-time
 
     JobPatchRequestBody:
       properties:

src/services/InterviewService.js

@@ -467,8 +467,8 @@ partiallyUpdateInterviewByRound.schema = Joi.object().keys({
   jobCandidateId: Joi.string().uuid().required(),
   round: Joi.number().integer().positive().required(),
   data: Joi.object().keys({
-    duration: Joi.number().integer().positive().required(),
-    timezone: Joi.string().required(),
+    duration: Joi.number().integer().positive(),
+    timezone: Joi.string(),
     hostUserId: Joi.string().uuid(),
     expireTimestamp: Joi.date(),
     availableTime: Joi.array().min(1).items(
@@ -484,15 +484,15 @@ partiallyUpdateInterviewByRound.schema = Joi.object().keys({
         end: Joi.string().regex(InterviewConstants.Nylas.StartEndRegex).required(),
         start: Joi.string().regex(InterviewConstants.Nylas.StartEndRegex).required()
       })
-    ).required(),
+    ),
     startTimestamp: Joi.date().greater('now').when('status', {
       is: [InterviewConstants.Status.Scheduled, InterviewConstants.Status.Rescheduled],
-      then: Joi.required(),
+      then: Joi.invalid(null),
       otherwise: Joi.allow(null)
     }),
     endTimestamp: Joi.date().greater(Joi.ref('startTimestamp')).when('status', {
       is: [InterviewConstants.Status.Scheduled, InterviewConstants.Status.Rescheduled],
-      then: Joi.required(),
+      then: Joi.invalid(null),
       otherwise: Joi.allow(null)
     }),
     status: Joi.interviewStatus(),
@@ -540,8 +540,8 @@ partiallyUpdateInterviewById.schema = Joi.object().keys({
   currentUser: Joi.object().required(),
   id: Joi.string().required(),
   data: Joi.object().keys({
-    duration: Joi.number().integer().positive().required(),
-    timezone: Joi.string().required(),
+    duration: Joi.number().integer().positive(),
+    timezone: Joi.string(),
     hostUserId: Joi.string().uuid(),
     expireTimestamp: Joi.date(),
     availableTime: Joi.array().min(1).items(
@@ -557,15 +557,15 @@ partiallyUpdateInterviewById.schema = Joi.object().keys({
         end: Joi.string().regex(InterviewConstants.Nylas.StartEndRegex).required(),
         start: Joi.string().regex(InterviewConstants.Nylas.StartEndRegex).required()
       })
-    ).required(),
+    ),
     startTimestamp: Joi.date().greater('now').when('status', {
       is: [InterviewConstants.Status.Scheduled, InterviewConstants.Status.Rescheduled],
-      then: Joi.required(),
+      then: Joi.invalid(null),
       otherwise: Joi.allow(null)
     }),
     endTimestamp: Joi.date().greater(Joi.ref('startTimestamp')).when('status', {
       is: [InterviewConstants.Status.Scheduled, InterviewConstants.Status.Rescheduled],
-      then: Joi.required(),
+      then: Joi.invalid(null),
       otherwise: Joi.allow(null)
     }),
     status: Joi.interviewStatus(),
@@ -767,6 +767,47 @@ async function updateCompletedInterviews () {
  */
 async function partiallyUpdateInterviewByWebhook (interviewId, webhookBody) {
   logger.info({ component: 'InterviewService', context: 'partiallyUpdateInterviewByWebhook', message: `Received webhook for interview id "${interviewId}": ${JSON.stringify(webhookBody)}` })
+
+  // this method is used by the Nylas webhooks, so use M2M user
+  const m2mUser = helper.getAuditM2Muser()
+  const bookingDetails = webhookBody.booking
+  const interviewStartTimeMoment = moment.unix(bookingDetails.start_time)
+  const interviewEndTimeMoment = moment.unix(bookingDetails.end_time)
+  let updatedInterview
+
+  if (bookingDetails.is_confirmed) {
+    try {
+      // CREATED + confirmed ==> inteview updated to scheduled
+      // UPDATED + cancelled ==> inteview expired
+      updatedInterview = await partiallyUpdateInterviewById(
+        m2mUser,
+        interviewId,
+        {
+          status: InterviewConstants.Status.Scheduled,
+          startTimestamp: interviewStartTimeMoment.toDate(),
+          endTimestamp: interviewEndTimeMoment.toDate()
+        }
+      )
+
+      logger.debug({
+        component: 'InterviewService',
+        context: 'partiallyUpdateInterviewByWebhook',
+        message:
+        `~~~~~~~~~~~NEW EVENT~~~~~~~~~~~\nInterview Scheduled under account id ${
+          bookingDetails.account_id
+        } (email is ${bookingDetails.recipient_email}) in calendar id ${
+          bookingDetails.calendar_id
+        }. Event status is ${InterviewConstants.Status.Scheduled} and starts from ${interviewStartTimeMoment
+          .format('MMM DD YYYY HH:mm')} and ends at ${interviewEndTimeMoment
+          .format('MMM DD YYYY HH:mm')}`
+      })
+    } catch (err) {
+      logger.logFullError(err, { component: 'InterviewService', context: 'partiallyUpdateInterviewByWebhook' })
+      throw new errors.BadRequestError(`Could not update interview: ${err.message}`)
+    }
+
+    return updatedInterview
+  }
 }
 
 module.exports = {

src/services/NotificationsSchedulerService.js

@@ -13,7 +13,8 @@ const ResourceBooking = models.ResourceBooking
 const helper = require('../common/helper')
 const constants = require('../../app-constants')
 const logger = require('../common/logger')
-const { processUpdateInterview } = require('../esProcessors/InterviewProcessor')
+const { getAuditM2Muser } = require('../common/helper')
+const interviewService = require('./InterviewService')
 
 const localLogger = {
   debug: (message, context) => logger.debug({ component: 'NotificationSchedulerService', context, message }),
@@ -655,17 +656,6 @@ async function sendInterviewScheduleReminderNotifications () {
   localLogger.debug(`[sendInterviewScheduleReminderNotifications]: Sent notifications for ${interviewCount} interviews which need to schedule.`)
 }
 
-/**
- * Update interview status by id and jobCandidateId
- * @param {*} entity interview entity
- */
-async function updateInterviewStatus (entity) {
-  const interviewOldValue = await Interview.findById(entity.id)
-  await Interview.update({ status: entity.status }, { where: { id: entity.id } })
-  await processUpdateInterview(entity)
-  await helper.postEvent(config.TAAS_INTERVIEW_UPDATE_TOPIC, entity, { oldValue: interviewOldValue.toJSON() })
-}
-
 // Send notifications to customer and candidate this interview has expired
 async function sendInterviewExpiredNotifications () {
   localLogger.debug('[sendInterviewExpiredNotifications]: Looking for due records...')
@@ -705,7 +695,17 @@ async function sendInterviewExpiredNotifications () {
   const templateGuest = 'taas.notification.interview-expired-guest'
 
   for (const interview of interviews) {
-    await updateInterviewStatus({ status: constants.Interviews.Status.Expired, id: interview.id, jobCandidateId: interview.jobCandidateId })
+    // this method is run by the app itself
+    const m2mUser = getAuditM2Muser()
+
+    await interviewService.partiallyUpdateInterviewById(
+      m2mUser,
+      interview.id,
+      {
+        status: constants.Interviews.Status.Expired
+      }
+    )
+
     // send host email
     const data = await getDataForInterview(interview)
     if (!data) { continue }
@@ -762,7 +762,6 @@ module.exports = {
   sendInterviewCompletedNotifications: errorCatchWrapper(sendInterviewCompletedNotifications, 'sendInterviewCompletedNotifications'),
   sendInterviewExpiredNotifications: errorCatchWrapper(sendInterviewExpiredNotifications, 'sendInterviewExpiredNotifications'),
   sendInterviewScheduleReminderNotifications: errorCatchWrapper(sendInterviewScheduleReminderNotifications, 'sendInterviewScheduleReminderNotifications'),
-  updateInterviewStatus,
   getDataForInterview,
   sendPostInterviewActionNotifications: errorCatchWrapper(sendPostInterviewActionNotifications, 'sendPostInterviewActionNotifications'),
   sendResourceBookingExpirationNotifications: errorCatchWrapper(sendResourceBookingExpirationNotifications, 'sendResourceBookingExpirationNotifications')

src/services/NylasWebhookService.js

@@ -10,7 +10,8 @@ const axios = require('axios')
 const moment = require('moment')
 
 const logger = require('../common/logger')
-const { updateInterviewStatus } = require('./NotificationsSchedulerService')
+const { partiallyUpdateInterviewById } = require('./InterviewService')
+const { getAuditM2Muser } = require('../common/helper')
 
 const localLogger = {
   debug: (message, context) =>
@@ -123,34 +124,22 @@ async function processFormattedEvent (webhookData, event) {
     }
   })
 
-  if (webhookData.type === EVENTTYPES.CREATED && event.status === 'confirmed') {
-    // CREATED + confirmed ==> inteview updated to scheduled
-    // UPDATED + cancelled ==> inteview expired
-
-    await updateInterviewStatus({
-      status: constants.Interviews.Status.Scheduled,
-      startTimestamp: moment.unix(event.startTime).toDate(),
-      endTimestamp: moment.unix(event.endTime).toDate(),
-      id: interview.id,
-      jobCandidateId: interview.jobCandidateId
-    })
+  // this method is used by the Nylas webhooks, so use M2M user
+  const m2mUser = getAuditM2Muser()
 
-    localLogger.debug(
-      `~~~~~~~~~~~NEW EVENT~~~~~~~~~~~\nInterview Scheduled under account id ${
-        event.accountId
-      } (email is ${event.email}) in calendar id ${
-        event.calendarId
-      }. Event status is ${event.status} and starts from ${moment
-        .unix(event.startTime)
-        .format('MMM DD YYYY HH:mm')} and ends at ${moment
-        .unix(event.endTime)
-        .format('MMM DD YYYY HH:mm')}`
-    )
+  if (webhookData.type === EVENTTYPES.CREATED && event.status === 'confirmed') {
+    localLogger.info('~~~~~~~~~~~NEW EVENT~~~~~~~~~~~\nEvent "Interview Scheduled" being processed by method InterviewService.partiallyUpdateInterviewByWebhook')
   } else if (
     webhookData.type === EVENTTYPES.UPDATED &&
     event.status === 'cancelled'
   ) {
-    await updateInterviewStatus({ status: constants.Interviews.Status.Cancelled, id: interview.id, jobCandidateId: interview.jobCandidateId })
+    await partiallyUpdateInterviewById(
+      m2mUser,
+      interview.id,
+      {
+        status: constants.Interviews.Status.Cancelled
+      }
+    )
 
     localLogger.debug(
       `~~~~~~~~~~~NEW EVENT~~~~~~~~~~~\nInterview cancelled under account id ${