diff --git a/designer/server/src/lib/dead-letter-queue.js b/designer/server/src/lib/dead-letter-queue.js index b38c27b30..b17dff687 100644 --- a/designer/server/src/lib/dead-letter-queue.js +++ b/designer/server/src/lib/dead-letter-queue.js @@ -45,8 +45,9 @@ 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 ) @@ -55,6 +56,20 @@ export async function getDeadLetterQueueMessages(dlq, token) { const requestUrl = new URL(`./admin/deadletter${qualifier}/view`, endpoint) + if (options?.visibilityTimeout) { + requestUrl.searchParams.set( + 'visibilityTimeout', + options.visibilityTimeout.toString() + ) + } + + if (options?.waitTimeSeconds) { + requestUrl.searchParams.set( + 'waitTimeSeconds', + options.waitTimeSeconds.toString() + ) + } + const { body } = await getJsonByType(requestUrl, getHeaders(token)) // Dedupe in case of duplicate messages @@ -65,6 +80,49 @@ export async function getDeadLetterQueueMessages(dlq, token) { 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 requestUrl = new URL( + `./admin/deadletter${qualifier}/view/${messageId}`, + endpoint + ) + + if (options?.visibilityTimeout) { + requestUrl.searchParams.set( + 'visibilityTimeout', + options.visibilityTimeout.toString() + ) + } + + if (options?.waitTimeSeconds) { + requestUrl.searchParams.set( + 'waitTimeSeconds', + options.waitTimeSeconds.toString() + ) + } + + const { body } = await getJsonByType(requestUrl, getHeaders(token)) + + return body.message ?? undefined +} + /** * @param {DeadLetterQueues} dlq * @param {string} 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/__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-queue-helper.js b/designer/server/src/routes/admin/dead-letter-queue-helper.js new file mode 100644 index 000000000..2a8be8f8c --- /dev/null +++ b/designer/server/src/routes/admin/dead-letter-queue-helper.js @@ -0,0 +1,81 @@ +import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-plugin/engine/types/schema.js' + +import { createJoiError } from '~/src/lib/error-boom-helper.js' + +/** + * @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 + } +} + +/** + * 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 { 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 1f71b861f..eacad52eb 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' @@ -9,6 +8,7 @@ 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 @@ -20,6 +20,10 @@ import { deleteDeadLetterMessageConfirmationViewModel, redriveDeadLetterQueueConfirmationViewModel } from '~/src/models/manage/dead-letter-queue.js' +import { + dlqMessagesMapper, + 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' @@ -67,68 +71,14 @@ const dlqActionPayloadSchema = Joi.object().keys({ }) /** - * @param {string} messageJson + * @param {any} json */ -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}` - ) - } +function formatJsonForAudit(json) { + const jsonOut = { + MessageId: json.MessageId, + Body: JSON.parse(json.Body) } - - /** - * @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 - } -} - -/** - * Keep specific properties - * @param {any[]} messages - */ -export function dlqMessageMapper(messages) { - return messages.map((m) => ({ - json: { - MessageId: m.MessageId, - Body: JSON.parse(m.Body) - } - })) + return JSON.stringify(jsonOut, null, 2) } export function generateTitling() { @@ -283,9 +233,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} */ ( @@ -304,7 +259,8 @@ export default [ text: dlq }, messages: mappedMessages, - queueName: dlq + queueName: dlq, + errorList: buildErrorList(validation?.formErrors) }) }, options: { @@ -433,15 +389,47 @@ export default [ } }), + /** + * @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) @@ -451,12 +439,6 @@ export default [ .flash(sessionNames.validationFailure.deadLetterQueues) .at(0) - const messages = await getDeadLetterQueueMessages(dlq, token) - - const mappedMessage = dlqMessageMapper(messages).find( - (m) => m.json.MessageId === messageId - ) - const { formValues, formErrors } = validation ?? {} const messageJson = { @@ -467,7 +449,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 } @@ -485,7 +471,9 @@ export default [ text: dlq }, messageJson, - queueName: dlq + messageId, + queueName: dlq, + messageJsonExisting: formValues?.messageJsonExisting }) }, options: { @@ -503,7 +491,7 @@ export default [ }), /** - * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string } }>} + * @satisfies {ServerRoute<{ Params: { dlq: DeadLetterQueues, messageId: string }, Payload: { messageJson: string } }>} */ ({ method: 'POST', @@ -524,20 +512,35 @@ export default [ ) } - const messages = await getDeadLetterQueueMessages(dlq, token) - const originalMessage = dlqMessageMapper(messages).find( - (m) => m.json.MessageId === messageId + 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) + const auditUser = mapUserForAudit(auth.credentials.user) await publishDlqActionEvent( dlq, MODIFY_AND_RESUBMIT, messageId, { - beforeJson: JSON.stringify(originalMessage), + beforeJson: formatJsonForAudit(origMessageJson), afterJson: messageJson }, auditUser @@ -548,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', @@ -568,5 +579,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 d88c6d4f6..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,14 +1,16 @@ 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, + getDeadLetterQueueMessage, getDeadLetterQueueMessages, 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' @@ -402,9 +404,15 @@ describe('Dead-letter queues routes', () => { test('should resubmit if resubmit button pressed when valid JSON', async () => { jest.mocked(resubmitDeadLetterQueueMessage).mockResolvedValue() + jest.mocked(getDeadLetterQueueMessage).mockResolvedValue({ + MessageId: 'message-id', + Body: '{ "field1": "value1" }', + ReceiptHandle: 'rec-handle' + }) + const options = { method: 'post', - url: '/admin/dead-letter-queues/audit-api/modify/12345', + url: '/admin/dead-letter-queues/audit-api/modify/message-id', auth, payload: { messageJson: JSON.stringify(validJsonMessage) @@ -415,10 +423,10 @@ 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', - '12345', + 'message-id', validJsonMessage.Body, expect.any(String) ) @@ -446,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' + ) + }) + }) }) /** 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 + + + + +