@defra-fish/sales-api-service 1.73.0-rc.8 → 1.73.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.73.0-rc.8",
+  "version": "1.73.0",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,15 +35,16 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.73.0-rc.8",
-    "@defra-fish/connectors-lib": "1.73.0-rc.8",
-    "@defra-fish/dynamics-lib": "1.73.0-rc.8",
+    "@defra-fish/business-rules-lib": "1.73.0",
+    "@defra-fish/connectors-lib": "1.73.0",
+    "@defra-fish/dynamics-lib": "1.73.0",
     "@hapi/boom": "9.1.2",
     "@hapi/hapi": "20.1.3",
     "@hapi/inert": "6.0.3",
     "@hapi/vision": "6.1.0",
     "debug": "4.3.3",
     "dot-prop": "6.0.1",
+    "dynamics-web-api": "2.4.0",
     "hapi-and-healthy": "7.0.7",
     "hapi-swagger": "14.2.5",
     "ioredis": "4.28.5",
@@ -52,5 +53,5 @@
     "moment-timezone": "0.5.34",
     "uuid": "8.3.2"
   },
-  "gitHead": "f74c85a07f6d13c63b8c2a6117722532406a2e49"
+  "gitHead": "128d150e6bd30468bca4e39fb44dd11c5598eb43"
 }

package/src/__mocks__/dynamics-web-api.js

@@ -1,3 +1,5 @@
 import { configureDynamicsWebApiMock } from '../../../dynamics-lib/src/__mocks__/dynamics-web-api-mock-helper.js'
-const DynamicsWebApi = jest.genMockFromModule('dynamics-web-api')
-export default configureDynamicsWebApiMock(DynamicsWebApi)
+const DynamicsWebApi = jest.fn()
+DynamicsWebApi.prototype = {}
+configureDynamicsWebApiMock(DynamicsWebApi)
+export { DynamicsWebApi }

package/src/server/plugins/__tests__/health.spec.js

