@defra-fish/payment-mop-up-job 1.63.0-rc.5 → 1.63.0-rc.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/payment-mop-up-job",
-  "version": "1.63.0-rc.5",
+  "version": "1.63.0-rc.7",
   "description": "Process incomplete web-sales",
   "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.5",
-    "@defra-fish/connectors-lib": "1.63.0-rc.5",
+    "@defra-fish/business-rules-lib": "1.63.0-rc.7",
+    "@defra-fish/connectors-lib": "1.63.0-rc.7",
     "bottleneck": "^2.19.5",
     "debug": "^4.3.3",
     "moment": "^2.29.1"
   },
-  "gitHead": "313d1d1a8ab65bd841c27cf615f8abeec527f401"
+  "gitHead": "345c44f58b91a92723579e072235aa9607827efb"
 }

package/src/processors/__tests__/processor.spec.js

@@ -161,6 +161,105 @@ describe('processor', () => {
     })
   })
 
+  it('calls fetchPaymentStatus with recurring as true since agreementId exists', async () => {
+    salesApi.retrieveStagedTransaction.mockReturnValueOnce({ recurringPayment: { agreementId: '123' } })
+    const paymentReference = '15nioqikvvnuu5l8m2qeaj0qap'
+    const journalEntriesAgreement = [
+      {
+        id: 'a0e0e5c3-1004-4271-80ba-d05eda3e8220',
+        paymentStatus: 'In Progress',
+        paymentReference,
+        paymentTimestamp: '2020-06-01T10:35:56.873Z'
+      }
+    ]
+    salesApi.paymentJournals.getAll.mockReturnValue(journalEntriesAgreement)
+    salesApi.updatePaymentJournal.mockImplementation(jest.fn())
+    salesApi.finaliseTransaction.mockImplementation(jest.fn())
+    govUkPayApi.fetchPaymentStatus.mockResolvedValueOnce({
+      json: async () => ({ state: { status: 'success' } })
+    })
+    govUkPayApi.fetchPaymentEvents.mockResolvedValueOnce({
+      json: async () => ({ events: [{ state: { status: 'success' }, updated: '2020-06-01T10:35:56.873Z' }] })
+    })
+
+    await execute(1, 1)
+
+    expect(govUkPayApi.fetchPaymentStatus).toHaveBeenCalledWith(paymentReference, true)
+  })
+
+  it('calls fetchPaymentStatus with recurring as false since agreementId does not exist', async () => {
+    salesApi.retrieveStagedTransaction.mockReturnValueOnce({})
+    const paymentReference = '25nioqikvvnuu5l8m2qeaj0qap'
+    const journalEntriesAgreement = [
+      {
+        id: 'a0e0e5c3-1004-4271-80ba-d05eda3e8220',
+        paymentStatus: 'In Progress',
+        paymentReference,
+        paymentTimestamp: '2020-06-01T10:35:56.873Z'
+      }
+    ]
+    salesApi.paymentJournals.getAll.mockReturnValue(journalEntriesAgreement)
+    salesApi.updatePaymentJournal.mockImplementation(jest.fn())
+    salesApi.finaliseTransaction.mockImplementation(jest.fn())
+    govUkPayApi.fetchPaymentStatus.mockReturnValueOnce({
+      json: async () => ({ state: { status: 'success' } })
+    })
+
+    await execute(1, 1)
+
+    expect(govUkPayApi.fetchPaymentStatus).toHaveBeenCalledWith(paymentReference, false)
+  })
+
+  it('calls fetchPaymentEvents with recurring as true since agreementId exists', async () => {
+    salesApi.retrieveStagedTransaction.mockReturnValueOnce({ recurringPayment: { agreementId: '123' } })
+    const paymentReference = '35nioqikvvnuu5l8m2qeaj0qap'
+    const journalEntriesAgreement = [
+      {
+        id: 'a0e0e5c3-1004-4271-80ba-d05eda3e8220',
+        paymentStatus: 'In Progress',
+        paymentReference,
+        paymentTimestamp: '2020-06-01T10:35:56.873Z',
+        agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472'
+      }
+    ]
+    salesApi.paymentJournals.getAll.mockReturnValue(journalEntriesAgreement)
+    salesApi.updatePaymentJournal.mockImplementation(jest.fn())
+    salesApi.finaliseTransaction.mockImplementation(jest.fn())
+    govUkPayApi.fetchPaymentStatus.mockResolvedValueOnce({
+      json: async () => ({ state: { status: 'success' } })
+    })
+    govUkPayApi.fetchPaymentEvents.mockResolvedValueOnce({
+      json: async () => ({ events: [{ state: { status: 'success' }, updated: '2020-06-01T10:35:56.873Z' }] })
+    })
+
+    await execute(1, 1)
+
+    expect(govUkPayApi.fetchPaymentEvents).toHaveBeenCalledWith(paymentReference, true)
+  })
+
+  it('calls fetchPaymentEvents with recurring as false since agreementId does not exist', async () => {
+    salesApi.retrieveStagedTransaction.mockReturnValueOnce({})
+    const paymentReference = '45nioqikvvnuu5l8m2qeaj0qap'
+    const journalEntriesAgreement = [
+      {
+        id: 'a0e0e5c3-1004-4271-80ba-d05eda3e8220',
+        paymentStatus: 'In Progress',
+        paymentReference,
+        paymentTimestamp: '2020-06-01T10:35:56.873Z'
+      }
+    ]
+    salesApi.paymentJournals.getAll.mockReturnValue(journalEntriesAgreement)
+    salesApi.updatePaymentJournal.mockImplementation(jest.fn())
+    salesApi.finaliseTransaction.mockImplementation(jest.fn())
+    govUkPayApi.fetchPaymentStatus.mockReturnValueOnce({
+      json: async () => ({ state: { status: 'success' } })
+    })
+
+    await execute(1, 1)
+
+    expect(govUkPayApi.fetchPaymentEvents).toHaveBeenCalledWith(paymentReference, false)
+  })
+
   describe('Result not present in GovPay', () => {
     const NOT_FOUND_ID = journalEntries[2].id
     const NOT_FOUND_PAYMENT_REFERENCE = journalEntries[2].paymentReference
@@ -199,9 +298,7 @@ describe('processor', () => {
 
     it("when a payment isn't present in GovPay, it's marked as expired after 3 hours", async () => {
       const missingJournalEntry = journalEntries.find(je => je.id === NOT_FOUND_ID)
-      missingJournalEntry.paymentTimestamp = moment()
-        .subtract(3, 'hours')
-        .toISOString()
+      missingJournalEntry.paymentTimestamp = moment().subtract(3, 'hours').toISOString()
       await execute(1, 1)
       expect(salesApi.updatePaymentJournal).toHaveBeenCalledWith(
         NOT_FOUND_ID,
@@ -213,9 +310,7 @@ describe('processor', () => {
 
     it("when a payment isn't present in GovPay, it's not marked as expired if 3 hours haven't passed", async () => {
       const missingJournalEntry = journalEntries.find(je => je.id === NOT_FOUND_ID)
-      missingJournalEntry.paymentTimestamp = moment()
-        .subtract(2, 'hours')
-        .toISOString()
+      missingJournalEntry.paymentTimestamp = moment().subtract(2, 'hours').toISOString()
       await execute(1, 1)
       expect(salesApi.updatePaymentJournal).not.toHaveBeenCalledWith(
         NOT_FOUND_ID,

package/src/processors/processor.js

@@ -5,7 +5,6 @@ import {
   TRANSACTION_SOURCE,
   PAYMENT_TYPE
 } from '@defra-fish/business-rules-lib'
-
 import Bottleneck from 'bottleneck'
 import moment from 'moment'
 import db from 'debug'
@@ -61,11 +60,12 @@ const processPaymentResults = async transaction => {
   }
 }
 
-const getStatus = async paymentReference => {
-  const paymentStatusResponse = await govUkPayApi.fetchPaymentStatus(paymentReference)
+const getStatus = async (paymentReference, agreementId) => {
+  const recurring = !!agreementId
+  const paymentStatusResponse = await govUkPayApi.fetchPaymentStatus(paymentReference, recurring)
   const paymentStatus = await paymentStatusResponse.json()
   if (paymentStatus.state?.status === 'success') {
-    const eventsResponse = await govUkPayApi.fetchPaymentEvents(paymentReference)
+    const eventsResponse = await govUkPayApi.fetchPaymentEvents(paymentReference, recurring)
     const { events } = await eventsResponse.json()
     paymentStatus.transactionTimestamp = events.find(e => e.state.status === 'success')?.updated
   }
@@ -82,8 +82,6 @@ export const execute = async (ageMinutes, scanDurationHours) => {
   const toTimestamp = moment().add(-1 * ageMinutes, 'minutes')
   const fromTimestamp = toTimestamp.clone().add(-1 * scanDurationHours, 'hours')
 
-  console.log(`Scanning the payment journal for payments created between ${fromTimestamp} and ${toTimestamp}`)
-
   const paymentJournals = await salesApi.paymentJournals.getAll({
     paymentStatus: PAYMENT_JOURNAL_STATUS_CODES.InProgress,
     from: fromTimestamp.toISOString(),
@@ -92,10 +90,13 @@ export const execute = async (ageMinutes, scanDurationHours) => {
 
   // Get the status for each payment from the GOV.UK Pay API.
   const transactions = await Promise.all(
-    paymentJournals.map(async p => ({
-      ...p,
-      paymentStatus: await getStatusWrapped(p.paymentReference)
-    }))
+    paymentJournals.map(async p => {
+      const transactionRecord = await salesApi.retrieveStagedTransaction(p.id)
+      return {
+        ...p,
+        paymentStatus: await getStatusWrapped(p.paymentReference, transactionRecord?.recurringPayment?.agreementId)
+      }
+    })
   )
 
   // Process each result