@defra/forms-engine-plugin 2.1.10 → 3.0.1

package/src/server/services/cacheService.ts

@@ -1,18 +1,16 @@
-import { type Request, type Server } from '@hapi/hapi'
+import { type Server } from '@hapi/hapi'
 import * as Hoek from '@hapi/hoek'
 
 import { config } from '~/src/config/index.js'
 import { type createServer } from '~/src/server/index.js'
 import {
+  type AnyFormRequest,
+  type AnyRequest,
   type FormPayload,
   type FormState,
   type FormSubmissionError,
   type FormSubmissionState
 } from '~/src/server/plugins/engine/types.js'
-import {
-  type FormRequest,
-  type FormRequestPayload
-} from '~/src/server/routes/types.js'
 
 const partition = 'cache'
 
@@ -25,66 +23,28 @@ export class CacheService {
    * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}
    */
   cache
-  generateKey?: (request: Request | FormRequest | FormRequestPayload) => string
-  customFetcher?: (
-    request: Request | FormRequest | FormRequestPayload
-  ) => Promise<FormSubmissionState | null>
-
   logger: Server['logger']
 
-  constructor({
-    server,
-    cacheName,
-    options
-  }: {
-    server: Server
-    cacheName?: string
-    options?: {
-      keyGenerator?: (
-        request: Request | FormRequest | FormRequestPayload
-      ) => string
-      sessionHydrator?: (
-        request: Request | FormRequest | FormRequestPayload
-      ) => Promise<FormSubmissionState | null>
-    }
-  }) {
-    const { keyGenerator, sessionHydrator } = options ?? {}
+  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {
     if (!cacheName) {
       server.log(
         'warn',
         'You are using the default hapi cache. Please provide a cache name in plugin registration options.'
       )
     }
-    this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this)
-    this.customFetcher = sessionHydrator ?? undefined
+
     this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })
     this.logger = server.logger
   }
 
