Batch Payments - Part 1 - Scheduler

Author: xxcxy

README.md

@@ -202,6 +202,7 @@ To be able to change and test `taas-es-processor` locally you can follow the nex
 | `npm run cov`                                                                                                             | Code Coverage Report.                                                                                                                              |
 | `npm run migrate`                                                                                                         | Run any migration files which haven't run yet.                                                                                                     |
 | `npm run migrate:undo`                                                                                                    | Revert most recent migration.                                                                                                                      |
+| `npm run demo-payment-scheduler`                                                                                          | Create 1000 Work Periods Payment records in with status "scheduled" and various "amount"                                                                         |
 
 ## Import and Export data
 

app-constants.js

@@ -76,6 +76,14 @@ const ChallengeStatus = {
   COMPLETED: 'Completed'
 }
 
+const WorkPeriodPaymentStatus = {
+  COMPLETED: 'completed',
+  SCHEDULED: 'scheduled',
+  IN_PROGRESS: 'in-progress',
+  FAILED: 'failed',
+  CANCELLED: 'cancelled'
+}
+
 const PaymentProcessingSwitch = {
   ON: 'ON',
   OFF: 'OFF'
@@ -87,5 +95,6 @@ module.exports = {
   Scopes,
   Interviews,
   ChallengeStatus,
+  WorkPeriodPaymentStatus,
   PaymentProcessingSwitch
 }

app.js

@@ -13,6 +13,7 @@ const schedule = require('node-schedule')
 const logger = require('./src/common/logger')
 const eventHandlers = require('./src/eventHandlers')
 const interviewService = require('./src/services/InterviewService')
+const { processScheduler } = require('./src/services/PaymentSchedulerService')
 
 // setup express app
 const app = express()
@@ -97,6 +98,9 @@ const server = app.listen(app.get('port'), () => {
   eventHandlers.init()
   // schedule updateCompletedInterviews to run every hour
   schedule.scheduleJob('0 0 * * * *', interviewService.updateCompletedInterviews)
+
+  // schedule payment processing
+  schedule.scheduleJob(config.PAYMENT_PROCESSING.CRON, processScheduler)
 })
 
 if (process.env.NODE_ENV === 'test') {

config/default.js

@@ -162,5 +162,38 @@ module.exports = {
   DEFAULT_TIMELINE_TEMPLATE_ID: process.env.DEFAULT_TIMELINE_TEMPLATE_ID || '53a307ce-b4b3-4d6f-b9a1-3741a58f77e6',
   DEFAULT_TRACK_ID: process.env.DEFAULT_TRACK_ID || '9b6fc876-f4d9-4ccb-9dfd-419247628825',
 
-  PAYMENT_PROCESSING_SWITCH: process.env.PAYMENT_PROCESSING_SWITCH || 'OFF'
+  PAYMENT_PROCESSING: {
+    // switch off actual API calls in Payment Scheduler
+    SWITCH: process.env.PAYMENT_PROCESSING_SWITCH || 'OFF',
+    // the payment scheduler cron config
+    CRON: process.env.PAYMENT_PROCESSING_CRON || '0 */5 * * * *',
+    // the number of records processed by one time
+    BATCH_SIZE: parseInt(process.env.PAYMENT_PROCESSING_BATCH_SIZE || 50),
+    // in-progress expired to determine whether a record has been processed abnormally, moment duration format
+    IN_PROGRESS_EXPIRED: process.env.IN_PROGRESS_EXPIRED || 'PT1H',
+    // the number of max retry config
+    MAX_RETRY_COUNT: parseInt(process.env.PAYMENT_PROCESSING_MAX_RETRY_COUNT || 10),
+    // the time of retry base delay, unit: ms
+    RETRY_BASE_DELAY: parseInt(process.env.PAYMENT_PROCESSING_RETRY_BASE_DELAY || 100),
+    // the time of retry max delay, unit: ms
+    RETRY_MAX_DELAY: parseInt(process.env.PAYMENT_PROCESSING_RETRY_MAX_DELAY || 10000),
+    // the max time of one request, unit: ms
+    PER_REQUEST_MAX_TIME: parseInt(process.env.PAYMENT_PROCESSING_PER_REQUEST_MAX_TIME || 30000),
+    // the max time of one payment record, unit: ms
+    PER_PAYMENT_MAX_TIME: parseInt(process.env.PAYMENT_PROCESSING_PER_PAYMENT_MAX_TIME || 60000),
+    // the max records of payment of a minute
+    PER_MINUTE_PAYMENT_MAX_COUNT: parseInt(process.env.PAYMENT_PROCESSING_PER_MINUTE_PAYMENT_MAX_COUNT || 12),
+    // the max requests of challenge of a minute
+    PER_MINUTE_CHALLENGE_REQUEST_MAX_COUNT: parseInt(process.env.PAYMENT_PROCESSING_PER_MINUTE_CHALLENGE_REQUEST_MAX_COUNT || 60),
+    // the max requests of resource of a minute
+    PER_MINUTE_RESOURCE_REQUEST_MAX_COUNT: parseInt(process.env.PAYMENT_PROCESSING_PER_MINUTE_CHALLENGE_REQUEST_MAX_COUNT || 20),
+    // the default step fix delay, unit: ms
+    FIX_DELAY_STEP: parseInt(process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP || 500),
+    // the fix delay between step one and step two, unit: ms
+    FIX_DELAY_STEP_1_2: parseInt(process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP_1_2 || process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP || 500),
+    // the fix delay between step two and step three, unit: ms
+    FIX_DELAY_STEP_2_3: parseInt(process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP_2_3 || process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP || 500),
+    // the fix delay between step three and step four, unit: ms
+    FIX_DELAY_STEP_3_4: parseInt(process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP_3_4 || process.env.PAYMENT_PROCESSING_FIX_DELAY_STEP || 500)
+  }
 }

data/demo-data.json

@@ -182,12 +182,12 @@
                 {
                     "id": "077aa2ca-5b60-4ad9-a965-1b37e08a5046",
                     "jobCandidateId": "881a19de-2b0c-4bb9-b36a-4cb5e223bdb5",
-                    "googleCalendarId": null,
+                    "calendarEventId": null,
                     "customMessage": null,
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 1,
                     "startTimestamp": null,
-                    "attendeesList": null,
+                    "guestEmails": null,
                     "status": "Completed",
                     "createdBy": "57646ff9-1cd3-4d3c-88ba-eb09a395366c",
                     "updatedBy": null,
@@ -211,12 +211,12 @@
                 {
                     "id": "b1f7ba76-640f-47e2-9463-59e51b51ec60",
                     "jobCandidateId": "827ee401-df04-42e1-abbe-7b97ce7937ff",
-                    "googleCalendarId": "dummyId",
+                    "calendarEventId": "dummyId",
                     "customMessage": "This is a custom message",
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 2,
                     "startTimestamp": null,
-                    "attendeesList": null,
+                    "guestEmails": null,
                     "status": "Scheduling",
                     "createdBy": "57646ff9-1cd3-4d3c-88ba-eb09a395366c",
                     "updatedBy": null,
@@ -226,12 +226,12 @@
                 {
                     "id": "3144fa65-ea1a-4bec-81b0-7cb1c8845826",
                     "jobCandidateId": "827ee401-df04-42e1-abbe-7b97ce7937ff",
-                    "googleCalendarId": null,
+                    "calendarEventId": null,
                     "customMessage": null,
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 1,
                     "startTimestamp": null,
-                    "attendeesList": null,
+                    "guestEmails": null,
                     "status": "Completed",
                     "createdBy": "57646ff9-1cd3-4d3c-88ba-eb09a395366c",
                     "updatedBy": null,
@@ -255,12 +255,12 @@
                 {
                     "id": "976d23a9-5710-453f-99d9-f57a588bb610",
                     "jobCandidateId": "a4ea7bcf-5b99-4381-b99c-a9bd05d83a36",
-                    "googleCalendarId": "dummyId",
+                    "calendarEventId": "dummyId",
                     "customMessage": "This is a custom message",
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 3,
                     "startTimestamp": null,
-                    "attendeesList": [
+                    "guestEmails": [
                         "[email protected]",
                         "[email protected]"
                     ],
@@ -273,12 +273,12 @@
                 {
                     "id": "a23e1bf2-1084-4cfe-a0d8-d83bc6fec655",
                     "jobCandidateId": "a4ea7bcf-5b99-4381-b99c-a9bd05d83a36",
-                    "googleCalendarId": "dummyId",
+                    "calendarEventId": "dummyId",
                     "customMessage": "This is a custom message",
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 2,
                     "startTimestamp": null,
-                    "attendeesList": [
+                    "guestEmails": [
                         "[email protected]",
                         "[email protected]"
                     ],
@@ -291,12 +291,12 @@
                 {
                     "id": "9efd72c3-1dc7-4ce2-9869-8cca81d0adeb",
                     "jobCandidateId": "a4ea7bcf-5b99-4381-b99c-a9bd05d83a36",
-                    "googleCalendarId": null,
+                    "calendarEventId": null,
                     "customMessage": null,
-                    "xaiTemplate": "interview-30",
+                    "templateUrl": "interview-30",
                     "round": 1,
                     "startTimestamp": null,
-                    "attendeesList": null,
+                    "guestEmails": null,
                     "status": "Completed",
                     "createdBy": "57646ff9-1cd3-4d3c-88ba-eb09a395366c",
                     "updatedBy": null,

docs/swagger.yaml

@@ -2380,7 +2380,7 @@ paths:
           required: false
           schema:
             type: string
-            enum: ["completed", "cancelled"]
+            enum: ["completed", "scheduled", "in-progress", "failed", "cancelled"]
           description: The payment status.
       responses:
         "200":
@@ -4211,8 +4211,22 @@ components:
           description: "The amount to be paid."
         status:
           type: string
-          enum: ["completed", "cancelled"]
+          enum: ["completed", "scheduled", "in-progress", "failed", "cancelled"]
           description: "The payment status."
+        statusDetails:
+          type: object
+          properties:
+            errorMessage:
+              type: string
+            errorCode:
+              type: integer
+            retry:
+              type: integer
+            step:
+              type: string
+            challengeId:
+              type: string
+              format: uuid
         billingAccountId:
           type: integer
           example: 80000071
@@ -4247,7 +4261,7 @@ components:
           description: "The amount to be paid."
         status:
           type: string
-          enum: ["completed", "cancelled"]
+          enum: ["completed", "scheduled", "in-progress", "failed", "cancelled"]
           description: "The payment status."
     WorkPeriodPaymentPatchRequestBody:
       properties:
@@ -4261,7 +4275,7 @@ components:
           description: "The amount to be paid."
         status:
           type: string
-          enum: ["completed", "cancelled"]
+          enum: ["completed", "scheduled", "in-progress", "failed", "cancelled"]
           description: "The payment status."
     CheckRun:
       type: object

migrations/2021-05-29-create-payment-scheduler-table-add-status-details-to-payment.js

@@ -0,0 +1,109 @@
+'use strict';
+
+const config = require('config')
+const _ = require('lodash')
+
+/**
+ * Create `payment_schedulers` table & relations.
+ */
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    const transaction = await queryInterface.sequelize.transaction()
+    try { 
+      await queryInterface.createTable('payment_schedulers', {
+        id: {
+          type: Sequelize.UUID,
+          primaryKey: true,
+          allowNull: false,
+          defaultValue: Sequelize.UUIDV4
+        },
+        challengeId: {
+          field: 'challenge_id',
+          type: Sequelize.UUID,
+          allowNull: false
+        },
+        workPeriodPaymentId: {
+          field: 'work_period_payment_id',
+          type: Sequelize.UUID,
+          allowNull: false,
+          references: {
+            model: {
+              tableName: 'work_period_payments',
+              schema: config.DB_SCHEMA_NAME
+            },
+            key: 'id'
+          }
+        },
+        step: {
+          type: Sequelize.INTEGER,
+          allowNull: false
+        },
+        status: {
+          type: Sequelize.ENUM(
+            'in-progress',
+            'completed',
+            'failed'
+          ),
+          allowNull: false
+        },
+        userId: {
+          field: 'user_id',
+          type: Sequelize.BIGINT
+        },
+        userHandle: {
+          field: 'user_handle',
+          type: Sequelize.STRING,
+          allowNull: false
+        },
+        createdAt: {
+          field: 'created_at',
+          type: Sequelize.DATE
+        },
+        updatedAt: {
+          field: 'updated_at',
+          type: Sequelize.DATE
+        },
+        deletedAt: {
+          field: 'deleted_at',
+          type: Sequelize.DATE
+        }
+      }, { schema: config.DB_SCHEMA_NAME, transaction })
+      await queryInterface.addColumn({ tableName: 'work_period_payments', schema: config.DB_SCHEMA_NAME }, 'status_details',
+        { type: Sequelize.JSONB },
+        { transaction })
+      await queryInterface.changeColumn({ tableName: 'work_period_payments', schema: config.DB_SCHEMA_NAME }, 'challenge_id',
+        { type: Sequelize.UUID },
+        { transaction })
+      await queryInterface.sequelize.query(`ALTER TYPE ${config.DB_SCHEMA_NAME}.enum_work_period_payments_status ADD VALUE 'scheduled'`)
+      await queryInterface.sequelize.query(`ALTER TYPE ${config.DB_SCHEMA_NAME}.enum_work_period_payments_status ADD VALUE 'in-progress'`)
+      await queryInterface.sequelize.query(`ALTER TYPE ${config.DB_SCHEMA_NAME}.enum_work_period_payments_status ADD VALUE 'failed'`)
+      await transaction.commit()
+    } catch (err) {
+      await transaction.rollback()
+      throw err
+    }
+  },
+
+  down: async (queryInterface, Sequelize) => {
+    const table = { schema: config.DB_SCHEMA_NAME, tableName: 'payment_schedulers' }
+    const statusTypeName = `${table.schema}.enum_${table.tableName}_status`
+    const transaction = await queryInterface.sequelize.transaction()
+    try {
+      await queryInterface.dropTable(table, { transaction })
+      // drop enum type for status column
+      await queryInterface.sequelize.query(`DROP TYPE ${statusTypeName}`, { transaction })
+
+      await queryInterface.changeColumn({ tableName: 'work_period_payments', schema: config.DB_SCHEMA_NAME }, 'challenge_id',
+        { type: Sequelize.UUID, allowNull: false },
+        { transaction })
+      await queryInterface.removeColumn({ tableName: 'work_period_payments', schema: config.DB_SCHEMA_NAME }, 'status_details',
+        { transaction })
+      await queryInterface.sequelize.query(`DELETE FROM pg_enum WHERE enumlabel in ('scheduled', 'in-progress', 'failed') AND enumtypid = (SELECT oid FROM pg_type WHERE typname = 'enum_work_period_payments_status')`,
+        { transaction })
+      await transaction.commit()
+    } catch (err) {
+      await transaction.rollback()
+      throw err
+    }
+  }
+};

package.json

@@ -26,6 +26,7 @@
     "local:init": "npm run local:reset && npm run data:import -- --force",
     "local:reset": "npm run delete-index -- --force || true && npm run create-index -- --force && npm run init-db force",
     "cov": "nyc --reporter=html --reporter=text npm run test",
+    "demo-payment-scheduler": "node scripts/demo-payment-scheduler/index.js && npm run index:all -- --force",
     "demo-payment": "node scripts/demo-payment"
   },
   "keywords": [],