Merge pull request #56 from DEFRA/fix/DF-330-missing-guidance

Uses placeholder text if submission guidance is not yet defined

Author: jbarnsley10

src/service/mappers/user-confirmation.js

@@ -2,6 +2,9 @@ import { escapeMarkdown } from '@defra/forms-engine-plugin/engine/components/hel
 
 import { format as dateFormat } from '~/src/helpers/date.js'
 
+const submisionGuidancePlaceholder =
+  "Define this text in the 'What happens next' section of the form overview"
+
 /**
  * @param {string} formName
  * @param {Date} submissionDate
@@ -30,7 +33,7 @@ export function getUserConfirmationEmailBody(
 We received your form submission for ‘${formName}’ on ${formattedSubmissionDate}.
 
 ## What happens next
-${submissionGuidance}
+${submissionGuidance ?? submisionGuidancePlaceholder}
 
 ## Get help
 ${contactDetails}Do not reply to this emall. We do not monitor reples to this email address.

src/service/mappers/user-confirmation.test.js

@@ -22,6 +22,28 @@ Some submission guidance
 ## Get help
 Do not reply to this emall. We do not monitor reples to this email address.
 
+From Defra
+`
+    )
+  })
+
+  test('should handle missing submission guidance', () => {
+    const formName = 'My Form Name'
+    const submissionDate = new Date('2025-11-04T14:21:35+00:00')
+    const metadata = buildMetaData()
+    expect(
+      getUserConfirmationEmailBody(formName, submissionDate, metadata)
+    ).toBe(
+      `
+# We have your form
+We received your form submission for ‘My Form Name’ on 2:21pm on Tuesday 4 November 2025.
+
+## What happens next
+Define this text in the 'What happens next' section of the form overview
+
+## Get help
+Do not reply to this emall. We do not monitor reples to this email address.
+
 From Defra
 `
     )

src/service/notify.js

@@ -160,10 +160,6 @@ export async function sendUserConfirmationEmail(formSubmissionMessage) {
 
   logger.info(logTags, 'Sending user confirmation email')
 
-  if (!metadata.submissionGuidance) {
-    throw new Error(`Missing submission guidance for form id ${formId}`)
-  }
-
   try {
     // Send confirmation email
     await sendNotification({

src/service/notify.test.js

@@ -698,26 +698,6 @@ describe('notify', () => {
       })
     })
 
-    it('should throw if confirmation email has no submission guidance set', async () => {
-      jest.mocked(getFormDefinition).mockResolvedValueOnce(baseDefinition)
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(
-        buildMetaData({
-          submissionGuidance: undefined
-        })
-      )
-      const formAdapterMessageWithUserEmail = structuredClone(
-        formAdapterSubmissionMessage
-      )
-      formAdapterMessageWithUserEmail.meta.custom = {
-        userConfirmationEmail: 'my-email@test.com'
-      }
-      await expect(() =>
-        sendNotifyEmails(formAdapterMessageWithUserEmail)
-      ).rejects.toThrow(
-        'Missing submission guidance for form id 68a8b0449ab460290c28940a'
-      )
-    })
-
     it('confirmation email should handle and throw errors', async () => {
       const err = new Error('Upstream failure')
       jest.mocked(getFormDefinition).mockResolvedValueOnce(baseDefinition)