@defra-fish/recurring-payments-job 1.63.0-rc.10 → 1.63.0-rc.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.63.0-rc.10",
+  "version": "1.63.0-rc.12",
   "description": "Rod Licensing Recurring Payments Job",
   "type": "module",
   "engines": {
@@ -36,11 +36,11 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.63.0-rc.10",
-    "@defra-fish/connectors-lib": "1.63.0-rc.10",
+    "@defra-fish/business-rules-lib": "1.63.0-rc.12",
+    "@defra-fish/connectors-lib": "1.63.0-rc.12",
     "commander": "^7.2.0",
     "debug": "^4.3.3",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "c4301461b148cbf244c1bb5c834521243ec0a534"
+  "gitHead": "077b17c4a39822d8db2419d99e0a8dce2bb4a8ff"
 }

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

@@ -1,34 +1,107 @@
 import commander from 'commander'
+import { airbrake } from '@defra-fish/connectors-lib'
 import { processRecurringPayments } from '../recurring-payments-processor.js'
 import fs from 'fs'
 
 jest.useFakeTimers()
 
-jest.mock('../recurring-payments-processor.js', () => {
-  if (!global.processRecurringPayments) {
-    global.processRecurringPayments = jest.fn()
+jest.mock('../recurring-payments-processor.js')
+jest.mock('@defra-fish/connectors-lib', () => ({
+  airbrake: {
+    initialise: jest.fn(),
+    flush: jest.fn()
   }
-  return { processRecurringPayments: global.processRecurringPayments }
-})
-
-jest.mock('commander', () => {
-  if (!global.commander) {
-    global.commander = jest.requireActual('commander')
-  }
-  return global.commander
-})
+}))
 
 jest.mock('fs')
-
 describe('recurring-payments-job', () => {
+  beforeAll(() => {
+    fs.readFileSync.mockReturnValue(JSON.stringify({ name: 'recurring-payments-test', version: '1.0.0' }))
+  })
+
   beforeEach(() => {
     jest.clearAllMocks()
     commander.args = ['test']
   })
 
+  it('initialises airbrake', () => {
+    jest.isolateModules(() => {
+      require('../recurring-payments-job.js')
+      expect(airbrake.initialise).toHaveBeenCalled()
+    })
+  })
+
+  it('flushes airbrake before script ends', () => {
+    jest.isolateModules(() => {
+      require('../recurring-payments-job.js')
+      expect(airbrake.flush).toHaveBeenCalled()
+    })
+  })
+
+  it("doesn't flush airbrake before processRecurringPayments has been called", () => {
+    jest.isolateModules(() => {
+      processRecurringPayments.mockImplementationOnce(() => {
+        expect(airbrake.flush).not.toHaveBeenCalled()
+      })
+      require('../recurring-payments-job.js')
+    })
+  })
+
+  it.each([
+    ['SIGINT', 130],
+    ['SIGTERM', 137]
+  ])('flushes airbrake on %s signal', (signal, code) => {
+    jest.isolateModules(() => {
+      // setup a delay so script doesn't call processRecurringPayments and exit naturally
+      process.env.RECURRING_PAYMENTS_LOCAL_DELAY = '1'
+      const signalCallbacks = {}
+      jest.spyOn(process, 'on')
+      jest.spyOn(process, 'exit')
+      process.on.mockImplementation((signalToken, callback) => {
+        signalCallbacks[signalToken] = callback
+      })
+      process.exit.mockImplementation(() => {
+        // so we don't crash out of the tests!
+      })
+
+      require('../recurring-payments-job.js')
+      signalCallbacks[signal]()
+
+      expect(airbrake.flush).toHaveBeenCalled()
+      process.on.mockRestore()
+      process.exit.mockRestore()
+    })
+  })
+
+  it.each([
+    ['SIGINT', 130],
+    ['SIGTERM', 137]
+  ])('calls process.exit on %s signal with %i code', (signal, code) => {
+    jest.isolateModules(() => {
+      // setup a delay so script doesn't call processRecurringPayments and exit naturally
+      process.env.RECURRING_PAYMENTS_LOCAL_DELAY = '1'
+      const signalCallbacks = {}
+      jest.spyOn(process, 'on')
+      jest.spyOn(process, 'exit')
+      process.on.mockImplementation((signalToken, callback) => {
+        signalCallbacks[signalToken] = callback
+      })
+      process.exit.mockImplementation(() => {
+        // so we don't crash out of the tests!
+      })
+
+      require('../recurring-payments-job.js')
+      signalCallbacks[signal]()
+
+      expect(process.exit).toHaveBeenCalledWith(code)
+      process.on.mockRestore()
+      process.exit.mockRestore()
+    })
+  })
+
   it('logs startup details including name and version', () => {
     const mockPkg = { name: 'recurring-payments-test', version: '1.2.3' }
-    fs.readFileSync.mockReturnValue(JSON.stringify(mockPkg))
+    fs.readFileSync.mockReturnValueOnce(JSON.stringify(mockPkg))
 
     jest.isolateModules(() => {
       const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
@@ -39,11 +112,13 @@ describe('recurring-payments-job', () => {
         mockPkg.name,
         mockPkg.version
       )
+      logSpy.mockRestore()
     })
   })
 
   it('calls processRecurringPayments when no delay', () => {
     jest.isolateModules(() => {
+      process.env.RECURRING_PAYMENTS_LOCAL_DELAY = '0'
       require('../recurring-payments-job.js')
       expect(processRecurringPayments).toHaveBeenCalled()
     })
@@ -51,6 +126,7 @@ describe('recurring-payments-job', () => {
 
   it('doesnt call setTimeout when no correct delay', () => {
     jest.isolateModules(() => {
+      process.env.RECURRING_PAYMENTS_LOCAL_DELAY = 'invalid-delay'
       const setTimeoutSpy = jest.spyOn(global, 'setTimeout')
       require('../recurring-payments-job.js')
       expect(setTimeoutSpy).not.toHaveBeenCalled()

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

@@ -20,6 +20,7 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
 }))
 jest.mock('@defra-fish/connectors-lib', () => ({
   salesApi: {
+    cancelRecurringPayment: jest.fn(),
     createPaymentJournal: jest.fn(),
     createTransaction: jest.fn(() => ({
       id: 'test-transaction-id',
@@ -636,6 +637,30 @@ describe('recurring-payments-processor', () => {
     }
   )
 
+  it.each([
+    ['a failure', 'agreement-id', getPaymentStatusFailure()],
+    ['a failure', 'test-agreement-id', getPaymentStatusFailure()],
+    ['a failure', 'another-agreement-id', getPaymentStatusFailure()],
+    ['an error', 'agreement-id', getPaymentStatusError()],
+    ['an error', 'test-agreement-id', getPaymentStatusError()],
+    ['an error', 'another-agreement-id', getPaymentStatusError()]
+  ])('cancelRecurringPayment is called when payment is %s', async (_status, agreementId, mockStatus) => {
+    salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment({ agreementId })])
+    const id = Symbol('recurring-payment-id')
+    salesApi.createTransaction.mockResolvedValueOnce({
+      recurringPayment: {
+        id
+      }
+    })
+    const mockPaymentResponse = { payment_id: 'test-payment-id', created_date: '2025-01-01T00:00:00.000Z' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+    getPaymentStatus.mockResolvedValueOnce(mockStatus)
+
+    await processRecurringPayments()
+
+    expect(salesApi.cancelRecurringPayment).toHaveBeenCalledWith(id)
+  })
+
   it('updatePaymentJournal is called with transaction id and failed status code payment is not succesful and payment journal exists', async () => {
     salesApi.getDueRecurringPayments.mockReturnValueOnce([getMockDueRecurringPayment()])
     const transactionId = 'test-transaction-id'

package/src/recurring-payments-job.js

@@ -1,13 +1,17 @@
 'use strict'
 import recurringPaymentsJob from 'commander'
 import { processRecurringPayments } from './recurring-payments-processor.js'
+import { airbrake } from '@defra-fish/connectors-lib'
 import path from 'path'
 import fs from 'fs'
 
+const SIGINT_CODE = 130
+const SIGTERM_CODE = 137
 const pkgPath = path.join(process.cwd(), 'package.json')
 const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
 
 console.log('Recurring payments job starting at %s. name: %s. version: %s', new Date().toISOString(), pkg.name, pkg.version)
+airbrake.initialise()
 
 const delay = parseInt(process.env.RECURRING_PAYMENTS_LOCAL_DELAY || '0', 10)
 if (delay > 0) {
@@ -20,6 +24,15 @@ if (delay > 0) {
 
 function executeRecurringPaymentsJob () {
   recurringPaymentsJob.action(processRecurringPayments())
+  airbrake.flush()
 }
 
+const shutdown = code => {
+  airbrake.flush()
+  process.exit(code)
+}
+
+process.on('SIGINT', () => shutdown(SIGINT_CODE))
+process.on('SIGTERM', () => shutdown(SIGTERM_CODE))
+
 export default recurringPaymentsJob

package/src/recurring-payments-processor.js

@@ -154,6 +154,7 @@ const processRecurringPaymentStatus = async payment => {
           paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.Failed
         })
       }
+      await salesApi.cancelRecurringPayment(payment.transaction.recurringPayment.id)
     }
   } catch (error) {
     const status = error.response?.status
@@ -165,5 +166,6 @@ const processRecurringPaymentStatus = async payment => {
     } else {
       debug(`Unexpected error fetching payment status for ${payment.paymentId}.`)
     }
+    await salesApi.cancelRecurringPayment(payment.transaction.recurringPayment.id)
   }
 }