feat/DF-607: Handles partial page when clicking 'Save and exit' (#1031)

* Handles partial page when clicking 'Save and exit'

* Extra coverage

* Updated plugin version

* Saves path and invalid state

* Fixed test

* Change of property name

* Saves URL at point of saving payload to flash

* Removed fallback '/'

* Bypass save if not path stored

* Stash

* Extra coverage
Extracted method to new file for easy mock

* Lint fix

Author: jbarnsley10

package-lock.json

@@ -41,7 +41,7 @@
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
     "@aws-sdk/client-sns": "^3.965.0",
-    "@defra/forms-engine-plugin": "^4.0.34",
+    "@defra/forms-engine-plugin": "^4.0.35",
     "@defra/forms-model": "^3.0.601",
     "@defra/hapi-tracing": "^1.30.0",
     "@elastic/ecs-pino-format": "^1.5.0",

package.json

@@ -1,3 +1,4 @@
 export const PREVIEW_PATH_PREFIX = '/preview'
 export const ERROR_PREVIEW_PATH_PREFIX = '/error-preview'
 export const FORM_PREFIX = '/form'
+export const SAVE_AND_EXIT_PAYLOAD = 'SAVE_AND_EXIT_PAYLOAD'

src/server/constants.js

@@ -3,7 +3,7 @@ import { type Server } from '@hapi/hapi'
 import { StatusCodes } from 'http-status-codes'
 
 import { FORM_PREFIX } from '~/src/server/constants.js'
-import { createServer } from '~/src/server/index.js'
+import { configureEnginePlugin, createServer } from '~/src/server/index.js'
 import {
   getFormDefinition,
   getFormMetadata
@@ -488,4 +488,36 @@ describe('Model cache', () => {
       expect(res.statusCode).toBe(StatusCodes.OK)
     })
   })
+
+  describe('configureEnginePlugin', () => {
+    const mockFlash = jest.fn()
+    const mockYar = {
+      flash: mockFlash
+    }
+    const mockRequest = /** @type {any} */ {
+      params: {
+        slug: 'test-form'
+      },
+      yar: mockYar,
+      url: {
+        pathname: '/my-path'
+      }
+    }
+    const mockH = {
+      redirect: jest.fn()
+    }
+    test('should handle save and exit', async () => {
+      const [pluginObject] = await configureEnginePlugin({})
+      expect(pluginObject).toBeDefined()
+      const saveAndExitFunc = pluginObject.options.saveAndExit
+      expect(saveAndExitFunc).toBeDefined()
+      saveAndExitFunc(mockRequest, mockH, undefined)
+      expect(mockFlash).toHaveBeenCalledWith(
+        'SAVE_AND_EXIT_PAYLOAD',
+        { action: undefined, crumb: undefined, __currentPagePath: '/my-path' },
+        true
+      )
+      expect(mockH.redirect).toHaveBeenCalledWith('/save-and-exit/test-form')
+    })
+  })
 })

src/server/index.test.ts

@@ -1,6 +1,6 @@
 import { join, parse } from 'path'
 
-import plugin from '@defra/forms-engine-plugin'
+import plugin, { CURRENT_PAGE_PATH_KEY } from '@defra/forms-engine-plugin'
 import { checkFormStatus } from '@defra/forms-engine-plugin/engine/helpers.js'
 import { FormModel } from '@defra/forms-engine-plugin/engine/models/FormModel.js'
 import { formSubmissionService } from '@defra/forms-engine-plugin/services/index.js'
@@ -29,7 +29,7 @@ import forwardLogs from '~/src/server/common/helpers/logging/forward-logs.js'
 import { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'
 import { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'
 import { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'
-import { FORM_PREFIX } from '~/src/server/constants.js'
+import { FORM_PREFIX, SAVE_AND_EXIT_PAYLOAD } from '~/src/server/constants.js'
 import { FeedbackPageController } from '~/src/server/plugins/FeedbackPageController.js'
 import { SummaryPageWithConfirmationEmailController } from '~/src/server/plugins/SummaryPageWithConfirmationEmailController.js'
 import { configureBlankiePlugin } from '~/src/server/plugins/blankie.js'
@@ -159,10 +159,21 @@ export const configureEnginePlugin = async ({
         h: FormResponseToolkit,
         _context: FormContext
       ) => {
-        const { params } = request
+        const { params, yar } = request
         const { slug } = params
         const { isPreview, state } = checkFormStatus(params)
 
+        // Payload from current page without crumb and action
+        // (in case current page is not saved to state yet i.e. only partially completed)
+        const pagePayload = {
+          ...request.payload,
+          crumb: undefined,
+          action: undefined,
+          [CURRENT_PAGE_PATH_KEY]: request.url.pathname
+        }
+
+        yar.flash(SAVE_AND_EXIT_PAYLOAD, pagePayload, true)
+
         return h.redirect(
           !isPreview
             ? `/save-and-exit/${slug}`

src/server/index.ts

@@ -0,0 +1,14 @@
+import { SAVE_AND_EXIT_PAYLOAD } from '~/src/server/constants.js'
+
+/**
+ * Get Save and Exit payload - extracted here to a separate file so it can easily be mocked
+ * @param {Request<{ Params: SaveAndExitParams }>} request
+ */
+export function getPayloadFromFlash(request) {
+  return request.yar.flash(SAVE_AND_EXIT_PAYLOAD)
+}
+
+/**
+ * @import { Request } from '@hapi/hapi'
+ * @import { SaveAndExitParams } from '~/src/server/models/save-and-exit.js'
+ */