@defra-fish/recurring-payments-job 1.61.0-rc.2 → 1.61.0-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/recurring-payments-job",
-  "version": "1.61.0-rc.2",
+  "version": "1.61.0-rc.4",
   "description": "Rod Licensing Recurring Payments Job",
   "type": "module",
   "engines": {
@@ -36,10 +36,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.61.0-rc.2",
-    "@defra-fish/connectors-lib": "1.61.0-rc.2",
+    "@defra-fish/business-rules-lib": "1.61.0-rc.4",
+    "@defra-fish/connectors-lib": "1.61.0-rc.4",
     "commander": "^7.2.0",
     "moment-timezone": "^0.5.34"
   },
-  "gitHead": "4a762cba2fbe794d581e4f6c05af93016b6d8728"
+  "gitHead": "492a8abe5453ea44483fa565fc7bdec42e926993"
 }

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

@@ -1,6 +1,7 @@
 import { salesApi } from '@defra-fish/connectors-lib'
 import { processRecurringPayments } from '../recurring-payments-processor.js'
 import { getPaymentStatus, sendPayment } from '../services/govuk-pay-service.js'
+import db from 'debug'
 
 jest.mock('@defra-fish/business-rules-lib')
 jest.mock('@defra-fish/connectors-lib', () => ({
@@ -16,12 +17,13 @@ jest.mock('@defra-fish/connectors-lib', () => ({
     processRPResult: jest.fn()
   }
 }))
-
 jest.mock('../services/govuk-pay-service.js', () => ({
   sendPayment: jest.fn(),
   getPaymentStatus: jest.fn()
 }))
+jest.mock('debug', () => jest.fn(() => jest.fn()))
 
+const debugMock = db.mock.results[0].value
 const PAYMENT_STATUS_DELAY = 60000
 const getPaymentStatusSuccess = () => ({ state: { status: 'success' } })
 const getMockPaymentRequestResponse = () => [
@@ -44,21 +46,18 @@ describe('recurring-payments-processor', () => {
     global.setTimeout = jest.fn((cb, ms) => cb())
   })
 
-  it('console log displays "Recurring Payments job disabled" when env is false', async () => {
+  it('debug displays "Recurring Payments job disabled" when env is false', async () => {
     process.env.RUN_RECURRING_PAYMENTS = 'false'
-    const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
 
     await processRecurringPayments()
 
-    expect(consoleLogSpy).toHaveBeenCalledWith('Recurring Payments job disabled')
+    expect(debugMock).toHaveBeenCalledWith('Recurring Payments job disabled')
   })
 
-  it('console log displays "Recurring Payments job enabled" when env is true', async () => {
-    const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
-
+  it('debug displays "Recurring Payments job enabled" when env is true', async () => {
     await processRecurringPayments()
 
-    expect(consoleLogSpy).toHaveBeenCalledWith('Recurring Payments job enabled')
+    expect(debugMock).toHaveBeenCalledWith('Recurring Payments job enabled')
   })
 
   it('get recurring payments is called when env is true', async () => {
@@ -69,12 +68,10 @@ describe('recurring-payments-processor', () => {
     expect(salesApi.getDueRecurringPayments).toHaveBeenCalledWith(date)
   })
 
-  it('console log displays "Recurring Payments found: " when env is true', async () => {
-    const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
-
+  it('debug displays "Recurring Payments found: " when env is true', async () => {
     await processRecurringPayments()
 
-    expect(consoleLogSpy).toHaveBeenCalledWith('Recurring Payments found: ', [])
+    expect(debugMock).toHaveBeenCalledWith('Recurring Payments found: ', [])
   })
 
   it('prepares the data for found recurring payments', async () => {
@@ -289,8 +286,7 @@ describe('recurring-payments-processor', () => {
     expect(getPaymentStatus).toHaveBeenCalledWith('test-payment-id')
   })
 
-  it('should log payment status for recurring payment', async () => {
-    const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+  it('debug should log payment status for recurring payment', async () => {
     const mockPaymentId = 'test-payment-id'
     const mockResponse = [
       {
@@ -304,17 +300,48 @@ describe('recurring-payments-processor', () => {
         }
       }
     ]
+    const mockStatus = getPaymentStatusSuccess()
     salesApi.getDueRecurringPayments.mockResolvedValueOnce(mockResponse)
     salesApi.createTransaction.mockResolvedValueOnce({
       id: mockPaymentId
     })
     const mockPaymentResponse = { payment_id: mockPaymentId, agreementId: 'agreement-1' }
     sendPayment.mockResolvedValueOnce(mockPaymentResponse)
+    getPaymentStatus.mockResolvedValueOnce(mockStatus)
+
+    await processRecurringPayments()
+
+    expect(debugMock).toHaveBeenCalledWith(`Payment status for ${mockPaymentId}: ${mockStatus.state.status}`)
+  })
+
+  it('debug should inform that the recurring payment has been processed', async () => {
+    const mockTransactionId = 'test-transaction-id'
+    salesApi.createTransaction.mockReturnValueOnce({
+      cost: 50
+    })
+    const mockResponse = [
+      {
+        entity: { agreementId: 'agreement-1' },
+        expanded: {
+          activePermission: {
+            entity: {
+              referenceNumber: 'ref-1'
+            }
+          }
+        }
+      }
+    ]
+    salesApi.getDueRecurringPayments.mockResolvedValueOnce(mockResponse)
+    salesApi.createTransaction.mockResolvedValueOnce({
+      id: mockTransactionId
+    })
+    const mockPaymentResponse = { payment_id: 'payment-id', agreementId: 'agreement-1' }
+    sendPayment.mockResolvedValueOnce(mockPaymentResponse)
     getPaymentStatus.mockResolvedValueOnce(getPaymentStatusSuccess())
 
     await processRecurringPayments()
 
-    expect(consoleLogSpy).toHaveBeenCalledWith(`Payment status for ${mockPaymentId}: success`)
+    expect(debugMock).toHaveBeenCalledWith(`Processed Recurring Payment for ${mockTransactionId}`)
   })
 
   it('should call setTimeout with correct delay when there are recurring payments', async () => {
@@ -484,7 +511,7 @@ describe('recurring-payments-processor', () => {
 
       const permits = []
       for (let i = 0; i < count; i++) {
-        permits.push(Symbol(`permit${i}`))
+        permits.push(`permit${i}`)
       }
 
       permits.forEach((permit, i) => {

package/src/recurring-payments-processor.js

@@ -2,6 +2,8 @@ import moment from 'moment-timezone'
 import { SERVICE_LOCAL_TIME } from '@defra-fish/business-rules-lib'
 import { salesApi } from '@defra-fish/connectors-lib'
 import { getPaymentStatus, sendPayment } from './services/govuk-pay-service.js'
+import db from 'debug'
+const debug = db('recurring-payments:processor')
 
 const PAYMENT_STATUS_DELAY = 60000
 const payments = []
@@ -9,17 +11,17 @@ const PAYMENT_STATUS_SUCCESS = 'success'
 
 export const processRecurringPayments = async () => {
   if (process.env.RUN_RECURRING_PAYMENTS?.toLowerCase() === 'true') {
-    console.log('Recurring Payments job enabled')
+    debug('Recurring Payments job enabled')
     const date = new Date().toISOString().split('T')[0]
     const response = await salesApi.getDueRecurringPayments(date)
-    console.log('Recurring Payments found: ', response)
+    debug('Recurring Payments found: ', response)
     await Promise.all(response.map(record => processRecurringPayment(record)))
     if (response.length > 0) {
       await new Promise(resolve => setTimeout(resolve, PAYMENT_STATUS_DELAY))
       await Promise.all(response.map(record => processRecurringPaymentStatus(record)))
     }
   } else {
-    console.log('Recurring Payments job disabled')
+    debug('Recurring Payments job disabled')
   }
 }
 
@@ -32,20 +34,20 @@ const processRecurringPayment = async record => {
 
 const createNewTransaction = async (referenceNumber, agreementId) => {
   const transactionData = await processPermissionData(referenceNumber, agreementId)
-  console.log('Creating new transaction based on', referenceNumber, 'with agreementId', agreementId)
+  debug('Creating new transaction based on: ', referenceNumber, 'with agreementId: ', agreementId)
   try {
     const response = await salesApi.createTransaction(transactionData)
-    console.log('New transaction created:', response)
+    debug('New transaction created:', response)
     return response
   } catch (e) {
-    console.log('Error creating transaction', JSON.stringify(transactionData))
+    console.error('Error creating transaction', JSON.stringify(transactionData))
     throw e
   }
 }
 
 const takeRecurringPayment = async (agreementId, transaction) => {
   const preparedPayment = preparePayment(agreementId, transaction)
-  console.log('Requesting payment:', preparedPayment)
+  debug('Requesting payment:', preparedPayment)
   const payment = await sendPayment(preparedPayment)
   payments.push({
     agreementId,
@@ -56,7 +58,7 @@ const takeRecurringPayment = async (agreementId, transaction) => {
 }
 
 const processPermissionData = async (referenceNumber, agreementId) => {
-  console.log('Preparing data based on', referenceNumber, 'with agreementId', agreementId)
+  debug('Preparing data based on', referenceNumber, 'with agreementId', agreementId)
   const data = await salesApi.preparePermissionDataForRenewal(referenceNumber)
   const licenseeWithoutCountryCode = Object.assign((({ countryCode: _countryCode, ...l }) => l)(data.licensee))
   return {
@@ -104,10 +106,11 @@ const processRecurringPaymentStatus = async record => {
   const {
     state: { status }
   } = await getPaymentStatus(paymentId)
-  console.log(`Payment status for ${paymentId}: ${status}`)
+  debug(`Payment status for ${paymentId}: ${status}`)
   if (status === PAYMENT_STATUS_SUCCESS) {
     const payment = payments.find(p => p.paymentId === paymentId)
     await salesApi.processRPResult(payment.transaction.id, paymentId, payment.created_date)
+    debug(`Processed Recurring Payment for ${payment.transaction.id}`)
   }
 }