@defra/forms-engine-plugin 2.1.10 → 3.0.1

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndReturn?: PluginOptions['saveAndReturn']\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/.server/typings/hapi/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.ts'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: Request | FormRequest | FormRequestPayload) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: FormRequest | FormRequestPayload | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndReturn?: PluginOptions['saveAndReturn']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module '@hapi/scooter' {\n  declare const hapiScooter: {\n    plugin: Plugin\n  }\n\n  export = hapiScooter\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module '@hapi/scooter' {\n  declare const hapiScooter: {\n    plugin: Plugin\n  }\n\n  export = hapiScooter\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "2.1.10",
+  "version": "3.0.1",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -28,7 +28,9 @@
     "./services/*": "./.server/server/plugins/engine/services/*",
     "./engine/*": "./.server/server/plugins/engine/*",
     "./helpers.js": "./.server/server/plugins/engine/components/helpers.js",
+    "./schema.js": "./.server/server/schemas/index.js",
     "./templates/*": "./.server/server/plugins/engine/views/*",
+    "./cache-service.js": "./.server/server/services/cacheService.js",
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -68,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.506",
+    "@defra/forms-model": "^3.0.552",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

package/src/server/index.test.ts

@@ -639,42 +639,3 @@ describe('prepareEnvironment', () => {
     )
   })
 })
-
-describe('Exit route handlers', () => {
-  let server: Server
-
-  beforeAll(async () => {
-    server = await createServer({
-      services: defaultServices
-    })
-    await server.initialize()
-  })
-
-  afterAll(async () => {
-    await server.stop()
-  })
-
-  beforeEach(() => {
-    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
-    server.app.models.clear()
-  })
-
-  test('GET /exit returns 200 with exit page content', async () => {
-    jest.mocked(getFormMetadata).mockResolvedValueOnce({
-      ...fixtures.form.metadata,
-      live: fixtures.form.state
-    })
-
-    jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-    const options = {
-      method: 'GET',
-      url: `${FORM_PREFIX}/slug/exit`
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.OK)
-    expect(res.result).toContain('Your progress has been saved')
-  })
-})

package/src/server/index.ts

@@ -82,8 +82,11 @@ export async function createServer(routeConfig?: RouteConfig) {
     prepareSecureContext(server)
   }
 
+  const cacheService = routeConfig?.cacheServiceCreator
+    ? routeConfig.cacheServiceCreator(server)
+    : undefined
   const pluginCrumb = configureCrumbPlugin(routeConfig)
-  const pluginEngine = await configureEnginePlugin(routeConfig)
+  const pluginEngine = await configureEnginePlugin(routeConfig, cacheService)
 
   await server.register(pluginSession)
   await server.register(pluginPulse)

package/src/server/plugins/engine/README.md

