@defra/forms-engine-plugin 3.0.9 → 4.0.0

package/src/server/plugins/engine/routes/questions.test.ts

@@ -40,8 +40,14 @@ jest.mock('~/src/server/plugins/engine/routes/index')
 
 describe('makeGetHandler', () => {
   const hMock: FormResponseToolkit = {
-    redirect: jest.fn(),
-    view: jest.fn()
+    redirect: jest.fn().mockReturnValue({
+      takeover: jest.fn().mockReturnValue({
+        statusCode: 302,
+        headers: { location: '/redirect-url' }
+      })
+    }),
+    view: jest.fn(),
+    continue: Symbol('continue')
   }
 
   beforeEach(() => {
@@ -84,8 +90,9 @@ describe('makeGetHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
-        Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
+          Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makeGetHandler()(requestMock, hMock)
@@ -126,8 +133,9 @@ describe('makeGetHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
-        Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
+          Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makeGetHandler()(requestMock, hMock)
@@ -164,7 +172,12 @@ describe('makeGetHandler', () => {
     jest
       .mocked(redirectOrMakeHandler)
       .mockImplementation(
-        async (_req: AnyFormRequest, _h: FormResponseToolkit, fn) => {
+        async (
+          _req: AnyFormRequest,
+          _h: FormResponseToolkit,
+          _onRequest,
+          fn
+        ) => {
           try {
             await fn(pageMock, contextMock)
           } catch (err) {
@@ -179,12 +192,57 @@ describe('makeGetHandler', () => {
 
     expect(error).toEqual(Boom.notFound('No model found for /some-path'))
   })
+
+  it('should pass onRequest callback to redirectOrMakeHandler', async () => {
+    const onRequestCallback = jest.fn().mockResolvedValue(undefined)
+    const modelMock = {
+      basePath: 'some-base-path',
+      def: { name: 'Hello world' }
+    } as FormModel
+
+    const pageMock = createMockPageController(
+      modelMock,
+      (
+        _request: FormRequest,
+        _context: FormContext,
+        _h: FormResponseToolkit
+      ) => {
+        return Promise.resolve({} as unknown as ResponseObject)
+      }
+    )
+
+    const contextMock = { data: {}, model: {} } as unknown as FormContext
+
+    const requestMock = {
+      params: { path: 'some-path' },
+      app: { model: modelMock }
+    } as FormRequest
+
+    jest
+      .mocked(redirectOrMakeHandler)
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, onRequest, fn) => {
+          expect(onRequest).toBe(onRequestCallback)
+          return Promise.resolve(fn(pageMock, contextMock))
+        }
+      )
+
+    await makeGetHandler(undefined, onRequestCallback)(requestMock, hMock)
+
+    expect(redirectOrMakeHandler).toHaveBeenCalledWith(
+      requestMock,
+      hMock,
+      onRequestCallback,
+      expect.any(Function)
+    )
+  })
 })
 
 describe('makePostHandler', () => {
   const hMock: FormResponseToolkit = {
     redirect: jest.fn(),
-    view: jest.fn()
+    view: jest.fn(),
+    continue: Symbol('continue')
   }
 
   beforeEach(() => {
@@ -230,8 +288,9 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
-        Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
+          Promise.resolve(fn(pageMock, contextMock))
       )
 
     const response = await makePostHandler()(requestMock, hMock)
@@ -269,8 +328,9 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
-        Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
+          Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makePostHandler()(requestMock, hMock)
@@ -310,8 +370,9 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
-        Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
+          Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makePostHandler()(requestMock, hMock)
@@ -349,7 +410,12 @@ describe('makePostHandler', () => {
     jest
       .mocked(redirectOrMakeHandler)
       .mockImplementation(
-        async (_req: AnyFormRequest, _h: FormResponseToolkit, fn) => {
+        async (
+          _req: AnyFormRequest,
+          _h: FormResponseToolkit,
+          _onRequest,
+          fn
+        ) => {
           try {
             await fn(pageMock, contextMock)
           } catch (err) {
@@ -364,6 +430,51 @@ describe('makePostHandler', () => {
 
     expect(error).toEqual(Boom.notFound('No model found for /some-path'))
   })
+
+  it('should pass onRequest callback to redirectOrMakeHandler', async () => {
+    const onRequestCallback = jest.fn().mockResolvedValue(undefined)
+    const modelMock = {
+      basePath: 'some-base-path',
+      def: { name: 'Hello world' }
+    } as FormModel
+
+    const pageMock = createMockPageController(
+      modelMock,
+      (
+        _request: FormRequest,
+        _context: FormContext,
+        _h: FormResponseToolkit
+      ) => {
+        return Promise.resolve({} as unknown as ResponseObject)
+      }
+    )
+
+    const contextMock = { data: {}, model: {} } as unknown as FormContext
+
+    const requestMock = {
+      params: { path: 'some-path' },
+      app: { model: modelMock },
+      payload: { some: 'payload' }
+    } as unknown as FormRequestPayload
+
+    jest
+      .mocked(redirectOrMakeHandler)
+      .mockImplementation(
+        (_req: AnyFormRequest, _h: FormResponseToolkit, onRequest, fn) => {
+          expect(onRequest).toBe(onRequestCallback)
+          return Promise.resolve(fn(pageMock, contextMock))
+        }
+      )
+
+    await makePostHandler(undefined, onRequestCallback)(requestMock, hMock)
+
+    expect(redirectOrMakeHandler).toHaveBeenCalledWith(
+      requestMock,
+      hMock,
+      onRequestCallback,
+      expect.any(Function)
+    )
+  })
 })
 
 function createMockPageController(

package/src/server/plugins/engine/routes/questions.ts

@@ -26,6 +26,7 @@ import {
 import {
   type AnyFormRequest,
   type FormContext,
+  type OnRequestCallback,
   type PreparePageEventRequestOptions
 } from '~/src/server/plugins/engine/types.js'
 import {
@@ -74,7 +75,8 @@ async function handleHttpEvent(
 }
 
 export function makeGetHandler(
-  preparePageEventRequestOptions?: PreparePageEventRequestOptions
+  preparePageEventRequestOptions?: PreparePageEventRequestOptions,
+  onRequest?: OnRequestCallback
 ) {
   return function getHandler(request: FormRequest, h: FormResponseToolkit) {
     const { params } = request
@@ -83,34 +85,40 @@ export function makeGetHandler(
       return dispatchHandler(request, h)
     }
 
-    return redirectOrMakeHandler(request, h, async (page, context) => {
-      // Check for a page onLoad HTTP event and if one exists,
-      // call it and assign the response to the context data
-      const { events } = page
-      const { model } = request.app
+    return redirectOrMakeHandler(
+      request,
+      h,
+      onRequest,
+      async (page, context) => {
+        // Check for a page onLoad HTTP event and if one exists,
+        // call it and assign the response to the context data
+        const { events } = page
+        const { model } = request.app
 
-      if (!model) {
-        throw Boom.notFound(`No model found for /${params.path}`)
-      }
+        if (!model) {
+          throw Boom.notFound(`No model found for /${params.path}`)
+        }
 
-      if (events?.onLoad && events.onLoad.type === 'http') {
-        await handleHttpEvent(
-          request,
-          page,
-          context,
-          events.onLoad,
-          model,
-          preparePageEventRequestOptions
-        )
-      }
+        if (events?.onLoad && events.onLoad.type === 'http') {
+          await handleHttpEvent(
+            request,
+            page,
+            context,
+            events.onLoad,
+            model,
+            preparePageEventRequestOptions
+          )
+        }
 
-      return page.makeGetRouteHandler()(request, context, h)
-    })
+        return page.makeGetRouteHandler()(request, context, h)
+      }
+    )
   }
 }
 
 export function makePostHandler(
-  preparePageEventRequestOptions?: PreparePageEventRequestOptions
+  preparePageEventRequestOptions?: PreparePageEventRequestOptions,
+  onRequest?: OnRequestCallback
 ) {
   return function postHandler(
     request: FormRequestPayload,
@@ -118,40 +126,45 @@ export function makePostHandler(
   ) {
     const { query } = request
 
-    return redirectOrMakeHandler(request, h, async (page, context) => {
-      const { pageDef } = page
-      const { isForceAccess } = context
-      const { model } = request.app
-      const { events } = page
+    return redirectOrMakeHandler(
+      request,
+      h,
+      onRequest,
+      async (page, context) => {
+        const { pageDef } = page
+        const { isForceAccess } = context
+        const { model } = request.app
+        const { events } = page
 
-      // Redirect to GET for preview URL direct access
-      if (isForceAccess && !hasFormComponents(pageDef)) {
-        return proceed(request, h, redirectPath(page.href, query))
-      }
+        // Redirect to GET for preview URL direct access
+        if (isForceAccess && !hasFormComponents(pageDef)) {
+          return proceed(request, h, redirectPath(page.href, query))
+        }
 
-      if (!model) {
-        throw Boom.notFound(`No model found for /${request.params.path}`)
-      }
+        if (!model) {
+          throw Boom.notFound(`No model found for /${request.params.path}`)
+        }
 
-      const response = await page.makePostRouteHandler()(request, context, h)
+        const response = await page.makePostRouteHandler()(request, context, h)
 
-      if (
-        events?.onSave &&
-        events.onSave.type === 'http' &&
-        isSuccessful(response)
-      ) {
-        await handleHttpEvent(
-          request,
-          page,
-          context,
-          events.onSave,
-          model,
-          preparePageEventRequestOptions
-        )
-      }
+        if (
+          events?.onSave &&
+          events.onSave.type === 'http' &&
+          isSuccessful(response)
+        ) {
+          await handleHttpEvent(
+            request,
+            page,
+            context,
+            events.onSave,
+            model,
+            preparePageEventRequestOptions
+          )
+        }
 
-      return response
-    })
+        return response
+      }
+    )
   }
 }
 
@@ -164,13 +177,14 @@ function isSuccessful(response: ResponseObject): boolean {
 export function getRoutes(
   getRouteOptions: RouteOptions<FormRequestRefs>,
   postRouteOptions: RouteOptions<FormRequestPayloadRefs>,
-  preparePageEventRequestOptions?: PreparePageEventRequestOptions
+  preparePageEventRequestOptions?: PreparePageEventRequestOptions,
+  onRequest?: OnRequestCallback
 ): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {
   return [
     {
       method: 'get',
       path: '/{slug}',
-      handler: makeGetHandler(preparePageEventRequestOptions),
+      handler: makeGetHandler(preparePageEventRequestOptions, onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -197,7 +211,7 @@ export function getRoutes(
     {
       method: 'get',
       path: '/{slug}/{path}/{itemId?}',
-      handler: makeGetHandler(preparePageEventRequestOptions),
+      handler: makeGetHandler(preparePageEventRequestOptions, onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -212,7 +226,7 @@ export function getRoutes(
     {
       method: 'get',
       path: '/preview/{state}/{slug}/{path}/{itemId?}',
-      handler: makeGetHandler(preparePageEventRequestOptions),
+      handler: makeGetHandler(preparePageEventRequestOptions, onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -228,7 +242,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/{slug}/{path}/{itemId?}',
-      handler: makePostHandler(preparePageEventRequestOptions),
+      handler: makePostHandler(preparePageEventRequestOptions, onRequest),
       options: {
         ...postRouteOptions,
         validate: {
@@ -250,7 +264,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/preview/{state}/{slug}/{path}/{itemId?}',
-      handler: makePostHandler(preparePageEventRequestOptions),
+      handler: makePostHandler(preparePageEventRequestOptions, onRequest),
       options: {
         ...postRouteOptions,
         validate: {

package/src/server/plugins/engine/routes/repeaters/item-delete.test.ts

@@ -0,0 +1,83 @@
+import { getRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'
+import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
+
+describe('repeater item-delete routes', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe('route configuration', () => {
+    it('should return all expected routes', () => {
+      const routes = getRoutes({}, {}, undefined)
+
+      expect(routes).toHaveLength(4)
+
+      const expectedPaths = [
+        '/{slug}/{path}/{itemId}/confirm-delete',
+        '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete'
+      ]
+
+      expectedPaths.forEach((path) => {
+        const getRoute = routes.find(
+          (route) => route.method === 'get' && route.path === path
+        )
+        const postRoute = routes.find(
+          (route) => route.method === 'post' && route.path === path
+        )
+
+        expect(getRoute).toBeDefined()
+        expect(postRoute).toBeDefined()
+      })
+    })
+
+    it('should pass onRequest callback to handlers', () => {
+      const onRequestCallback: OnRequestCallback = jest
+        .fn()
+        .mockResolvedValue(undefined)
+      const routes = getRoutes({}, {}, onRequestCallback)
+
+      // Test that the handlers are created with the onRequest callback
+      const getRoute = routes.find(
+        (route) =>
+          route.method === 'get' &&
+          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
+      )
+      const postRoute = routes.find(
+        (route) =>
+          route.method === 'post' &&
+          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
+      )
+
+      expect(getRoute?.handler).toBeDefined()
+      expect(postRoute?.handler).toBeDefined()
+    })
+  })
+
+  describe('handler functionality', () => {
+    it('should create handlers that accept onRequest callback', () => {
+      const onRequestCallback: OnRequestCallback = jest
+        .fn()
+        .mockResolvedValue(undefined)
+      const routes = getRoutes({}, {}, onRequestCallback)
+
+      // Test that the handlers are created with the onRequest callback
+      const getRoute = routes.find(
+        (route) =>
+          route.method === 'get' &&
+          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
+      )
+      const postRoute = routes.find(
+        (route) =>
+          route.method === 'post' &&
+          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
+      )
+
+      expect(getRoute?.handler).toBeDefined()
+      expect(postRoute?.handler).toBeDefined()
+
+      // Test that handlers are functions
+      expect(typeof getRoute?.handler).toBe('function')
+      expect(typeof postRoute?.handler).toBe('function')
+    })
+  })
+})

package/src/server/plugins/engine/routes/repeaters/item-delete.ts

@@ -6,6 +6,7 @@ import Joi from 'joi'
 import { FileUploadPageController } from '~/src/server/plugins/engine/pageControllers/FileUploadPageController.js'
 import { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'
 import { redirectOrMakeHandler } from '~/src/server/plugins/engine/routes/index.js'
+import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequest,
   type FormRequestPayload,
@@ -23,52 +24,57 @@ import {
 } from '~/src/server/schemas/index.js'
 
 // Item delete GET route
-function getHandler(request: FormRequest, h: FormResponseToolkit) {
-  const { params } = request
+function getHandler(onRequest?: OnRequestCallback) {
+  return async function (request: FormRequest, h: FormResponseToolkit) {
+    const { params } = request
 
-  return redirectOrMakeHandler(request, h, (page, context) => {
-    if (
-      !(
-        page instanceof RepeatPageController ||
-        page instanceof FileUploadPageController
-      )
-    ) {
-      throw Boom.notFound(`No page found for /${params.path}`)
-    }
+    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {
+      if (
+        !(
+          page instanceof RepeatPageController ||
+          page instanceof FileUploadPageController
+        )
+      ) {
+        throw Boom.notFound(`No page found for /${params.path}`)
+      }
 
-    return page.makeGetItemDeleteRouteHandler()(request, context, h)
-  })
+      return page.makeGetItemDeleteRouteHandler()(request, context, h)
+    })
+  }
 }
 
-function postHandler(request: FormRequestPayload, h: FormResponseToolkit) {
-  const { params } = request
+function postHandler(onRequest?: OnRequestCallback) {
+  return async function (request: FormRequestPayload, h: FormResponseToolkit) {
+    const { params } = request
 
-  return redirectOrMakeHandler(request, h, (page, context) => {
-    const { isForceAccess } = context
+    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {
+      const { isForceAccess } = context
 
-    if (
-      isForceAccess ||
-      !(
-        page instanceof RepeatPageController ||
-        page instanceof FileUploadPageController
-      )
-    ) {
-      throw Boom.notFound(`No page found for /${params.path}`)
-    }
+      if (
+        isForceAccess ||
+        !(
+          page instanceof RepeatPageController ||
+          page instanceof FileUploadPageController
+        )
+      ) {
+        throw Boom.notFound(`No page found for /${params.path}`)
+      }
 
-    return page.makePostItemDeleteRouteHandler()(request, context, h)
-  })
+      return page.makePostItemDeleteRouteHandler()(request, context, h)
+    })
+  }
 }
 
 export function getRoutes(
   getRouteOptions: RouteOptions<FormRequestRefs>,
-  postRouteOptions: RouteOptions<FormRequestPayloadRefs>
+  postRouteOptions: RouteOptions<FormRequestPayloadRefs>,
+  onRequest?: OnRequestCallback
 ): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {
   return [
     {
       method: 'get',
       path: '/{slug}/{path}/{itemId}/confirm-delete',
-      handler: getHandler,
+      handler: getHandler(onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -84,7 +90,7 @@ export function getRoutes(
     {
       method: 'get',
       path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',
-      handler: getHandler,
+      handler: getHandler(onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -101,7 +107,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/{slug}/{path}/{itemId}/confirm-delete',
-      handler: postHandler,
+      handler: postHandler(onRequest),
       options: {
         ...postRouteOptions,
         validate: {
@@ -124,7 +130,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',
-      handler: postHandler,
+      handler: postHandler(onRequest),
       options: {
         ...postRouteOptions,
         validate: {