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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.63.0-rc.8",
+  "version": "1.63.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.63.0-rc.8",
-    "@defra-fish/connectors-lib": "1.63.0-rc.8",
-    "@defra-fish/dynamics-lib": "1.63.0-rc.8",
+    "@defra-fish/business-rules-lib": "1.63.0",
+    "@defra-fish/connectors-lib": "1.63.0",
+    "@defra-fish/dynamics-lib": "1.63.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -52,5 +52,5 @@
     "moment-timezone": "^0.5.34",
     "uuid": "^8.3.2"
   },
-  "gitHead": "4376fb63f6e1867708241521e43c4bce5791e08a"
+  "gitHead": "7cfb8ef668002fc340b755dd3aaa4572063e115c"
 }

package/src/schema/__tests__/recurring-payments.schema.spec.js

@@ -33,10 +33,10 @@ const getResponseSampleData = () => ({
         mobilePhone: null,
         organisation: null,
         premises: '1',
-        street: 'Catharine Place',
+        street: 'Test Street',
         locality: null,
-        town: 'Bath',
-        postcode: 'BA1 2PR'
+        town: 'Testville',
+        postcode: 'TE1 1ST'
       }
     },
     activePermission: {
@@ -166,3 +166,19 @@ describe('cancelRecurringPaymentRequestParamsSchema', () => {
     expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
   })
 })
+
+describe('cancelRecurringPaymentRequestParamsSchema', () => {
+  it('validates expected object', async () => {
+    const sampleData = { id: 'abc123' }
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync(sampleData)).not.toThrow()
+  })
+
+  it('throws an error if id missing', async () => {
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync({}).rejects.toThrow())
+  })
+
+  it('throws an error if id is not the correct type', async () => {
+    const sampleData = { id: 99 }
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+})

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

@@ -2,9 +2,19 @@ import initialiseServer from '../server.js'
 import Boom from '@hapi/boom'
 import dotProp from 'dot-prop'
 import { SERVER } from '../../config.js'
