@planning-inspectorate/dynamic-forms 3.2.0 → 3.3.1

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';
+	}
+}

package/src/components/macros/answer-list.njk

@@ -1,29 +0,0 @@
-{% from "govuk/components/summary-list/macro.njk" import govukSummaryList %}
-
-{% macro answerList(answers) %}
-    {% set summaryRows = [] %}
-
-    {% for item in answers %}
-        {% set summaryRows = (summaryRows.push({
-            key: {
-                text: item.label
-            },
-            value: {
-                html: item.answer | escape | nl2br | safe
-            },
-            actions: {
-                items: [
-                    {
-                        href: item.removeLink,
-                        text: "Remove",
-                        visuallyHiddenText: item.label + ", " + item.answer
-                    }
-                ]
-            }
-        }), summaryRows) %}
-    {% endfor %}
-
-    {{ govukSummaryList({
-        rows: summaryRows
-    }) }}
-{% endmacro %}

package/src/middleware/check-not-submitted.js

@@ -1,13 +0,0 @@
-/**
- * @param {string} alreadySubmittedUrl
- * @returns {import('express').Handler}
- */
-export default (alreadySubmittedUrl) => (req, res, next) => {
-	const journeyResponse = res?.locals?.journeyResponse;
-
-	if (journeyResponse?.answers?.submitted === 'yes' || journeyResponse?.answers?.submitted === true) {
-		return res.redirect(alreadySubmittedUrl);
-	}
-
-	return next();
-};

package/src/middleware/check-not-submitted.test.js

@@ -1,118 +0,0 @@
-import { describe, it, mock } from 'node:test';
-import assert from 'node:assert';
-import checkNotSubmitted from './check-not-submitted.js';
-
-const testUrl = '/test';
-
-describe('dynamic-forms/middleware/check-not-submitted', () => {
-	const mockReq = () => ({
-		cookies: {},
-		log: {},
-		params: {}
-	});
-
-	[
-		{
-			description: 'should do nothing if submitted is undefined',
-			given: () => {
-				return {
-					req: mockReq(),
-					res: {}
-				};
-			},
-			expected: (req, res, next) => {
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should do nothing if submitted is false',
-			given: () => {
-				return {
-					req: mockReq(),
-					res: {
-						locals: {
-							journeyResponse: {
-								answers: { submitted: false }
-							}
-						}
-					}
-				};
-			},
-			expected: (req, res, next) => {
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should do nothing if submitted is no',
-			given: () => {
-				return {
-					req: mockReq(),
-					res: {
-						locals: {
-							journeyResponse: {
-								answers: {
-									submitted: 'no'
-								}
-							}
-						}
-					}
-				};
-			},
-			expected: (req, res, next) => {
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should redirect if submitted is true',
-			given: () => {
-				return {
-					req: mockReq(),
-					res: {
-						locals: {
-							journeyResponse: {
-								answers: {
-									submitted: true
-								}
-							}
-						},
-						redirect: mock.fn()
-					}
-				};
-			},
-			expected: (req, res) => {
-				assert.strictEqual(res.redirect.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should redirect if submitted is yes',
-			given: () => {
-				return {
-					req: mockReq(),
-					res: {
-						locals: {
-							journeyResponse: {
-								answers: {
-									submitted: 'yes'
-								}
-							}
-						},
-						redirect: mock.fn()
-					}
-				};
-			},
-			expected: (req, res) => {
-				assert.strictEqual(res.redirect.mock.callCount(), 1);
-			}
-		}
-	].forEach(({ description, given, expected }) => {
-		it(description, () => {
-			const next = mock.fn();
-			const req = given().req;
-			const res = given().res;
-
-			checkNotSubmitted(testUrl)(req, res, next);
-
-			expected(req, res, next);
-		});
-	});
-});

package/src/middleware/dynamic-req-files-to-req-body-files.js

@@ -1,46 +0,0 @@
-/**
- * Middleware for converting `req.files` to `req.body.files`.
- *
- * The requirement for this is due to `express-validator` only considering a limited subset of
- * keys on the `req` object as being eligible for validation.
- *
- * This middleware is designed for use with component-based dynamic forms
- *
- * This has not been tested with
- * pages that contain two or more multiple file uploads.
- *
- * @returns {function(*, *, *): (*)}
- */
-export default () => (req, res, next) => {
-	if (!req.body || !req.files || !req.params) {
-		return next();
-	}
-
-	const { journey } = res.locals;
-
-	const questionObj = journey.getQuestionByParams(req.params);
-	const filesPropertyPath = questionObj.fieldName;
-
-	if (typeof req.files[filesPropertyPath] === 'undefined') {
-		req.body.files = [];
-		return next();
-	}
-
-	try {
-		req.body.files = {
-			...req.body.files,
-			// Ensure we are always working with an array. Single files would otherwise be an object.
-			[filesPropertyPath]: Array.isArray(req.files[filesPropertyPath])
-				? req.files[filesPropertyPath]
-				: [req.files[filesPropertyPath]]
-		};
-	} catch (err) {
-		// this feels like it should never happen, as nothing in the try block throws. This is a precaution.
-		/* istanbul ignore next */
-		req.log.debug({ err, filesPropertyPath }, 'Error extracting req.files[filesPropertyPath]');
-		/* istanbul ignore next */
-		req.body.files = [];
-	}
-
-	return next();
-};