Send Weekly Surveys

Author: yoution

app.js

@@ -14,6 +14,7 @@ const logger = require('./src/common/logger')
 const eventHandlers = require('./src/eventHandlers')
 const interviewService = require('./src/services/InterviewService')
 const { processScheduler } = require('./src/services/PaymentSchedulerService')
+const { sendSurveys } = require('./src/services/SurveyService')
 
 // setup express app
 const app = express()
@@ -98,7 +99,8 @@ const server = app.listen(app.get('port'), () => {
   eventHandlers.init()
   // schedule updateCompletedInterviews to run every hour
   schedule.scheduleJob('0 0 * * * *', interviewService.updateCompletedInterviews)
-
+  // schedule sendSurveys
+  schedule.scheduleJob(config.WEEKLY_SURVEY.CRON, sendSurveys)
   // schedule payment processing
   schedule.scheduleJob(config.PAYMENT_PROCESSING.CRON, processScheduler)
 })

config/default.js

@@ -180,6 +180,16 @@ module.exports = {
   INTERNAL_MEMBER_GROUPS: process.env.INTERNAL_MEMBER_GROUPS || ['20000000', '20000001', '20000003', '20000010', '20000015'],
   // Topcoder skills cache time in minutes
   TOPCODER_SKILLS_CACHE_TIME: process.env.TOPCODER_SKILLS_CACHE_TIME || 60,
+  // weekly survey scheduler config
+  WEEKLY_SURVEY: {
+    CRON: process.env.WEEKLY_SURVEY_CRON || '0 1 * * 7',
+    BASE_URL: process.env.WEEKLY_SURVEY_BASE_URL || 'https://api.surveymonkey.net/v3/surveys',
+    JWT_TOKEN: process.env.WEEKLY_SURVEY_JWT_TOKEN || '',
+    SURVEY_ID: process.env.WEEKLY_SURVEY_SURVEY_ID || '',
+    SURVEY_MASTER_COLLECTOR_ID: process.env.WEEKLY_SURVEY_SURVEY_MASTER_COLLECTOR_ID || '',
+    SURVEY_MASTER_MESSAGE_ID: process.env.WEEKLY_SURVEY_SURVEY_MASTER_MESSAGE_ID || '',
+    SURVEY_CONTACT_GROUP_ID: process.env.WEEKLY_SURVEY_SURVEY_CONTACT_GROUP_ID || ''
+  },
   // payment scheduler config
   PAYMENT_PROCESSING: {
     // switch off actual API calls in Payment Scheduler

docs/swagger.yaml

@@ -4470,6 +4470,10 @@ components:
           format: float
           example: 13
           description: "The member rate."
+        sendWeeklySurvey:
+          type: boolean
+          example: true,
+          description: "whether we should send weekly survey to this ResourceBooking or no"
         customerRate:
           type: integer
           format: float
@@ -4527,6 +4531,10 @@ components:
           format: uuid
           example: "a55fe1bc-1754-45fa-9adc-cf3d6d7c377a"
           description: "The external id."
+        sendWeeklySurvey:
+          type: boolean
+          example: true,
+          description: "whether we should send weekly survey to this ResourceBooking or no"
         jobId:
           type: string
           format: uuid
@@ -4584,6 +4592,10 @@ components:
           format: float
           example: 13.23
           description: "The member rate."
+        sendWeeklySurvey:
+          type: boolean
+          example: true,
+          description: "whether we should send weekly survey to this ResourceBooking or no"
         customerRate:
           type: number
           format: float
@@ -4620,6 +4632,22 @@ components:
           type: string
           format: uuid
           description: "The resource booking id."
+        sentSurvey:
+          type: boolean
+          example: true
+          description: "whether we've already sent a survey for this WorkPeriod of no"
+        sentSurveyError:
+          description: "error details if error happened during sending survey"
+          type: object
+          properties:
+            errorMessage:
+              type: string
+              example: "error message"
+              description: "The error message"
+            errorCode:
+              type: integer
+              example: 429
+              description: "HTTP code of error"
         userHandle:
           type: string
           example: "eisbilir"
@@ -4695,6 +4723,22 @@ components:
           type: integer
           example: 2
           description: "The count of the days worked for that work period."
+        sentSurvey:
+          type: boolean
+          example: true
+          description: "whether we've already sent a survey for this WorkPeriod of no"
+        sentSurveyError:
+          description: "error details if error happened during sending survey"
+          type: object
+          properties:
+            errorMessage:
+              type: string
+              example: "error message"
+              description: "The error message"
+            errorCode:
+              type: integer
+              example: 429
+              description: "HTTP code of error"
     WorkPeriodPayment:
       required:
         - id

migrations/2021-07-26-add-send-weekly-survery-fields.js

@@ -0,0 +1,43 @@
+const config = require('config')
+
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    const transaction = await queryInterface.sequelize.transaction()
+    try {
+      await queryInterface.addColumn({ tableName: 'resource_bookings', schema: config.DB_SCHEMA_NAME }, 'send_weekly_survey',
+        { type: Sequelize.BOOLEAN, allowNull: false, defaultValue: true },
+        { transaction })
+      await queryInterface.addColumn({ tableName: 'work_periods', schema: config.DB_SCHEMA_NAME }, 'sent_survey',
+        { type: Sequelize.BOOLEAN, allowNull: false, defaultValue: false },
+        { transaction })
+      await queryInterface.addColumn({ tableName: 'work_periods', schema: config.DB_SCHEMA_NAME }, 'sent_survey_error',
+        {
+          type: Sequelize.JSONB({
+            errorCode: {
+              field: 'error_code',
+              type: Sequelize.INTEGER,
+            },
+            errorMessage: {
+              field: 'error_message',
+              type: Sequelize.STRING(255)
+            },
+          }), allowNull: true }, { transaction })
+      await transaction.commit()
+    } catch (err) {
+      await transaction.rollback()
+      throw err
+    }
+  },
+  down: async (queryInterface, Sequelize) => {
+    const transaction = await queryInterface.sequelize.transaction()
+    try {
+      await queryInterface.removeColumn({ tableName: 'resource_bookings', schema: config.DB_SCHEMA_NAME }, 'send_weekly_survey', { transaction })
+      await queryInterface.removeColumn({ tableName: 'work_periods', schema: config.DB_SCHEMA_NAME }, 'send_survey', { transaction })
+      await queryInterface.removeColumn({ tableName: 'work_periods', schema: config.DB_SCHEMA_NAME }, 'sent_survey_error', { transaction } )
+      await transaction.commit()
+    } catch (err) {
+      await transaction.rollback()
+      throw err
+    }
+  },
+}