+import fs from 'fs'
+
+jest.mock('fs', () => {
+  const actual = jest.requireActual('fs')
+  return {
+    ...actual,
+    readFileSync: jest.fn(() => JSON.stringify({ name: 'sales-api-test', version: '1.2.3' }))
+  }
+})
 
 describe('hapi server', () => {
   describe('initialisation', () => {
+    const serverInfoUri = 'test'
     let serverConfigSpy
     beforeAll(() => {
       const Hapi = jest.requireActual('@hapi/hapi')
@@ -15,7 +25,7 @@ describe('hapi server', () => {
         register: jest.fn(),
         route: jest.fn(),
         info: {
-          uri: 'test'
+          uri: serverInfoUri
         },
         listener: {}
       }))
@@ -48,6 +58,22 @@ describe('hapi server', () => {
         headersTimeout: 5123
       })
     })
+
+    it('logs startup details including name and version', async () => {
+      const mockPkg = { name: 'sales-api-test', version: '1.2.3' }
+      fs.readFileSync.mockReturnValue(JSON.stringify(mockPkg))
+      const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+
+      await initialiseServer({ port: 4000 })
+
+      expect(logSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Server started at %s. Listening on %s. name: %s. version: %s'),
+        expect.any(String),
+        serverInfoUri,
+        mockPkg.name,
+        mockPkg.version
+      )
+    })
   })
 
   describe('configuration', () => {

package/src/server/server.js

@@ -8,6 +8,8 @@ import Boom from '@hapi/boom'
 import { SERVER } from '../config.js'
 import moment from 'moment'
 import { airbrake } from '@defra-fish/connectors-lib'
+import path from 'path'
+import fs from 'fs'
 
 export default async (opts = { port: SERVER.Port }) => {
   airbrake.initialise()
@@ -49,7 +51,17 @@ export default async (opts = { port: SERVER.Port }) => {
   server.route(Routes)
 
   await server.start()
-  console.log('Server started at %s. Listening on %s', moment().toISOString(), server.info.uri)
+
+  const pkgPath = path.join(process.cwd(), 'package.json')
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+
+  console.log(
+    'Server started at %s. Listening on %s. name: %s. version: %s',
+    moment().toISOString(),
+    server.info.uri,
+    pkg.name,
+    pkg.version
+  )
 
   const shutdown = async code => {
     await server.stop()

package/src/services/__tests__/permissions.service.spec.js

@@ -62,7 +62,9 @@ describe('permissions service', () => {
       const number = await generatePermissionNumber(
         getSamplePermission({
           permitId: MOCK_12MONTH_DISABLED_PERMIT.id,
-          birthDate: moment().subtract(JUNIOR_MAX_AGE, 'years').format('YYYY-MM-DD')
+          birthDate: moment()
+            .subtract(JUNIOR_MAX_AGE + 1, 'years')
+            .format('YYYY-MM-DD')
         }),
         'Telesales'
       )

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

@@ -5,6 +5,7 @@ import {
   findRecurringPaymentsByAgreementId,
   findById,
   Permission,
+  persist,
   RecurringPayment
 } from '@defra-fish/dynamics-lib'
 import {
@@ -48,7 +49,8 @@ jest.mock('@defra-fish/dynamics-lib', () => ({
   findRecurringPaymentsByAgreementId: jest.fn(() => ({ toRetrieveRequest: () => {} })),
   dynamicsClient: {
     retrieveMultipleRequest: jest.fn(() => ({ value: [] }))
-  }
+  },
+  persist: jest.fn()
 }))
 
 jest.mock('@defra-fish/connectors-lib', () => ({
@@ -93,7 +95,6 @@ jest.mock('../../services/paymentjournals/payment-journals.service.js', () => ({
 }))
 
 jest.mock('@defra-fish/business-rules-lib', () => ({
-  ADVANCED_PURCHASE_MAX_DAYS: 30,
   PAYMENT_JOURNAL_STATUS_CODES: {
     InProgress: 'InProgressCode',
     Cancelled: 'CancelledCode',
@@ -453,6 +454,17 @@ describe('recurring payments service', () => {
         '2025-11-12T00:00:00.000Z',
         '3456'
       ],
+      [
+        'starts thirty-one days after issue date - next due on issue date plus one year',
+        '9o8u7yhui89u8i9oiu8i8u7yhu',
+        {
+          startDate: '2024-12-14T00:00:00.000Z',
+          issueDate: '2024-11-12T15:00:45.922Z',
+          endDate: '2025-12-13T23:59:59.999Z'
+        },
+        '2025-11-12T00:00:00.000Z',
+        '4321'
+      ],
       [
         "issued on 29th Feb '24, starts on 30th March '24 - next due on 28th Feb '25",
         'hy7u8ijhyu78jhyu8iu8hjiujn',
@@ -509,11 +521,11 @@ describe('recurring payments service', () => {
 
     it.each([
       [
-        'start date is thirty one days after issue date',
+        'start date equals issue date',
         {
-          startDate: '2024-12-14T00:00:00.000Z',
-          issueDate: '2024-11-12T15:00:45.922Z',
-          endDate: '2025-12-13T23:59:59.999Z'
+          startDate: '2024-11-11T00:00:00.000Z',
+          issueDate: '2024-11-11T00:00:00.000Z',
+          endDate: '2025-11-10T23:59:59.999Z'
         }
       ],
       [
@@ -870,28 +882,29 @@ describe('recurring payments service', () => {
 
   describe('cancelRecurringPayment', () => {
     it('should call findById with RecurringPayment and the provided id', async () => {
+      findById.mockReturnValueOnce(getMockRecurringPayment())
       const id = 'abc123'
       await cancelRecurringPayment(id)
       expect(findById).toHaveBeenCalledWith(RecurringPayment, id)
     })
 
-    it('should log a RecurringPayment record when there is one match', async () => {
-      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
-      const recurringPayment = { entity: getMockRecurringPayment() }
+    it('should call persist with the updated RecurringPayment', async () => {
+      const recurringPayment = getMockRecurringPayment()
       findById.mockReturnValueOnce(recurringPayment)
 
+      const cancelledDate = new Date().toISOString().split('T')[0]
+      const cancelledReason = { description: 'Payment Failure', id: 910400002, label: 'Payment Failure' }
+      const expectedUpdatedRecurringPayment = { ...recurringPayment, cancelledReason, cancelledDate }
+
       await cancelRecurringPayment('id')
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('RecurringPayment for cancellation: ', recurringPayment)
+      expect(persist).toHaveBeenCalledWith([expect.objectContaining(expectedUpdatedRecurringPayment)])
     })
 
-    it('should log no matches when there are no matches', async () => {
-      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+    it('should raise an error when there are no matches', async () => {
       findById.mockReturnValueOnce(undefined)
 
-      await cancelRecurringPayment('id')
-
-      expect(consoleLogSpy).toHaveBeenCalledWith('No matches found for cancellation')
+      await expect(cancelRecurringPayment('id')).rejects.toThrow('Invalid id provided for recurring payment cancellation')
     })
   })
 })

package/src/services/permissions.service.js

@@ -1,5 +1,5 @@
 import { Permission, Permit } from '@defra-fish/dynamics-lib'
-import { isJunior, isSenior, SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
+import { SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
 import { getGlobalOptionSetValue, getReferenceDataForEntityAndId } from './reference-data.service.js'
 import { redis } from './ioredis.service.js'
 import moment from 'moment-timezone'
@@ -76,6 +76,9 @@ export const calculateEndDateMoment = async ({ permitId, startDate }) => {
  */
 export const calculateEndDate = async ({ permitId, startDate }) => (await calculateEndDateMoment({ permitId, startDate })).toISOString()
 
+const ADULT_AGE = 17
+const SENIOR_AGE = 66
+
 /**
  * Determine the appropriate age category code for use in a permission number
  * @param birthDate The birth date of the licensee
@@ -85,14 +88,16 @@ export const calculateEndDate = async ({ permitId, startDate }) => (await calcul
 const getAgeCategory = (birthDate, issueDate) => {
   const dob = moment(birthDate)
   const issue = moment(issueDate)
-  const diff = issue.diff(dob, 'years', true)
+  const seventeenthBirthday = dob.clone().add(ADULT_AGE, 'years')
+  const sixtysixthBirthday = dob.clone().add(SENIOR_AGE, 'years')
 
-  if (isJunior(diff)) {
+  if (issue.isBefore(seventeenthBirthday)) {
     return 'J'
-  } else if (isSenior(diff)) {
+  } else if (issue.isSameOrAfter(sixtysixthBirthday)) {
     return 'S'
+  } else {
+    return 'F'
   }
-  return 'F'
 }
 
 /**

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

@@ -1,19 +1,21 @@
 import {
+  dynamicsClient,
   executeQuery,
   findById,
   findDueRecurringPayments,
   findRecurringPaymentsByAgreementId,
-  RecurringPayment,
-  dynamicsClient
+  persist,
+  RecurringPayment
 } from '@defra-fish/dynamics-lib'
 import { calculateEndDate, generatePermissionNumber } from './permissions.service.js'
 import { getObfuscatedDob } from './contacts.service.js'
 import { createHash } from 'node:crypto'
-import { ADVANCED_PURCHASE_MAX_DAYS, PAYMENT_JOURNAL_STATUS_CODES, PAYMENT_TYPE, TRANSACTION_SOURCE } from '@defra-fish/business-rules-lib'
+import { PAYMENT_JOURNAL_STATUS_CODES, PAYMENT_TYPE, TRANSACTION_SOURCE } from '@defra-fish/business-rules-lib'
 import { TRANSACTION_STAGING_TABLE, TRANSACTION_QUEUE } from '../config.js'
 import { TRANSACTION_STATUS } from '../services/transactions/constants.js'
 import { retrieveStagedTransaction } from '../services/transactions/retrieve-transaction.js'
 import { createPaymentJournal, getPaymentJournal, updatePaymentJournal } from '../services/paymentjournals/payment-journals.service.js'
+import { getGlobalOptionSetValue } from './reference-data.service.js'
 import moment from 'moment'
 import { AWS, govUkPayApi } from '@defra-fish/connectors-lib'
 import db from 'debug'
@@ -24,7 +26,7 @@ export const getRecurringPayments = date => executeQuery(findDueRecurringPayment
 
 const getNextDueDate = (startDate, issueDate, endDate) => {
   const mStart = moment(startDate)
-  if (mStart.isAfter(moment(issueDate)) && mStart.isSameOrBefore(moment(issueDate).add(ADVANCED_PURCHASE_MAX_DAYS, 'days'), 'day')) {
+  if (mStart.isAfter(moment(issueDate))) {
     if (mStart.isSame(moment(issueDate), 'day')) {
       return moment(startDate).add(1, 'year').subtract(10, 'days').startOf('day').toISOString()
     }
@@ -165,9 +167,14 @@ export const findNewestExistingRecurringPaymentInCrm = async agreementId => {
 export const cancelRecurringPayment = async id => {
   const recurringPayment = await findById(RecurringPayment, id)
   if (recurringPayment) {
-    console.log('RecurringPayment for cancellation: ', recurringPayment)
+    const data = recurringPayment
+    data.cancelledDate = new Date().toISOString().split('T')[0]
+    data.cancelledReason = await getGlobalOptionSetValue(RecurringPayment.definition.mappings.cancelledReason.ref, 'Payment Failure')
+    const updatedRecurringPayment = Object.assign(new RecurringPayment(), data)
+    await persist([updatedRecurringPayment])
+    return updatedRecurringPayment
   } else {
-    console.log('No matches found for cancellation')
+    throw new Error('Invalid id provided for recurring payment cancellation')
   }
 }