@defra/forms-engine-plugin 3.0.3 → 3.0.5

package/src/server/plugins/engine/outputFormatters/adapter/v1.ts

@@ -6,7 +6,7 @@ import {
 import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
-import { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
+import { categoriseData } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
 import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
 import {
   type FormAdapterSubmissionMessageData,
@@ -25,20 +25,9 @@ export function format(
   formStatus: ReturnType<typeof checkFormStatus>,
   formMetadata?: FormMetadata
 ): string {
-  const v2DataString = machineV2(
-    context,
-    items,
-    model,
-    submitResponse,
-    formStatus
-  )
-  const v2DataParsed = JSON.parse(v2DataString) as {
-    data: FormAdapterSubmissionMessageData
-  }
-
   const csvFiles = extractCsvFiles(submitResponse)
 
-  const transformedData = v2DataParsed.data
+  const { main: v2Main, ...v2Data } = categoriseData(items)
 
   const versionMetadata = getVersionMetadata(
     context.submittedVersionNumber,
@@ -60,7 +49,21 @@ export function format(
   if (versionMetadata) {
     meta.versionMetadata = versionMetadata
   }
-  const data: FormAdapterSubmissionMessageData = transformedData
+
+  const main = Object.fromEntries(
+    Object.entries(v2Main).map(([key, value]) => {
+      if (value === undefined) {
+        return [key, null]
+      }
+
+      return [key, value]
+    })
+  )
+
+  const data: FormAdapterSubmissionMessageData = {
+    main,
+    ...v2Data
+  }
 
   const result: FormAdapterSubmissionMessageResult = {
     files: csvFiles

package/src/server/plugins/engine/outputFormatters/machine/v2.test.ts

@@ -9,6 +9,10 @@ import {
   type DetailItemRepeat
 } from '~/src/server/plugins/engine/models/types.js'
 import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
+import {
+  SummaryPageController,
+  getFormSubmissionData
+} from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
 import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
 import {
   FileStatus,
@@ -267,4 +271,41 @@ describe('getPersonalisation', () => {
     expect(parsedBody.meta.referenceNumber).toBe('foobar')
     expect(parsedBody.data).toEqual(expectedData)
   })
+
+  it('should return the machine output 2', () => {
+    const pageDef = definition.pages[2]
+    const controller = new SummaryPageController(model, pageDef)
+
+    const summaryViewModel = controller.getSummaryViewModel(request, context)
+
+    const items = getFormSubmissionData(
+      summaryViewModel.context,
+      summaryViewModel.details
+    )
+
+    const body = format(context, items, model, submitResponse, formStatus)
+
+    const parsedBody = JSON.parse(body)
+
+    const expectedData = {
+      main: {
+        orderType: 'delivery'
+      },
+      repeaters: {
+        pizza: [
+          {
+            quantity: 2,
+            toppings: 'Ham'
+          },
+          {
+            quantity: 1,
+            toppings: 'Pepperoni'
+          }
+        ]
+      },
+      files: {}
+    }
+
+    expect(parsedBody.data).toEqual(expectedData)
+  })
 })

package/src/server/plugins/engine/outputFormatters/machine/v2.ts

@@ -74,7 +74,7 @@ export function format(
  *    }
  * }
  */
-function categoriseData(items: DetailItem[]) {
+export function categoriseData(items: DetailItem[]) {
   const output: {
     main: Record<string, RichFormValue>
     repeaters: Record<string, Record<string, RichFormValue>[]>

package/src/server/plugins/engine/pageControllers/FileUploadPageController.ts

@@ -326,11 +326,11 @@ export class FileUploadPageController extends QuestionPageController {
       // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)
       // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.
       if (depth >= 5) {
-        const error = new Error(
+        const err = new Error(
           `Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`
         )
         request.logger.error(
-          error,
+          err,
           `[uploadTimeout] Exceeded cumulative retry delay for uploadId: ${uploadId} at depth: ${depth} - re-initiating new upload`
         )
         await this.initiateAndStoreNewUpload(request, state)

package/src/server/plugins/engine/routes/file-upload.ts

@@ -23,11 +23,10 @@ export async function getHandler(
     }
 
     return h.response(status)
-  } catch (error) {
-    const errMsg = getErrorMessage(error)
+  } catch (err) {
     request.logger.error(
-      errMsg,
-      `[uploadStatusFailed] Upload status check failed for uploadId: ${uploadId} - ${errMsg}`
+      err,
+      `[uploadStatusFailed] Upload status check failed for uploadId: ${uploadId} - ${getErrorMessage(err)}`
     )
     return h.response({ error: 'Status check error' }).code(500)
   }

package/src/server/plugins/engine/services/notifyService.test.ts

@@ -301,7 +301,7 @@ describe('notifyService', () => {
     ).rejects.toThrow('Notification service unavailable')
 
     expect(mockRequest.logger.error).toHaveBeenCalledWith(
-      'Notification service unavailable',
+      new Error('Notification service unavailable'),
       expect.stringContaining(
         '[emailSendFailed] Error sending notification email'
       )

package/src/server/plugins/engine/services/notifyService.ts

@@ -79,10 +79,9 @@ export async function submit(
 
     request.logger.info(logTags, 'Email sent successfully')
   } catch (err) {
-    const errMsg = getErrorMessage(err)
     request.logger.error(
-      errMsg,
-      `[emailSendFailed] Error sending notification email - templateId: ${templateId} - recipient: ${emailAddress} - ${errMsg}`
+      err,
+      `[emailSendFailed] Error sending notification email - templateId: ${templateId} - recipient: ${emailAddress} - ${getErrorMessage(err)}`
     )
 
     throw err

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

@@ -446,7 +446,7 @@ export type RichFormValue =
   | UkAddressState
 
 export interface FormAdapterSubmissionMessageData {
-  main: Record<string, RichFormValue>
+  main: Record<string, RichFormValue | null>
   repeaters: Record<string, Record<string, RichFormValue>[]>
   files: Record<string, FormAdapterFile[]>
 }

package/src/server/plugins/errorPages.ts

@@ -19,18 +19,18 @@ export default {
           // processing the request
           const statusCode = response.output.statusCode
 
-          const error = {
+          const err = {
             statusCode,
             message: response.message,
             stack: response.stack
           }
 
           request.logger.error(
-            error,
+            err,
             `[httpError] HTTP ${statusCode} error occurred - ${response.message} - path: ${request.path} - method: ${request.method}`
           )
 
-          return h.response(error).code(statusCode)
+          return h.response(err).code(statusCode)
         }
 
         return h.continue