@defra-fish/sales-api-service 1.76.0-rc.2 → 1.76.0-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.76.0-rc.2",
+  "version": "1.76.0-rc.4",
   "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.76.0-rc.2",
-    "@defra-fish/connectors-lib": "1.76.0-rc.2",
-    "@defra-fish/dynamics-lib": "1.76.0-rc.2",
+    "@defra-fish/business-rules-lib": "1.76.0-rc.4",
+    "@defra-fish/connectors-lib": "1.76.0-rc.4",
+    "@defra-fish/dynamics-lib": "1.76.0-rc.4",
     "@hapi/boom": "9.1.2",
     "@hapi/hapi": "20.1.3",
     "@hapi/inert": "6.0.3",
@@ -53,5 +53,5 @@
     "moment-timezone": "0.5.34",
     "uuid": "8.3.2"
   },
-  "gitHead": "254132463f912d406c9260b08e694e20dbc2cc46"
+  "gitHead": "92ce370aa6b17da8ad236ba2bc071240bc677ed1"
 }

package/src/services/transactions/__tests__/__snapshots__/finalise-transaction.spec.js.snap

@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`transaction service finaliseTransaction transaction rollback throws an internal server error if the SQS message fails to send 1`] = `"Failed to send transaction to staging queue: SQS send message failed"`;
+
+exports[`transaction service finaliseTransaction transaction rollback throws an internal server error if the rollback fails 1`] = `"Failed to rollback transaction record b364c12f-ce62-4c62-b4bd-4a06fd57e256 after SQS send failure: Rollback failed"`;

package/src/services/transactions/__tests__/finalise-transaction.spec.js

@@ -12,9 +12,12 @@ import moment from 'moment'
 import { TRANSACTION_STATUS } from '../constants.js'
 import permissionsService from '../../permissions.service.js'
 import { AWS } from '@defra-fish/connectors-lib'
+import db from 'debug'
 
 const { START_AFTER_PAYMENT_MINUTES } = BusinessRulesLib
 const { docClient, sqs } = AWS.mock.results[0].value
