From d539342b6480fe649a9ea6fbf483147756a7a618 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Mon, 27 Apr 2026 09:43:07 +0100 Subject: [PATCH 1/7] Stash with retry --- .../src/routes/admin/dead-letter-queues.js | 61 +++++++++++++++---- 1 file changed, 49 insertions(+), 12 deletions(-) diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index 1f71b861f..f816622b8 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -30,6 +30,9 @@ const REDRIVE = 'redrive' const DELETE = 'delete' const CONFIRM = 'confirm' +const MAX_DLQ_READ_ATTEMPTS = 5 +const WAIT_TIME_IN_MILLIS = 1000 + const dlqSchema = Joi.string() .required() .valid(...Object.values(DeadLetterQueues)) @@ -118,17 +121,43 @@ export function validateMessageJson(messageJson) { } } +/** + * @param {DeadLetterQueues} dlq + * @param {string} token + * @param {string} messageId + * @returns {Promise} + */ +export async function readDlqWithRetry(dlq, token, messageId) { + let attempts = 0 + let foundMessage + while (attempts < MAX_DLQ_READ_ATTEMPTS) { + attempts++ + const messages = await getDeadLetterQueueMessages(dlq, token) + + foundMessage = messages.find((m) => m.json.MessageId === messageId) + if (foundMessage) { + break + } + + await new Promise((resolve) => + setTimeout(resolve, WAIT_TIME_IN_MILLIS) + ) + } + return foundMessage +} + /** * Keep specific properties - * @param {any[]} messages + * @param {any} message + * @returns {{ json: { MessageId: string, Body: any }}} */ -export function dlqMessageMapper(messages) { - return messages.map((m) => ({ +export function dlqMessageMapper(message) { + return { json: { - MessageId: m.MessageId, - Body: JSON.parse(m.Body) + MessageId: message.MessageId, + Body: JSON.parse(message.Body) } - })) + } } export function generateTitling() { @@ -451,11 +480,18 @@ export default [ .flash(sessionNames.validationFailure.deadLetterQueues) .at(0) - const messages = await getDeadLetterQueueMessages(dlq, token) + const foundMessage = await readDlqWithRetry(dlq, token, messageId) - const mappedMessage = dlqMessageMapper(messages).find( - (m) => m.json.MessageId === messageId - ) + if (!foundMessage) { + return redirectWithErrors( + request, + h, + error, + sessionNames.validationFailure.deadLetterQueues + ) + } + + const mappedMessage = dlqMessageMapper(foundMessage) const { formValues, formErrors } = validation ?? {} @@ -467,7 +503,7 @@ export default [ }, value: formValues?.messageJson ?? - JSON.stringify(mappedMessage?.json, null, 2), + JSON.stringify(mappedMessage.json, null, 2), rows: 30, errorMessage: formErrors?.messageJson ? { text: formErrors.messageJson.text } @@ -525,9 +561,10 @@ export default [ } const messages = await getDeadLetterQueueMessages(dlq, token) - const originalMessage = dlqMessageMapper(messages).find( + const message = messages.find( (m) => m.json.MessageId === messageId ) + const originalMessage = dlqMessageMapper(message) await resubmitDeadLetterQueueMessage(dlq, messageId, body, token) From 5ae463e5cac70d8bcef25091b356670b8a2845c5 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Mon, 27 Apr 2026 11:43:07 +0100 Subject: [PATCH 2/7] Handles message not found --- .../src/routes/admin/dead-letter-queues.js | 61 ++++++++++++++----- .../routes/admin/dead-letter-queues.test.js | 54 +++++++++++++++- 2 files changed, 97 insertions(+), 18 deletions(-) diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index f816622b8..21c0206c0 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -14,6 +14,7 @@ import { resubmitDeadLetterQueueMessage } from '~/src/lib/dead-letter-queue.js' import { createJoiError } from '~/src/lib/error-boom-helper.js' +import { addErrorsToSession } from '~/src/lib/error-helper.js' import { redirectWithErrors } from '~/src/lib/redirect-helper.js' import { publishDlqActionEvent } from '~/src/messaging/publish.js' import { @@ -134,14 +135,12 @@ export async function readDlqWithRetry(dlq, token, messageId) { attempts++ const messages = await getDeadLetterQueueMessages(dlq, token) - foundMessage = messages.find((m) => m.json.MessageId === messageId) + foundMessage = messages.find((m) => m.MessageId === messageId) if (foundMessage) { break } - await new Promise((resolve) => - setTimeout(resolve, WAIT_TIME_IN_MILLIS) - ) + await new Promise((resolve) => setTimeout(resolve, WAIT_TIME_IN_MILLIS)) } return foundMessage } @@ -160,6 +159,14 @@ export function dlqMessageMapper(message) { } } +/** + * @param {any[]} messages + * @returns {{ json: { MessageId: string, Body: any }}[]} + */ +export function dlqMessagesMapper(messages) { + return messages.map(dlqMessageMapper) +} + export function generateTitling() { const pageHeading = ADMIN_TOOLS @@ -312,9 +319,14 @@ export default [ const navigation = buildAdminNavigation(ADMIN_TOOLS) + // Validation errors + const validation = yar + .flash(sessionNames.validationFailure.deadLetterQueues) + .at(0) + const messages = await getDeadLetterQueueMessages(dlq, token) - const mappedMessages = dlqMessageMapper(messages) + const mappedMessages = dlqMessagesMapper(messages) // Saved banner const notification = /** @type {string[] | undefined} */ ( @@ -333,7 +345,8 @@ export default [ text: dlq }, messages: mappedMessages, - queueName: dlq + queueName: dlq, + errorList: buildErrorList(validation?.formErrors) }) }, options: { @@ -463,7 +476,7 @@ export default [ }), /** - * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string } }>} + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: any }>} */ ({ method: 'GET', @@ -483,12 +496,18 @@ export default [ const foundMessage = await readDlqWithRetry(dlq, token, messageId) if (!foundMessage) { - return redirectWithErrors( + const error = createJoiError( + 'messageJson', + `Unable to find message ${messageId} in dead letter queue` + ) + addErrorsToSession( request, - h, - error, - sessionNames.validationFailure.deadLetterQueues + sessionNames.validationFailure.deadLetterQueues, + error ) + return h + .redirect(`${ROUTE_FULL_PATH}/${dlq}`) + .code(StatusCodes.SEE_OTHER) } const mappedMessage = dlqMessageMapper(foundMessage) @@ -560,11 +579,21 @@ export default [ ) } - const messages = await getDeadLetterQueueMessages(dlq, token) - const message = messages.find( - (m) => m.json.MessageId === messageId - ) - const originalMessage = dlqMessageMapper(message) + const foundMessage = await readDlqWithRetry(dlq, token, messageId) + if (!foundMessage) { + const error = createJoiError( + 'messageJson', + `Unable to find message ${messageId} in dead letter queue` + ) + return redirectWithErrors( + request, + h, + error, + sessionNames.validationFailure.deadLetterQueues + ) + } + + const originalMessage = dlqMessageMapper(foundMessage) await resubmitDeadLetterQueueMessage(dlq, messageId, body, token) diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index d88c6d4f6..c84d8d342 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -376,6 +376,23 @@ describe('Dead-letter queues routes', () => { expect(response.result).toMatchSnapshot() }) + test('should show errors when message no longer in queue', async () => { + jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([]) + + const options = { + method: 'get', + url: '/admin/dead-letter-queues/audit-api/modify/message-id', + auth + } + + const { + response: { statusCode, headers } + } = await renderResponse(server, options) + + expect(statusCode).toBe(StatusCodes.SEE_OTHER) + expect(headers.location).toBe('/admin/dead-letter-queues/audit-api') + }, 10000) + test('should show errors if resubmit button pressed when invalid JSON', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() @@ -399,9 +416,11 @@ describe('Dead-letter queues routes', () => { ) }) - test('should resubmit if resubmit button pressed when valid JSON', async () => { + test('should show errors if resubmit button pressed when message no longer in queue', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() + jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([]) + const options = { method: 'post', url: '/admin/dead-letter-queues/audit-api/modify/12345', @@ -415,10 +434,41 @@ describe('Dead-letter queues routes', () => { response: { statusCode, headers } } = await renderResponse(server, options) + expect(statusCode).toBe(StatusCodes.SEE_OTHER) + expect(resubmitDeadLetterQueueMessage).not.toHaveBeenCalled() + expect(headers.location).toBe( + '/admin/dead-letter-queues/audit-api/modify/12345' + ) + }, 10000) + + test('should resubmit if resubmit button pressed when valid JSON', async () => { + jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() + + jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([ + { + MessageId: 'message-id', + Body: '{ "field1": "value1" }', + ReceiptHandle: 'rec-handle' + } + ]) + + const options = { + method: 'post', + url: '/admin/dead-letter-queues/audit-api/modify/message-id', + auth, + payload: { + messageJson: JSON.stringify(validJsonMessage) + } + } + + const { + response: { statusCode, headers } + } = await renderResponse(server, options) + expect(statusCode).toBe(StatusCodes.MOVED_TEMPORARILY) expect(resubmitDeadLetterQueueMessage).toHaveBeenCalledWith( 'audit-api', - '12345', + 'message-id', validJsonMessage.Body, expect.any(String) ) From 6573f350200570aed05969f1a110204b6db11941 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Mon, 27 Apr 2026 11:58:32 +0100 Subject: [PATCH 3/7] Sonar fixes --- .../routes/admin/dead-letter-queue-helper.js | 109 +++++++++++++++++ .../src/routes/admin/dead-letter-queues.js | 112 ++---------------- .../routes/admin/dead-letter-queues.test.js | 2 +- 3 files changed, 118 insertions(+), 105 deletions(-) create mode 100644 designer/server/src/routes/admin/dead-letter-queue-helper.js diff --git a/designer/server/src/routes/admin/dead-letter-queue-helper.js b/designer/server/src/routes/admin/dead-letter-queue-helper.js new file mode 100644 index 000000000..3aef4f4ed --- /dev/null +++ b/designer/server/src/routes/admin/dead-letter-queue-helper.js @@ -0,0 +1,109 @@ +import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-plugin/engine/types/schema.js' + +import { getDeadLetterQueueMessages } from '~/src/lib/dead-letter-queue.js' +import { createJoiError } from '~/src/lib/error-boom-helper.js' + +const MAX_DLQ_READ_ATTEMPTS = 5 +const WAIT_TIME_IN_MILLIS = 1000 + +/** + * @param {string} messageJson + */ +export function validateMessageJson(messageJson) { + let json + try { + json = JSON.parse(messageJson) + } catch (err) { + const typedError = /** @type {{ message?: string }} */ (err) + return { + error: createJoiError( + 'messageJson', + `Invalid JSON: ${typedError.message}` + ) + } + } + + /** + * @type { FormAdapterSubmissionMessagePayload | undefined } + */ + const messageBody = json.Body + if (!messageBody) { + return { + error: createJoiError( + 'messageJson', + 'Invalid JSON: Missing "Body" element' + ) + } + } + + const { error } = formAdapterSubmissionMessagePayloadSchema.validate( + messageBody, + { + abortEarly: false, + stripUnknown: true + } + ) + if (error) { + const errorText = error.details.map((d) => d.message).join(', ') + const joiError = createJoiError( + 'messageJson', + `JSON does not match the schema: ${errorText}` + ) + return { + error: joiError + } + } + return { + body: messageBody + } +} + +/** + * @param {DeadLetterQueues} dlq + * @param {string} token + * @param {string} messageId + * @returns {Promise} + */ +export async function readDlqWithRetry(dlq, token, messageId) { + let attempts = 0 + let foundMessage + while (attempts < MAX_DLQ_READ_ATTEMPTS) { + attempts++ + const messages = await getDeadLetterQueueMessages(dlq, token) + + foundMessage = messages.find((m) => m.MessageId === messageId) + if (foundMessage) { + break + } + + await new Promise((resolve) => setTimeout(resolve, WAIT_TIME_IN_MILLIS)) + } + return foundMessage +} + +/** + * Keep specific properties + * @param {any} message + * @returns {{ json: { MessageId: string, Body: any }}} + */ +export function dlqMessageMapper(message) { + return { + json: { + MessageId: message.MessageId, + Body: JSON.parse(message.Body) + } + } +} + +/** + * @param {any[]} messages + * @returns {{ json: { MessageId: string, Body: any }}[]} + */ +export function dlqMessagesMapper(messages) { + return messages.map(dlqMessageMapper) +} + +/** + * @import { DeadLetterQueues } from '@defra/forms-model' + * @import { FormAdapterSubmissionMessagePayload } from '@defra/forms-engine-plugin/engine/types.js' + */ diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index 21c0206c0..602780782 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -1,4 +1,3 @@ -import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-plugin/engine/types/schema.js' import { DeadLetterQueues, Scopes } from '@defra/forms-model' import { StatusCodes } from 'http-status-codes' import Joi from 'joi' @@ -21,6 +20,12 @@ import { deleteDeadLetterMessageConfirmationViewModel, redriveDeadLetterQueueConfirmationViewModel } from '~/src/models/manage/dead-letter-queue.js' +import { + dlqMessageMapper, + dlqMessagesMapper, + readDlqWithRetry, + validateMessageJson +} from '~/src/routes/admin/dead-letter-queue-helper.js' export const ROUTE_FULL_PATH = '/admin/dead-letter-queues' const CONFIRMATION_PAGE_PATH = 'forms/confirmation-page' @@ -31,9 +36,6 @@ const REDRIVE = 'redrive' const DELETE = 'delete' const CONFIRM = 'confirm' -const MAX_DLQ_READ_ATTEMPTS = 5 -const WAIT_TIME_IN_MILLIS = 1000 - const dlqSchema = Joi.string() .required() .valid(...Object.values(DeadLetterQueues)) @@ -70,103 +72,6 @@ const dlqActionPayloadSchema = Joi.object().keys({ messageId: messageIdSchema }) -/** - * @param {string} messageJson - */ -export function validateMessageJson(messageJson) { - let json - try { - json = JSON.parse(messageJson) - } catch (err) { - const typedError = /** @type {{ message?: string }} */ (err) - return { - error: createJoiError( - 'messageJson', - `Invalid JSON: ${typedError.message}` - ) - } - } - - /** - * @type { FormAdapterSubmissionMessagePayload | undefined } - */ - const messageBody = json.Body - if (!messageBody) { - return { - error: createJoiError( - 'messageJson', - 'Invalid JSON: Missing "Body" element' - ) - } - } - - const { error } = formAdapterSubmissionMessagePayloadSchema.validate( - messageBody, - { - abortEarly: false, - stripUnknown: true - } - ) - if (error) { - const errorText = error.details.map((d) => d.message).join(', ') - const joiError = createJoiError( - 'messageJson', - `JSON does not match the schema: ${errorText}` - ) - return { - error: joiError - } - } - return { - body: messageBody - } -} - -/** - * @param {DeadLetterQueues} dlq - * @param {string} token - * @param {string} messageId - * @returns {Promise} - */ -export async function readDlqWithRetry(dlq, token, messageId) { - let attempts = 0 - let foundMessage - while (attempts < MAX_DLQ_READ_ATTEMPTS) { - attempts++ - const messages = await getDeadLetterQueueMessages(dlq, token) - - foundMessage = messages.find((m) => m.MessageId === messageId) - if (foundMessage) { - break - } - - await new Promise((resolve) => setTimeout(resolve, WAIT_TIME_IN_MILLIS)) - } - return foundMessage -} - -/** - * Keep specific properties - * @param {any} message - * @returns {{ json: { MessageId: string, Body: any }}} - */ -export function dlqMessageMapper(message) { - return { - json: { - MessageId: message.MessageId, - Body: JSON.parse(message.Body) - } - } -} - -/** - * @param {any[]} messages - * @returns {{ json: { MessageId: string, Body: any }}[]} - */ -export function dlqMessagesMapper(messages) { - return messages.map(dlqMessageMapper) -} - export function generateTitling() { const pageHeading = ADMIN_TOOLS @@ -581,14 +486,14 @@ export default [ const foundMessage = await readDlqWithRetry(dlq, token, messageId) if (!foundMessage) { - const error = createJoiError( + const notFoundError = createJoiError( 'messageJson', `Unable to find message ${messageId} in dead letter queue` ) return redirectWithErrors( request, h, - error, + notFoundError, sessionNames.validationFailure.deadLetterQueues ) } @@ -634,5 +539,4 @@ export default [ /** * @import { ServerRoute } from '@hapi/hapi' - * @import { FormAdapterSubmissionMessagePayload } from '@defra/forms-engine-plugin/engine/types.js' */ diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index c84d8d342..1ff2769e4 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -8,7 +8,7 @@ import { redriveDeadLetterQueueMessages, resubmitDeadLetterQueueMessage } from '~/src/lib/dead-letter-queue.js' -import { validateMessageJson } from '~/src/routes/admin/dead-letter-queues.js' +import { validateMessageJson } from '~/src/routes/admin/dead-letter-queue-helper.js' import { authSuperAdmin as auth } from '~/test/fixtures/auth.js' import { renderResponse } from '~/test/helpers/component-helpers.js' From f9690a4f92b88db77718688cf0c54c09606d3b65 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Mon, 27 Apr 2026 15:21:52 +0100 Subject: [PATCH 4/7] Post message content between screens Co-authored-by: Copilot --- .../dead-letter-queues.test.js.snap | 15 ++-- .../src/routes/admin/dead-letter-queues.js | 69 ++++++++++++------- .../routes/admin/dead-letter-queues.test.js | 17 ----- designer/server/src/typings/hapi/index.d.ts | 1 + .../views/admin/dead-letter-queue-modify.njk | 2 +- .../views/admin/dead-letter-queue-view.njk | 6 +- 6 files changed, 58 insertions(+), 52 deletions(-) diff --git a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap index 741ada13b..5e4b1a539 100644 --- a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap +++ b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap @@ -215,7 +215,11 @@ exports[`Dead-letter queues routes Journey should render form with messages and
Copy to clipboard - Modify and resubmit +
+ + + +
@@ -844,18 +848,13 @@ exports[`Dead-letter queues routes Journey should render modify form with messag

audit-api: Modifying message

- +
You can leave the 'MessageId' value unchanged - it will get a new value when you resubmit
- +
diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index 602780782..c873deb5a 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -13,7 +13,6 @@ import { resubmitDeadLetterQueueMessage } from '~/src/lib/dead-letter-queue.js' import { createJoiError } from '~/src/lib/error-boom-helper.js' -import { addErrorsToSession } from '~/src/lib/error-helper.js' import { redirectWithErrors } from '~/src/lib/redirect-helper.js' import { publishDlqActionEvent } from '~/src/messaging/publish.js' import { @@ -381,14 +380,46 @@ export default [ }), /** - * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: any }>} + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJsonText: string } }>} + */ + ({ + method: 'POST', + path: `${ROUTE_FULL_PATH}/{dlq}/modify-redirect/{messageId}`, + handler(request, h) { + const { params, payload, yar } = request + const { dlq, messageId } = params + const { messageJsonText } = payload + + yar.flash(sessionNames.validationFailure.deadLetterQueues, { + formValues: { messageJsonExisting: messageJsonText } + }) + + return h + .redirect(`${ROUTE_FULL_PATH}/${dlq}/modify/${messageId}`) + .code(StatusCodes.SEE_OTHER) + }, + options: { + validate: { + params: dlqModifyParamSchema + }, + auth: { + mode: 'required', + access: { + entity: 'user', + scope: [`+${Scopes.DeadLetterQueues}`] + } + } + } + }), + + /** + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string } }>} */ ({ method: 'GET', path: `${ROUTE_FULL_PATH}/{dlq}/modify/{messageId}`, - async handler(request, h) { - const { auth, params, yar } = request - const { token } = auth.credentials + handler(request, h) { + const { params, yar } = request const { dlq, messageId } = params const navigation = buildAdminNavigation(ADMIN_TOOLS) @@ -398,25 +429,6 @@ export default [ .flash(sessionNames.validationFailure.deadLetterQueues) .at(0) - const foundMessage = await readDlqWithRetry(dlq, token, messageId) - - if (!foundMessage) { - const error = createJoiError( - 'messageJson', - `Unable to find message ${messageId} in dead letter queue` - ) - addErrorsToSession( - request, - sessionNames.validationFailure.deadLetterQueues, - error - ) - return h - .redirect(`${ROUTE_FULL_PATH}/${dlq}`) - .code(StatusCodes.SEE_OTHER) - } - - const mappedMessage = dlqMessageMapper(foundMessage) - const { formValues, formErrors } = validation ?? {} const messageJson = { @@ -427,7 +439,11 @@ export default [ }, value: formValues?.messageJson ?? - JSON.stringify(mappedMessage.json, null, 2), + JSON.stringify( + JSON.parse(formValues?.messageJsonExisting ?? '{}'), + null, + 2 + ), rows: 30, errorMessage: formErrors?.messageJson ? { text: formErrors.messageJson.text } @@ -445,6 +461,7 @@ export default [ text: dlq }, messageJson, + messageId, queueName: dlq }) }, @@ -502,6 +519,8 @@ export default [ await resubmitDeadLetterQueueMessage(dlq, messageId, body, token) + await deleteDeadLetterQueueMessage(dlq, messageId, token) + const auditUser = mapUserForAudit(auth.credentials.user) await publishDlqActionEvent( dlq, diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index 1ff2769e4..ee6540b80 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -376,23 +376,6 @@ describe('Dead-letter queues routes', () => { expect(response.result).toMatchSnapshot() }) - test('should show errors when message no longer in queue', async () => { - jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([]) - - const options = { - method: 'get', - url: '/admin/dead-letter-queues/audit-api/modify/message-id', - auth - } - - const { - response: { statusCode, headers } - } = await renderResponse(server, options) - - expect(statusCode).toBe(StatusCodes.SEE_OTHER) - expect(headers.location).toBe('/admin/dead-letter-queues/audit-api') - }, 10000) - test('should show errors if resubmit button pressed when invalid JSON', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() diff --git a/designer/server/src/typings/hapi/index.d.ts b/designer/server/src/typings/hapi/index.d.ts index 978e27b3f..a585c3d8c 100644 --- a/designer/server/src/typings/hapi/index.d.ts +++ b/designer/server/src/typings/hapi/index.d.ts @@ -192,6 +192,7 @@ declare module '@hapi/yar' { [sessionNames.validationFailure.deadLetterQueues]: ValidationFailure<{ dlq: string messageJson?: string + messageJsonExisting?: string }> [sessionNames.validationFailure.formInspect]: ValidationFailure<{ type: string diff --git a/designer/server/src/views/admin/dead-letter-queue-modify.njk b/designer/server/src/views/admin/dead-letter-queue-modify.njk index e0a66c572..464999500 100644 --- a/designer/server/src/views/admin/dead-letter-queue-modify.njk +++ b/designer/server/src/views/admin/dead-letter-queue-modify.njk @@ -37,7 +37,7 @@

{{ queueName }}: Modifying message

- + {{ govukTextarea(messageJson) }} {{ govukButton({ diff --git a/designer/server/src/views/admin/dead-letter-queue-view.njk b/designer/server/src/views/admin/dead-letter-queue-view.njk index 0ca88fd12..607cebb84 100644 --- a/designer/server/src/views/admin/dead-letter-queue-view.njk +++ b/designer/server/src/views/admin/dead-letter-queue-view.njk @@ -42,7 +42,11 @@
Copy to clipboard - Modify and resubmit + + + + +
From ced8d1c9d356c0ca6cd29a6b0ede3c55e35c61ea Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Tue, 28 Apr 2026 10:41:09 +0100 Subject: [PATCH 5/7] Stash --- designer/server/src/lib/dead-letter-queue.js | 17 +++++++++-- .../dead-letter-queues.test.js.snap | 2 ++ .../routes/admin/dead-letter-queue-helper.js | 28 ------------------- .../src/routes/admin/dead-letter-queues.js | 28 ++++--------------- .../routes/admin/dead-letter-queues.test.js | 25 ----------------- .../views/admin/dead-letter-queue-modify.njk | 2 ++ 6 files changed, 24 insertions(+), 78 deletions(-) diff --git a/designer/server/src/lib/dead-letter-queue.js b/designer/server/src/lib/dead-letter-queue.js index b38c27b30..047a46b62 100644 --- a/designer/server/src/lib/dead-letter-queue.js +++ b/designer/server/src/lib/dead-letter-queue.js @@ -45,15 +45,28 @@ export function getEndpoint(dlq) { /** * @param {DeadLetterQueues} dlq * @param {string} token + * @param {{ visibilityTimeout: number | undefined, waitTimeSeconds: number | undefined}} [options] */ -export async function getDeadLetterQueueMessages(dlq, token) { +export async function getDeadLetterQueueMessages(dlq, token, options) { const getJsonByType = /** @type {typeof getJson<{ messages: any[] }>} */ ( getJson ) const { endpoint, qualifier } = getEndpoint(dlq) - const requestUrl = new URL(`./admin/deadletter${qualifier}/view`, endpoint) + const queryParams = [] + if (options?.visibilityTimeout) { + queryParams.push(`visibilityTimeout=${options.visibilityTimeout}`) + } + if (options?.waitTimeSeconds) { + queryParams.push(`waitTimeSeconds=${options.waitTimeSeconds}`) + } + const queryParamStr = queryParams.length ? `?${queryParams.join('&')}` : '' + + const requestUrl = new URL( + `./admin/deadletter${qualifier}/view${queryParamStr}`, + endpoint + ) const { body } = await getJsonByType(requestUrl, getHeaders(token)) diff --git a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap index 5e4b1a539..d0ca0eae3 100644 --- a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap +++ b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap @@ -858,6 +858,8 @@ exports[`Dead-letter queues routes Journey should render modify form with messag
+ + diff --git a/designer/server/src/routes/admin/dead-letter-queue-helper.js b/designer/server/src/routes/admin/dead-letter-queue-helper.js index 3aef4f4ed..2a8be8f8c 100644 --- a/designer/server/src/routes/admin/dead-letter-queue-helper.js +++ b/designer/server/src/routes/admin/dead-letter-queue-helper.js @@ -1,11 +1,7 @@ import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-plugin/engine/types/schema.js' -import { getDeadLetterQueueMessages } from '~/src/lib/dead-letter-queue.js' import { createJoiError } from '~/src/lib/error-boom-helper.js' -const MAX_DLQ_READ_ATTEMPTS = 5 -const WAIT_TIME_IN_MILLIS = 1000 - /** * @param {string} messageJson */ @@ -58,29 +54,6 @@ export function validateMessageJson(messageJson) { } } -/** - * @param {DeadLetterQueues} dlq - * @param {string} token - * @param {string} messageId - * @returns {Promise} - */ -export async function readDlqWithRetry(dlq, token, messageId) { - let attempts = 0 - let foundMessage - while (attempts < MAX_DLQ_READ_ATTEMPTS) { - attempts++ - const messages = await getDeadLetterQueueMessages(dlq, token) - - foundMessage = messages.find((m) => m.MessageId === messageId) - if (foundMessage) { - break - } - - await new Promise((resolve) => setTimeout(resolve, WAIT_TIME_IN_MILLIS)) - } - return foundMessage -} - /** * Keep specific properties * @param {any} message @@ -104,6 +77,5 @@ export function dlqMessagesMapper(messages) { } /** - * @import { DeadLetterQueues } from '@defra/forms-model' * @import { FormAdapterSubmissionMessagePayload } from '@defra/forms-engine-plugin/engine/types.js' */ diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index c873deb5a..2b4bae19b 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -12,7 +12,6 @@ import { redriveDeadLetterQueueMessages, resubmitDeadLetterQueueMessage } from '~/src/lib/dead-letter-queue.js' -import { createJoiError } from '~/src/lib/error-boom-helper.js' import { redirectWithErrors } from '~/src/lib/redirect-helper.js' import { publishDlqActionEvent } from '~/src/messaging/publish.js' import { @@ -20,9 +19,7 @@ import { redriveDeadLetterQueueConfirmationViewModel } from '~/src/models/manage/dead-letter-queue.js' import { - dlqMessageMapper, dlqMessagesMapper, - readDlqWithRetry, validateMessageJson } from '~/src/routes/admin/dead-letter-queue-helper.js' @@ -462,7 +459,8 @@ export default [ }, messageJson, messageId, - queueName: dlq + queueName: dlq, + messageJsonExisting: formValues?.messageJsonExisting }) }, options: { @@ -480,7 +478,7 @@ export default [ }), /** - * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string } }>} + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string, origMessageJson: string } }>} */ ({ method: 'POST', @@ -489,7 +487,7 @@ export default [ const { auth, params, payload, yar } = request const { token } = auth.credentials const { dlq, messageId } = params - const { messageJson } = payload + const { messageJson, origMessageJson } = payload const { error, body } = validateMessageJson(messageJson) if (error) { @@ -501,22 +499,6 @@ export default [ ) } - const foundMessage = await readDlqWithRetry(dlq, token, messageId) - if (!foundMessage) { - const notFoundError = createJoiError( - 'messageJson', - `Unable to find message ${messageId} in dead letter queue` - ) - return redirectWithErrors( - request, - h, - notFoundError, - sessionNames.validationFailure.deadLetterQueues - ) - } - - const originalMessage = dlqMessageMapper(foundMessage) - await resubmitDeadLetterQueueMessage(dlq, messageId, body, token) await deleteDeadLetterQueueMessage(dlq, messageId, token) @@ -527,7 +509,7 @@ export default [ MODIFY_AND_RESUBMIT, messageId, { - beforeJson: JSON.stringify(originalMessage), + beforeJson: origMessageJson, afterJson: messageJson }, auditUser diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index ee6540b80..377a63461 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -399,31 +399,6 @@ describe('Dead-letter queues routes', () => { ) }) - test('should show errors if resubmit button pressed when message no longer in queue', async () => { - jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() - - jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([]) - - const options = { - method: 'post', - url: '/admin/dead-letter-queues/audit-api/modify/12345', - auth, - payload: { - messageJson: JSON.stringify(validJsonMessage) - } - } - - const { - response: { statusCode, headers } - } = await renderResponse(server, options) - - expect(statusCode).toBe(StatusCodes.SEE_OTHER) - expect(resubmitDeadLetterQueueMessage).not.toHaveBeenCalled() - expect(headers.location).toBe( - '/admin/dead-letter-queues/audit-api/modify/12345' - ) - }, 10000) - test('should resubmit if resubmit button pressed when valid JSON', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() diff --git a/designer/server/src/views/admin/dead-letter-queue-modify.njk b/designer/server/src/views/admin/dead-letter-queue-modify.njk index 464999500..1484c460b 100644 --- a/designer/server/src/views/admin/dead-letter-queue-modify.njk +++ b/designer/server/src/views/admin/dead-letter-queue-modify.njk @@ -40,6 +40,8 @@ {{ govukTextarea(messageJson) }} + + {{ govukButton({ text: "Resubmit" }) }} From 4b12b7f5e6da5c908c36880e847765f33332f1c0 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Wed, 29 Apr 2026 14:21:44 +0100 Subject: [PATCH 6/7] Reworked --- designer/server/src/lib/dead-letter-queue.js | 38 ++++++++++++++ .../dead-letter-queues.test.js.snap | 2 - .../src/routes/admin/dead-letter-queues.js | 49 +++++++++++++++++-- .../routes/admin/dead-letter-queues.test.js | 15 +++--- .../views/admin/dead-letter-queue-modify.njk | 2 - 5 files changed, 89 insertions(+), 17 deletions(-) diff --git a/designer/server/src/lib/dead-letter-queue.js b/designer/server/src/lib/dead-letter-queue.js index 047a46b62..d7ab1f645 100644 --- a/designer/server/src/lib/dead-letter-queue.js +++ b/designer/server/src/lib/dead-letter-queue.js @@ -78,6 +78,44 @@ export async function getDeadLetterQueueMessages(dlq, token, options) { return uniqueMessages.values().toArray() } +/** + * @param {DeadLetterQueues} dlq + * @param {string} messageId + * @param {string} token + * @param {{ visibilityTimeout: number | undefined, waitTimeSeconds: number | undefined}} [options] + * @returns {Promise} + */ +export async function getDeadLetterQueueMessage( + dlq, + messageId, + token, + options +) { + const getJsonByType = /** @type {typeof getJson<{ message: any }>} */ ( + getJson + ) + + const { endpoint, qualifier } = getEndpoint(dlq) + + const queryParams = [] + if (options?.visibilityTimeout) { + queryParams.push(`visibilityTimeout=${options.visibilityTimeout}`) + } + if (options?.waitTimeSeconds) { + queryParams.push(`waitTimeSeconds=${options.waitTimeSeconds}`) + } + const queryParamStr = queryParams.length ? `?${queryParams.join('&')}` : '' + + const requestUrl = new URL( + `./admin/deadletter${qualifier}/view/${messageId}${queryParamStr}`, + endpoint + ) + + const { body } = await getJsonByType(requestUrl, getHeaders(token)) + + return body.message ?? undefined +} + /** * @param {DeadLetterQueues} dlq * @param {string} token diff --git a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap index d0ca0eae3..5e4b1a539 100644 --- a/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap +++ b/designer/server/src/routes/admin/__snapshots__/dead-letter-queues.test.js.snap @@ -858,8 +858,6 @@ exports[`Dead-letter queues routes Journey should render modify form with messag
- - diff --git a/designer/server/src/routes/admin/dead-letter-queues.js b/designer/server/src/routes/admin/dead-letter-queues.js index 2b4bae19b..eacad52eb 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.js +++ b/designer/server/src/routes/admin/dead-letter-queues.js @@ -8,10 +8,12 @@ import { buildErrorList } from '~/src/common/helpers/build-error-details.js' import { buildAdminNavigation } from '~/src/common/nunjucks/context/build-navigation.js' import { deleteDeadLetterQueueMessage, + getDeadLetterQueueMessage, getDeadLetterQueueMessages, redriveDeadLetterQueueMessages, resubmitDeadLetterQueueMessage } from '~/src/lib/dead-letter-queue.js' +import { createJoiError } from '~/src/lib/error-boom-helper.js' import { redirectWithErrors } from '~/src/lib/redirect-helper.js' import { publishDlqActionEvent } from '~/src/messaging/publish.js' import { @@ -68,6 +70,17 @@ const dlqActionPayloadSchema = Joi.object().keys({ messageId: messageIdSchema }) +/** + * @param {any} json + */ +function formatJsonForAudit(json) { + const jsonOut = { + MessageId: json.MessageId, + Body: JSON.parse(json.Body) + } + return JSON.stringify(jsonOut, null, 2) +} + export function generateTitling() { const pageHeading = ADMIN_TOOLS @@ -478,7 +491,7 @@ export default [ }), /** - * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string, origMessageJson: string } }>} + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string } }>} */ ({ method: 'POST', @@ -487,7 +500,7 @@ export default [ const { auth, params, payload, yar } = request const { token } = auth.credentials const { dlq, messageId } = params - const { messageJson, origMessageJson } = payload + const { messageJson } = payload const { error, body } = validateMessageJson(messageJson) if (error) { @@ -499,6 +512,24 @@ export default [ ) } + const origMessageJson = await getDeadLetterQueueMessage( + dlq, + messageId, + token + ) + if (!origMessageJson) { + const joiError = createJoiError( + 'messageJson', + `Unable to find message id ${messageId} in ${dlq}` + ) + return redirectWithErrors( + request, + h, + joiError, + sessionNames.validationFailure.deadLetterQueues + ) + } + await resubmitDeadLetterQueueMessage(dlq, messageId, body, token) await deleteDeadLetterQueueMessage(dlq, messageId, token) @@ -509,7 +540,7 @@ export default [ MODIFY_AND_RESUBMIT, messageId, { - beforeJson: origMessageJson, + beforeJson: formatJsonForAudit(origMessageJson), afterJson: messageJson }, auditUser @@ -520,12 +551,20 @@ export default [ `The modified message has been submitted and the original message removed from DLQ '${dlq}'` ) - return h.redirect(ROUTE_FULL_PATH) + return h.redirect(ROUTE_FULL_PATH).code(StatusCodes.SEE_OTHER) }, options: { validate: { params: dlqModifyParamSchema, - payload: dlqModifyPayloadSchema + payload: dlqModifyPayloadSchema, + failAction: (request, h, err) => { + return redirectWithErrors( + request, + h, + err, + sessionNames.validationFailure.deadLetterQueues + ) + } }, auth: { mode: 'required', diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index 377a63461..67ca7f3ad 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -4,6 +4,7 @@ import { StatusCodes } from 'http-status-codes' import { createServer } from '~/src/createServer.js' import { deleteDeadLetterQueueMessage, + getDeadLetterQueueMessage, getDeadLetterQueueMessages, redriveDeadLetterQueueMessages, resubmitDeadLetterQueueMessage @@ -402,13 +403,11 @@ describe('Dead-letter queues routes', () => { test('should resubmit if resubmit button pressed when valid JSON', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() - jest.mocked(getDeadLetterQueueMessages).mockResolvedValue([ - { - MessageId: 'message-id', - Body: '{ "field1": "value1" }', - ReceiptHandle: 'rec-handle' - } - ]) + jest.mocked(getDeadLetterQueueMessage).mockResolvedValue({ + MessageId: 'message-id', + Body: '{ "field1": "value1" }', + ReceiptHandle: 'rec-handle' + }) const options = { method: 'post', @@ -423,7 +422,7 @@ describe('Dead-letter queues routes', () => { response: { statusCode, headers } } = await renderResponse(server, options) - expect(statusCode).toBe(StatusCodes.MOVED_TEMPORARILY) + expect(statusCode).toBe(StatusCodes.SEE_OTHER) expect(resubmitDeadLetterQueueMessage).toHaveBeenCalledWith( 'audit-api', 'message-id', diff --git a/designer/server/src/views/admin/dead-letter-queue-modify.njk b/designer/server/src/views/admin/dead-letter-queue-modify.njk index 1484c460b..464999500 100644 --- a/designer/server/src/views/admin/dead-letter-queue-modify.njk +++ b/designer/server/src/views/admin/dead-letter-queue-modify.njk @@ -40,8 +40,6 @@ {{ govukTextarea(messageJson) }} - - {{ govukButton({ text: "Resubmit" }) }} From 2d2bccd349924b0f6a628be85235038d02441b24 Mon Sep 17 00:00:00 2001 From: Jez Barnsley Date: Thu, 30 Apr 2026 08:35:47 +0100 Subject: [PATCH 7/7] Changes after review, and extra coverage --- designer/server/src/lib/dead-letter-queue.js | 43 ++++++++------ .../server/src/lib/dead-letter-queue.test.js | 57 +++++++++++++++++++ .../routes/admin/dead-letter-queues.test.js | 32 +++++++++++ 3 files changed, 114 insertions(+), 18 deletions(-) diff --git a/designer/server/src/lib/dead-letter-queue.js b/designer/server/src/lib/dead-letter-queue.js index d7ab1f645..b17dff687 100644 --- a/designer/server/src/lib/dead-letter-queue.js +++ b/designer/server/src/lib/dead-letter-queue.js @@ -54,19 +54,21 @@ export async function getDeadLetterQueueMessages(dlq, token, options) { const { endpoint, qualifier } = getEndpoint(dlq) - const queryParams = [] + const requestUrl = new URL(`./admin/deadletter${qualifier}/view`, endpoint) + if (options?.visibilityTimeout) { - queryParams.push(`visibilityTimeout=${options.visibilityTimeout}`) + requestUrl.searchParams.set( + 'visibilityTimeout', + options.visibilityTimeout.toString() + ) } + if (options?.waitTimeSeconds) { - queryParams.push(`waitTimeSeconds=${options.waitTimeSeconds}`) + requestUrl.searchParams.set( + 'waitTimeSeconds', + options.waitTimeSeconds.toString() + ) } - const queryParamStr = queryParams.length ? `?${queryParams.join('&')}` : '' - - const requestUrl = new URL( - `./admin/deadletter${qualifier}/view${queryParamStr}`, - endpoint - ) const { body } = await getJsonByType(requestUrl, getHeaders(token)) @@ -97,19 +99,24 @@ export async function getDeadLetterQueueMessage( const { endpoint, qualifier } = getEndpoint(dlq) - const queryParams = [] + const requestUrl = new URL( + `./admin/deadletter${qualifier}/view/${messageId}`, + endpoint + ) + if (options?.visibilityTimeout) { - queryParams.push(`visibilityTimeout=${options.visibilityTimeout}`) + requestUrl.searchParams.set( + 'visibilityTimeout', + options.visibilityTimeout.toString() + ) } + if (options?.waitTimeSeconds) { - queryParams.push(`waitTimeSeconds=${options.waitTimeSeconds}`) + requestUrl.searchParams.set( + 'waitTimeSeconds', + options.waitTimeSeconds.toString() + ) } - const queryParamStr = queryParams.length ? `?${queryParams.join('&')}` : '' - - const requestUrl = new URL( - `./admin/deadletter${qualifier}/view/${messageId}${queryParamStr}`, - endpoint - ) const { body } = await getJsonByType(requestUrl, getHeaders(token)) diff --git a/designer/server/src/lib/dead-letter-queue.test.js b/designer/server/src/lib/dead-letter-queue.test.js index 4ba745831..c58796c89 100644 --- a/designer/server/src/lib/dead-letter-queue.test.js +++ b/designer/server/src/lib/dead-letter-queue.test.js @@ -2,6 +2,7 @@ import { DeadLetterQueues } from '@defra/forms-model' import { deleteDeadLetterQueueMessage, + getDeadLetterQueueMessage, getDeadLetterQueueMessages, getEndpoint, redriveDeadLetterQueueMessages, @@ -60,6 +61,62 @@ describe('dead-letter queue lib functions', () => { ) expect(res).toEqual(['message1']) }) + + it('should call endpoint with extra query params', async () => { + jest + .mocked(getJson) + // @ts-expect-error - partial mock of response + .mockResolvedValueOnce({ body: { messages: ['message1'] } }) + const dlq = DeadLetterQueues.SubmissionsApiFormSubmissions + const res = await getDeadLetterQueueMessages(dlq, 'token', { + visibilityTimeout: 5, + waitTimeSeconds: 10 + }) + expect(getJson).toHaveBeenCalledWith( + new URL( + 'http://localhost:3002/admin/deadletter/form-submissions/view?visibilityTimeout=5&waitTimeSeconds=10' + ), + expect.anything() + ) + expect(res).toEqual(['message1']) + }) + }) + + describe('getDeadLetterQueueMessage', () => { + it('should call endpoint', async () => { + jest + .mocked(getJson) + // @ts-expect-error - partial mock of response + .mockResolvedValueOnce({ body: { message: 'message1' } }) + const dlq = DeadLetterQueues.SubmissionsApiFormSubmissions + const res = await getDeadLetterQueueMessage(dlq, 'message-id', 'token') + expect(getJson).toHaveBeenCalledWith( + new URL( + 'http://localhost:3002/admin/deadletter/form-submissions/view/message-id' + ), + expect.anything() + ) + expect(res).toBe('message1') + }) + + it('should call endpoint with extra query params', async () => { + jest + .mocked(getJson) + // @ts-expect-error - partial mock of response + .mockResolvedValueOnce({ body: { message: 'message1' } }) + const dlq = DeadLetterQueues.SubmissionsApiFormSubmissions + const res = await getDeadLetterQueueMessage(dlq, 'message-id', 'token', { + visibilityTimeout: 5, + waitTimeSeconds: 10 + }) + expect(getJson).toHaveBeenCalledWith( + new URL( + 'http://localhost:3002/admin/deadletter/form-submissions/view/message-id?visibilityTimeout=5&waitTimeSeconds=10' + ), + expect.anything() + ) + expect(res).toBe('message1') + }) }) describe('redriveDeadLetterQueueMessages', () => { diff --git a/designer/server/src/routes/admin/dead-letter-queues.test.js b/designer/server/src/routes/admin/dead-letter-queues.test.js index 67ca7f3ad..32bfbb369 100644 --- a/designer/server/src/routes/admin/dead-letter-queues.test.js +++ b/designer/server/src/routes/admin/dead-letter-queues.test.js @@ -1,6 +1,7 @@ import { DeadLetterQueues } from '@defra/forms-model' import { StatusCodes } from 'http-status-codes' +import { sessionNames } from '~/src/common/constants/session-names.js' import { createServer } from '~/src/createServer.js' import { deleteDeadLetterQueueMessage, @@ -453,6 +454,37 @@ describe('Dead-letter queues routes', () => { ) }) }) + + describe('modify-redirect', () => { + test('should redirect and flash json payload', async () => { + const options = { + method: 'post', + url: '/admin/dead-letter-queues/audit-api/modify-redirect/message-id', + auth, + payload: { + messageJsonText: '{ "text": "some json content" }' + } + } + + const { + response: { statusCode, headers, request } + } = await renderResponse(server, options) + + const jsonResult = request.yar.flash( + sessionNames.validationFailure.deadLetterQueues + ) + + expect(statusCode).toBe(StatusCodes.SEE_OTHER) + expect(jsonResult).toEqual([ + { + formValues: { messageJsonExisting: '{ "text": "some json content" }' } + } + ]) + expect(headers.location).toBe( + '/admin/dead-letter-queues/audit-api/modify/message-id' + ) + }) + }) }) /**