package.json

@@ -19,6 +19,7 @@
     "index:roles": "node scripts/es/reIndexRoles.js",
     "data:export": "node scripts/data/exportData.js",
     "data:import": "node scripts/data/importData.js",
+    "data:workperiod": "node scripts/data/updateWorkPeriodSentSurveyField.js",
     "migrate": "npx sequelize db:migrate",
     "migrate:undo": "npx sequelize db:migrate:undo",
     "test": "mocha test/unit/*.test.js --timeout 30000 --require test/prepare.js --exit",

scripts/data/updateWorkPeriodSentSurveyField.js

@@ -0,0 +1,68 @@
+/*
+ * update WorkPeriod field `sentSurvey=true`
+ */
+const _ = require('lodash')
+const moment = require('moment')
+const logger = require('../../src/common/logger')
+const { Op } = require('sequelize')
+const models = require('../../src/models')
+
+const ResourceBooking = models.ResourceBooking
+const WorkPeriod = models.WorkPeriod
+
+async function updateWorkPeriod () {
+  const transaction = await models.sequelize.transaction()
+  try {
+    // Start a transaction
+    const queryCriteria = {
+      attributes: ['sendWeeklySurvey', 'id'],
+      include: [{
+        as: 'workPeriods',
+        model: WorkPeriod,
+        required: true,
+        where: {
+          [Op.and]: [
+            { sentSurveyError: null },
+            { sentSurvey: false },
+            { paymentStatus: ['completed'] },
+            { endDate: { [Op.lte]: moment().subtract(7, 'days').format('YYYY-MM-DD') } }
+          ]
+        }
+      }],
+      where: {
+        [Op.and]: [{ sendWeeklySurvey: true }]
+      },
+      transaction
+    }
+
+    const resourceBookings = await ResourceBooking.findAll(queryCriteria)
+
+    _.forEach(resourceBookings, r => {
+      _.forEach(r.workPeriods, async w => {
+        // await w.update({sentSurvey: true}, {transaction: transaction} )
+        await w.update({ sentSurvey: true })
+      })
+    })
+
+    // commit transaction only if all things went ok
+    logger.info({
+      component: 'importData',
+      message: 'committing transaction to database...'
+    })
+    await transaction.commit()
+  } catch (error) {
+    // logger.error({
+    //   component: 'importData',
+    //   message: `Error while writing data of model: WorkPeriod`
+    // })
+    // rollback all insert operations
+    if (transaction) {
+      logger.info({
+        component: 'importData',
+        message: 'rollback database transaction...'
+      })
+      transaction.rollback()
+    }
+  }
+}
+updateWorkPeriod()

src/common/helper.js

@@ -176,6 +176,7 @@ esIndexPropertyMapping[config.get('esConfig.ES_INDEX_RESOURCE_BOOKING')] = {
   endDate: { type: 'date', format: 'yyyy-MM-dd' },
   memberRate: { type: 'float' },
   customerRate: { type: 'float' },
+  sendWeeklySurvey: { type: 'boolean' },
   rateType: { type: 'keyword' },
   billingAccountId: { type: 'integer', null_value: 0 },
   workPeriods: {
@@ -189,6 +190,14 @@ esIndexPropertyMapping[config.get('esConfig.ES_INDEX_RESOURCE_BOOKING')] = {
       },
       projectId: { type: 'integer' },
       userId: { type: 'keyword' },
+      sentSurvey: { type: 'boolean' },
+      sentSurveyError: {
+        type: 'nested',
+        properties: {
+          errorCode: { type: 'integer' },
+          errorMessage: { type: 'keyword' }
+        }
+      },
       startDate: { type: 'date', format: 'yyyy-MM-dd' },
       endDate: { type: 'date', format: 'yyyy-MM-dd' },
       daysWorked: { type: 'integer' },
@@ -2012,6 +2021,7 @@ async function getMembersSuggest (fragment) {
 }
 
 module.exports = {
+  encodeQueryString,
   getParamFromCliArgs,
   promptUser,
   sleep,