Config Broker Version 1.0.1 - This service uses DefraID and the Save and Return + content:
This service uses DefraID and the Save and Return feature, and demonstrates the use of the following components and page types:
id: 434ab3dc-fad9-44c5-8601-b19477a1d77e @@ -129,7 +216,6 @@ pages: application type: YesNoField options: - classes: govuk-radios--inline customValidationMessages: any.required: Select 'Yes' to continue shortDescription: Yes or No @@ -332,6 +418,66 @@ pages: id: 264fbff1-35f6-49d3-98ae-b7582b1e41b5 schema: {} id: 88d7b067-68c2-4fe1-9a9a-ea98f0752e03 + - title: Select all the eligible land parcels for the location of your woodland + controller: CommonSelectLandParcelPageController + components: + - name: landParcels + type: CheckboxesField + title: Select land parcels + config: + enableMultipleParcelSelect: true + topSection: | ++ You must include all woodland on your holding in your application. A holding + is all the land in the same geographical location that is managed as a unit. +
+ ++ For larger holdings, this is all woodland within the same geographical + location. +
+ ++ Land parcels must be entirely within England and defined as an area of land + that: +
+ ++ The woodland must be larger than 0.5 hectares in total. The total area for the + application can be made up of separate blocks of woodland but the minimum + block size must be 0.5ha. +
+ ++ To find out more about what land is eligible for a WMP read our + + Applicant's guide: PA3 Woodland management plan 2026 guidance + . +
+Phone: 020 8026 2395
+Monday to Friday, 8:30am to 5pm, except bank holidays
++ + Find out about call charges (opens in new tab) + +
+Email: farmpayments@rpa.gov.uk
+We aim to respond to emails within 10 working days
+ path: /select-land-parcel + id: f9f1a33b-2fb5-4418-951b-680067efc179 - title: Multi Field Form Example path: /multi-field-form components: @@ -406,6 +552,10 @@ pages: options: {} schema: {} id: 089374a5-13e7-494d-994e-9b38c4b7392c + - title: Check your details + path: /check-details + controller: CheckDetailsController + id: f7a2c8b1-3d4e-5f6a-7b8c-9d0e1f2a3b4c - title: Check your answers path: /summary controller: CheckResponsesPageController diff --git a/src/server/common/forms/services/api-form-service.js b/src/server/common/forms/services/api-form-service.js index 951004ded..916268d12 100644 --- a/src/server/common/forms/services/api-form-service.js +++ b/src/server/common/forms/services/api-form-service.js @@ -1,6 +1,7 @@ import jwt from 'jsonwebtoken' import { logger } from '~/src/server/common/helpers/logging/log.js' import { getFormDef, setFormDef, setFormMeta, setSlugReverse } from './forms-redis.js' +import { hoistPageConfig } from '~/src/server/common/forms/services/form.js' export class ApiFormService { /** @@ -122,6 +123,7 @@ export class ApiFormService { // Apply URL substitutions const definition = configureDefinition(rawDefinition) + hoistPageConfig(definition) // Copy metadata from the definition into the cache entry entry.metadata = definition.metadata diff --git a/src/server/common/forms/services/api-form-service.test.js b/src/server/common/forms/services/api-form-service.test.js index 35dc2fe6c..ec7d3f2ff 100644 --- a/src/server/common/forms/services/api-form-service.test.js +++ b/src/server/common/forms/services/api-form-service.test.js @@ -145,6 +145,34 @@ describe('ApiFormService', () => { expect(setSlugReverse).toHaveBeenCalledWith({}, 'api-id', 'my-form') }) + test('hoists config section if present on a page', async () => { + const entry = { id: 'api-id', slug: 'my-form', title: 'My Form', metadata: {}, source: 'api' } + const definition = { + name: 'my-form', + metadata: { grantRedirectRules: {} }, + pages: [{ path: 'mypage', config: { item: 'value' } }] + } + vi.spyOn(service, 'fetchFormMetadata').mockResolvedValue(entry) + vi.spyOn(service, 'fetchFormDefinition').mockResolvedValue(definition) + const configure = vi.fn((d) => d) + const validateWhitelist = vi.fn() + const validateRedirect = vi.fn() + const validateDetailsPage = vi.fn() + + await service.loadAll({}, ['my-form'], {}, configure, validateWhitelist, validateRedirect, validateDetailsPage) + + expect(configure).toHaveBeenCalledWith(definition) + expect(validateWhitelist).toHaveBeenCalledWith({ title: 'My Form' }, definition) + expect(validateRedirect).toHaveBeenCalledWith({ title: 'My Form' }, definition) + expect(validateDetailsPage).toHaveBeenCalledWith({ title: 'My Form' }, definition) + expect(setFormMeta).toHaveBeenCalledWith({}, 'my-form', { + ...entry, + metadata: { grantRedirectRules: {}, pageConfig: { mypage: { item: 'value' } } } + }) + expect(setFormDef).toHaveBeenCalledWith({}, 'my-form', { ...definition, pages: [{ path: 'mypage' }] }, 300) + expect(setSlugReverse).toHaveBeenCalledWith({}, 'api-id', 'my-form') + }) + test('merges shared redirect rules into definition metadata', async () => { const entry = { id: 'api-id', slug: 'my-form', title: 'My Form', metadata: {}, source: 'api' } const definition = { diff --git a/src/server/common/helpers/form-verify-and-request-load.js b/src/server/common/helpers/form-verify-and-request-load.js new file mode 100644 index 000000000..4dac06ba6 --- /dev/null +++ b/src/server/common/helpers/form-verify-and-request-load.js @@ -0,0 +1,27 @@ +import { statusCodes } from '~/src/server/common/constants/status-codes.js' +import { findFormBySlug } from '~/src/server/common/forms/services/find-form-by-slug.js' + +export async function validateRequestAndFindForm(request, h) { + const { slug } = request.params + + if (!slug) { + return { error: h.response('Bad request - missing slug').code(statusCodes.badRequest).takeover() } + } + + const form = await findFormBySlug(slug) + if (!form) { + return { error: h.response('Form not found').code(statusCodes.notFound).takeover() } + } + + // For pages that do not extend the DXT controllers, this model will not be set, but it is required for retrieving the + // correct state from backend when using form definitions loaded via config API (as version is required) + if (!request.app?.model) { + request.app.model = { + def: { + metadata: form.metadata + } + } + } + + return { form, slug } +} diff --git a/src/server/common/helpers/form-verify-and-request-load.test.js b/src/server/common/helpers/form-verify-and-request-load.test.js new file mode 100644 index 000000000..9f4da15d9 --- /dev/null +++ b/src/server/common/helpers/form-verify-and-request-load.test.js @@ -0,0 +1,40 @@ +import { mockHapiRequest, mockHapiResponseToolkit } from '~/src/__mocks__/index.js' +import { validateRequestAndFindForm } from './form-verify-and-request-load.js' +import { vi } from 'vitest' +import { findFormBySlug } from '../forms/services/find-form-by-slug.js' +import { MOCK_FORM_WITH_PATH } from '~/src/__test-fixtures__/mock-forms-cache.js' + +vi.mock('../forms/services/find-form-by-slug.js') + +const mockForm = MOCK_FORM_WITH_PATH + +describe('form-verify-and-request-load', () => { + it('should return 400 response error when slug is missing', async () => { + const mockH = mockHapiResponseToolkit() + const result = await validateRequestAndFindForm(mockHapiRequest({ params: {} }), mockH) + expect(result.error).toBe(mockH) + expect(mockH.response).toHaveBeenCalledWith('Bad request - missing slug') + expect(mockH.code).toHaveBeenCalledWith(400) + }) + + it('should return 404 response error when form not found', async () => { + findFormBySlug.mockResolvedValue(undefined) + const mockH = mockHapiResponseToolkit() + const result = await validateRequestAndFindForm(mockHapiRequest({ params: { slug: 'test-slug' } }), mockH) + expect(result.error).toBe(mockH) + expect(mockH.response).toHaveBeenCalledWith('Form not found') + expect(mockH.code).toHaveBeenCalledWith(404) + }) + + it('should return form and slug and set request app model when inputs valid', async () => { + const formWithMetaData = { ...mockForm, metadata: { some: 'metadata' } } + findFormBySlug.mockResolvedValue(formWithMetaData) + const mockH = mockHapiResponseToolkit() + const requestProps = { params: { slug: 'test-slug' }, app: {} } + const result = await validateRequestAndFindForm(mockHapiRequest(requestProps), mockH) + expect(result.error).toBeUndefined() + expect(result.form).toBe(formWithMetaData) + expect(result.slug).toBe('test-slug') + expect(requestProps.app.model.def.metadata).toEqual({ some: 'metadata' }) + }) +}) diff --git a/src/server/confirmation/config-confirmation.js b/src/server/confirmation/config-confirmation.js index d3c594e91..38d41a093 100644 --- a/src/server/confirmation/config-confirmation.js +++ b/src/server/confirmation/config-confirmation.js @@ -1,47 +1,9 @@ -import { findFormBySlug } from '~/src/server/common/forms/services/find-form-by-slug.js' import { ConfirmationService } from './services/confirmation.service.js' import { getFormsCacheService } from '~/src/server/common/helpers/forms-cache/forms-cache.js' import { log, LogCodes } from '~/src/server/common/helpers/logging/log.js' import { ApplicationStatus } from '~/src/server/common/constants/application-status.js' import { statusCodes } from '~/src/server/common/constants/status-codes.js' - -/** - * Validates request parameters and finds form by slug - * @param {object} request - Hapi request object - * @param {object} h - Hapi response toolkit - * @returns {Promise