Merge pull request #211 from imcaizheng/feature/allow-toggle-actual-payments

Add ability to switch on/off actual payments via config

Author: maxceem

app-constants.js

@@ -53,9 +53,15 @@ const ChallengeStatus = {
   COMPLETED: 'Completed'
 }
 
+const PaymentProcessingSwitch = {
+  ON: 'ON',
+  OFF: 'OFF'
+}
+
 module.exports = {
   UserRoles,
   FullManagePermissionRoles,
   Scopes,
-  ChallengeStatus
+  ChallengeStatus,
+  PaymentProcessingSwitch
 }

config/default.js

@@ -148,5 +148,6 @@ module.exports = {
   DEFAULT_TRACK_ID: process.env.DEFAULT_TRACK_ID || '9b6fc876-f4d9-4ccb-9dfd-419247628825',
 
   // default time zone for Work Periods
-  WORK_PERIOD_TIME_ZONE: process.env.WORK_PERIOD_TIME_ZONE || 'America/New_York'
+  WORK_PERIOD_TIME_ZONE: process.env.WORK_PERIOD_TIME_ZONE || 'America/New_York',
+  PAYMENT_PROCESSING_SWITCH: process.env.PAYMENT_PROCESSING_SWITCH || 'OFF'
 }

package.json

@@ -20,13 +20,13 @@
     "data:import": "node scripts/data/importData.js",
     "migrate": "npx sequelize db:migrate",
     "migrate:undo": "npx sequelize db:migrate:undo",
-    "test": "mocha test/unit/*.test.js --timeout 30000 --exit",
+    "test": "mocha test/unit/*.test.js --timeout 30000 --require test/prepare.js --exit",
     "services:up": "docker-compose -f ./local/docker-compose.yml up -d",
     "services:down": "docker-compose -f ./local/docker-compose.yml down",
     "services:logs": "docker-compose -f ./local/docker-compose.yml logs",
     "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 mocha test/unit/*.test.js --timeout 30000 --exit",
+    "cov": "nyc --reporter=html --reporter=text npm run test",
     "demo-payment": "node scripts/demo-payment"
   },
   "keywords": [],
@@ -87,4 +87,4 @@
       "test/unit/**"
     ]
   }
-}
+}

src/bootstrap.js

@@ -2,6 +2,8 @@ const fs = require('fs')
 const Joi = require('joi')
 const path = require('path')
 const logger = require('./common/logger')
+const constants = require('../app-constants')
+const config = require('config')
 
 Joi.page = () => Joi.number().integer().min(1).default(1)
 Joi.perPage = () => Joi.number().integer().min(1).default(20)
@@ -36,3 +38,14 @@ function buildServices (dir) {
 }
 
 buildServices(path.join(__dirname, 'services'))
+
+// validate some configurable parameters for the app
+const paymentProcessingSwitchSchema = Joi.string().label('PAYMENT_PROCESSING_SWITCH').valid(
+  ...Object.values(constants.PaymentProcessingSwitch)
+)
+try {
+  Joi.attempt(config.PAYMENT_PROCESSING_SWITCH, paymentProcessingSwitchSchema)
+} catch (err) {
+  console.error(err.message)
+  process.exit(1)
+}

src/controllers/WorkPeriodPaymentController.js

@@ -3,6 +3,7 @@
  */
 const service = require('../services/WorkPeriodPaymentService')
 const helper = require('../common/helper')
+const config = require('config')
 
 /**
  * Get workPeriodPayment by id
@@ -19,7 +20,7 @@ async function getWorkPeriodPayment (req, res) {
  * @param res the response
  */
 async function createWorkPeriodPayment (req, res) {
-  res.send(await service.createWorkPeriodPayment(req.authUser, req.body))
+  res.send(await service.createWorkPeriodPayment(req.authUser, req.body, { paymentProcessingSwitch: config.PAYMENT_PROCESSING_SWITCH }))
 }
 
 /**

src/services/WorkPeriodPaymentService.js

@@ -12,8 +12,9 @@ const moment = require('moment')
 const helper = require('../common/helper')
 const logger = require('../common/logger')
 const errors = require('../common/errors')
+const constants = require('../../app-constants')
 const models = require('../models')
-const { createPayment } = require('./PaymentService')
+const PaymentService = require('./PaymentService')
 
 const WorkPeriodPayment = models.WorkPeriodPayment
 const esClient = helper.getESClient()
@@ -89,20 +90,21 @@ getWorkPeriodPayment.schema = Joi.object().keys({
  * Create workPeriodPayment
  * @param {Object} currentUser the user who perform this operation
  * @param {Object} workPeriodPayment the workPeriodPayment to be created
+ * @param {Object} options the extra options to control the function
  * @returns {Object} the created workPeriodPayment
  */
