Added 'delete DLQ message'

Author: jbarnsley10

src/messaging/event.js

@@ -40,7 +40,8 @@ export function receiveDlqMessages() {
   const command = new ReceiveMessageCommand({
     QueueUrl: deadLetterQueueUrl,
     MaxNumberOfMessages: 10,
-    VisibilityTimeout: 5
+    VisibilityTimeout: 1,
+    WaitTimeSeconds: 0
   })
   return sqsClient.send(command)
 }
@@ -56,6 +57,20 @@ export function redriveDlqMessages() {
   return sqsClient.send(command)
 }
 
+/**
+ * Delete DLQ message
+ * @param {string} receiptHandle
+ * @returns {Promise<DeleteMessageCommandOutput>}
+ */
+export function deleteDlqMessage(receiptHandle) {
+  const command = new DeleteMessageCommand({
+    QueueUrl: deadLetterQueueUrl,
+    ReceiptHandle: receiptHandle
+  })
+
+  return sqsClient.send(command)
+}
+
 /**
  * Delete event message
  * @param {Message} message

src/messaging/event.test.js

@@ -8,6 +8,7 @@ import { mockClient } from 'aws-sdk-client-mock'
 
 import 'aws-sdk-client-mock-jest'
 import {
+  deleteDlqMessage,
   deleteEventMessage,
   receiveDlqMessages,
   receiveEventMessages,
@@ -67,7 +68,8 @@ describe('event', () => {
       await receiveDlqMessages()
       expect(snsMock).toHaveReceivedCommandWith(ReceiveMessageCommand, {
         QueueUrl: expect.any(String),
-        VisibilityTimeout: 5
+        VisibilityTimeout: 1,
+        WaitTimeSeconds: 0
       })
     })
   })
@@ -89,6 +91,24 @@ describe('event', () => {
       })
     })
   })
+
+  describe('deleteDlqMessage', () => {
+    it('should delete event message', async () => {
+      /**
+       * @type {DeleteMessageCommandOutput}
+       */
+      const deleteResult = {
+        $metadata: {}
+      }
+
+      snsMock.on(DeleteMessageCommand).resolves(deleteResult)
+      await deleteDlqMessage(messageStub.ReceiptHandle)
+      expect(snsMock).toHaveReceivedCommandWith(DeleteMessageCommand, {
+        QueueUrl: expect.any(String),
+        ReceiptHandle: receiptHandle
+      })
+    })
+  })
 })
 
 /**

src/routes/admin.js

@@ -1,12 +1,18 @@
 import { Scopes } from '@defra/forms-model'
+import Joi from 'joi'
 
 import {
+  deleteDlqMessage,
   receiveDlqMessages,
   redriveDlqMessages
 } from '~/src/messaging/event.js'
 
 const OK_RESPONSE = 200
 
+const receiptHandleSchema = Joi.object({
+  receiptHandle: Joi.string().required()
+})
+
 /**
  * @type {ServerRoute[]}
  */
@@ -16,7 +22,7 @@ export default [
     path: '/admin/deadletter/view',
     async handler(_request, h) {
       const messages = await receiveDlqMessages()
-      return h.response({ messages: messages.Messages }).code(OK_RESPONSE)
+      return h.response({ messages: messages.Messages ?? [] }).code(OK_RESPONSE)
     },
     options: {
       auth: {
@@ -40,6 +46,27 @@ export default [
         scope: [`+${Scopes.DeadLetterQueues}`]
       }
     }
+  },
+
+  /**
+   * @type {ServerRoute}
+   */
+  {
+    method: 'DELETE',
+    path: '/admin/deadletter/{receiptHandle}',
+    async handler(request, h) {
+      const { params } = request
+      await deleteDlqMessage(params.receiptHandle)
+      return h.response({ message: 'success' }).code(OK_RESPONSE)
+    },
+    options: {
+      auth: {
+        scope: [`+${Scopes.DeadLetterQueues}`]
+      },
+      validate: {
+        params: receiptHandleSchema
+      }
+    }
   }
 ]
 

src/routes/admin.test.js

@@ -1,5 +1,6 @@
 import { createServer } from '~/src/api/server.js'
 import {
+  deleteDlqMessage,
   receiveDlqMessages,
   redriveDlqMessages
 } from '~/src/messaging/event.js'
@@ -55,6 +56,21 @@ describe('Admin routes', () => {
       expect(redriveDlqMessages).toHaveBeenCalled()
     })
   })
+
+  describe('DELETE', () => {
+    test('/admin/dead-letter/receiptHandle route returns 200', async () => {
+      const response = await server.inject({
+        method: 'DELETE',
+        url: '/admin/deadletter/receipt-handle',
+        auth
+      })
+
+      expect(response.statusCode).toEqual(okStatusCode)
+      expect(response.headers['content-type']).toContain(jsonContentType)
+      expect(response.result).toEqual({ message: 'success' })
+      expect(deleteDlqMessage).toHaveBeenCalled()
+    })
+  })
 })
 
 /**