@planning-inspectorate/dynamic-forms 3.1.0 → 3.3.0

package/src/section.test.js

@@ -715,12 +715,14 @@ describe('./src/dynamic-forms/section.js', () => {
 				const section = new Section('s1', 'S').addQuestion(q1).addQuestion(manageListQ, manageListSection);
 				return { section, q1, manageListQ, q3, q4 };
 			};
+			const response = { answers: {} };
 			it(`should get first question within a manage list section`, () => {
 				const { section, manageListQ, q3 } = newSectionWithManageList();
 				const next = section.getNextQuestion({
 					questionFieldName: manageListQ.fieldName,
-					response: {},
+					response,
 					manageListQuestion: manageListQ,
+					routeParams: {},
 					takeNextQuestion: true,
 					reverse: false
 				});
@@ -730,8 +732,9 @@ describe('./src/dynamic-forms/section.js', () => {
 				const { section, manageListQ, q3, q4 } = newSectionWithManageList();
 				const next = section.getNextQuestion({
 					questionFieldName: q3.fieldName,
-					response: {},
+					response,
 					manageListQuestion: manageListQ,
+					routeParams: {},
 					takeNextQuestion: false,
 					reverse: false
 				});
@@ -741,8 +744,9 @@ describe('./src/dynamic-forms/section.js', () => {
 				const { section, manageListQ, q4 } = newSectionWithManageList();
 				const next = section.getNextQuestion({
 					questionFieldName: q4.fieldName,
-					response: {},
+					response,
 					manageListQuestion: manageListQ,
+					routeParams: {},
 					takeNextQuestion: false,
 					reverse: false
 				});

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

@@ -1,9 +1,10 @@
 import { describe, it } from 'node:test';
 import assert from 'assert';
-import { questionsInOrder } from './questions.js';
+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 { COMPONENT_TYPES } from '#src/index.js';
 
 describe('check-your-answers', () => {
 	it(`should render all question rows with no answers`, async (ctx) => {
@@ -39,6 +40,23 @@ describe('check-your-answers', () => {
 
 		// 'answer' each question
 		for (const q of questionsInOrder) {
+			// Save happens on subquestion for manage list questions
+			if (q.type === COMPONENT_TYPES.MANAGE_LIST) {
+				// Get the list of subquestions for this manage list question
+				const manageListQuestion = manageListQuestions.find(
+					(question) => question.manageListQuestion.fieldName === q.fieldName
+				);
+				const subQuestionAnswers = mockAnswerBody(q)[manageListQuestion.manageListQuestion.fieldName];
+				// Post to them individually
+				for (const answer of subQuestionAnswers) {
+					const id = answer.id;
+					for (const subQuestion of manageListQuestion.questions) {
+						const key = subQuestion.fieldName;
+						const body = { [key]: answer[key] };
+						await testServer.post(`/questions/${q.url}/add/${id}/${subQuestion.url}`, body, { redirect: 'manual' });
+					}
+				}
+			}
 			await testServer.post(`/questions/${q.url}`, mockAnswerBody(q), { redirect: 'manual' });
 		}
 

package/test/questions.test.js

@@ -257,9 +257,9 @@ export function mockAnswerBody(q) {
 			// manage list questions not available here so just hard coded
 			return {
 				[q.fieldName]: [
-					{ travelCompanionName: 'Companion 1', travelCompanionEmail: 'compaion-1@example.com' },
-					{ travelCompanionName: 'Companion 2', travelCompanionEmail: 'compaion-2@example.com' },
-					{ travelCompanionName: 'Companion 3', travelCompanionEmail: 'compaion-3@example.com' }
+					{ 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' }
 				]
 			};
 		}

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();
-};

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

@@ -1,221 +0,0 @@
-import { describe, it, mock, beforeEach } from 'node:test';
-import assert from 'node:assert';
-import dynamicReqFilesToReqBodyFilesMiddleware from './dynamic-req-files-to-req-body-files.js';
-
-describe('dynamic-forms/middleware/dynamic-req-files-to-req-body-files', () => {
-	let counter = 0;
-	let mockReq;
-	let mockRes;
-	let filesPropertyPath = `example-files-property-path-${counter}`;
-
-	const mockgetQuestionByParams = mock.fn(() => {
-		return { fieldName: filesPropertyPath };
-	});
-
-	beforeEach(() => {
-		mockReq = () => ({
-			cookies: {},
-			log: {},
-			params: {}
-		});
-
-		mockRes = () => ({
-			clearCookie: mock.fn(),
-			cookie: mock.fn(),
-			locals: {
-				journeyResponse: mock.fn(),
-				journey: { getQuestionByParams: mockgetQuestionByParams }
-			},
-			redirect: mock.fn(),
-			render: mock.fn(),
-			sendStatus: mock.fn(),
-			status: mock.fn()
-		});
-
-		counter++;
-		filesPropertyPath = `example-files-property-path-${counter}`;
-	});
-
-	[
-		{
-			description: 'should return early if `req.body` is not set',
-			given: () => mockReq(),
-			expected: (req, res, next) => {
-				assert.strictEqual(req.body, undefined);
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should return early if `req.files` is not set',
-			given: () => ({
-				...mockReq(),
-				body: {}
-			}),
-			expected: (req, res, next) => {
-				assert.strictEqual(req.body.files, undefined);
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should return early if `req.params` is not set',
-			given: () => ({
-				cookies: {},
-				log: {},
-				body: {},
-				files: {}
-			}),
-			expected: (req, res, next) => {
-				assert.strictEqual(req.body.files, undefined);
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description:
-				'should set `req.body.files = []` if unable to find the given file property path `req.files` - unset',
-			given: () => ({
-				...mockReq(),
-				body: {},
-				files: {},
-				params: {
-					section: 'mock-section',
-					question: 'mock-question'
-				}
-			}),
-			expected: (req, res, next) => {
-				assert.deepStrictEqual(req.body.files, []);
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description:
-				'should set `req.body.files = []` if unable to find the given file property path `req.files` - wrong path',
-			given: () => ({
-				...mockReq(),
-				body: {},
-				files: {
-					'some-different-path': {
-						x: 'y'
-					}
-				},
-				params: {
-					section: 'mock-section',
-					question: 'mock-question'
-				}
-			}),
-			expected: (req, res, next) => {
-				assert.deepStrictEqual(req.body.files, []);
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should set `req.body.files = [req.files]` when given a single file',
-			given: () => ({
-				...mockReq(),
-				body: {},
-				params: {
-					section: 'mock-section',
-					question: 'mock-question'
-				},
-				files: {
-					[filesPropertyPath]: {
-						a: 'b'
-					}
-				}
-			}),
-			expected: (req, res, next) => {
-				assert.deepStrictEqual(req.body.files, { [filesPropertyPath]: [{ a: 'b' }] });
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should set `req.body.files = [...req.files]` when given multiple files',
-			given: () => ({
-				...mockReq(),
-				body: {},
-				params: {
-					section: 'mock-section',
-					question: 'mock-question'
-				},
-				files: {
-					[filesPropertyPath]: [
-						{
-							a: 'b'
-						},
-						{
-							c: 'd'
-						}
-					]
-				}
-			}),
-			expected: (req, res, next) => {
-				assert.deepStrictEqual(req.body.files, {
-					[filesPropertyPath]: [
-						{
-							a: 'b'
-						},
-						{
-							c: 'd'
-						}
-					]
-				});
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		},
-		{
-			description: 'should retain existing req.body.files when working with a different key',
-			given: () => ({
-				...mockReq(),
-				body: {
-					files: {
-						'an-existing-key-value-pair': [
-							{
-								rgb: 'xyz'
-							}
-						]
-					}
-				},
-				files: {
-					[filesPropertyPath]: [
-						{
-							a: 'b'
-						},
-						{
-							c: 'd'
-						}
-					]
-				},
-				params: {
-					section: 'mock-section',
-					question: 'mock-question'
-				}
-			}),
-			expected: (req, res, next) => {
-				assert.deepStrictEqual(req.body.files, {
-					'an-existing-key-value-pair': [
-						{
-							rgb: 'xyz'
-						}
-					],
-					[filesPropertyPath]: [
-						{
-							a: 'b'
-						},
-						{
-							c: 'd'
-						}
-					]
-				});
-				assert.strictEqual(next.mock.callCount(), 1);
-			}
-		}
-	].forEach(({ description, given, expected }) => {
-		it(description, () => {
-			const next = mock.fn();
-			const req = given();
-
-			dynamicReqFilesToReqBodyFilesMiddleware()(req, mockRes(), next);
-
-			expected(req, mockRes(), next);
-		});
-	});
-});

package/src/validator/required-file-upload-validator.js

@@ -1,38 +0,0 @@
-import BaseValidator from './base-validator.js';
-import { checkSchema } from 'express-validator';
-
-import requiredFileUploadSchema from './schemas/required-file-upload-schema.js';
-
-/**
- * @typedef {import('../questions/question.js')} Question
- */
-
-/**
- * enforces that at least one file is present for a question, whether it is being/already uploaded
- * @class
- */
-export default class RequiredFileUploadValidator extends BaseValidator {
-	/**
-	 * creates an instance of a RequiredFileUploadValidator
-	 * @param {string} [errorMessage] - custom error message to show on validation failure
-	 */
-	constructor(errorMessage) {
-		super();
-
-		if (errorMessage) {
-			this.errorMessage = errorMessage;
-		} else {
-			this.errorMessage = 'You must add your documents';
-		}
-	}
-
-	/**
-	 * validates against path based on questionObj's fieldname
-	 * @param {Question} questionObj
-	 */
-	validate(questionObj, journeyResponse) {
-		const path = questionObj.fieldName;
-		const documentType = questionObj.documentType.name;
-		return checkSchema(requiredFileUploadSchema(path, journeyResponse, documentType, this.errorMessage))[0];
-	}
-}

package/src/validator/required-file-upload-validator.test.js

@@ -1,141 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import RequiredFileUploadValidator from './required-file-upload-validator.js';
-
-describe('./src/dynamic-forms/validator/required-file-upload-validator.js', () => {
-	describe('validate', () => {
-		it('should have a rule for path featuring fieldName', () => {
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-
-			const rule = requiredFileUploadValidator
-				.validate({
-					fieldName: 'test-field-name',
-					documentType: {
-						name: 'test-doc-type'
-					}
-				})
-				.builder.build();
-
-			assert.deepStrictEqual(rule.fields, ['test-field-name']);
-			assert.strictEqual(!!rule.optional, false);
-			assert.strictEqual(rule.stack.length, 1);
-			assert.strictEqual(rule.stack[0].validator.name, 'options');
-			assert.strictEqual(!!rule.stack[0].validator.negated, false);
-		});
-
-		it('should pass if file being uploaded', async () => {
-			const questionObj = {
-				fieldName: 'test-fieldname',
-				documentType: {
-					name: 'test-doc-type'
-				}
-			};
-			const journeyResponse = {};
-			const req = { files: { test: 'test123' } };
-
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-			const validationResult = await requiredFileUploadValidator.validate(questionObj, journeyResponse).run(req);
-
-			assert.strictEqual(validationResult.errors.length, 0);
-		});
-
-		it('should pass if no file being uploaded and file matching question document type already uploaded', async () => {
-			const questionObj = {
-				fieldName: 'another-test-fieldname',
-				documentType: {
-					name: 'test-doc-type'
-				}
-			};
-			const uploadedFile = {
-				file: 'already-uploaded',
-				type: 'test-doc-type'
-			};
-			const journeyResponse = {
-				answers: { SubmissionDocumentUpload: [uploadedFile] }
-			};
-			const req = { body: {} };
-
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-			const validationResult = await requiredFileUploadValidator.validate(questionObj, journeyResponse).run(req);
-
-			assert.strictEqual(validationResult.errors.length, 0);
-		});
-
-		it('should fail if no file being uploaded and no file matching question document type already uploaded', async () => {
-			const questionObj = {
-				fieldName: 'yet-another-test-fieldname',
-				documentType: {
-					name: 'test-doc-type'
-				}
-			};
-			const journeyResponse = { answers: { SubmissionDocumentUpload: [] } };
-			const req = { body: {} };
-
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-			const validationResult = await requiredFileUploadValidator.validate(questionObj, journeyResponse).run(req);
-
-			assert.strictEqual(validationResult.errors.length, 1);
-		});
-
-		it('should fail if no file being uploaded matching question doc type and all existing files matching doc type being removed', async () => {
-			const questionObj = {
-				fieldName: 'test-fieldname',
-				documentType: {
-					name: 'test-doc-type'
-				}
-			};
-
-			const journeyResponse = {
-				answers: {
-					SubmissionDocumentUpload: [
-						{
-							file: 'to-be-removed',
-							type: 'test-doc-type'
-						},
-						{
-							file: 'to-be-removed-too',
-							type: 'test-doc-type'
-						}
-					]
-				}
-			};
-			const req = { body: {} };
-			req.body.removedFiles =
-				'[{"file": "to-be-removed", "type": "test-doc-type"}, {"file": "to-be-removed-too", "type": "test-doc-type"}]';
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-			const validationResult = await requiredFileUploadValidator.validate(questionObj, journeyResponse).run(req);
-
-			assert.strictEqual(validationResult.errors.length, 1);
-		});
-
-		it('should pass if existing files matching question doc type and only some being removed', async () => {
-			const questionObj = {
-				fieldName: 'test-fieldname',
-				documentType: {
-					name: 'test-doc-type'
-				}
-			};
-			const journeyResponse = {
-				answers: {
-					SubmissionDocumentUpload: [
-						{
-							file: 'to-be-removed',
-							type: 'test-doc-type'
-						},
-						{
-							file: 'to-be-kept',
-							type: 'test-doc-type'
-						}
-					]
-				}
-			};
-			const req = { body: {} };
-			req.body.removedFiles = '[{"file": "to-be-removed", "type": "test-doc-type"}]';
-
-			const requiredFileUploadValidator = new RequiredFileUploadValidator();
-			const validationResult = await requiredFileUploadValidator.validate(questionObj, journeyResponse).run(req);
-
-			assert.strictEqual(validationResult.errors.length, 0);
-		});
-	});
-});