feat: add interview scheduler

1. Add Sequelize schema for Interview model.
2. Add `create-interviews-table` migration.
3. Add ES mapping for interviews.
4. Update existing index/re-index, and import/export scripts for the applied changes.
5. Add/implement the following endpoints.
  * `PATCH /jobCandidates/:jobCandidateId/requestInterview`
  * `PATCH /jobCandidates/:jobCandidateId/updateInterview/:round`
  * `GET /jobCandidates/:jobCandidateId/interviews`
  * `GET /jobCandidates/:jobCandidateId/interviews/:round`
6. Update the existing JobCandidate endpoints for applied changes.
7. Set up an hourly scheduled job to check & update Completed interviews.
8. Update `TeamService.sendEmail` for the interview scheduling feature.
9. Update POSTMAN collection & environment.
10. Update Swagger.

Author: cagdas001

README.md

@@ -34,7 +34,9 @@
       AUTH0_AUDIENCE_UBAHN=
       AUTH0_CLIENT_ID=
       AUTH0_CLIENT_SECRET=
-
+      # necessary if you'll utilize email functionality of interviews
+      INTERVIEW_INVITATION_SENDGRID_TEMPLATE_ID=
+      INTERVIEW_INVITATION_SENDER_EMAIL=
       # Locally deployed services (via docker-compose)
       ES_HOST=dockerhost:9200
       DATABASE_URL=postgres://postgres:postgres@dockerhost:5432/postgres

app-constants.js

@@ -39,11 +39,33 @@ const Scopes = {
   CREATE_WORK_PERIOD: 'create:taas-workPeriods',
   UPDATE_WORK_PERIOD: 'update:taas-workPeriods',
   DELETE_WORK_PERIOD: 'delete:taas-workPeriods',
-  ALL_WORK_PERIOD: 'all:taas-workPeriods'
+  ALL_WORK_PERIOD: 'all:taas-workPeriods',
+  // interview
+  READ_INTERVIEW: 'read:taas-interviews',
+  CREATE_INTERVIEW: 'create:taas-interviews',
+  UPDATE_INTERVIEW: 'update:taas-interviews',
+  ALL_INTERVIEW: 'all:taas-interviews'
+}
+
+// Interview related constants
+const Interviews = {
+  Status: {
+    Scheduling: 'Scheduling',
+    Scheduled: 'Scheduled',
+    RequestedForReschedule: 'Requested for reschedule',
+    Rescheduled: 'Rescheduled',
+    Completed: 'Completed',
+    Cancelled: 'Cancelled'
+  },
+  XaiTemplate: {
+    '30MinInterview': '30-min-interview',
+    '60MinInterview': '60-min-interview'
+  }
 }
 
 module.exports = {
   UserRoles,
   FullManagePermissionRoles,
-  Scopes
+  Scopes,
+  Interviews
 }

app.js

@@ -9,8 +9,10 @@ const express = require('express')
 const cors = require('cors')
 const HttpStatus = require('http-status-codes')
 const interceptor = require('express-interceptor')
+const schedule = require('node-schedule')
 const logger = require('./src/common/logger')
 const eventHandlers = require('./src/eventHandlers')
+const interviewService = require('./src/services/InterviewService')
 
 // setup express app
 const app = express()