-async function createWorkPeriodPayment (currentUser, workPeriodPayment) {
+async function createWorkPeriodPayment (currentUser, workPeriodPayment, options = { paymentProcessingSwitch: 'OFF' }) {
   // check permission
   await _checkUserPermissionForCRUWorkPeriodPayment(currentUser)
 
   const { projectId, userHandle, endDate } = await helper.ensureWorkPeriodById(workPeriodPayment.workPeriodId) // ensure work period exists
-  const paymentChallenge = await createPayment({
+  const paymentChallenge = options.paymentProcessingSwitch === constants.PaymentProcessingSwitch.ON ? (await PaymentService.createPayment({
     projectId,
     userHandle,
     amount: workPeriodPayment.amount,
     name: `TaaS Payment - ${userHandle} - Week Ending ${moment(endDate).format('D/M/YYYY')}`,
     description: `TaaS Payment - ${userHandle} - Week Ending ${moment(endDate).format('D/M/YYYY')}`
-  })
+  })) : ({ id: '00000000-0000-0000-0000-000000000000' })
   workPeriodPayment.id = uuid.v4()
   workPeriodPayment.challengeId = paymentChallenge.id
   workPeriodPayment.createdBy = await helper.getUserId(currentUser.userId)
@@ -128,7 +130,8 @@ createWorkPeriodPayment.schema = Joi.object().keys({
     workPeriodId: Joi.string().uuid().required(),
     amount: Joi.number().greater(0).allow(null),
     status: Joi.workPeriodPaymentStatus().default('completed')
-  }).required()
+  }).required(),
+  options: Joi.object()
 }).required()
 
 /**

test/prepare.js

@@ -0,0 +1,7 @@
+/*
+ * Prepare for tests.
+ */
+
+process.env.NODE_ENV = 'test'
+require('../src/bootstrap')
+require('../src/eventHandlers').init()

test/unit/ResourceBookingService.test.js

@@ -1,6 +1,4 @@
 /* eslint-disable no-unused-expressions */
-process.env.NODE_ENV = 'test'
-require('../../src/bootstrap')
 
 // const _ = require('lodash')
 const expect = require('chai').expect
@@ -10,12 +8,10 @@ const service = require('../../src/services/ResourceBookingService')
 const workPeriodService = require('../../src/services/WorkPeriodService')
 const testData = require('./common/testData')
 const helper = require('../../src/common/helper')
-const eventHandlers = require('../../src/eventHandlers')
 // const esClient = helper.getESClient()
 const busApiClient = helper.getBusApiClient()
 const ResourceBooking = models.ResourceBooking
 const WorkPeriod = models.WorkPeriod
-eventHandlers.init()
 describe('resourceBooking service test', () => {
   let stubEnsureJobById
   let stubEnsureUserById

test/unit/WorkPeriodPaymentService.test.js

@@ -0,0 +1,43 @@
+/* eslint-disable no-unused-expressions */
+
+// const _ = require('lodash')
+const expect = require('chai').expect
+const sinon = require('sinon')
+const models = require('../../src/models')
+const service = require('../../src/services/WorkPeriodPaymentService')
+const paymentService = require('../../src/services/PaymentService')
+const testData = require('./common/testData')
+const helper = require('../../src/common/helper')
+// const esClient = helper.getESClient()
+const busApiClient = helper.getBusApiClient()
+describe('workPeriod service test', () => {
+  beforeEach(() => {
+    sinon.stub(busApiClient, 'postEvent').callsFake(async () => {})
+  })
+
+  afterEach(() => {
+    sinon.restore()
+  })
+
+  describe('create work period test', () => {
+    describe('when PAYMENT_PROCESSING_SWITCH is ON/OFF', async () => {
+      let stubCreatePaymentService
+
+      beforeEach(async () => {
+        sinon.stub(helper, 'ensureWorkPeriodById').callsFake(async () => testData.workPeriodPayment01.ensureWorkPeriodByIdResponse)
+        sinon.stub(helper, 'getUserId').callsFake(async () => {})
+        sinon.stub(models.WorkPeriodPayment, 'create').callsFake(() => testData.workPeriodPayment01.response)
+        stubCreatePaymentService = sinon.stub(paymentService, 'createPayment').callsFake(async () => testData.workPeriodPayment01.createPaymentResponse)
+      })
+
+      it('do not create payment if PAYMENT_PROCESSING_SWITCH is OFF', async () => {
+        await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'OFF' })
+        expect(stubCreatePaymentService.calledOnce).to.be.false
+      })
+      it('create payment if PAYMENT_PROCESSING_SWITCH is ON', async () => {
+        await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
+        expect(stubCreatePaymentService.calledOnce).to.be.true
+      })
+    })
+  })
+})

test/unit/common/testData.js

@@ -496,10 +496,43 @@ resourceBookingUpdate.updateResponse4.toJSON = function () {
 resourceBookingUpdate.response4.update = function () {
   return resourceBookingUpdate.updateResponse4
 }
+
+const workPeriodPayment01 = {
+  request: {
+    workPeriodId: '467b4df7-ced4-41b9-9710-b83808cddaf4',
+    amount: 600,
+    status: 'completed'
+  },
+  response: {
+    workPeriodId: '467b4df7-ced4-41b9-9710-b83808cddaf4',
+    amount: 600,
+    status: 'completed',
+    id: '01971e6f-0f09-4a2a-bc2e-2adac0f00622',
+    challengeId: '00000000-0000-0000-0000-000000000000',
+    createdBy: '57646ff9-1cd3-4d3c-88ba-eb09a395366c',
+    updatedAt: '2021-04-21T12:58:07.535Z',
+    createdAt: '2021-04-21T12:58:07.535Z',
+    updatedBy: null
+  },
+  ensureWorkPeriodByIdResponse: {
+    projectId: 111,
+    userHandle: 'pshah_manager',
+    endDate: '2021-03-13'
+  },
+  createPaymentResponse: {
+    id: 'c65f0cbf-b197-423d-91cc-db6e3bad9075'
+  }
+}
+
+workPeriodPayment01.response.toJSON = function () {
+  return workPeriodPayment01.response
+}
+
 module.exports = {
   currentUser,
   UserTCConnCopilot,
   resourceBooking5Week,
   resourceBooking1Week,
-  resourceBookingUpdate
+  resourceBookingUpdate,
+  workPeriodPayment01
 }