@planning-inspectorate/dynamic-forms 3.3.0 → 3.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",

package/src/components/address/question.js

@@ -72,12 +72,11 @@ export default class AddressQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse
 	 * @returns {Promise<{answers: Record<string, unknown>}>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
 		const data = {
 			addressLine1: req.body[this.fieldName + '_addressLine1'],
@@ -94,7 +93,6 @@ export default class AddressQuestion extends Question {
 		const answers = {
 			[this.fieldName]: address
 		};
-		journeyResponse.answers[this.fieldName] = address;
 
 		return {
 			answers

package/src/components/boolean/question.js

@@ -97,28 +97,23 @@ export default class BooleanQuestion extends RadioQuestion {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise.<Object>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		// set answer on response
-		let responseToSave = { answers: {} };
+		const answers = {};
 		const fieldValue = req.body[this.fieldName]?.trim();
 
-		responseToSave.answers[this.fieldName] = fieldValue === BOOLEAN_OPTIONS.YES;
+		answers[this.fieldName] = fieldValue === BOOLEAN_OPTIONS.YES;
 
 		for (const propName in req.body) {
 			if (propName.startsWith(this.fieldName + '_')) {
-				responseToSave.answers[propName] = req.body[propName]?.trim();
-				journeyResponse.answers[propName] = req.body[propName]?.trim();
+				answers[propName] = req.body[propName]?.trim();
 			}
 		}
 
-		journeyResponse.answers[this.fieldName] = fieldValue;
-
-		return responseToSave;
+		return { answers };
 	}
 }

package/src/components/date/question.js

@@ -27,27 +27,21 @@ export default class DateQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise.<Object>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		// set answer on response
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		const dayInput = req.body[`${this.fieldName}_day`];
 		const monthInput = req.body[`${this.fieldName}_month`];
 		const yearInput = req.body[`${this.fieldName}_year`];
 
-		const dateToSave = parseDateInput({ day: dayInput, month: monthInput, year: yearInput });
-
-		responseToSave.answers[this.fieldName] = dateToSave;
-
-		journeyResponse.answers[this.fieldName] = responseToSave.answers[this.fieldName];
+		answers[this.fieldName] = parseDateInput({ day: dayInput, month: monthInput, year: yearInput });
 
-		return responseToSave;
+		return { answers };
 	}
 
 	answerForViewModel(answers, isPayload) {

package/src/components/date-period/question.js

@@ -36,15 +36,13 @@ export default class DatePeriodQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise.<Object>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		// set answer on response
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		const startDayInput = req.body[`${this.fieldName}_start_day`];
 		const startMonthInput = req.body[`${this.fieldName}_start_month`];
@@ -70,11 +68,9 @@ export default class DatePeriodQuestion extends Question {
 			year: endYearInput
 		});
 
-		responseToSave.answers[this.fieldName] = { start: startDate, end: endDate };
-
-		journeyResponse.answers[this.fieldName] = responseToSave.answers[this.fieldName];
+		answers[this.fieldName] = { start: startDate, end: endDate };
 
-		return responseToSave;
+		return { answers };
 	}
 
 	answerForViewModel(answers, isPayload) {

package/src/components/date-time/question.js

@@ -23,14 +23,13 @@ export default class DateTimeQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise.<Object>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		const dayInput = req.body[`${this.fieldName}_day`];
 		const monthInput = req.body[`${this.fieldName}_month`];
@@ -39,7 +38,7 @@ export default class DateTimeQuestion extends Question {
 		const minutesInput = req.body[`${this.fieldName}_minutes`];
 		const periodInput = req.body[`${this.fieldName}_period`];
 
-		responseToSave.answers[this.fieldName] = parseDateInput({
+		answers[this.fieldName] = parseDateInput({
 			day: dayInput,
 			month: monthInput,
 			year: yearInput,
@@ -47,9 +46,7 @@ export default class DateTimeQuestion extends Question {
 			minute: minutesInput
 		});
 
-		journeyResponse.answers[this.fieldName] = responseToSave.answers[this.fieldName];
-
-		return responseToSave;
+		return { answers };
 	}
 
 	answerForViewModel(answers, isPayload) {

package/src/components/date-time/question.test.js

@@ -131,20 +131,13 @@ describe('./lib/forms/custom-components/date-time/question.js', () => {
 					siteVisitDate_period: 'am'
 				}
 			};
-			const journeyResponse = { answers: {} };
-
-			const responseToSave = await question.getDataToSave(req, journeyResponse);
+			const responseToSave = await question.getDataToSave(req);
 
 			assert.deepStrictEqual(responseToSave, {
 				answers: {
 					siteVisitDate: new Date('2025-02-21T00:12:00.000Z')
 				}
 			});
-			assert.deepStrictEqual(journeyResponse, {
-				answers: {
-					siteVisitDate: new Date('2025-02-21T00:12:00.000Z')
-				}
-			});
 		});
 		it('should get data to save when time period is pm', async () => {
 			const req = {
@@ -157,20 +150,13 @@ describe('./lib/forms/custom-components/date-time/question.js', () => {
 					siteVisitDate_period: 'pm'
 				}
 			};
-			const journeyResponse = { answers: {} };
-
-			const responseToSave = await question.getDataToSave(req, journeyResponse);
+			const responseToSave = await question.getDataToSave(req);
 
 			assert.deepStrictEqual(responseToSave, {
 				answers: {
 					siteVisitDate: new Date('2025-02-21T20:12:00.000Z')
 				}
 			});
-			assert.deepStrictEqual(journeyResponse, {
-				answers: {
-					siteVisitDate: new Date('2025-02-21T20:12:00.000Z')
-				}
-			});
 		});
 		it('should get data to save when bst date', async () => {
 			const req = {
@@ -183,20 +169,13 @@ describe('./lib/forms/custom-components/date-time/question.js', () => {
 					siteVisitDate_period: 'am'
 				}
 			};
-			const journeyResponse = { answers: {} };
-
-			const responseToSave = await question.getDataToSave(req, journeyResponse);
+			const responseToSave = await question.getDataToSave(req);
 
 			assert.deepStrictEqual(responseToSave, {
 				answers: {
 					siteVisitDate: new Date('2025-05-20T23:12:00.000Z')
 				}
 			});
-			assert.deepStrictEqual(journeyResponse, {
-				answers: {
-					siteVisitDate: new Date('2025-05-20T23:12:00.000Z')
-				}
-			});
 		});
 	});
 	describe('formatAnswerForSummary', () => {

package/src/components/manage-list/question.js

@@ -71,7 +71,10 @@ export default class ManageListQuestion extends Question {
 			return [];
 		}
 		const mockJourney = {
-			getCurrentQuestionUrl() {}
+			getCurrentQuestionUrl() {},
+			response: {
+				answers: answer
+			}
 		};
 		return (
 			this.section.questions
@@ -92,10 +95,11 @@ export default class ManageListQuestion extends Question {
 	}
 
 	async getDataToSave(req, journeyResponse) {
-		let responseToSave = { answers: {} };
-		const data = journeyResponse.answers[this.fieldName];
-		responseToSave.answers[this.fieldName] = data || [];
-		return responseToSave;
+		return {
+			answers: {
+				[this.fieldName]: journeyResponse.answers[this.fieldName] || []
+			}
+		};
 	}
 
 	formatAnswerForSummary(sectionSegment, journey, answer) {

package/src/components/manage-list/question.test.js

@@ -3,7 +3,7 @@ import assert from 'node:assert';
 import ManageListQuestion from '#src/components/manage-list/question.js';
 import { ManageListSection } from '#src/components/manage-list/manage-list-section.js';
 import { mockJourney } from '#test/mock/journey.js';
-import { mockRandomUUID } from '#src/lib/uuid.test.js';
+import { mockRandomUUID } from '#test/mock/uuid.js';
 import { configureNunjucksTestEnv } from '#test/utils/nunjucks.js';
 import path from 'path';
 import { snapshotsDir } from '#test/utils/utils.js';
@@ -136,4 +136,41 @@ describe('components/manage-list/question', () => {
 			}
 		);
 	});
+
+	describe('getDataToSave', () => {
+		it('should return existing journey answers if present', async () => {
+			const q = newQuestion();
+			const existingData = [{ id: '1', name: 'Test' }];
+			const req = { body: {} };
+			const journeyResponse = {
+				answers: {
+					[FIELDNAME]: existingData
+				}
+			};
+
+			const result = await q.getDataToSave(req, journeyResponse);
+
+			assert.deepStrictEqual(result, {
+				answers: {
+					[FIELDNAME]: existingData
+				}
+			});
+		});
+
+		it('should return an empty array if no journey answers are present', async () => {
+			const q = newQuestion();
+			const req = { body: {} };
+			const journeyResponse = {
+				answers: {}
+			};
+
+			const result = await q.getDataToSave(req, journeyResponse);
+
+			assert.deepStrictEqual(result, {
+				answers: {
+					[FIELDNAME]: []
+				}
+			});
+		});
+	});
 });

package/src/components/manage-list/utils.js

@@ -12,3 +12,24 @@ export function answerObjectForManageList(response, manageListQuestion, manageLi
 	}
 	return answers.find((a) => a.id === manageListItemId) || {};
 }
+
+/**
+ * Similar to answerObjectForManageList but will edit response and add a new array entry if not found
+ *
+ * @param {import('#src/journey/journey-response.js').JourneyResponse} response
+ * @param {import('./question.js')} manageListQuestion
+ * @param {import('#src/journey/journey-types.d.ts').RouteParams} params
+ * @returns {import('#src/journey/journey-types.d.ts').ManageListAnswers}
+ */
+export function answerObjectForManageListSaving(response, manageListQuestion, params) {
+	const answersList =
+		response.answers[manageListQuestion?.fieldName] || (response.answers[manageListQuestion?.fieldName] = []);
+	let answers = answersList.find((item) => item.id === params.manageListItemId);
+	if (!answers) {
+		answers = {
+			id: params.manageListItemId
+		};
+		answersList.push(answers);
+	}
+	return answers;
+}

package/src/components/manage-list/utils.test.js

@@ -1,6 +1,6 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
-import { answerObjectForManageList } from '#src/components/manage-list/utils.js';
+import { answerObjectForManageList, answerObjectForManageListSaving } from '#src/components/manage-list/utils.js';
 
 describe('manage-list-utils', () => {
 	describe('answerObjectForManageList', () => {
@@ -44,4 +44,37 @@ describe('manage-list-utils', () => {
 			assert.deepStrictEqual(got, {});
 		});
 	});
+
+	describe('answerObjectForManageListSaving', () => {
+		it('should add an array with a new object if not found', () => {
+			const manageListQuestion = {
+				fieldName: 'manageListQuestion'
+			};
+			const journeyResponse = {
+				answers: {}
+			};
+			const params = { manageListItemId: '1' };
+			const got = answerObjectForManageListSaving(journeyResponse, manageListQuestion, params);
+			assert.deepStrictEqual(got, { id: '1' });
+			assert.ok(Array.isArray(journeyResponse.answers.manageListQuestion));
+			assert.ok(journeyResponse.answers.manageListQuestion[0]?.id, '1');
+		});
+		it('should return the manage list item object for manage list questions', () => {
+			const manageListQuestion = {
+				fieldName: 'manageListQuestion'
+			};
+			const answers = {
+				id: '1',
+				myField: 'my-value'
+			};
+			const journeyResponse = {
+				answers: {
+					manageListQuestion: [answers]
+				}
+			};
+			const params = { manageListItemId: '1' };
+			const got = answerObjectForManageListSaving(journeyResponse, manageListQuestion, params);
+			assert.strictEqual(got, answers);
+		});
+	});
 });

package/src/components/multi-field-input/question.js

@@ -74,28 +74,23 @@ export default class MultiFieldInputQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise<{ answers: Record<string, unknown> }>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		/**
-		 * @type {{ answers: Record<string, unknown> }}
-		 */
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		for (const inputField of this.inputFields) {
 			let value = req.body[inputField.fieldName];
 			if (typeof value === 'string') {
 				value = value.trim();
 			}
-			responseToSave.answers[inputField.fieldName] = value;
-			journeyResponse.answers[inputField.fieldName] = responseToSave.answers[inputField.fieldName];
+			answers[inputField.fieldName] = value;
 		}
 
-		return responseToSave;
+		return { answers };
 	}
 
 	/**
@@ -123,7 +118,8 @@ export default class MultiFieldInputQuestion extends Question {
 		return [
 			{
 				key: `${this.title}`,
-				value: nl2br(escape(formattedAnswer)),
+				// Do not convert new lines to breaks in ManageListSection, as this causes a "doubled up" <br>
+				value: this.isInManageListSection ? escape(formattedAnswer) : nl2br(escape(formattedAnswer)),
 				action: this.getAction(sectionSegment, journey, summaryDetails)
 			}
 		];

package/src/components/multi-field-input/question.test.js

@@ -34,7 +34,7 @@ function createMultiFieldInputQuestion(
 	});
 }
 
-describe('./src/dynamic-forms/components/single-line-input/question.js', () => {
+describe('./src/dynamic-forms/components/multi-field-input/question.js', () => {
 	it('should create', () => {
 		const testQuestion = createMultiFieldInputQuestion();
 
@@ -320,5 +320,33 @@ describe('./src/dynamic-forms/components/single-line-input/question.js', () => {
 
 			assert.deepStrictEqual(result, expectedResult);
 		});
+		it('should return escaped text with newlines (no <br>) when isInManageListSection is true', () => {
+			const question = createMultiFieldInputQuestion();
+
+			question.isInManageListSection = true;
+
+			const journey = new Journey({
+				journeyId: 'TEST',
+				makeBaseUrl: () => 'base',
+				taskListUrl: 'cases/create-a-case/check-your-answers',
+				response: {
+					answers: {
+						testField1: 'Line 1',
+						testField2: 'Line & 2'
+					}
+				},
+				journeyTemplate: 'mock template',
+				taskListTemplate: 'mock path',
+				journeyTitle: 'mock title',
+				sections: []
+			});
+
+			const expectedValue = 'Line 1\nLine &amp; 2\n';
+
+			const result = question.formatAnswerForSummary('questions', journey);
+
+			assert.strictEqual(result[0].value, expectedValue);
+			assert.strictEqual(result[0].value.includes('<br>'), false);
+		});
 	});
 });

package/src/components/text-entry-redact/question.js

@@ -60,10 +60,9 @@ export default class TextEntryRedactQuestion extends Question {
 	async getDataToSave(req, journeyResponse) {
 		if (this.useRedactedFieldNameForSave) {
 			const fieldName = this.fieldName + 'Redacted';
-			const responseToSave = { answers: {} };
-			responseToSave.answers[fieldName] = req.body[this.fieldName];
-			journeyResponse.answers[fieldName] = responseToSave.answers[fieldName];
-			return responseToSave;
+			const answers = {};
+			answers[fieldName] = req.body[this.fieldName];
+			return { answers };
 		}
 		return super.getDataToSave(req, journeyResponse);
 	}

package/src/components/unit-option-entry/question.js

@@ -127,17 +127,13 @@ export default class UnitOptionEntryQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise<{ answers: Record<string, unknown> }>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		/**
-		 * @type {{ answers: Record<string, unknown> }}
-		 */
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		/** @type {string[]} */
 		const fields = Array.isArray(req.body[this.fieldName]) ? req.body[this.fieldName] : [req.body[this.fieldName]];
@@ -150,8 +146,7 @@ export default class UnitOptionEntryQuestion extends Question {
 		if (!selectedOptions.length)
 			throw new Error(`User submitted option(s) did not correlate with valid answers to ${this.fieldName} question`);
 
-		responseToSave.answers[this.fieldName] = fieldValues.join(this.optionJoinString);
-		journeyResponse.answers[this.fieldName] = fieldValues;
+		answers[this.fieldName] = fieldValues.join(this.optionJoinString);
 
 		this.options.forEach((option) => {
 			if (!option.conditional) return;
@@ -162,13 +157,11 @@ export default class UnitOptionEntryQuestion extends Question {
 			if (optionIsSelectedOption) {
 				if (conditionalIsJustHTML(option.conditional)) return;
 				const conversionFactor = option.conditional.conversionFactor || 1;
-				const value = req.body[option.conditional.fieldName] * conversionFactor;
-				responseToSave.answers[this.conditionalFieldName] = value;
-				journeyResponse.answers[this.conditionalFieldName] = value;
+				answers[this.conditionalFieldName] = req.body[option.conditional.fieldName] * conversionFactor;
 			}
 		});
 
-		return responseToSave;
+		return { answers };
 	}
 
 	/**

package/src/controller.js

@@ -1,5 +1,6 @@
 import { SECTION_STATUS } from './section.js';
 import questionUtils from './components/utils/question-utils.js';
+import { answerObjectForManageListSaving } from '#src/components/manage-list/utils.js';
 
 /**
  * @typedef {import('./journey/journey.js').Journey} Journey
@@ -249,6 +250,16 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 			if (redirectToTaskListOnSuccess) {
 				return res.redirect(journey.taskListUrl);
 			}
+			// edit the journey.response which question.shouldDisplay uses
+			// we need to ensure the latest answer just submitted is included
+			// as question.shouldDisplay checks the response and is used to determine the next question
+			let answers = journeyResponse.answers;
+			if (question.isInManageListSection) {
+				answers = answerObjectForManageListSaving(journeyResponse, manageListQuestion, req.params);
+			}
+			for (const [k, v] of Object.entries(data?.answers || {})) {
+				answers[k] = v;
+			}
 			// move to the next question
 			return journey.redirectToNextQuestion(res, req.params, manageListQuestion);
 		} catch (err) {

package/src/controller.test.js

@@ -379,6 +379,7 @@ describe('dynamic-form/controller', () => {
 			const saveData = mock.fn();
 			await buildSave(saveData)(req, res, journeyId);
 
+			assert.strictEqual(sampleQuestionObj.getDataToSave.mock.callCount(), 1);
 			assert.strictEqual(saveData.mock.callCount(), 1);
 			assert.deepStrictEqual(saveData.mock.calls[0].arguments, [
 				{
@@ -499,6 +500,9 @@ describe('dynamic-form/controller', () => {
 			const sampleQuestionObjWithActions = {
 				...sampleQuestionObj
 			};
+			sampleQuestionObjWithActions.getDataToSave.mock.mockImplementationOnce(() => ({
+				answers: { [sampleQuestionObj.fieldName]: 'my-answer' }
+			}));
 
 			req.params = {
 				referenceId: mockRef,
@@ -522,6 +526,8 @@ describe('dynamic-form/controller', () => {
 			assert.strictEqual(saveData.mock.callCount(), 1);
 			assert.strictEqual(res.redirect.mock.callCount(), 1);
 			assert.strictEqual(res.redirect.mock.calls[0].arguments[0], expectedUrl);
+			// journey response should be edited if redirecting to next question
+			assert.strictEqual(res.locals.journeyResponse.answers?.sampleFieldName, 'my-answer');
 		});
 
 		it('should redirect to task list if configured', async () => {
@@ -531,6 +537,9 @@ describe('dynamic-form/controller', () => {
 			const sampleQuestionObjWithActions = {
 				...sampleQuestionObj
 			};
+			sampleQuestionObjWithActions.getDataToSave.mock.mockImplementationOnce(() => ({
+				answers: { [sampleQuestionObj.fieldName]: 'my-answer' }
+			}));
 
 			req.params = {
 				referenceId: mockRef,
@@ -555,6 +564,8 @@ describe('dynamic-form/controller', () => {
 			assert.strictEqual(res.redirect.mock.callCount(), 1);
 			assert.match(res.redirect.mock.calls[0].arguments[0], /\/task-list$/);
 			assert.strictEqual(mockJourney.getNextQuestionUrl.mock.callCount(), 0);
+			// journey response should not be edited if redirecting to task list
+			assert.strictEqual(Object.keys(res.locals.journeyResponse.answers).length, 0);
 		});
 
 		describe('manageListQuestions', () => {
@@ -585,7 +596,8 @@ describe('dynamic-form/controller', () => {
 				const journey = {
 					getSection: mock.fn(() => ({ segment: 'section-1' })),
 					getQuestionByParams: mock.fn(),
-					redirectToNextQuestion: mock.fn()
+					redirectToNextQuestion: mock.fn(),
+					response: { answers: {} }
 				};
 				const res = {
 					locals: {

package/src/lib/uuid.test.js

@@ -2,18 +2,6 @@ import { Uuid } from '#src/lib/uuid.js';
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
 
-/**
- *
- * @param {import('node:test').TestContext} ctx
- * @param {string} [uuid]
- */
-export function mockRandomUUID(ctx, uuid = '00000000-0000-0000-0000-000000000000') {
-	const original = Uuid.randomUUID;
-	Uuid.randomUUID = ctx.mock.fn(() => uuid);
-	// restore after the tests
-	ctx.after(() => (Uuid.randomUUID = original));
-}
-
 describe('uuid', () => {
 	it('should return a valid v4 UUID', () => {
 		assert.match(

package/src/questions/options-question.js

@@ -120,17 +120,13 @@ export default class OptionsQuestion extends Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
 	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise<{ answers: Record<string, unknown> }>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		/**
-		 * @type {{ answers: Record<string, unknown> }}
-		 */
-		let responseToSave = { answers: {} };
+		const answers = {};
 
 		const fields = Array.isArray(req.body[this.fieldName]) ? req.body[this.fieldName] : [req.body[this.fieldName]];
 		const fieldValues = fields.map((x) => x.trim());
@@ -142,8 +138,7 @@ export default class OptionsQuestion extends Question {
 		if (!selectedOptions.length)
 			throw new Error(`User submitted option(s) did not correlate with valid answers to ${this.fieldName} question`);
 
-		responseToSave.answers[this.fieldName] = fieldValues.join(this.optionJoinString);
-		journeyResponse.answers[this.fieldName] = fieldValues;
+		answers[this.fieldName] = fieldValues.join(this.optionJoinString);
 
 		this.options.forEach((option) => {
 			if (!option.conditional) return;
@@ -152,11 +147,9 @@ export default class OptionsQuestion extends Question {
 				(selectedOption) => option.text === selectedOption.text && option.value === selectedOption.value
 			);
 
-			const value = optionIsSelectedOption ? req.body[key]?.trim() : null;
-			responseToSave.answers[key] = value;
-			journeyResponse.answers[key] = value;
+			answers[key] = optionIsSelectedOption ? req.body[key]?.trim() : null;
 		});
 
-		return responseToSave;
+		return { answers };
 	}
 }

package/src/questions/question.js

@@ -338,38 +338,24 @@ export class Question {
 	}
 
 	/**
-	 * returns the data to send to the DB
-	 * side effect: modifies journeyResponse with the new answers
+	 * Get the data to save from the request, returns an object of answers
+	 *
 	 * @param {import('express').Request} req
-	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
+	 * @param {JourneyResponse} journeyResponse - current journey response
 	 * @returns {Promise<{ answers: Record<string, unknown> }>}
-	 */
+	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
-		/**
-		 * @type {{ answers: Record<string, unknown> }}
-		 */
-		let responseToSave = { answers: {} };
+		const answers = {};
 
-		responseToSave.answers[this.fieldName] = req.body[this.fieldName];
+		answers[this.fieldName] = req.body[this.fieldName];
 
 		for (const propName in req.body) {
 			if (propName.startsWith(this.fieldName + '_')) {
-				responseToSave.answers[propName] = req.body[propName];
-				journeyResponse.answers[propName] = req.body[propName];
+				answers[propName] = req.body[propName];
 			}
-			// todo: sort this
-			// } else if (numericFields.has(propName)) {
-			// 	const numericValue = Number(req.body[propName]);
-			// 	if (!isNaN(numericValue)) {
-			// 		responseToSave.answers[propName] = numericValue;
-			// 		journeyResponse.answers[propName] = numericValue;
-			// 	}
-			// }
 		}
 
-		journeyResponse.answers[this.fieldName] = responseToSave.answers[this.fieldName];
-
-		return responseToSave;
+		return { answers };
 	}
 
 	/**

package/src/questions/question.test.js

@@ -325,7 +325,7 @@ describe('./src/dynamic-forms/question.js', () => {
 	});
 
 	describe('getDataToSave', () => {
-		it('should return answer from req.body and modify journeyResponse', async () => {
+		it('should return answer from req.body', async () => {
 			const question = getTestQuestion();
 
 			const req = {
@@ -333,14 +333,8 @@ describe('./src/dynamic-forms/question.js', () => {
 					[question.fieldName]: { a: 1 }
 				}
 			};
-			const journeyResponse = {
-				answers: {
-					[question.fieldName]: { b: 1 },
-					other: 'another-answer'
-				}
-			};
 
-			const result = await question.getDataToSave(req, journeyResponse);
+			const result = await question.getDataToSave(req);
 
 			const expectedResult = {
 				answers: {
@@ -348,8 +342,6 @@ describe('./src/dynamic-forms/question.js', () => {
 				}
 			};
 			assert.deepStrictEqual(result, expectedResult);
-			expectedResult.answers.other = 'another-answer';
-			assert.deepStrictEqual(journeyResponse, expectedResult);
 		});
 
 		it('should handle nested properties', async () => {
@@ -362,14 +354,8 @@ describe('./src/dynamic-forms/question.js', () => {
 					[question.fieldName + '_2']: { a: 3 }
 				}
 			};
-			const journeyResponse = {
-				answers: {
-					[question.fieldName]: { b: 1 },
-					other: 'another-answer'
-				}
-			};
 
-			const result = await question.getDataToSave(req, journeyResponse);
+			const result = await question.getDataToSave(req);
 
 			const expectedResult = {
 				answers: {
@@ -379,8 +365,6 @@ describe('./src/dynamic-forms/question.js', () => {
 				}
 			};
 			assert.deepStrictEqual(result, expectedResult);
-			expectedResult.answers.other = 'another-answer';
-			assert.deepStrictEqual(journeyResponse, expectedResult);
 		});
 	});
 

package/test/check-your-answers.test.js

@@ -3,7 +3,7 @@ import assert from 'assert';
 import { manageListQuestions, questionsInOrder } from './questions.js';
 import path from 'path';
 import { escapeForRegExp, snapshotsDir } from './utils/utils.js';
-import { createAppWithQuestions, mockAnswer, mockAnswerBody } from './questions.test.js';
+import { createAppWithQuestions, mockAnswer, mockAnswerBody } from './utils/question-test-utils.js';
 import { COMPONENT_TYPES } from '#src/index.js';
 
 describe('check-your-answers', () => {

package/test/mock/uuid.js

@@ -0,0 +1,13 @@
+import { Uuid } from '#src/lib/uuid.js';
+
+/**
+ *
+ * @param {import('node:test').TestContext} ctx
+ * @param {string} [uuid]
+ */
+export function mockRandomUUID(ctx, uuid = '00000000-0000-0000-0000-000000000000') {
+	const original = Uuid.randomUUID;
+	Uuid.randomUUID = ctx.mock.fn(() => uuid);
+	// restore after the tests
+	ctx.after(() => (Uuid.randomUUID = original));
+}

package/test/questions.test.js

@@ -1,76 +1,11 @@
 import { describe, it } from 'node:test';
 import assert from 'assert';
-import { createApp } from './utils/app.js';
-import { TestServer } from './utils/test-server.js';
-import { getQuestions, manageListQuestions, questionsInOrder } from './questions.js';
-import { buildGetJourney } from '../src/middleware/build-get-journey.js';
-import { createJourney, JOURNEY_ID } from './journey.js';
-import { buildGetJourneyResponseFromSession, saveDataToSession } from '../src/lib/session-answer-store.js';
-import validate from '../src/validator/validator.js';
-import { validationErrorHandler } from '../src/validator/validation-error-handler.js';
-import { buildSave, list, question } from '../src/controller.js';
+import { manageListQuestions, questionsInOrder } from './questions.js';
 import path from 'path';
 import { COMPONENT_TYPES } from '../src/index.js';
 import { escapeForRegExp, snapshotsDir } from './utils/utils.js';
-import { BOOLEAN_OPTIONS } from '../src/components/boolean/question.js';
-import { mockRandomUUID } from '#src/lib/uuid.test.js';
-
-/**
- * @param {import('node:test').TestContext} ctx
- * @returns {Promise<TestServer>}
- */
-export async function createAppWithQuestions(ctx) {
-	const app = createApp();
-	const questions = getQuestions();
-	const getJourney = buildGetJourney((req, journeyResponse) => createJourney(questions, journeyResponse));
-	const getJourneyResponse = buildGetJourneyResponseFromSession(JOURNEY_ID);
-
-	// app.use((req, res, next) => {
-	//   console.log(req.method, req.url, req.session);
-	//   next();
-	// });
-
-	app.get(
-		'/:section/:question{/:manageListAction/:manageListItemId/:manageListQuestion}',
-		getJourneyResponse,
-		getJourney,
-		question
-	);
-
-	app.post(
-		'/:section/:question{/:manageListAction/:manageListItemId/:manageListQuestion}',
-		getJourneyResponse,
-		getJourney,
-		validate,
-		validationErrorHandler,
-		buildSave(saveDataToSession)
-	);
-
-	app.get('/check-your-answers', getJourneyResponse, getJourney, (req, res) => list(req, res, '', {}));
-
-	app.use((req, res) => {
-		res.status(404);
-	});
-
-	/**
-	 * @type {import('express').ErrorRequestHandler}
-	 */
-	function errorHandler(error, req, res, next) {
-		console.error('Internal Server Error:', error);
-		if (res.headersSent) {
-			return next(error);
-		}
-		res.status(500);
-		res.render('error', { error });
-	}
-
-	app.use(errorHandler);
-
-	const server = new TestServer(app, { rememberCookies: true, timeoutMs: 2000 });
-	await server.start();
-	ctx.after(async () => await server.stop());
-	return server;
-}
+import { createAppWithQuestions, mockAnswerBody } from '#test/utils/question-test-utils.js';
+import { mockRandomUUID } from '#test/mock/uuid.js';
 
 describe('question pages', () => {
 	it('should have a test for each question type', () => {
@@ -187,135 +122,3 @@ describe('question pages', () => {
 		}
 	});
 });
-
-/**
- * Build a valid payload for a question.
- * @param {import('../src/questions/question-props.js').QuestionProps} q
- * @returns {Object}
- */
-export function mockAnswerBody(q) {
-	switch (q.type) {
-		case COMPONENT_TYPES.BOOLEAN:
-			return { [q.fieldName]: BOOLEAN_OPTIONS.YES };
-		case COMPONENT_TYPES.CHECKBOX:
-			return { [q.fieldName]: [q.options[0].value] };
-		case COMPONENT_TYPES.RADIO:
-		case COMPONENT_TYPES.SELECT:
-			return { [q.fieldName]: q.options[0].value };
-		case COMPONENT_TYPES.NUMBER:
-			return { [q.fieldName]: 1 };
-		case COMPONENT_TYPES.DATE:
-			return {
-				[q.fieldName + '_day']: 1,
-				[q.fieldName + '_month']: 1,
-				[q.fieldName + '_year']: 2025
-			};
-		case COMPONENT_TYPES.DATE_PERIOD:
-			return {
-				[q.fieldName + '_start_day']: 1,
-				[q.fieldName + '_start_month']: 1,
-				[q.fieldName + '_start_year']: 2025,
-				[q.fieldName + '_end_day']: 2,
-				[q.fieldName + '_end_month']: 1,
-				[q.fieldName + '_end_year']: 2025
-			};
-		case COMPONENT_TYPES.DATE_TIME:
-			return {
-				[q.fieldName + '_day']: 1,
-				[q.fieldName + '_month']: 1,
-				[q.fieldName + '_year']: 2025,
-				[q.fieldName + '_hour']: 10,
-				[q.fieldName + '_minutes']: 45,
-				[q.fieldName + '_period']: 'am'
-			};
-		case COMPONENT_TYPES.TEXT_ENTRY:
-		case COMPONENT_TYPES.SINGLE_LINE_INPUT:
-			return { [q.fieldName]: 'test' };
-		case COMPONENT_TYPES.TEXT_ENTRY_REDACT:
-			return { [q.fieldName]: 'secret' };
-		case COMPONENT_TYPES.MULTI_FIELD_INPUT: {
-			const res = {};
-			for (const field of q.inputFields) {
-				res[field.fieldName] = mockAnswer(field);
-			}
-			return res;
-		}
-		case COMPONENT_TYPES.ADDRESS:
-			return {
-				[q.fieldName + '_addressLine1']: '1 Test St',
-				[q.fieldName + '_townCity']: 'Testville',
-				[q.fieldName + '_postcode']: 'TE5 5ST'
-			};
-		case COMPONENT_TYPES.UNIT_OPTION:
-			return {
-				[q.fieldName]: 'kg',
-				[q.options[0].conditional.fieldName]: 10
-			};
-		case COMPONENT_TYPES.EMAIL:
-			return { [q.fieldName]: 'test@example.com' };
-		case COMPONENT_TYPES.MANAGE_LIST: {
-			// manage list questions not available here so just hard coded
-			return {
-				[q.fieldName]: [
-					{ id: '1234', travelCompanionName: 'Companion 1', travelCompanionEmail: 'companion-1@example.com' },
-					{ id: '4567', travelCompanionName: 'Companion 2', travelCompanionEmail: 'companion-2@example.com' },
-					{ id: '8901', travelCompanionName: 'Companion 3', travelCompanionEmail: 'companion-3@example.com' }
-				]
-			};
-		}
-		default:
-			return { [q.fieldName]: 'test' };
-	}
-}
-
-/**
- * Build a valid & formatted answer for a question.
- * @param {import('../src/questions/question-props.js').QuestionProps} q
- * @returns {Object}
- */
-export function mockAnswer(q) {
-	switch (q.type) {
-		case COMPONENT_TYPES.BOOLEAN:
-			return BOOLEAN_OPTIONS.YES;
-		case COMPONENT_TYPES.CHECKBOX:
-			return q.options[0].text;
-		case COMPONENT_TYPES.RADIO:
-		case COMPONENT_TYPES.SELECT:
-			return q.options[0].text;
-		case COMPONENT_TYPES.NUMBER:
-			return 1;
-		case COMPONENT_TYPES.DATE:
-			return '1 January 2025';
-		case COMPONENT_TYPES.DATE_PERIOD:
-			return 'Start: 00:00 1 January 2025<br>End: 00:00 2 January 2025';
-		case COMPONENT_TYPES.DATE_TIME:
-			return '1 January 2025<br>10:45am';
-		case COMPONENT_TYPES.TEXT_ENTRY:
-		case COMPONENT_TYPES.SINGLE_LINE_INPUT:
-			return 'test';
-		case COMPONENT_TYPES.TEXT_ENTRY_REDACT:
-			return 'secret';
-		case COMPONENT_TYPES.MULTI_FIELD_INPUT:
-			if (q.inputFields) {
-				let res = '';
-				for (const field of q.inputFields) {
-					res += mockAnswer(field) + '<br>';
-				}
-				return res;
-			}
-			break;
-		case COMPONENT_TYPES.ADDRESS: {
-			const answer = mockAnswerBody(q);
-			return Object.values(answer).filter(Boolean).join('<br>');
-		}
-		case COMPONENT_TYPES.UNIT_OPTION:
-			return '10 kg';
-		case COMPONENT_TYPES.EMAIL:
-			return 'test@example.com';
-		case COMPONENT_TYPES.MANAGE_LIST: {
-			return `3 ${q.title}`;
-		}
-		default:
-			return 'test';
-	}
-}

package/test/utils/question-test-utils.js

@@ -0,0 +1,200 @@
+import { getQuestions } from '#test/questions.js';
+import { COMPONENT_TYPES } from '#src/index.js';
+import { createApp } from '#test/utils/app.js';
+import { buildGetJourney } from '#src/middleware/build-get-journey.js';
+import { buildGetJourneyResponseFromSession, saveDataToSession } from '#src/lib/session-answer-store.js';
+import { createJourney, JOURNEY_ID } from '#test/journey.js';
+import { buildList, buildSave, question } from '#src/controller.js';
+import validate from '#src/validator/validator.js';
+import { validationErrorHandler } from '#src/validator/validation-error-handler.js';
+import { TestServer } from '#test/utils/test-server.js';
+import { BOOLEAN_OPTIONS } from '#src/components/boolean/question.js';
+
+/**
+ * @param {import('node:test').TestContext} ctx
+ * @returns {Promise<TestServer>}
+ */
+export async function createAppWithQuestions(ctx) {
+	const app = createApp();
+	const questions = getQuestions();
+	const getJourney = buildGetJourney((req, journeyResponse) => createJourney(questions, journeyResponse));
+	const getJourneyResponse = buildGetJourneyResponseFromSession(JOURNEY_ID);
+
+	// app.use((req, res, next) => {
+	//   console.log(req.method, req.url, req.session);
+	//   next();
+	// });
+
+	app.get(
+		'/:section/:question{/:manageListAction/:manageListItemId/:manageListQuestion}',
+		getJourneyResponse,
+		getJourney,
+		question
+	);
+
+	app.post(
+		'/:section/:question{/:manageListAction/:manageListItemId/:manageListQuestion}',
+		getJourneyResponse,
+		getJourney,
+		validate,
+		validationErrorHandler,
+		buildSave(saveDataToSession)
+	);
+
+	app.get('/check-your-answers', getJourneyResponse, getJourney, buildList());
+
+	app.use((req, res) => {
+		res.status(404);
+	});
+
+	/**
+	 * @type {import('express').ErrorRequestHandler}
+	 */
+	function errorHandler(error, req, res, next) {
+		console.error('Internal Server Error:', error);
+		if (res.headersSent) {
+			return next(error);
+		}
+		res.status(500);
+		res.render('error', { error });
+	}
+
+	app.use(errorHandler);
+
+	const server = new TestServer(app, { rememberCookies: true, timeoutMs: 2000 });
+	await server.start();
+	ctx.after(async () => await server.stop());
+	return server;
+}
+
+/**
+ * Build a valid payload for a question.
+ * @param {import('../src/questions/question-props.js').QuestionProps} q
+ * @returns {Object}
+ */
+export function mockAnswerBody(q) {
+	switch (q.type) {
+		case COMPONENT_TYPES.BOOLEAN:
+			return { [q.fieldName]: BOOLEAN_OPTIONS.YES };
+		case COMPONENT_TYPES.CHECKBOX:
+			return { [q.fieldName]: [q.options[0].value] };
+		case COMPONENT_TYPES.RADIO:
+		case COMPONENT_TYPES.SELECT:
+			return { [q.fieldName]: q.options[0].value };
+		case COMPONENT_TYPES.NUMBER:
+			return { [q.fieldName]: 1 };
+		case COMPONENT_TYPES.DATE:
+			return {
+				[q.fieldName + '_day']: 1,
+				[q.fieldName + '_month']: 1,
+				[q.fieldName + '_year']: 2025
+			};
+		case COMPONENT_TYPES.DATE_PERIOD:
+			return {
+				[q.fieldName + '_start_day']: 1,
+				[q.fieldName + '_start_month']: 1,
+				[q.fieldName + '_start_year']: 2025,
+				[q.fieldName + '_end_day']: 2,
+				[q.fieldName + '_end_month']: 1,
+				[q.fieldName + '_end_year']: 2025
+			};
+		case COMPONENT_TYPES.DATE_TIME:
+			return {
+				[q.fieldName + '_day']: 1,
+				[q.fieldName + '_month']: 1,
+				[q.fieldName + '_year']: 2025,
+				[q.fieldName + '_hour']: 10,
+				[q.fieldName + '_minutes']: 45,
+				[q.fieldName + '_period']: 'am'
+			};
+		case COMPONENT_TYPES.TEXT_ENTRY:
+		case COMPONENT_TYPES.SINGLE_LINE_INPUT:
+			return { [q.fieldName]: 'test' };
+		case COMPONENT_TYPES.TEXT_ENTRY_REDACT:
+			return { [q.fieldName]: 'secret' };
+		case COMPONENT_TYPES.MULTI_FIELD_INPUT: {
+			const res = {};
+			for (const field of q.inputFields) {
+				res[field.fieldName] = mockAnswer(field);
+			}
+			return res;
+		}
+		case COMPONENT_TYPES.ADDRESS:
+			return {
+				[q.fieldName + '_addressLine1']: '1 Test St',
+				[q.fieldName + '_townCity']: 'Testville',
+				[q.fieldName + '_postcode']: 'TE5 5ST'
+			};
+		case COMPONENT_TYPES.UNIT_OPTION:
+			return {
+				[q.fieldName]: 'kg',
+				[q.options[0].conditional.fieldName]: 10
+			};
+		case COMPONENT_TYPES.EMAIL:
+			return { [q.fieldName]: 'test@example.com' };
+		case COMPONENT_TYPES.MANAGE_LIST: {
+			// manage list questions not available here so just hard coded
+			return {
+				[q.fieldName]: [
+					{ id: '1234', travelCompanionName: 'Companion 1', travelCompanionEmail: 'companion-1@example.com' },
+					{ id: '4567', travelCompanionName: 'Companion 2', travelCompanionEmail: 'companion-2@example.com' },
+					{ id: '8901', travelCompanionName: 'Companion 3', travelCompanionEmail: 'companion-3@example.com' }
+				]
+			};
+		}
+		default:
+			return { [q.fieldName]: 'test' };
+	}
+}
+
+/**
+ * Build a valid & formatted answer for a question.
+ * @param {import('../src/questions/question-props.js').QuestionProps} q
+ * @returns {Object}
+ */
+export function mockAnswer(q) {
+	switch (q.type) {
+		case COMPONENT_TYPES.BOOLEAN:
+			return BOOLEAN_OPTIONS.YES;
+		case COMPONENT_TYPES.CHECKBOX:
+			return q.options[0].text;
+		case COMPONENT_TYPES.RADIO:
+		case COMPONENT_TYPES.SELECT:
+			return q.options[0].text;
+		case COMPONENT_TYPES.NUMBER:
+			return 1;
+		case COMPONENT_TYPES.DATE:
+			return '1 January 2025';
+		case COMPONENT_TYPES.DATE_PERIOD:
+			return 'Start: 00:00 1 January 2025<br>End: 00:00 2 January 2025';
+		case COMPONENT_TYPES.DATE_TIME:
+			return '1 January 2025<br>10:45am';
+		case COMPONENT_TYPES.TEXT_ENTRY:
+		case COMPONENT_TYPES.SINGLE_LINE_INPUT:
+			return 'test';
+		case COMPONENT_TYPES.TEXT_ENTRY_REDACT:
+			return 'secret';
+		case COMPONENT_TYPES.MULTI_FIELD_INPUT:
+			if (q.inputFields) {
+				let res = '';
+				for (const field of q.inputFields) {
+					res += mockAnswer(field) + '<br>';
+				}
+				return res;
+			}
+			break;
+		case COMPONENT_TYPES.ADDRESS: {
+			const answer = mockAnswerBody(q);
+			return Object.values(answer).filter(Boolean).join('<br>');
+		}
+		case COMPONENT_TYPES.UNIT_OPTION:
+			return '10 kg';
+		case COMPONENT_TYPES.EMAIL:
+			return 'test@example.com';
+		case COMPONENT_TYPES.MANAGE_LIST: {
+			return `3 ${q.title}`;
+		}
+		default:
+			return 'test';
+	}
+}