@@ -84,7 +84,7 @@ describe('hapi healthcheck', () => {
   })
 
   it('exposes a service status page returning a 500 error when unhealthy', async () => {
-    jest.spyOn(dynamicsClient, 'executeUnboundFunction').mockImplementation(async () => {
+    jest.spyOn(dynamicsClient, 'callFunction').mockImplementation(async () => {
       throw new Error('Simulated')
     })
     const result = await server.inject({ method: 'GET', url: '/service-status' })

package/src/server/plugins/health.js

@@ -19,7 +19,7 @@ export default {
     test: {
       node: [
         async () => {
-          return { connection: 'dynamics', status: 'ok', ...(await dynamicsClient.executeUnboundFunction('RetrieveVersion')) }
+          return { connection: 'dynamics', status: 'ok', ...(await dynamicsClient.callFunction('RetrieveVersion')) }
         },
         async () => {
           return { connection: 'dynamodb', status: 'ok', ...(await ddb.listTables()) }

package/src/services/__tests__/recurring-payments.service.spec.js

@@ -52,7 +52,7 @@ jest.mock('@defra-fish/dynamics-lib', () => ({
   findDueRecurringPayments: jest.fn(),
   findRecurringPaymentsByAgreementId: jest.fn(() => ({ toRetrieveRequest: () => {} })),
   dynamicsClient: {
-    retrieveMultipleRequest: jest.fn(() => ({ value: [] }))
+    retrieveMultiple: jest.fn(() => ({ value: [] }))
   },
   persist: jest.fn(),
   findRecurringPaymentByPermissionId: jest.fn(() => ({ toRetrieveRequest: () => {} })),
@@ -780,16 +780,16 @@ describe('recurring payments service', () => {
       expect(findRecurringPaymentsByAgreementId).toHaveBeenCalledWith(agreementId)
     })
 
-    it('passes query created by findRecurringPaymentsByAgreementId to retrieveMultipleRequest', async () => {
+    it('passes query created by findRecurringPaymentsByAgreementId to retrieveMultiple', async () => {
       const retrieveRequest = Symbol('retrieve request')
       findRecurringPaymentsByAgreementId.mockReturnValueOnce({ toRetrieveRequest: () => retrieveRequest })
       await findNewestExistingRecurringPaymentInCrm()
-      expect(dynamicsClient.retrieveMultipleRequest).toHaveBeenCalledWith(retrieveRequest)
+      expect(dynamicsClient.retrieveMultiple).toHaveBeenCalledWith(retrieveRequest)
     })
 
     it('returns a Recurring Payment (not a plain object)', async () => {
       jest.spyOn(RecurringPayment, 'fromResponse')
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce(getMockResponse())
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce(getMockResponse())
       const recurringPayment = await findNewestExistingRecurringPaymentInCrm()
       expect(RecurringPayment.fromResponse.mock.results[0].value).toBe(recurringPayment)
     })
@@ -824,13 +824,13 @@ describe('recurring payments service', () => {
         '908-oid'
       ]
     ])('returns most recent existing recurring payment from %s', async (_desc, mockResponseData, expectedId) => {
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce({ value: mockResponseData })
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce({ value: mockResponseData })
       const recurringPayment = await findNewestExistingRecurringPaymentInCrm()
       expect(recurringPayment.id).toBe(expectedId)
     })
 
     it('returns boolean false if no recurring payments found', async () => {
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce({ value: [] })
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce({ value: [] })
       const recurringPayment = await findNewestExistingRecurringPaymentInCrm()
       expect(recurringPayment).toBeFalsy()
     })
@@ -987,7 +987,7 @@ describe('recurring payments service', () => {
   describe('findLinkedRecurringPayment', () => {
     const arrangeLinkedRcpSuccess = mockResponse => {
       jest.spyOn(RecurringPayment, 'fromResponse')
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce(mockResponse)
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce(mockResponse)
       retrieveGlobalOptionSets.mockReturnValueOnce({
         cached: jest.fn().mockResolvedValue({ definition: 'mock-def' })
       })
@@ -999,11 +999,11 @@ describe('recurring payments service', () => {
       expect(findRecurringPaymentByPermissionId).toHaveBeenCalledWith(permissionId)
     })
 
-    it('passes query created by findRecurringPaymentByPermissionId to retrieveMultipleRequest', async () => {
+    it('passes query created by findRecurringPaymentByPermissionId to retrieveMultiple', async () => {
       const retrieveRequest = Symbol('retrieve request')
       findRecurringPaymentByPermissionId.mockReturnValueOnce({ toRetrieveRequest: () => retrieveRequest })
       await findLinkedRecurringPayment()
-      expect(dynamicsClient.retrieveMultipleRequest).toHaveBeenCalledWith(retrieveRequest)
+      expect(dynamicsClient.retrieveMultiple).toHaveBeenCalledWith(retrieveRequest)
     })
 
     it('calls RecurringPayment.fromResponse with response and definitions', async () => {
@@ -1037,7 +1037,7 @@ describe('recurring payments service', () => {
         'rcp-456'
       ]
     ])('returns the most recent linked recurring payment (%s)', async (_desc, mockData, expectedId) => {
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce({ value: mockData })
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce({ value: mockData })
       retrieveGlobalOptionSets.mockReturnValueOnce({ cached: jest.fn().mockResolvedValue({ def: 'mock' }) })
 
       const recurringPayment = await findLinkedRecurringPayment('abc123')
@@ -1045,7 +1045,7 @@ describe('recurring payments service', () => {
     })
 
     it('returns false if no linked recurring payments found', async () => {
-      dynamicsClient.retrieveMultipleRequest.mockReturnValueOnce({ value: [] })
+      dynamicsClient.retrieveMultiple.mockReturnValueOnce({ value: [] })
       const recurringPayment = await findLinkedRecurringPayment('abc123')
       expect(recurringPayment).toBeFalsy()
     })

package/src/services/__tests__/reference-data.service.spec.js

@@ -12,7 +12,7 @@ import {
   MOCK_1DAY_SENIOR_PERMIT_DYNAMICS_RESPONSE,
   MOCK_CONCESSION_DYNAMICS_RESPONSE
 } from '../../__mocks__/test-data.js'
-import dynamicsWebApi from 'dynamics-web-api'
+import { DynamicsWebApi } from 'dynamics-web-api'
 
 const getOptionSetMappingExpectation = (name, ...keys) => {
   const options = keys.reduce((acc, k) => {
@@ -32,8 +32,8 @@ const getOptionSetMappingExpectation = (name, ...keys) => {
 
 describe('reference-data service', () => {
   beforeAll(async () => {
-    dynamicsWebApi.__reset()
-    dynamicsWebApi.__setResponse('executeBatch', [
+    DynamicsWebApi.__reset()
+    DynamicsWebApi.__setResponse('executeBatch', [
       {
         value: [MOCK_12MONTH_SENIOR_PERMIT_DYNAMICS_RESPONSE, MOCK_1DAY_SENIOR_PERMIT_DYNAMICS_RESPONSE]
       },
@@ -50,12 +50,12 @@ describe('reference-data service', () => {
         permits: expect.arrayContaining([expect.any(Permit)]),
         concessions: expect.arrayContaining([expect.any(Concession)])
       })
-      expect(dynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
     })
     it('uses a cache', async () => {
       await getReferenceData()
       await getReferenceData()
-      expect(dynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -63,7 +63,7 @@ describe('reference-data service', () => {
     it('retrieves an entries for the given type', async () => {
       const result = await getReferenceDataForEntity(Permit)
       expect(result).toEqual(expect.arrayContaining([expect.any(Permit)]))
-      expect(dynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -71,12 +71,12 @@ describe('reference-data service', () => {
     it('retrieves an entry for a given id', async () => {
       const result = await getReferenceDataForEntityAndId(Permit, MOCK_12MONTH_SENIOR_PERMIT_DYNAMICS_RESPONSE.defra_permitid)
       expect(result).toBeInstanceOf(Permit)
-      expect(dynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
     })
     it('returns undefined if not found', async () => {
       const result = await getReferenceDataForEntityAndId(Permit, 'not-found')
       expect(result).toBe(undefined)
-      expect(dynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.executeBatch).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -89,7 +89,7 @@ describe('reference-data service', () => {
           defra_concessionproof: getOptionSetMappingExpectation('defra_concessionproof', 910400000, 910400001, 910400002, 910400003)
         })
       )
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -97,12 +97,12 @@ describe('reference-data service', () => {
     it('retrieves all option-sets for a single name', async () => {
       const result = await getGlobalOptionSet('defra_duration')
       expect(result).toMatchObject(getOptionSetMappingExpectation('defra_duration', 910400000, 910400001, 910400002, 910400003))
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
     it('returns undefined if not found', async () => {
       const result = await getGlobalOptionSet('not-found')
       expect(result).toBe(undefined)
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
   })
 
@@ -110,17 +110,17 @@ describe('reference-data service', () => {
     it('retrieves a single option-set for a single name and label', async () => {
       const result = await getGlobalOptionSetValue('defra_duration', '1 day')
       expect(result).toMatchObject({ id: 910400000, label: '1 day', description: '1 day' })
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
     it('returns undefined if the option-set label is not found', async () => {
       const result = await getGlobalOptionSetValue('defra_duration', 'not-found')
       expect(result).toBe(undefined)
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
     it('returns undefined if the option-set name is not found', async () => {
       const result = await getGlobalOptionSetValue('not-found', 'not-found')
       expect(result).toBe(undefined)
-      expect(dynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
+      expect(DynamicsWebApi.prototype.retrieveGlobalOptionSets).toHaveBeenCalledTimes(1)
     })
   })
 })

package/src/services/recurring-payments.service.js

@@ -158,7 +158,7 @@ export const processRPResult = async (transactionId, paymentId, createdDate) =>
 
 export const findNewestExistingRecurringPaymentInCrm = async agreementId => {
   const query = findRecurringPaymentsByAgreementId(agreementId)
-  const response = await dynamicsClient.retrieveMultipleRequest(query.toRetrieveRequest())
+  const response = await dynamicsClient.retrieveMultiple(query.toRetrieveRequest())
   if (response.value.length) {
     const [rcpResponseData] = response.value.sort((a, b) => Date.parse(b.defra_enddate) - Date.parse(a.defra_enddate))
     return RecurringPayment.fromResponse(rcpResponseData)
@@ -192,7 +192,7 @@ const determineRecurringPaymentName = (transactionRecord, contact) => {
 
 export const findLinkedRecurringPayment = async permissionId => {
   const query = findRecurringPaymentByPermissionId(permissionId)
-  const response = await dynamicsClient.retrieveMultipleRequest(query.toRetrieveRequest())
+  const response = await dynamicsClient.retrieveMultiple(query.toRetrieveRequest())
   if (response.value.length) {
     const [rcpResponseData] = response.value.sort((a, b) => Date.parse(b.defra_enddate) - Date.parse(a.defra_enddate))
     const definition = await retrieveGlobalOptionSets().cached()