-  async getState(
-    request: Request | FormRequest | FormRequestPayload
-  ): Promise<FormSubmissionState> {
+  async getState(request: AnyRequest): Promise<FormSubmissionState> {
     const key = this.Key(request)
-
-    let cached = await this.cache.get(key)
-
-    // If nothing in Redis, attempt to rehydrate from backend DB
-    if (!cached && this.customFetcher) {
-      const rehydrated = await this.customFetcher(request)
-
-      if (rehydrated != null) {
-        await this.cache.set(key, rehydrated, config.get('sessionTimeout'))
-        cached = await this.getState(request)
-      }
-    }
+    const cached = await this.cache.get(key)
 
     return cached ?? {}
   }
 
-  async setState(
-    request: FormRequest | FormRequestPayload,
-    state: FormSubmissionState
-  ) {
+  async setState(request: AnyFormRequest, state: FormSubmissionState) {
     const key = this.Key(request)
     const ttl = config.get('sessionTimeout')
 
@@ -94,7 +54,7 @@ export class CacheService {
   }
 
   async getConfirmationState(
-    request: FormRequest | FormRequestPayload
+    request: AnyFormRequest
   ): Promise<{ confirmed?: true }> {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
     const value = await this.cache.get(key)
@@ -103,7 +63,7 @@ export class CacheService {
   }
 
   async setConfirmationState(
-    request: FormRequest | FormRequestPayload,
+    request: AnyFormRequest,
     confirmationState: { confirmed?: true }
   ) {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
@@ -112,14 +72,14 @@ export class CacheService {
     return this.cache.set(key, confirmationState, ttl)
   }
 
-  async clearState(request: FormRequest | FormRequestPayload) {
+  async clearState(request: AnyFormRequest) {
     if (request.yar.id) {
       await this.cache.drop(this.Key(request))
     }
   }
 
   getFlash(
-    request: FormRequest | FormRequestPayload
+    request: AnyFormRequest
   ): { errors: FormSubmissionError[] } | undefined {
     const key = this.Key(request)
     const messages = request.yar.flash(key.id)
@@ -130,7 +90,7 @@ export class CacheService {
   }
 
   setFlash(
-    request: FormRequest | FormRequestPayload,
+    request: AnyFormRequest,
     message: { errors: FormSubmissionError[] }
   ) {
     const key = this.Key(request)
@@ -138,35 +98,24 @@ export class CacheService {
     request.yar.flash(key.id, message)
   }
 
-  private defaultKeyGenerator(
-    request: Request | FormRequest | FormRequestPayload
-  ): string {
-    if (!request.yar.id) {
-      throw new Error('No session ID found')
-    }
-
-    const state = (request.params.state as string) || ''
-    const slug = (request.params.slug as string) || ''
-    return `${request.yar.id}:${state}:${slug}:`
-  }
-
   /**
    * The key used to store user session data against.
    * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`
    * @param request - hapi request object
    * @param additionalIdentifier - appended to the id
    */
-  Key(
-    request: Request | FormRequest | FormRequestPayload,
-    additionalIdentifier?: ADDITIONAL_IDENTIFIER
-  ) {
-    const baseKey = this.generateKey
-      ? this.generateKey(request)
-      : this.defaultKeyGenerator(request)
+  Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {
+    if (!request.yar.id) {
+      throw new Error('No session ID found')
+    }
+
+    const state = (request.params.state as string) || ''
+    const slug = (request.params.slug as string) || ''
+    const key = `${request.yar.id}:${state}:${slug}:`
 
     return {
       segment: partition,
-      id: `${baseKey}${additionalIdentifier ?? ''}`
+      id: `${key}${additionalIdentifier ?? ''}`
     }
   }
 }

package/src/server/types.ts

@@ -4,6 +4,7 @@ import {
   type SubmitPayload,
   type SubmitResponsePayload
 } from '@defra/forms-model'
+import { type Server } from '@hapi/hapi'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
@@ -18,6 +19,7 @@ import {
   type FormRequestPayload,
   type FormStatus
 } from '~/src/server/routes/types.js'
+import { type CacheService } from '~/src/server/services/cacheService.js'
 
 export interface FormsService {
   getFormMetadata: (slug: string) => Promise<FormMetadata>
@@ -49,7 +51,8 @@ export interface RouteConfig {
   controllers?: Record<string, typeof PageController>
   preparePageEventRequestOptions?: PreparePageEventRequestOptions
   onRequest?: OnRequestCallback
-  saveAndReturn?: PluginOptions['saveAndReturn']
+  saveAndExit?: PluginOptions['saveAndExit']
+  cacheServiceCreator?: (server: Server) => CacheService
 }
 
 export interface OutputService {

package/src/typings/hapi/index.d.ts

@@ -5,11 +5,10 @@ import { type ServerYar, type Yar } from '@hapi/yar'
 import { type Logger } from 'pino'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PluginOptions } from '~/src/server/plugins/engine/types.ts'
 import {
-  type FormRequest,
-  type FormRequestPayload
-} from '~/src/server/routes/types.js'
+  type AnyFormRequest,
+  type PluginOptions
+} from '~/src/server/plugins/engine/types.ts'
 import { type CacheService } from '~/src/server/services/index.js'
 
 declare module '@hapi/hapi' {
@@ -17,15 +16,15 @@ declare module '@hapi/hapi' {
   // props from plugins which doesn't export @types
   interface PluginProperties {
     crumb: {
-      generate?: (request: Request | FormRequest | FormRequestPayload) => string
+      generate?: (request: AnyRequest) => string
     }
     'forms-engine-plugin': {
       baseLayoutPath: string
       cacheService: CacheService
       viewContext?: (
-        request: FormRequest | FormRequestPayload | null
+        request: AnyFormRequest | null
       ) => Record<string, unknown> | Promise<Record<string, unknown>>
-      saveAndReturn?: PluginOptions['saveAndReturn']
+      saveAndExit?: PluginOptions['saveAndExit']
     }
   }
 

package/.server/server/plugins/engine/routes/exit.d.ts

@@ -1,46 +0,0 @@
-import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi';
-import Joi from 'joi';
-import { type FormRequest, type FormRequestRefs } from '~/src/server/routes/types.js';
-export declare function getRoutes(getRouteOptions: RouteOptions<FormRequestRefs>): {
-    method: string;
-    path: string;
-    handler: (request: FormRequest, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
-    options: {
-        validate: {
-            params: Joi.ObjectSchema<any>;
-        };
-        auth?: false | string | import("@hapi/hapi").RouteOptionsAccess | undefined;
-        app?: import("@hapi/hapi").RouteOptionsApp | undefined;
-        bind?: object | null | undefined;
-        cache?: false | import("@hapi/hapi").RouteOptionsCache | undefined;
-        compression?: { [P in keyof import("@hapi/hapi").ContentEncoders]?: Parameters<import("@hapi/hapi").ContentEncoders[P]>[0]; } | undefined;
-        cors?: boolean | import("@hapi/hapi").RouteOptionsCors | undefined;
-        description?: string | undefined;
-        ext?: { [key in import("@hapi/hapi").RouteRequestExtType]?: import("@hapi/hapi").RouteExtObject | import("@hapi/hapi").RouteExtObject[] | undefined; } | undefined;
-        files?: {
-            relativeTo: string;
-        } | undefined;
-        handler?: object | import("@hapi/hapi").Lifecycle.Method<FormRequestRefs, import("@hapi/hapi").Lifecycle.ReturnValue<FormRequestRefs>> | undefined;
-        id?: string | undefined;
-        isInternal?: boolean | undefined;
-        json?: import("@hapi/hapi").Json.StringifyArguments | undefined;
-        log?: {
-            collect: boolean;
-        } | undefined;
-        notes?: string | string[] | undefined;
-        payload?: import("@hapi/hapi").RouteOptionsPayload | undefined;
-        plugins?: import("@hapi/hapi").PluginSpecificConfiguration | undefined;
-        pre?: import("@hapi/hapi").RouteOptionsPreArray<FormRequestRefs> | undefined;
-        response?: import("@hapi/hapi").RouteOptionsResponse | undefined;
-        security?: import("@hapi/hapi").RouteOptionsSecure | undefined;
-        state?: {
-            parse?: boolean | undefined;
-            failAction?: import("@hapi/hapi").Lifecycle.FailAction | undefined;
-        } | undefined;
-        tags?: string[] | undefined;
-        timeout?: {
-            server?: boolean | number | undefined;
-            socket?: boolean | number | undefined;
-        } | undefined;
-    };
-}[];

package/.server/server/plugins/engine/routes/exit.js

@@ -1,36 +0,0 @@
-import { slugSchema } from '@defra/forms-model';
-import Boom from '@hapi/boom';
-import Joi from 'joi';
-export function getRoutes(getRouteOptions) {
-  return [{
-    method: 'get',
-    path: '/{slug}/exit',
-    handler: (request, h) => {
-      const {
-        app
-      } = request;
-      const {
-        model
-      } = app;
-      if (!model) {
-        throw Boom.notFound('No model found for exit page');
-      }
-      const returnUrl = request.query.returnUrl;
-      const exitViewModel = {
-        pageTitle: 'Your progress has been saved',
-        phaseTag: model.def.phaseBanner?.phase,
-        returnUrl
-      };
-      return h.view('exit', exitViewModel);
-    },
-    options: {
-      ...getRouteOptions,
-      validate: {
-        params: Joi.object().keys({
-          slug: slugSchema
-        })
-      }
-    }
-  }];
-}
-//# sourceMappingURL=exit.js.map

package/.server/server/plugins/engine/routes/exit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"exit.js","names":["slugSchema","Boom","Joi","getRoutes","getRouteOptions","method","path","handler","request","h","app","model","notFound","returnUrl","query","exitViewModel","pageTitle","phaseTag","def","phaseBanner","phase","view","options","validate","params","object","keys","slug"],"sources":["../../../../../src/server/plugins/engine/routes/exit.ts"],"sourcesContent":["import { slugSchema } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport {\n  type FormRequest,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\n\nexport function getRoutes(getRouteOptions: RouteOptions<FormRequestRefs>) {\n  return [\n    {\n      method: 'get',\n      path: '/{slug}/exit',\n      handler: (\n        request: FormRequest,\n        h: Pick<ResponseToolkit, 'redirect' | 'view'>\n      ) => {\n        const { app } = request\n        const { model } = app\n\n        if (!model) {\n          throw Boom.notFound('No model found for exit page')\n        }\n\n        const returnUrl = request.query.returnUrl\n\n        const exitViewModel = {\n          pageTitle: 'Your progress has been saved',\n          phaseTag: model.def.phaseBanner?.phase,\n          returnUrl\n        }\n\n        return h.view('exit', exitViewModel)\n      },\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema\n          })\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,oBAAoB;AAC/C,OAAOC,IAAI,MAAM,YAAY;AAE7B,OAAOC,GAAG,MAAM,KAAK;AAOrB,OAAO,SAASC,SAASA,CAACC,eAA8C,EAAE;EACxE,OAAO,CACL;IACEC,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,cAAc;IACpBC,OAAO,EAAEA,CACPC,OAAoB,EACpBC,CAA6C,KAC1C;MACH,MAAM;QAAEC;MAAI,CAAC,GAAGF,OAAO;MACvB,MAAM;QAAEG;MAAM,CAAC,GAAGD,GAAG;MAErB,IAAI,CAACC,KAAK,EAAE;QACV,MAAMV,IAAI,CAACW,QAAQ,CAAC,8BAA8B,CAAC;MACrD;MAEA,MAAMC,SAAS,GAAGL,OAAO,CAACM,KAAK,CAACD,SAAS;MAEzC,MAAME,aAAa,GAAG;QACpBC,SAAS,EAAE,8BAA8B;QACzCC,QAAQ,EAAEN,KAAK,CAACO,GAAG,CAACC,WAAW,EAAEC,KAAK;QACtCP;MACF,CAAC;MAED,OAAOJ,CAAC,CAACY,IAAI,CAAC,MAAM,EAAEN,aAAa,CAAC;IACtC,CAAC;IACDO,OAAO,EAAE;MACP,GAAGlB,eAAe;MAClBmB,QAAQ,EAAE;QACRC,MAAM,EAAEtB,GAAG,CAACuB,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE3B;QACR,CAAC;MACH;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}

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

@@ -1,47 +0,0 @@
-import { slugSchema } from '@defra/forms-model'
-import Boom from '@hapi/boom'
-import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'
-import Joi from 'joi'
-
-import {
-  type FormRequest,
-  type FormRequestRefs
-} from '~/src/server/routes/types.js'
-
-export function getRoutes(getRouteOptions: RouteOptions<FormRequestRefs>) {
-  return [
-    {
-      method: 'get',
-      path: '/{slug}/exit',
-      handler: (
-        request: FormRequest,
-        h: Pick<ResponseToolkit, 'redirect' | 'view'>
-      ) => {
-        const { app } = request
-        const { model } = app
-
-        if (!model) {
-          throw Boom.notFound('No model found for exit page')
-        }
-
-        const returnUrl = request.query.returnUrl
-
-        const exitViewModel = {
-          pageTitle: 'Your progress has been saved',
-          phaseTag: model.def.phaseBanner?.phase,
-          returnUrl
-        }
-
-        return h.view('exit', exitViewModel)
-      },
-      options: {
-        ...getRouteOptions,
-        validate: {
-          params: Joi.object().keys({
-            slug: slugSchema
-          })
-        }
-      }
-    }
-  ]
-}