@@ -93,6 +95,8 @@ app.use((err, req, res, next) => {
 const server = app.listen(app.get('port'), () => {
   logger.info({ component: 'app', message: `Express server listening on port ${app.get('port')}` })
   eventHandlers.init()
+  // schedule updateCompletedInterviews to run every hour
+  schedule.scheduleJob('0 0 * * * *', interviewService.updateCompletedInterviews)
 })
 
 if (process.env.NODE_ENV === 'test') {

config/default.js

@@ -119,6 +119,13 @@ module.exports = {
   TAAS_WORK_PERIOD_UPDATE_TOPIC: process.env.TAAS_WORK_PERIOD_UPDATE_TOPIC || 'taas.workperiod.update',
   // the delete work period entity Kafka message topic
   TAAS_WORK_PERIOD_DELETE_TOPIC: process.env.TAAS_WORK_PERIOD_DELETE_TOPIC || 'taas.workperiod.delete',
+  // topics for interview service
+  // the request interview Kafka message topic
+  TAAS_INTERVIEW_REQUEST_TOPIC: process.env.TAAS_INTERVIEW_REQUEST_TOPIC || 'taas.interview.requested',
+  // the interview update Kafka message topic
+  TAAS_INTERVIEW_UPDATE_TOPIC: process.env.TAAS_INTERVIEW_UPDATE_TOPIC || 'taas.interview.update',
+  // the interview bulk update Kafka message topic
+  TAAS_INTERVIEW_BULK_UPDATE_TOPIC: process.env.TAAS_INTERVIEW_BULK_UPDATE_TOPIC || 'taas.interview.bulkUpdate',
 
   // the Kafka message topic for sending email
   EMAIL_TOPIC: process.env.EMAIL_TOPIC || 'external.action.email',
@@ -128,10 +135,18 @@ module.exports = {
   // the emails address for receiving the issue report
   // REPORT_ISSUE_EMAILS may contain comma-separated list of email which is converted to array
   REQUEST_EXTENSION_EMAILS: (process.env.REQUEST_EXTENSION_EMAILS || '').split(','),
+  // the emails address for interview invitation
+  // INTERVIEW_INVITATION_CC_LIST may contain comma-separated list of email which is converted to array
+  // scheduler@x.ai should be in the CC list
+  INTERVIEW_INVITATION_CC_LIST: (process.env.INTERVIEW_INVITATION_CC_LIST || 'scheduler@x.ai').split(','),
   // SendGrid email template ID for reporting issue
   REPORT_ISSUE_SENDGRID_TEMPLATE_ID: process.env.REPORT_ISSUE_SENDGRID_TEMPLATE_ID,
   // SendGrid email template ID for requesting extension
   REQUEST_EXTENSION_SENDGRID_TEMPLATE_ID: process.env.REQUEST_EXTENSION_SENDGRID_TEMPLATE_ID,
+  // SendGrid email template ID for interview invitation
+  INTERVIEW_INVITATION_SENDGRID_TEMPLATE_ID: process.env.INTERVIEW_INVITATION_SENDGRID_TEMPLATE_ID,
+  // The sender (aka `from`) email for invitation.
+  INTERVIEW_INVITATION_SENDER_EMAIL: process.env.INTERVIEW_INVITATION_SENDER_EMAIL,
   // the URL where TaaS App is hosted
   TAAS_APP_URL: process.env.TAAS_APP_URL || 'https://platform.topcoder-dev.com/taas/myteams'
 }

config/email_template.config.js

@@ -59,5 +59,29 @@ module.exports = {
          '{{text}}',
     recipients: config.REPORT_ISSUE_EMAILS,
     sendgridTemplateId: config.REQUEST_EXTENSION_SENDGRID_TEMPLATE_ID
+  },
+
+  /* Request interview for a job candidate
+   *
+   * - interviewType: the x.ai interview type. Example: "30-min-interview"
+   * - candidateName: Full name of candidate. Example: "John Doe"
+   * - jobName: The title of the job. Example: "TaaS API Misc Updates"
+   * - customMessage: if it's needed, a custom message can be added to the end of email. Example: "I would like to invite you for an interview..."
+   *
+   * Template (defined in SendGrid):
+   * Subject: '/{{interviewType}} tech interview with {{candidateName}} for {{jobName}} is requested by the Customer'
+   * Body:
+   * 'The customer has requested /{{interviewType}} with {{candidateName}} for {{jobName}}.'
+   * + 'In a few minutes you will receive an invitation from our scheduling tool. Please proceed with the invitation to agree on timing.'
+   * + '<br /><br />{{customMessage}}'
+   *
+   * Note, that the template should be defined in SendGrid.
+   * The subject & body above (identical to actual SendGrid template) is for reference purposes.
+   * We won't pass subject & body but only substitutions (replacements in template subject/body).
+   */
+  'interview-invitation': {
+    from: config.INTERVIEW_INVITATION_SENDER_EMAIL,
+    cc: config.INTERVIEW_INVITATION_CC_LIST,
+    sendgridTemplateId: config.INTERVIEW_INVITATION_SENDGRID_TEMPLATE_ID
   }
 }