+const debugLogger = db.mock.results[1].value // first call is by retrieve-transaction.js
+global.structuredClone = global.structuredClone ?? (obj => JSON.parse(JSON.stringify(obj)))
 
 jest.mock('../../permissions.service.js', () => ({
   generatePermissionNumber: jest.fn(() => MOCK_PERMISSION_NUMBER),
@@ -50,6 +53,8 @@ jest.mock('@defra-fish/connectors-lib', () => {
   }
 })
 
+jest.mock('debug', () => jest.fn(() => jest.fn()))
+
 const getStagedTransactionRecord = () => {
   const record = mockStagedTransactionRecord()
   const {
@@ -265,6 +270,107 @@ describe('transaction service', () => {
       docClient.get.mockRejectedValueOnce(new Error('Test error'))
       await expect(finaliseTransaction(mockTransactionPayload())).rejects.toThrow('Test error')
     })
+
+    describe('transaction rollback', () => {
+      const sqsFailureSetup = ({
+        mockRecord = mockStagedTransactionRecord(),
+        updateExpression = { expression: 'update-expression' }
+      } = {}) => {
+        docClient.get.mockResolvedValueOnce({ Item: mockRecord })
+        docClient.createUpdateExpression.mockReturnValueOnce({}).mockReturnValueOnce(updateExpression)
+        const { id: _omitId, ...originalRecord } = JSON.parse(JSON.stringify(mockRecord))
+        sqs.sendMessage.mockRejectedValueOnce(new Error('SQS send message failed'))
+        return { mockRecord, originalRecord }
+      }
+
+      const getSamplePayment = () => ({
+        amount: 30,
+        timestamp: new Date().toISOString()
+      })
+
+      it('rolls back the transaction if the SQS message fails to send', async () => {
+        const updateExpression = { expression: Symbol('update-expression') }
+        const { mockRecord } = sqsFailureSetup({ updateExpression })
+        try {
+          await finaliseTransaction({
+            id: mockRecord.id,
+            payment: getSamplePayment()
+          })
+        } catch (e) {}
+
+        expect(docClient.update).toHaveBeenNthCalledWith(
+          2,
+          expect.objectContaining({
+            TableName: TRANSACTION_STAGING_TABLE.TableName,
+            Key: { id: mockRecord.id },
+            ...updateExpression
+          })
+        )
+      })
+
+      it('uses createUpdateExpression to roll back the transaction when the SQS message fails to send', async () => {
+        const updateExpression = { expression: Symbol('update-expression') }
+        const { mockRecord, originalRecord } = sqsFailureSetup({
+          mockRecord: {
+            ...mockStagedTransactionRecord(),
+            uniqueTag: 'afd113fe-acfb-4124-a2ed-f1b182df55fd'
+          },
+          updateExpression
+        })
+        try {
+          await finaliseTransaction({
+            id: mockRecord.id,
+            payment: getSamplePayment()
+          })
+        } catch (e) {}
+
+        expect(docClient.createUpdateExpression).toHaveBeenNthCalledWith(2, originalRecord)
+      })
+
+      it('throws an internal server error if the SQS message fails to send', async () => {
+        const {
+          mockRecord: { id }
+        } = sqsFailureSetup()
+
+        await expect(
+          finaliseTransaction({
+            id,
+            payment: getSamplePayment()
+          })
+        ).rejects.toThrowErrorMatchingSnapshot()
+      })
+
+      it('logs the error if the SQS message fails to send', async () => {
+        const {
+          mockRecord: { id }
+        } = sqsFailureSetup()
+        try {
+          await finaliseTransaction({ id, payment: getSamplePayment() })
+        } catch (e) {}
+        expect(debugLogger).toHaveBeenCalledWith(
+          'Error sending transaction %s to staging queue: %o',
+          id,
+          expect.objectContaining({
+            message: 'Failed to send transaction to staging queue: SQS send message failed',
+            isBoom: true
+          })
+        )
+      })
+
+      it('throws an internal server error if the rollback fails', async () => {
+        const {
+          mockRecord: { id }
+        } = sqsFailureSetup()
+        docClient.update.mockResolvedValueOnce({ Attributes: { status: {} } })
+        docClient.update.mockRejectedValueOnce(new Error('Rollback failed'))
+        await expect(
+          finaliseTransaction({
+            id,
+            payment: getSamplePayment()
+          })
+        ).rejects.toThrowErrorMatchingSnapshot()
+      })
+    })
   })
 
   describe('finaliseTransaction adjusts licence times according to issue date and start date', () => {

package/src/services/transactions/finalise-transaction.js

@@ -23,6 +23,7 @@ const getAdjustedStartDate = ({ issueDate, startDate, dataSource }) => {
 export async function finaliseTransaction ({ id, ...payload }) {
   debug('Finalising transaction %s', id)
   const transactionRecord = await retrieveStagedTransaction(id)
+  const { id: _omitId, ...originalTransactionRecord } = structuredClone(transactionRecord)
 
   if (transactionRecord.status?.id === TRANSACTION_STATUS.FINALISED) {
     throw Boom.resourceGone('The transaction has already been finalised', transactionRecord)
@@ -60,12 +61,29 @@ export async function finaliseTransaction ({ id, ...payload }) {
   })
   debug('Updated transaction record for identifier %s', id)
 
-  const receipt = await sqs.sendMessage({
-    QueueUrl: TRANSACTION_QUEUE.Url,
-    MessageGroupId: id,
-    MessageDeduplicationId: id,
-    MessageBody: JSON.stringify({ id })
-  })
+  const receipt = await (async () => {
+    try {
+      return await sqs.sendMessage({
+        QueueUrl: TRANSACTION_QUEUE.Url,
+        MessageGroupId: id,
+        MessageDeduplicationId: id,
+        MessageBody: JSON.stringify({ id })
+      })
+    } catch (error) {
+      try {
+        await docClient.update({
+          TableName: TRANSACTION_STAGING_TABLE.TableName,
+          Key: { id },
+          ...docClient.createUpdateExpression(originalTransactionRecord),
+          ReturnValues: 'ALL_NEW'
+        })
+      } catch (rollbackError) {
+        throw Boom.internal(`Failed to rollback transaction record ${id} after SQS send failure`, rollbackError)
+      }
+      debug('Error sending transaction %s to staging queue: %o', id, error)
+      throw Boom.internal('Failed to send transaction to staging queue', error)
+    }
+  })()
 
   debug('Sent transaction %s to staging queue with message-id %s', id, receipt.MessageId)
   updatedRecord.status.messageId = receipt.MessageId