Merge pull request #474 from DEFRA/fix/df-912-dlq-payload

fix/df-912: Changed delete to contain receiptHandle in the payload

Author: jbarnsley10

src/api/types.js

@@ -65,7 +65,7 @@
  */
 
 /**
- * @typedef {{ Params: { dlq: string, receiptHandle: string }}} DeadLetterQueueAndHandleRequest
+ * @typedef {{ Params: { dlq: string, messageId: string }, Payload: { receiptHandle: string }}} DeadLetterQueueAndHandleRequest
  */
 
 /**

src/models/form.js

@@ -66,4 +66,6 @@ export const getSubmissionByReferenceResponseSchema = Joi.object()
  */
 export const dqlSchema = Joi.string().valid('form-submissions', 'save-and-exit')
 
+export const messageIdSchema = Joi.string()
+
 export const receiptHandleSchema = Joi.string()

src/routes/admin.js

@@ -1,6 +1,7 @@
 import { Scopes, idSchema } from '@defra/forms-model'
 import Joi from 'joi'
 
+import { createLogger } from '~/src/helpers/logging/logger.js'
 import {
   deleteDlqMessage,
   receiveDlqMessages,
@@ -11,6 +12,7 @@ import {
   generateFeedbackSubmissionsFileResponseSchema,
   generateFormSubmissionsFileResponseSchema,
   magicLinkSchema,
+  messageIdSchema,
   receiptHandleSchema,
   resetSaveAndExitLinkResponseSchema
 } from '~/src/models/form.js'
@@ -23,6 +25,8 @@ import {
 
 const OK_RESPONSE = 200
 
+const logger = createLogger()
+
 export default [
   /**
    * @satisfies {ServerRoute<ResetSaveAndExit>}
@@ -170,7 +174,10 @@ export default [
     path: '/admin/deadletter/{dlq}/redrive',
     async handler(request, h) {
       const { params } = request
-      await redriveDlqMessages(params.dlq)
+      const { dlq } = params
+      logger.info(`Redriving DLQ ${dlq}`)
+      await redriveDlqMessages(dlq)
+      logger.info(`Redriving DLQ ${dlq} triggered successfully`)
       return h.response({ message: 'success' }).code(OK_RESPONSE)
     },
     options: {
@@ -193,10 +200,14 @@ export default [
    */
   ({
     method: 'DELETE',
-    path: '/admin/deadletter/{dlq}/{receiptHandle}',
+    path: '/admin/deadletter/{dlq}/{messageId}',
     async handler(request, h) {
-      const { params } = request
-      await deleteDlqMessage(params.dlq, params.receiptHandle)
+      const { params, payload } = request
+      const { dlq, messageId } = params
+      const { receiptHandle } = payload
+      logger.info(`Deleting DLQ message ${messageId} on ${dlq}`)
+      await deleteDlqMessage(dlq, receiptHandle)
+      logger.info(`Deleted DLQ message ${messageId} on ${dlq}`)
       return h.response({ message: 'success' }).code(OK_RESPONSE)
     },
     options: {
@@ -208,9 +219,14 @@ export default [
         params: Joi.object()
           .keys({
             dlq: dqlSchema.required(),
+            messageId: messageIdSchema.required()
+          })
+          .label('deadLetterDeleteMessageParams'),
+        payload: Joi.object()
+          .keys({
             receiptHandle: receiptHandleSchema.required()
           })
-          .label('deadLetterQueueAndHandleParams')
+          .label('deadLetterDeleteMessagePayload')
       }
     }
   })

src/routes/admin.test.js

@@ -254,30 +254,42 @@ describe('Admin route', () => {
   })
 
   describe('DELETE', () => {
-    test('/admin/dead-letter/save-and-exit/receiptHandle route returns 200', async () => {
+    test('/admin/dead-letter/save-and-exit/message-id route returns 200', async () => {
       const response = await server.inject({
         method: 'DELETE',
-        url: '/admin/deadletter/save-and-exit/receipt-handle',
-        auth: authSuperadmin
+        url: '/admin/deadletter/save-and-exit/message-id',
+        auth: authSuperadmin,
+        payload: {
+          receiptHandle: 'receipt-handle'
+        }
       })
 
       expect(response.statusCode).toEqual(okStatusCode)
       expect(response.headers['content-type']).toContain(jsonContentType)
       expect(response.result).toEqual({ message: 'success' })
-      expect(deleteDlqMessage).toHaveBeenCalled()
+      expect(deleteDlqMessage).toHaveBeenCalledWith(
+        'save-and-exit',
+        'receipt-handle'
+      )
     })
 
-    test('/admin/dead-letter/form-submissions/receiptHandle route returns 200', async () => {
+    test('/admin/dead-letter/form-submissions/message-id route returns 200', async () => {
       const response = await server.inject({
         method: 'DELETE',
-        url: '/admin/deadletter/form-submissions/receipt-handle',
-        auth: authSuperadmin
+        url: '/admin/deadletter/form-submissions/message-id',
+        auth: authSuperadmin,
+        payload: {
+          receiptHandle: 'receipt-handle'
+        }
       })
 
       expect(response.statusCode).toEqual(okStatusCode)
       expect(response.headers['content-type']).toContain(jsonContentType)
       expect(response.result).toEqual({ message: 'success' })
-      expect(deleteDlqMessage).toHaveBeenCalled()
+      expect(deleteDlqMessage).toHaveBeenCalledWith(
+        'form-submissions',
+        'receipt-handle'
+      )
     })
   })
 })