@defra-fish/sales-api-service 1.22.0-rc.7 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.22.0-rc.7",
+  "version": "1.22.0",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.22.0-rc.7",
-    "@defra-fish/connectors-lib": "1.22.0-rc.7",
-    "@defra-fish/dynamics-lib": "1.22.0-rc.7",
+    "@defra-fish/business-rules-lib": "1.22.0",
+    "@defra-fish/connectors-lib": "1.22.0",
+    "@defra-fish/dynamics-lib": "1.22.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -50,6 +50,5 @@
     "joi": "^17.4.0",
     "moment": "^2.29.1",
     "uuid": "^8.3.2"
-  },
-  "gitHead": "4840a94a046213c95478ea8ce84c086a81d5b2fb"
+  }
 }

package/src/schema/transaction.schema.js

@@ -34,7 +34,8 @@ const createTransactionRequestSchemaContent = {
       .min(1)
       .required()
   }),
-  createdBy: Joi.string().optional()
+  createdBy: Joi.string().optional(),
+  journalId: Joi.string().optional()
 }
 
 /**

package/src/services/transactions/__tests__/finalise-transaction.spec.js

@@ -31,9 +31,15 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
 
 const getStagedTransactionRecord = () => {
   const record = mockStagedTransactionRecord()
-  const { permissions: [permission] } = record
-  permission.issueDate = moment(permission.issueDate).year(2021).toISOString()
-  permission.startDate = moment(permission.startDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
+  const {
+    permissions: [permission]
+  } = record
+  permission.issueDate = moment(permission.issueDate)
+    .year(2021)
+    .toISOString()
+  permission.startDate = moment(permission.startDate)
+    .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
+    .toISOString()
   return record
 }
 
@@ -231,35 +237,40 @@ describe('transaction service', () => {
       ['2021-09-30T22:14:01.892Z', '2021-09-30T21:44:01.892Z', '2021-09-08T21:44:01.892Z', 47, 'Web Sales'],
       ['2021-09-30T00:14:01.892Z', '2021-09-29T17:14:01.892Z', '2022-09-30T17:14:01.892Z', 12, 'Telesales'],
       ['2021-11-30T23:14:01.892Z', '2021-11-30T22:22:01.892Z', '2022-11-30T22:22:01.892Z', 1, 'Telesales']
-    ])('adjusts startDate if startDate is less than 30 minutes after issueDate', async (issueDate, startDate, endDate, startAfterPaymentMinutes, dataSource) => {
-      BusinessRulesLib.START_AFTER_PAYMENT_MINUTES = startAfterPaymentMinutes
-      const mockRecord = mockStagedTransactionRecord()
-      mockRecord.dataSource = dataSource
-      const [mockPermission] = mockRecord.permissions
-      mockPermission.issueDate = issueDate
-      mockPermission.startDate = startDate
-      mockPermission.endDate = endDate
-      const completionFields = getCompletionFields()
-      AwsMock.DynamoDB.DocumentClient.__setResponse('update', {
-        Attributes: { ...mockRecord, ...completionFields, status: { id: TRANSACTION_STATUS.FINALISED } }
-      })
-      AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
-
-      await finaliseTransaction({ id: mockRecord.id, ...completionFields })
-
-      expect(AwsMock.DynamoDB.DocumentClient.mockedMethods.update).toHaveBeenCalledWith(
-        expect.objectContaining({
-          ExpressionAttributeValues: expect.objectContaining({
-            ':permissions': expect.arrayContaining([
-              expect.objectContaining({
-                permitId: mockPermission.permitId,
-                startDate: moment(issueDate).add(startAfterPaymentMinutes, 'minutes').toISOString()
-              })
-            ])
-          })
+    ])(
+      'adjusts startDate if startDate is less than 30 minutes after issueDate',
+      async (issueDate, startDate, endDate, startAfterPaymentMinutes, dataSource) => {
+        BusinessRulesLib.START_AFTER_PAYMENT_MINUTES = startAfterPaymentMinutes
+        const mockRecord = mockStagedTransactionRecord()
+        mockRecord.dataSource = dataSource
+        const [mockPermission] = mockRecord.permissions
+        mockPermission.issueDate = issueDate
+        mockPermission.startDate = startDate
+        mockPermission.endDate = endDate
+        const completionFields = getCompletionFields()
+        AwsMock.DynamoDB.DocumentClient.__setResponse('update', {
+          Attributes: { ...mockRecord, ...completionFields, status: { id: TRANSACTION_STATUS.FINALISED } }
         })
-      )
-    })
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
+
+        await finaliseTransaction({ id: mockRecord.id, ...completionFields })
+
+        expect(AwsMock.DynamoDB.DocumentClient.mockedMethods.update).toHaveBeenCalledWith(
+          expect.objectContaining({
+            ExpressionAttributeValues: expect.objectContaining({
+              ':permissions': expect.arrayContaining([
+                expect.objectContaining({
+                  permitId: mockPermission.permitId,
+                  startDate: moment(issueDate)
+                    .add(startAfterPaymentMinutes, 'minutes')
+                    .toISOString()
+                })
+              ])
+            })
+          })
+        )
+      }
+    )
 
     it.each([
       ['2021-09-30T17:14:01.892Z', '2021-09-30T17:44:02.892Z', '2022-09-30T17:44:02.892Z'],
@@ -367,36 +378,39 @@ describe('transaction service', () => {
       ['2021-09-30T23:14:01.892Z', '2021-09-30T23:00:49.892Z', '2022-09-30T23:00:49.892Z', 'Post Office Sales'],
       ['2021-09-30T22:14:01.892Z', '2021-09-30T21:44:01.892Z', '2022-09-30T21:44:01.892Z', 'DDE File'],
       ['2021-09-30T00:14:01.892Z', '2021-09-29T17:14:01.892Z', '2022-09-29T17:14:01.892Z', 'DDE File']
-    ])('leaves start and end time unmodified for any data source type other than Web Sales and Telesales', async (issueDate, startDate, endDate, dataSource) => {
-      permissionsService.calculateEndDate.mockReturnValueOnce(endDate)
-      const mockRecord = mockStagedTransactionRecord()
-      mockRecord.dataSource = dataSource
-      const [mockPermission] = mockRecord.permissions
-      mockPermission.issueDate = issueDate
-      mockPermission.startDate = startDate
-      mockPermission.endDate = endDate
-      const completionFields = getCompletionFields()
-      AwsMock.DynamoDB.DocumentClient.__setResponse('update', {
-        Attributes: { ...mockRecord, ...completionFields, status: { id: TRANSACTION_STATUS.FINALISED } }
-      })
-      AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
-
-      await finaliseTransaction({ id: mockRecord.id, ...completionFields })
-
-      expect(AwsMock.DynamoDB.DocumentClient.mockedMethods.update).toHaveBeenCalledWith(
-        expect.objectContaining({
-          ExpressionAttributeValues: expect.objectContaining({
-            ':permissions': expect.arrayContaining([
-              expect.objectContaining({
-                permitId: mockPermission.permitId,
-                startDate,
-                endDate
-              })
-            ])
-          })
+    ])(
+      'leaves start and end time unmodified for any data source type other than Web Sales and Telesales',
+      async (issueDate, startDate, endDate, dataSource) => {
+        permissionsService.calculateEndDate.mockReturnValueOnce(endDate)
+        const mockRecord = mockStagedTransactionRecord()
+        mockRecord.dataSource = dataSource
+        const [mockPermission] = mockRecord.permissions
+        mockPermission.issueDate = issueDate
+        mockPermission.startDate = startDate
+        mockPermission.endDate = endDate
+        const completionFields = getCompletionFields()
+        AwsMock.DynamoDB.DocumentClient.__setResponse('update', {
+          Attributes: { ...mockRecord, ...completionFields, status: { id: TRANSACTION_STATUS.FINALISED } }
         })
-      )
-    })
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
+
+        await finaliseTransaction({ id: mockRecord.id, ...completionFields })
+
+        expect(AwsMock.DynamoDB.DocumentClient.mockedMethods.update).toHaveBeenCalledWith(
+          expect.objectContaining({
+            ExpressionAttributeValues: expect.objectContaining({
+              ':permissions': expect.arrayContaining([
+                expect.objectContaining({
+                  permitId: mockPermission.permitId,
+                  startDate,
+                  endDate
+                })
+              ])
+            })
+          })
+        )
+      }
+    )
 
     it.each([
       ['2021-09-30T17:14:01.892Z', '2021-09-30T17:14:01.892Z'],
@@ -427,7 +441,9 @@ describe('transaction service', () => {
       expect(permission).toEqual(
         expect.objectContaining({
           permitId: mockPermission.permitId,
-          startDate: moment(completionFields.payment.timestamp).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
+          startDate: moment(completionFields.payment.timestamp)
+            .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
+            .toISOString()
         })
       )
     })

package/src/services/transactions/__tests__/process-transaction-queue.spec.js

@@ -24,6 +24,7 @@ import {
 } from '../../../__mocks__/test-data.js'
 import { TRANSACTION_STAGING_TABLE, TRANSACTION_STAGING_HISTORY_TABLE } from '../../../config.js'
 import AwsMock from 'aws-sdk'
+import { POCL_DATA_SOURCE, DDE_DATA_SOURCE } from '@defra-fish/business-rules-lib'
 
 jest.mock('../../reference-data.service.js', () => ({
   ...jest.requireActual('../../reference-data.service.js'),
@@ -56,7 +57,9 @@ jest.mock('../../contacts.service.js', () => ({
 }))
 
 jest.mock('@defra-fish/business-rules-lib', () => ({
-  POCL_TRANSACTION_SOURCES: ['Post Office Sales', 'DDE File'],
+  POCL_DATA_SOURCE: 'POCL_DATA_SOURCE',
+  DDE_DATA_SOURCE: 'DDE_DATA_SOURCE',
+  POCL_TRANSACTION_SOURCES: ['POCL_DATA_SOURCE', 'DDE_DATA_SOURCE'],
   START_AFTER_PAYMENT_MINUTES: 30
 }))
 
@@ -244,18 +247,38 @@ describe('transaction service', () => {
   })
 
   describe('.getTransactionJournalRefNumber', () => {
-    let mockRecord
-    beforeAll(() => {
-      mockRecord = mockFinalisedTransactionRecord()
-      mockRecord.dataSource = 'Post Office Sales'
-    })
     describe('when the transaction type is "Payment"', () => {
+      it.each([
+        ['123456', 2020],
+        ['654321', 2021],
+        ['567890', 2022]
+      ])('and it\'s a DDE File, and has a journal id, returns journal id', (journalId, year) => {
+        jest.useFakeTimers()
+        jest.setSystemTime(new Date(year, 1, 1, 10, 0, 0, 0))
+        const mockRecord = getSampleRecord({
+          dataSource: DDE_DATA_SOURCE,
+          journalId
+        })
+        const refNumber = getTransactionJournalRefNumber(mockRecord, 'Payment')
+        expect(refNumber).toBe(`DDE-${year}-${journalId}`)
+        jest.useRealTimers()
+      })
+
+      it('and it\'s a POCL file, and has a journal id and a serial number, returns serial number', () => {
+        const mockRecord = getSampleRecord()
+        mockRecord.journalId = '123456'
+        const refNumber = getTransactionJournalRefNumber(mockRecord, 'Payment')
+        expect(refNumber).toBe(mockRecord.serialNumber)
+      })
+
       it('and the serial number is present, returns serial number', () => {
+        const mockRecord = getSampleRecord()
         const refNumber = getTransactionJournalRefNumber(mockRecord, 'Payment')
         expect(refNumber).toBe(mockRecord.serialNumber)
       })
 
       it('and the serial number is not present, returns id', () => {
+        const mockRecord = getSampleRecord()
         const refNumber = getTransactionJournalRefNumber({ ...mockRecord, serialNumber: null }, 'Payment')
         expect(refNumber).toBe(mockRecord.id)
       })
@@ -263,14 +286,22 @@ describe('transaction service', () => {
 
     describe('when the transaction type is "Charge"', () => {
       it('and the serial number is present, returns id', () => {
+        const mockRecord = getSampleRecord()
         const refNumber = getTransactionJournalRefNumber(mockRecord, 'Charge')
         expect(refNumber).toBe(mockRecord.id)
       })
 
       it('and the serial number is not present, returns id', () => {
+        const mockRecord = getSampleRecord()
         const refNumber = getTransactionJournalRefNumber({ ...mockRecord, serialNumber: null }, 'Charge')
         expect(refNumber).toBe(mockRecord.id)
       })
     })
+
+    const getSampleRecord = (overrides = {}) => ({
+      ...mockFinalisedTransactionRecord(),
+      dataSource: POCL_DATA_SOURCE,
+      ...overrides
+    })
   })
 })

package/src/services/transactions/finalise-transaction.js

@@ -15,7 +15,9 @@ const getAdjustedStartDate = ({ issueDate, startDate, dataSource }) => {
   const startDateTooEarly = moment(startDate).isBefore(moment(issueDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes'))
   const webOrTelesales = !POCL_TRANSACTION_SOURCES.includes(dataSource)
   if (startDateTooEarly && webOrTelesales) {
-    return moment(issueDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
+    return moment(issueDate)
+      .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
+      .toISOString()
   }
   return startDate
 }

package/src/services/transactions/process-transaction-queue.js

@@ -11,7 +11,7 @@ import {
   RecurringPayment,
   RecurringPaymentInstruction
 } from '@defra-fish/dynamics-lib'
-import { POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
+import { DDE_DATA_SOURCE, POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
 import { getReferenceDataForEntityAndId, getGlobalOptionSetValue, getReferenceDataForEntity } from '../reference-data.service.js'
 import { resolveContactPayload } from '../contacts.service.js'
 import { retrieveStagedTransaction } from './retrieve-transaction.js'
@@ -30,7 +30,7 @@ const debug = db('sales:transactions')
  * @param id
  * @returns {Promise<void>}
  */
-export async function processQueue({ id }) {
+export async function processQueue ({ id }) {
   debug('Processing message from queue for staging id %s', id)
   const entities = []
   const transactionRecord = await retrieveStagedTransaction(id)
@@ -170,6 +170,9 @@ const createTransactionEntities = async transactionRecord => {
 
 export const getTransactionJournalRefNumber = (transactionRecord, type) => {
   if (POCL_TRANSACTION_SOURCES.includes(transactionRecord.dataSource) && type === 'Payment') {
+    if (transactionRecord.dataSource === DDE_DATA_SOURCE && transactionRecord.journalId) {
+      return `DDE-${(new Date()).getFullYear()}-${transactionRecord.journalId}`
+    }
     return transactionRecord.serialNumber || transactionRecord.id
   }
   return transactionRecord.id