@@ -86,9 +86,9 @@ There are a number of `LiquidJS` filters available to you from within the templa
 ]
 ```
 
-### Save and return
+### Save and exit
 
-See [our save and return feature page](/docs/features/code-based/SAVE_AND_RETURN.md).
+See [our save and exit feature page](/docs/features/code-based/SAVE_AND_EXIT.md).
 
 ### Additional notes
 

package/src/server/plugins/engine/components/helpers/helpers.test.ts

@@ -25,7 +25,7 @@ describe('helpers tests', () => {
 })
 
 describe('ComponentBase tests', () => {
-  test('should handle save and return functionality', () => {
+  test('should handle save and exit functionality', () => {
     const mockComponentDef = {
       type: 'TextField',
       name: 'testField',

package/src/server/plugins/engine/configureEnginePlugin.ts

@@ -10,17 +10,21 @@ import { formsService } from '~/src/server/plugins/engine/services/localFormsSer
 import { type PluginOptions } from '~/src/server/plugins/engine/types.js'
 import { findPackageRoot } from '~/src/server/plugins/engine/vision.js'
 import { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'
+import { type CacheService } from '~/src/server/services/cacheService.js'
 import { type RouteConfig } from '~/src/server/types.js'
 
-export const configureEnginePlugin = async ({
-  formFileName,
-  formFilePath,
-  services,
-  controllers,
-  preparePageEventRequestOptions,
-  onRequest,
-  saveAndReturn
-}: RouteConfig = {}): Promise<{
+export const configureEnginePlugin = async (
+  {
+    formFileName,
+    formFilePath,
+    services,
+    controllers,
+    preparePageEventRequestOptions,
+    onRequest,
+    saveAndExit
+  }: RouteConfig = {},
+  cache?: CacheService
+): Promise<{
   plugin: typeof plugin
   options: PluginOptions
 }> => {
@@ -50,7 +54,7 @@ export const configureEnginePlugin = async ({
         formsService: await formsService()
       },
       controllers,
-      cacheName: 'session',
+      cache: cache ?? 'session',
       nunjucks: {
         baseLayoutPath: 'dxt-devtool-baselayout.html',
         paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner
@@ -59,7 +63,7 @@ export const configureEnginePlugin = async ({
       preparePageEventRequestOptions,
       onRequest,
       baseUrl: 'http://localhost:3009', // always runs locally
-      saveAndReturn
+      saveAndExit
     }
   }
 }

package/src/server/plugins/engine/helpers.test.ts

@@ -30,7 +30,8 @@ import {
 import {
   FormAction,
   FormStatus,
-  type FormRequest
+  type FormRequest,
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 import definition from '~/test/form/definitions/basic.js'
 import templateDefinition from '~/test/form/definitions/templates.js'
@@ -47,7 +48,7 @@ type HrefFilter = (this: NunjucksContext, path: string) => string | undefined
 describe('Helpers', () => {
   let page: PageControllerClass
   let request: FormContextRequest
-  let h: Pick<ResponseToolkit, 'redirect' | 'view'>
+  let h: FormResponseToolkit
 
   beforeEach(() => {
     const model = new FormModel(definition, {

package/src/server/plugins/engine/helpers.ts

@@ -23,6 +23,7 @@ import {
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
+  type AnyFormRequest,
   type FormContext,
   type FormContextRequest,
   type FormSubmissionError
@@ -32,8 +33,7 @@ import {
   FormStatus,
   type FormParams,
   type FormQuery,
-  type FormRequest,
-  type FormRequestPayload
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 
 const logger = createLogger()
@@ -117,7 +117,7 @@ engine.registerFilter('answer', function (name: string) {
 
 export function proceed(
   request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,
-  h: Pick<ResponseToolkit, 'redirect' | 'view'>,
+  h: FormResponseToolkit,
   nextUrl: string
 ) {
   const { method, payload, query } = request
@@ -327,7 +327,7 @@ export function getError(detail: ValidationErrorItem): FormSubmissionError {
  * is not disabled on the current route, and that cookies/state are present.
  */
 export function safeGenerateCrumb(
-  request: FormRequest | FormRequestPayload | null
+  request: AnyFormRequest | null
 ): string | undefined {
   // no request or no .state
   if (!request?.state) {
@@ -380,8 +380,8 @@ export function getCacheService(server: Server) {
   return getPluginOptions(server).cacheService
 }
 
-export function getSaveAndReturnHelpers(server: Server) {
-  return getPluginOptions(server).saveAndReturn
+export function getSaveAndExitHelpers(server: Server) {
+  return getPluginOptions(server).saveAndExit
 }
 
 export function getPluginOptions(server: Server) {

package/src/server/plugins/engine/models/FormModel.test.ts

@@ -141,6 +141,21 @@ describe('FormModel', () => {
       expect(model.schemaVersion).toBe(SchemaVersion.V1)
     })
 
+    it('sets versionNumber from options', () => {
+      const model = new FormModel(definition, {
+        basePath: 'test',
+        versionNumber: 42
+      })
+
+      expect(model.versionNumber).toBe(42)
+    })
+
+    it('sets versionNumber to undefined when not provided', () => {
+      const model = new FormModel(definition, { basePath: 'test' })
+
+      expect(model.versionNumber).toBeUndefined()
+    })
+
     it.each([
       {
         input: undefined,
@@ -185,7 +200,7 @@ describe('FormModel', () => {
   })
 
   describe('getFormContext', () => {
-    it.each([FormAction.Validate, FormAction.SaveAndReturn, undefined])(
+    it.each([FormAction.Validate, FormAction.SaveAndExit, undefined])(
       'returns a form context with the correct payload and state when action is %s',
       (action) => {
         const formModel = new FormModel(fieldsRequiredDefinition, {
@@ -219,7 +234,7 @@ describe('FormModel', () => {
       }
     )
 
-    it('returns without updating the state when the action is not validate or saveAndReturn', () => {
+    it('returns without updating the state when the action is not validate or saveAndExit', () => {
       const formModel = new FormModel(fieldsRequiredDefinition, {
         basePath: '/components'
       })
@@ -329,6 +344,55 @@ describe('FormModel', () => {
       )
     })
 
+    it('includes submittedVersionNumber in context when versionNumber is set', () => {
+      const formModel = new FormModel(fieldsRequiredDefinition, {
+        basePath: '/components',
+        versionNumber: 123
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar'
+      }
+      const pageUrl = new URL('http://example.com/components/fields-required')
+
+      const request: FormContextRequest = buildFormContextRequest({
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'components', slug: 'fields-required' },
+        url: pageUrl,
+        app: { model: formModel }
+      })
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.submittedVersionNumber).toBe(123)
+    })
+
+    it('sets submittedVersionNumber to undefined when versionNumber is not set', () => {
+      const formModel = new FormModel(fieldsRequiredDefinition, {
+        basePath: '/components'
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar'
+      }
+      const pageUrl = new URL('http://example.com/components/fields-required')
+
+      const request: FormContextRequest = buildFormContextRequest({
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'components', slug: 'fields-required' },
+        url: pageUrl,
+        app: { model: formModel }
+      })
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.submittedVersionNumber).toBeUndefined()
+    })
+
     it('redirects to the page if the list field (radio) is invalidated due to list item conditions', () => {
       const formModel = new FormModel(conditionsListDefinition, {
         basePath: '/conditional-list-items'

package/src/server/plugins/engine/models/FormModel.ts

@@ -76,6 +76,7 @@ export class FormModel {
   name: string
   values: FormDefinition
   basePath: string
+  versionNumber?: number
   conditions: Partial<Record<string, ExecutableCondition>>
   pages: PageControllerClass[]
   services: Services
@@ -94,7 +95,7 @@ export class FormModel {
 
   constructor(
     def: typeof this.def,
-    options: { basePath: string },
+    options: { basePath: string; versionNumber?: number },
     services: Services = defaultServices,
     controllers?: Record<string, typeof PageController>
   ) {
@@ -148,6 +149,7 @@ export class FormModel {
     this.name = def.name ?? ''
     this.values = result.value
     this.basePath = options.basePath
+    this.versionNumber = options.versionNumber
     this.conditions = {}
     this.services = services
     this.controllers = controllers
@@ -344,7 +346,8 @@ export class FormModel {
       componentDefMap: this.componentDefMap,
       pageMap: this.pageMap,
       componentMap: this.componentMap,
-      referenceNumber: getReferenceNumber(state)
+      referenceNumber: getReferenceNumber(state),
+      submittedVersionNumber: this.versionNumber
     }
 
     // Validate current page
@@ -543,8 +546,7 @@ function validateFormPayload(
   // Skip validation GET requests or other actions
   if (
     !request.payload ||
-    (action &&
-      ![FormAction.Validate, FormAction.SaveAndReturn].includes(action))
+    (action && ![FormAction.Validate, FormAction.SaveAndExit].includes(action))
   ) {
     return context
   }

package/src/server/plugins/engine/models/SummaryViewModel.test.ts

@@ -5,7 +5,7 @@ import {
 } from '~/src/server/plugins/engine/models/index.js'
 import { SummaryPageController } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
 import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import { serverWithSaveAndReturn } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
+import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
 import {
   createPage,
   type PageControllerClass
@@ -274,16 +274,16 @@ describe('SummaryPageController', () => {
       },
       query: {},
       app: { model },
-      server: serverWithSaveAndReturn
+      server: serverWithSaveAndExit
     }
   })
 
-  describe('Save and Return functionality', () => {
-    it('should show save and return button on summary page', () => {
-      expect(controller.shouldShowSaveAndReturn(request.server)).toBe(true)
+  describe('Save and Exit functionality', () => {
+    it('should show save and exit button on summary page', () => {
+      expect(controller.shouldShowSaveAndExit(request.server)).toBe(true)
     })
 
-    it('should handle save and return from summary page', () => {
+    it('should handle save and exit from summary page', () => {
       const state: FormState = {
         $$__referenceNumber: 'foobar',
         orderType: 'collection',
@@ -293,7 +293,7 @@ describe('SummaryPageController', () => {
       const context = model.getFormContext(request, state)
       const viewModel = controller.getViewModel(request, context)
 
-      expect(viewModel).toHaveProperty('allowSaveAndReturn', true)
+      expect(viewModel).toHaveProperty('allowSaveAndExit', true)
     })
 
     it('should display correct page title', () => {

package/src/server/plugins/engine/models/SummaryViewModel.ts

@@ -51,7 +51,7 @@ export class SummaryViewModel {
   serviceUrl: string
   hasMissingNotificationEmail?: boolean
   components?: ComponentViewModel[]
-  allowSaveAndReturn = false
+  allowSaveAndExit = false
 
   constructor(
     request: FormContextRequest,

package/src/server/plugins/engine/options.js

@@ -1,6 +1,7 @@
 import Joi from 'joi'
 
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+import { CacheService } from '~/src/server/services/index.js'
 
 const logger = createLogger()
 
@@ -8,7 +9,10 @@ const pluginRegistrationOptionsSchema = Joi.object({
   model: Joi.object().optional(),
   services: Joi.object().optional(),
   controllers: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
-  cacheName: Joi.string().optional(),
+  cache: Joi.alternatives().try(
+    Joi.object().instance(CacheService),
+    Joi.string()
+  ),
   globals: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
   filters: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
   pluginPath: Joi.string().optional(),
@@ -20,11 +24,7 @@ const pluginRegistrationOptionsSchema = Joi.object({
   preparePageEventRequestOptions: Joi.function().optional(),
   onRequest: Joi.function().optional(),
   baseUrl: Joi.string().uri().required(),
-  saveAndReturn: Joi.object({
-    keyGenerator: Joi.function(),
-    sessionHydrator: Joi.function(),
-    sessionPersister: Joi.function()
-  }).optional()
+  saveAndExit: Joi.function().optional()
 })
 
 /**

package/src/server/plugins/engine/options.test.js

@@ -19,7 +19,7 @@ describe('validatePluginOptions', () => {
     expect(validatePluginOptions(validOptions)).toEqual(validOptions)
   })
 
-  it('accepts optional properties keyGenerator, sessionHydrator, and sessionPersister', () => {
+  it('accepts optional property saveAndExit', () => {
     /**
      * @type {PluginOptions}
      */
@@ -32,11 +32,7 @@ describe('validatePluginOptions', () => {
         return { hello: 'world' }
       },
       baseUrl: 'http://localhost:3009',
-      saveAndReturn: {
-        keyGenerator: () => 'test-key',
-        sessionHydrator: () => Promise.resolve({ someState: 'value' }),
-        sessionPersister: () => Promise.resolve(undefined)
-      }
+      saveAndExit: (request, h) => h.redirect('/save-and-exit')
     }
 
     expect(validatePluginOptions(validOptionsWithOptionals)).toEqual(