fix daysWorked calculation during automatic WP creation/updates

Author: eisbilir

migrations/2021-04-22-2-populate-work-periods-for-resource-bookings.js

@@ -41,7 +41,7 @@ module.exports = {
               user_handle: user.handle,
               start_date: period.startDate,
               end_date: period.endDate,
-              days_worked: period.daysWorked,
+              days_worked: null,
               payment_status: 'pending',
               created_by: config.m2m.M2M_AUDIT_USER_ID,
               created_at: new Date()

src/common/helper.js

@@ -1260,10 +1260,10 @@ async function createChallengeResource (data, token) {
  * Populates workPeriods from start and end date of resource booking
  * @param {Date} start start date of the resource booking
  * @param {Date} end end date of the resource booking
- * @returns {Array} information about workPeriods
+ * @returns {Array<{startDate:Date, endDate:Date, daysWorked:number}>} information about workPeriods
  */
 function extractWorkPeriods (start, end) {
-  // canculate daysWorked for a week
+  // canculate maximum possible daysWorked for a week
   function getDaysWorked (week) {
     if (weeks === 1) {
       return Math.min(endDay, 5) - Math.max(startDay, 1) + 1

src/eventHandlers/ResourceBookingEventHandler.js

@@ -176,7 +176,8 @@ async function updateWorkPeriods (payload) {
   const workPeriodsToAdd = _.differenceBy(newWorkPeriods, workPeriods, 'startDate')
   // find which workperiods' daysWorked propery should be updated
   let workPeriodsToUpdate = _.intersectionBy(newWorkPeriods, workPeriods, 'startDate')
-  workPeriodsToUpdate = _.differenceWith(workPeriodsToUpdate, workPeriods, (a, b) => b.startDate === a.startDate && b.daysWorked === a.daysWorked)
+  // find which workperiods' daysWorked property is preset and exceeds the possible maximum
+  workPeriodsToUpdate = _.differenceWith(workPeriodsToUpdate, workPeriods, (a, b) => b.startDate === a.startDate && _.defaultTo(b.daysWorked, a.daysWorked) <= a.daysWorked)
   // include id
   workPeriodsToUpdate = _.map(workPeriodsToUpdate, wpu => {
     wpu.id = _.filter(workPeriods, ['startDate', wpu.startDate])[0].id
@@ -186,7 +187,7 @@ async function updateWorkPeriods (payload) {
     logger.debug({
       component: 'ResourceBookingEventHandler',
       context: 'updateWorkPeriods',
-      message: `id: ${payload.value.id} resource booking has no change in dates - ignored`
+      message: `id: ${payload.value.id} resource booking has no change in dates that affect work periods - ignored`
     })
     return
   }
@@ -248,8 +249,7 @@ async function deleteWorkPeriods (payload) {
 
 /**
  * Calls WorkPeriodService to create workPeriods
- * @param {Array<{startDate:Date,
- * endDate:Date, daysWorked:number}>} periods work period data
+ * @param {Array<{startDate:Date, endDate:Date}>} periods work period data
  * @param {string} resourceBookingId resourceBookingId of work period
  * @returns {undefined}
  */
@@ -259,7 +259,7 @@ async function _createWorkPeriods (periods, resourceBookingId) {
       resourceBookingId: resourceBookingId,
       startDate: period.startDate,
       endDate: period.endDate,
-      daysWorked: period.daysWorked,
+      daysWorked: null,
       paymentStatus: 'pending'
     })))
 }

src/services/PaymentService.js

@@ -79,13 +79,13 @@ async function createChallenge (challenge, token) {
       pureV5Task: true
     },
     tags: ['Other'],
-    startDate: new Date(),
+    startDate: new Date()
   }
 
   if (challenge.billingAccountId) {
     body.billing = {
       billingAccountId: challenge.billingAccountId,
-      markup: 0, // for TaaS payments we always use 0 markup
+      markup: 0 // for TaaS payments we always use 0 markup
     }
   }
   try {

test/unit/ResourceBookingService.test.js

@@ -6,7 +6,8 @@ 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 commonData = require('./common/CommonData')
+const testData = require('./common/WorkPeriodPaymentData')
 const helper = require('../../src/common/helper')
 // const esClient = helper.getESClient()
 const busApiClient = helper.getBusApiClient()
@@ -35,7 +36,7 @@ describe('workPeriod service test', () => {
     })
 
     it('create work period success', async () => {
-      const response = await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
+      const response = await service.createWorkPeriodPayment(commonData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
       expect(stubGetUserId.calledOnce).to.be.true
       expect(stubEnsureWorkPeriodById.calledOnce).to.be.true
       expect(stubEnsureResourceBookingById.calledOnce).to.be.true
@@ -45,7 +46,7 @@ describe('workPeriod service test', () => {
     })
 
     it('create work period success - billingAccountId is set', async () => {
-      await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
+      await service.createWorkPeriodPayment(commonData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
       expect(stubCreatePayment.calledOnce).to.be.true
       expect(stubCreatePayment.args[0][0]).to.include({
         billingAccountId: testData.workPeriodPayment01.ensureResourceBookingByIdResponse.billingAccountId
@@ -61,19 +62,19 @@ describe('workPeriod service test', () => {
       sinon.stub(helper, 'ensureResourceBookingById').callsFake(async () => testData.workPeriodPayment01.ensureResourceBookingByIdResponse02)
 
       try {
-        await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request)
+        await service.createWorkPeriodPayment(commonData.currentUser, testData.workPeriodPayment01.request)
       } catch (err) {
         expect(err.message).to.include('"ResourceBooking" Billing account is not assigned to the resource booking')
       }
     })
 
     describe('when PAYMENT_PROCESSING_SWITCH is ON/OFF', async () => {
       it('do not create payment if PAYMENT_PROCESSING_SWITCH is OFF', async () => {
-        await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'OFF' })
+        await service.createWorkPeriodPayment(commonData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'OFF' })
         expect(stubCreatePayment.calledOnce).to.be.false
       })
       it('create payment if PAYMENT_PROCESSING_SWITCH is ON', async () => {
-        await service.createWorkPeriodPayment(testData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
+        await service.createWorkPeriodPayment(commonData.currentUser, testData.workPeriodPayment01.request, { paymentProcessingSwitch: 'ON' })
         expect(stubCreatePayment.calledOnce).to.be.true
       })
     })

test/unit/WorkPeriodPaymentService.test.js

@@ -0,0 +1,12 @@
+const currentUser = {
+  userId: '00000000-0000-0000-0000-000000000000',
+  isMachine: true
+}
+const UserTCConnCopilot = {
+  userId: '4709473d-f060-4102-87f8-4d51ff0b34c1',
+  handle: 'TCConnCopilot'
+}
+module.exports = {
+  currentUser,
+  UserTCConnCopilot
+}