Sends user confirmation email

package.json

@@ -31,8 +31,8 @@
   },
   "dependencies": {
     "@aws-sdk/client-sqs": "3.894.0",
-    "@defra/forms-engine-plugin": "3.0.4",
-    "@defra/forms-model": "3.0.552",
+    "@defra/forms-engine-plugin": "3.0.9",
+    "@defra/forms-model": "3.0.559",
     "@defra/hapi-tracing": "^1.28.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/hapi": "^21.4.2",

src/config/index.js

@@ -127,13 +127,13 @@ export const config = convict({
   designerUrl: {
     doc: 'URL to call Forms Designer',
     format: String,
-    default: null,
+    default: '',
     env: 'DESIGNER_URL'
   },
   managerUrl: {
     doc: 'URL to call Forms Manager API',
     format: String,
-    default: null,
+    default: '',
     env: 'MANAGER_URL'
   },
   isSecureContextEnabled: {

src/lib/manager.js

@@ -12,9 +12,7 @@ const managerUrl = config.get('managerUrl')
  * @returns {Promise<FormDefinition>}
  */
 export async function getFormDefinition(formId, formStatus, versionNumber) {
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (!managerUrl) {
-    //  TS / eslint conflict
     throw new Error('Missing MANAGER_URL')
   }
 
@@ -33,5 +31,22 @@ export async function getFormDefinition(formId, formStatus, versionNumber) {
 }
 
 /**
- * @import { FormDefinition } from '@defra/forms-model'
+ * Gets the form metadata from the Forms Manager API
+ * @param {string} formId
+ * @returns {Promise<FormMetadata>}
+ */
+export async function getFormMetadata(formId) {
+  if (!managerUrl) {
+    throw new Error('Missing MANAGER_URL')
+  }
+
+  const formUrl = new URL(`/forms/${formId}`, managerUrl)
+
+  const { body } = await getJson(formUrl)
+
+  return body
+}
+
+/**
+ * @import { FormDefinition, FormMetadata } from '@defra/forms-model'
  */

src/lib/manager.test.js

@@ -1,111 +1,149 @@
 import { FormStatus } from '@defra/forms-model'
-import { buildDefinition } from '@defra/forms-model/stubs'
+import { buildDefinition, buildMetaData } from '@defra/forms-model/stubs'
 
 import { getJson } from '~/src/lib/fetch.js'
-import { getFormDefinition } from '~/src/lib/manager.js'
+import { getFormDefinition, getFormMetadata } from '~/src/lib/manager.js'
 jest.mock('~/src/lib/fetch.js')
 jest.mock('~/src/config/index.js', () => ({
   config: {
     get: jest.fn().mockReturnValueOnce('http://forms-manager')
   }
 }))
 
-describe('getDefinition', () => {
-  it('should get the current definition if draft', async () => {
-    const expectedDefinition = buildDefinition()
-    const formId = '68a890909ab460290c289409'
-    jest
-      .mocked(getJson)
-      .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
-    const definition = await getFormDefinition(
-      formId,
-      FormStatus.Draft,
-      undefined
-    )
-    expect(getJson).toHaveBeenCalledWith(
-      expect.objectContaining({
-        href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/draft'
-      })
-    )
-    expect(definition).toEqual(expectedDefinition)
-  })
+describe('Manager', () => {
+  describe('getDefinition', () => {
+    it('should get the current definition if draft', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Draft,
+        undefined
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/draft'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
 
-  it('should get the current definition if live', async () => {
-    const expectedDefinition = buildDefinition()
-    const formId = '68a890909ab460290c289409'
-    jest
-      .mocked(getJson)
-      .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
-    const definition = await getFormDefinition(
-      formId,
-      FormStatus.Live,
-      undefined
-    )
-    expect(getJson).toHaveBeenCalledWith(
-      expect.objectContaining({
-        href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/'
-      })
-    )
-    expect(definition).toEqual(expectedDefinition)
-  })
+    it('should get the current definition if live', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Live,
+        undefined
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
 
-  it('should get a specific version if version number is provided', async () => {
-    const expectedDefinition = buildDefinition()
-    const formId = '68a890909ab460290c289409'
-    const versionNumber = 3
-    jest
-      .mocked(getJson)
-      .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
-    const definition = await getFormDefinition(
-      formId,
-      FormStatus.Live,
-      versionNumber
-    )
-    expect(getJson).toHaveBeenCalledWith(
-      expect.objectContaining({
-        href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/3/definition'
-      })
-    )
-    expect(definition).toEqual(expectedDefinition)
-  })
+    it('should get a specific version if version number is provided', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      const versionNumber = 3
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Live,
+        versionNumber
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/3/definition'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
+
+    it('should get a specific version with draft status if version number is provided', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      const versionNumber = 1
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Draft,
+        versionNumber
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/1/definition'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
+
+    it('should handle version number 0 correctly', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      const versionNumber = 0
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Live,
+        versionNumber
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/0/definition'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
 
-  it('should get a specific version with draft status if version number is provided', async () => {
-    const expectedDefinition = buildDefinition()
-    const formId = '68a890909ab460290c289409'
-    const versionNumber = 1
-    jest
-      .mocked(getJson)
-      .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
-    const definition = await getFormDefinition(
-      formId,
-      FormStatus.Draft,
-      versionNumber
-    )
-    expect(getJson).toHaveBeenCalledWith(
-      expect.objectContaining({
-        href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/1/definition'
-      })
-    )
-    expect(definition).toEqual(expectedDefinition)
+    it('should throw if no manager url set', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Draft,
+        undefined
+      )
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/draft'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
   })
 
-  it('should handle version number 0 correctly', async () => {
-    const expectedDefinition = buildDefinition()
-    const formId = '68a890909ab460290c289409'
-    const versionNumber = 0
-    jest
-      .mocked(getJson)
-      .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
-    const definition = await getFormDefinition(
-      formId,
-      FormStatus.Live,
-      versionNumber
-    )
-    expect(getJson).toHaveBeenCalledWith(
-      expect.objectContaining({
-        href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/0/definition'
-      })
-    )
-    expect(definition).toEqual(expectedDefinition)
+  describe('getMetadata', () => {
+    it('should get the metadata', async () => {
+      const expectedMetadata = buildMetaData()
+      const formId = '68a890909ab460290c289409'
+      jest
+        .mocked(getJson)
+        .mockResolvedValueOnce({ response: {}, body: expectedMetadata })
+      const metadata = await getFormMetadata(formId)
+      expect(getJson).toHaveBeenCalledWith(
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409'
+        })
+      )
+      expect(metadata).toEqual(expectedMetadata)
+    })
   })
 })

src/service/index.js

@@ -1,13 +1,13 @@
 import { handleFormSubmissionEvents } from '~/src/service/events.js'
-import { sendNotifyEmail } from '~/src/service/notify.js'
+import { sendNotifyEmails } from '~/src/service/notify.js'
 
 /**
  * @param {Message[]} messages
  * @returns {Promise<{saved: FormAdapterSubmissionMessage[]; failed: any[]}>}
  */
 export async function handleEvent(messages) {
   const service = {
-    handleFormSubmission: sendNotifyEmail
+    handleFormSubmission: sendNotifyEmails
   }
   return handleFormSubmissionEvents(messages, service)
 }