Consume payment responses (#24)

.snyk

@@ -1,4 +1,18 @@
 # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.22.0
-ignore: {}
+version: v1.19.0
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-AXIOS-1579269:
+    - '@azure/identity > axios':
+        reason: no fix
+        expires: '2021-10-02T17:50:04.275Z'
+    - '@azure/identity > @azure/msal-node > axios':
+        reason: no fix
+        expires: '2021-10-02T17:50:04.276Z'
+    - ffc-messaging > @azure/identity > axios:
+        reason: No fix
+        expires: '2021-10-02T17:50:04.276Z'
+    - ffc-messaging > @azure/identity > @azure/msal-node > axios:
+        reason: No fix
+        expires: '2021-10-02T17:50:04.276Z'
 patch: {}

Dockerfile

@@ -1,4 +1,4 @@
-ARG PARENT_VERSION=1.2.5-node14.16.1
+ARG PARENT_VERSION=1.2.9-node14.17.6
 ARG PORT_DEBUG=9229
 ARG PORT=3008
 

app/acknowledgement.js

@@ -0,0 +1,9 @@
+const db = require('./data')
+
+const updateAcknowledgement = async (acknowledgement) => {
+  if (acknowledgement.success) {
+    await db.completedPaymentRequest.update({ acknowledged: acknowledgement.acknowledged }, { where: { invoiceNumber: acknowledgement.invoiceNumber } })
+  }
+}
+
+module.exports = updateAcknowledgement

app/config/index.js

@@ -36,6 +36,8 @@ const value = result.value
 value.isDev = value.env === 'development'
 value.isProd = value.env === 'production'
 value.processingSubscription = mqConfig.processingSubscription
+value.acknowledgementSubscription = mqConfig.acknowledgementSubscription
+value.returnSubscription = mqConfig.returnSubscription
 value.submitTopic = mqConfig.submitTopic
 value.dbConfig = dbConfig
 

app/config/mq-config.js

@@ -15,6 +15,16 @@ const mqSchema = joi.object({
     topic: joi.string(),
     numberOfReceivers: joi.number().default(3)
   },
+  acknowledgementSubscription: {
+    name: joi.string(),
+    address: joi.string(),
+    topic: joi.string()
+  },
+  returnSubscription: {
+    name: joi.string(),
+    address: joi.string(),
+    topic: joi.string()
+  },
   submitTopic: {
     name: joi.string(),
     address: joi.string()
@@ -34,6 +44,16 @@ const mqConfig = {
     address: process.env.PROCESSING_SUBSCRIPTION_ADDRESS,
     topic: process.env.PROCESSING_TOPIC_ADDRESS
   },
+  acknowledgementSubscription: {
+    name: process.env.ACKNOWLEDGEMENT_SUBSCRIPTION_NAME,
+    address: process.env.ACKNOWLEDGEMENT_SUBSCRIPTION_ADDRESS,
+    topic: process.env.ACKNOWLEDGEMENT_TOPIC_ADDRESS
+  },
+  returnSubscription: {
+    name: process.env.RETURN_SUBSCRIPTION_NAME,
+    address: process.env.RETURN_SUBSCRIPTION_ADDRESS,
+    topic: process.env.RETURN_TOPIC_ADDRESS
+  },
   submitTopic: {
     name: process.env.PAYMENTSUBMIT_TOPIC_NAME,
     address: process.env.PAYMENTSUBMIT_TOPIC_ADDRESS
@@ -50,9 +70,13 @@ if (mqResult.error) {
 }
 
 const processingSubscription = { ...mqResult.value.messageQueue, ...mqResult.value.processingSubscription }
+const acknowledgementSubscription = { ...mqResult.value.messageQueue, ...mqResult.value.acknowledgementSubscription }
+const returnSubscription = { ...mqResult.value.messageQueue, ...mqResult.value.returnSubscription }
 const submitTopic = { ...mqResult.value.messageQueue, ...mqResult.value.submitTopic }
 
 module.exports = {
   processingSubscription,
+  acknowledgementSubscription,
+  returnSubscription,
   submitTopic
 }

app/messaging/index.js

@@ -2,7 +2,11 @@ const config = require('../config')
 const processPaymentMessage = require('./process-payment-message')
 const { MessageReceiver } = require('ffc-messaging')
 const publishPendingPaymentRequests = require('./publish-pending-payment-requests')
+const processAcknowledgementMessage = require('./process-acknowledgement-message')
+const processReturnMessage = require('./process-return-message')
 const paymentReceivers = []
+let acknowledgementReceiver
+let returnReceiver
 
 const start = async () => {
   for (let i = 0; i < config.processingSubscription.numberOfReceivers; i++) {
@@ -15,6 +19,14 @@ const start = async () => {
   }
   setInterval(() => publishPendingPaymentRequests(), config.paymentRequestPublishingInterval)
   console.info('Ready to publish payment requests')
+
+  const acknowledgementAction = message => processAcknowledgementMessage(message, acknowledgementReceiver)
+  acknowledgementReceiver = new MessageReceiver(config.acknowledgementSubscription, acknowledgementAction)
+  await acknowledgementReceiver.subscribe()
+
+  const returnAction = message => processReturnMessage(message, returnReceiver)
+  returnReceiver = new MessageReceiver(config.returnSubscription, returnAction)
+  await returnReceiver.subscribe()
 }
 
 const stop = async () => {

app/messaging/process-acknowledgement-message.js

@@ -0,0 +1,13 @@
+const updateAcknowledgement = require('../acknowledgement')
+
+const processAcknowledgementMessage = async (message, receiver) => {
+  try {
+    await updateAcknowledgement(message.body)
+    await receiver.completeMessage(message)
+  } catch (err) {
+    console.error('Unable to process acknowledgement request:', err)
+    await receiver.deadLetterMessage(message)
+  }
+}
+
+module.exports = processAcknowledgementMessage

app/messaging/process-return-message.js

@@ -0,0 +1,13 @@
+const updateSettlementStatus = require('../settlement')
+
+const processReturnMessage = async (message, receiver) => {
+  try {
+    await updateSettlementStatus(message.body)
+    await receiver.completeMessage(message)
+  } catch (err) {
+    console.error('Unable to process return request:', err)
+    await receiver.deadLetterMessage(message)
+  }
+}
+
+module.exports = processReturnMessage

app/settlement.js

@@ -0,0 +1,9 @@
+const db = require('./data')
+
+const updateSettlementStatus = async (returnData) => {
+  if (returnData.settled) {
+    await db.completedPaymentRequest.update({ settled: returnData.settlementDate }, { where: { invoiceNumber: returnData.invoiceNumber } })
+  }
+}
+
+module.exports = updateSettlementStatus

docker-compose.yaml

@@ -16,6 +16,10 @@ services:
       MESSAGE_QUEUE_USER: ${MESSAGE_QUEUE_USER:-notset}
       PROCESSING_TOPIC_ADDRESS: ${PROCESSING_TOPIC_ADDRESS:-notset}
       PROCESSING_SUBSCRIPTION_ADDRESS: ${PROCESSING_SUBSCRIPTION_ADDRESS:-notset}
+      ACKNOWLEDGEMENT_TOPIC_ADDRESS: ${ACKNOWLEDGEMENT_TOPIC_ADDRESS:-notset}
+      ACKNOWLEDGEMENT_SUBSCRIPTION_ADDRESS: ${ACKNOWLEDGEMENT_SUBSCRIPTION_ADDRESS:-notset}
+      RETURN_TOPIC_ADDRESS: ${RETURN_TOPIC_ADDRESS:-notset}
+      RETURN_SUBSCRIPTION_ADDRESS: ${RETURN_SUBSCRIPTION_ADDRESS:-notset}
       PAYMENTSUBMIT_TOPIC_ADDRESS: ${PAYMENTSUBMIT_TOPIC_ADDRESS:-notset}
       POSTGRES_DB: ffc_sfi_payments
       POSTGRES_HOST: ${POSTGRES_HOST:-ffc-sfi-payments-postgres}

helm/ffc-sfi-payments/templates/config-map.yaml

@@ -6,6 +6,10 @@ data:
   MESSAGE_QUEUE_HOST: {{ quote .Values.container.messageQueueHost }}
   PROCESSING_TOPIC_ADDRESS: {{ quote .Values.container.processingTopicAddress }}
   PROCESSING_SUBSCRIPTION_ADDRESS: {{ quote .Values.container.processingSubscriptionAddress }}
+  ACKNOWLEDGEMENT_TOPIC_ADDRESS: {{ quote .Values.container.acknowledgementTopicAddress }}
+  ACKNOWLEDGEMENT_SUBSCRIPTION_ADDRESS: {{ quote .Values.container.acknowledgementSubscriptionAddress }}
+  RETURN_TOPIC_ADDRESS: {{ quote .Values.container.returnTopicAddress }}
+  RETURN_SUBSCRIPTION_ADDRESS: {{ quote .Values.container.returnSubscriptionAddress }}
   PAYMENTSUBMIT_TOPIC_ADDRESS: {{ quote .Values.container.paymentSubmitTopicAddress }}
   POSTGRES_DB: {{ quote .Values.postgresService.postgresDb }}
   POSTGRES_HOST: {{ quote .Values.postgresService.postgresHost }}

helm/ffc-sfi-payments/values.yaml

@@ -36,11 +36,15 @@ container:
   requestMemory: 180Mi
   requestCpu: 40m
   limitMemory: 280Mi
-  limitCpu: 120m
+  limitCpu: 300m
   port: 3008
   messageQueueHost: namespace.servicebus.windows.net
   processingTopicAddress: ffc-sfi-payment-processing
   processingSubscriptionAddress: ffc-sfi-payment-processing-payments
+  acknowledgementTopicAddress: ffc-sfi-payment-acknowledgement
+  acknowledgementSubscriptionAddress: ffc-sfi-payment-acknowledgement-payments
+  returnTopicAddress: ffc-sfi-payment-return
+  returnSubscriptionAddress: ffc-sfi-payment-return-payments
   paymentSubmitTopicAddress: ffc-sfi-payment-submit
 
 postgresService:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-sfi-payments",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "FFC SFI payment services",
   "homepage": "https://github.com/DEFRA/ffc-sfi-payments",
   "main": "app/index.js",

provision.azure.yaml

@@ -1,3 +1,5 @@
 resources:
   topics:
-    - name: payment
+    - name: processing
+    - name: acknowledgement
+    - name: return

test/integration/local/acknowledgement.test.js

@@ -0,0 +1,56 @@
+const db = require('../../../app/data')
+const updateAcknowledgement = require('../../../app/acknowledgement')
+let scheme
+let paymentRequest
+let acknowledgement
+
+describe('update settlement status', () => {
+  beforeEach(async () => {
+    await db.sequelize.truncate({ cascade: true })
+
+    scheme = {
+      schemeId: 1,
+      name: 'SFI',
+      active: true
+    }
+
+    paymentRequest = {
+      completedPaymentRequestId: 1,
+      paymentRequestId: 1,
+      schemeId: 1,
+      frn: 1234567890,
+      marketingYear: 2022,
+      invoiceNumber: 'S12345678A123456V001'
+    }
+
+    acknowledgement = {
+      invoiceNumber: 'S12345678A123456V001',
+      acknowledged: new Date(2021, 8, 2),
+      success: true
+    }
+  })
+
+  afterAll(async () => {
+    await db.sequelize.truncate({ cascade: true })
+    await db.sequelize.close()
+  })
+
+  test('should add acknowledged date if success', async () => {
+    await db.scheme.create(scheme)
+    await db.paymentRequest.create(paymentRequest)
+    await db.completedPaymentRequest.create(paymentRequest)
+    await updateAcknowledgement(acknowledgement)
+    const updatedPaymentRequest = await db.completedPaymentRequest.findByPk(paymentRequest.paymentRequestId)
+    expect(updatedPaymentRequest.acknowledged).toStrictEqual(new Date(2021, 8, 2))
+  })
+
+  test('should not add acknowledged date to failure', async () => {
+    await db.scheme.create(scheme)
+    await db.paymentRequest.create(paymentRequest)
+    await db.completedPaymentRequest.create(paymentRequest)
+    acknowledgement.success = false
+    await updateAcknowledgement(acknowledgement)
+    const updatedPaymentRequest = await db.completedPaymentRequest.findByPk(paymentRequest.paymentRequestId)
+    expect(updatedPaymentRequest.acknowledged).toBeNull()
+  })
+})

test/integration/local/settlement.test.js

@@ -0,0 +1,56 @@
+const db = require('../../../app/data')
+const updateSettlementStatus = require('../../../app/settlement')
+let scheme
+let paymentRequest
+let returnData
+
+describe('update settlement status', () => {
+  beforeEach(async () => {
+    await db.sequelize.truncate({ cascade: true })
+
+    scheme = {
+      schemeId: 1,
+      name: 'SFI',
+      active: true
+    }
+
+    paymentRequest = {
+      completedPaymentRequestId: 1,
+      paymentRequestId: 1,
+      schemeId: 1,
+      frn: 1234567890,
+      marketingYear: 2022,
+      invoiceNumber: 'S12345678A123456V001'
+    }
+
+    returnData = {
+      invoiceNumber: 'S12345678A123456V001',
+      settled: true,
+      settlementDate: new Date(2021, 8, 2)
+    }
+  })
+
+  afterAll(async () => {
+    await db.sequelize.truncate({ cascade: true })
+    await db.sequelize.close()
+  })
+
+  test('should add settlement date to settled', async () => {
+    await db.scheme.create(scheme)
+    await db.paymentRequest.create(paymentRequest)
+    await db.completedPaymentRequest.create(paymentRequest)
+    await updateSettlementStatus(returnData)
+    const updatedPaymentRequest = await db.completedPaymentRequest.findByPk(paymentRequest.paymentRequestId)
+    expect(updatedPaymentRequest.settled).toStrictEqual(new Date(2021, 8, 2))
+  })
+
+  test('should not add settlement date to unsettled', async () => {
+    await db.scheme.create(scheme)
+    await db.paymentRequest.create(paymentRequest)
+    await db.completedPaymentRequest.create(paymentRequest)
+    returnData.settled = false
+    await updateSettlementStatus(returnData)
+    const updatedPaymentRequest = await db.completedPaymentRequest.findByPk(paymentRequest.paymentRequestId)
+    expect(updatedPaymentRequest.settled).toBeNull()
+  })
+})

test/unit/messaging/process-acknowledgement-message.test.js

@@ -0,0 +1,42 @@
+jest.mock('ffc-messaging')
+jest.mock('../../../app/data')
+jest.mock('../../../app/acknowledgement')
+const mockUpdateAcknowledgement = require('../../../app/acknowledgement')
+const processAcknowledgementMessage = require('../../../app/messaging/process-acknowledgement-message')
+let receiver
+
+describe('process acknowledgement message', () => {
+  beforeEach(() => {
+    receiver = {
+      completeMessage: jest.fn(),
+      deadLetterMessage: jest.fn()
+    }
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('completes valid message', async () => {
+    const message = {
+      body: {
+        frn: 1234567890
+      }
+    }
+    await processAcknowledgementMessage(message, receiver)
+    expect(receiver.completeMessage).toHaveBeenCalledWith(message)
+  })
+
+  test('dead letters invalid message', async () => {
+    mockUpdateAcknowledgement.mockImplementation(() => {
+      throw new Error()
+    })
+    const message = {
+      body: {
+        frn: 1234567890
+      }
+    }
+    await processAcknowledgementMessage(message, receiver)
+    expect(receiver.deadLetterMessage).toHaveBeenCalledWith(message)
+  })
+})