Merge pull request #60 from DEFRA/fix/DF-330-reply-to

Set replyTo for confirmation email

Author: jbarnsley10

README.md

@@ -2,28 +2,32 @@
 
 Core delivery platform Node.js Backend Template.
 
-- [Requirements](#requirements)
-  - [Node.js](#nodejs)
-- [Local development](#local-development)
-  - [Setup](#setup)
-  - [Development](#development)
-  - [Testing](#testing)
-  - [Production](#production)
-  - [Npm scripts](#npm-scripts)
-  - [Update dependencies](#update-dependencies)
-  - [Formatting](#formatting)
-    - [Windows prettier issue](#windows-prettier-issue)
-- [API endpoints](#api-endpoints)
-- [Development helpers](#development-helpers)
-  - [Proxy](#proxy)
-- [Docker](#docker)
-  - [Development image](#development-image)
-  - [Production image](#production-image)
-  - [Docker Compose](#docker-compose)
-  - [Dependabot](#dependabot)
-  - [SonarCloud](#sonarcloud)
-- [Licence](#licence)
-  - [About the licence](#about-the-licence)
+- [forms-notify-listener](#forms-notify-listener)
+  - [Requirements](#requirements)
+    - [Node.js](#nodejs)
+  - [Local development](#local-development)
+    - [Setup](#setup)
+    - [Development](#development)
+    - [Development](#development-1)
+    - [Testing](#testing)
+    - [Production](#production)
+    - [Notes on SQS queue configuration](#notes-on-sqs-queue-configuration)
+      - [Queue configuration in forms-audit-api](#queue-configuration-in-forms-audit-api)
+    - [Npm scripts](#npm-scripts)
+    - [Update dependencies](#update-dependencies)
+    - [Formatting](#formatting)
+      - [Windows prettier issue](#windows-prettier-issue)
+  - [API endpoints](#api-endpoints)
+  - [Development helpers](#development-helpers)
+    - [Proxy](#proxy)
+  - [Docker](#docker)
+    - [Development image](#development-image)
+    - [Production image](#production-image)
+    - [Docker Compose](#docker-compose)
+    - [Dependabot](#dependabot)
+    - [SonarCloud](#sonarcloud)
+  - [Licence](#licence)
+    - [About the licence](#about-the-licence)
 
 ## Requirements
 
@@ -64,6 +68,7 @@ AWS_SECRET_ACCESS_KEY=dummy
 RECEIVE_MESSAGE_TIMEOUT_MS=5000
 NOTIFY_TEMPLATE_ID=3d448938-8a8b-40c2-a3de-414597f976e1
 NOTIFY_API_KEY=[your api key]
+NOTIFY_REPLY_TO_ID=462e5ac0-28f1-4e51-9d8e-8d8c31f59f6a
 RECEIVE_MESSAGE_TIMEOUT_MS=5000
 MANAGER_URL=http://localhost:3001
 DESIGNER_URL=http://localhost:3000

jest.setup.js

@@ -1,4 +1,6 @@
 process.env.MANAGER_URL = 'http://manager'
 process.env.DESIGNER_URL = 'http://designer'
 process.env.NOTIFY_TEMPLATE_ID = '2d48d7f9-32ae-43be-9bf1-8bf5cd7bfc17'
+process.env.NOTIFY_REPLY_TO_ID = '462e5ac0-28f1-4e51-9d8e-8d8c31f59f6a'
 process.env.NOTIFY_API_KEY = 'dummy'
+process.env.NOTIFY_CONFIRMATION_REPLY_TO_ID = 'dummy'

src/config/index.js

@@ -110,16 +110,24 @@ export const config = convict({
    * Email outputs
    * Email outputs will use notify to send an email to a single inbox.
    */
+  /** @type {SchemaObj<string>} */
   notifyTemplateId: {
     format: String,
     default: null,
     env: 'NOTIFY_TEMPLATE_ID'
   },
+  /** @type {SchemaObj<string>} */
   notifyAPIKey: {
     format: String,
     default: null,
     env: 'NOTIFY_API_KEY'
   },
+  /** @type {SchemaObj<string>} */
+  notifyReplyToId: {
+    format: String,
+    default: null,
+    env: 'NOTIFY_REPLY_TO_ID'
+  },
 
   /**
    * API integrations

src/lib/notify.js

@@ -3,8 +3,7 @@ import { token } from '@hapi/jwt'
 import { config } from '~/src/config/index.js'
 import { postJson } from '~/src/lib/fetch.js'
 
-// @ts-expect-error - incorrect typings in convict
-const notifyAPIKey = /** @type {string} */ (config.get('notifyAPIKey'))
+const notifyAPIKey = config.get('notifyAPIKey')
 
 const API_KEY_SUBSTRING_REDUCTION = 36
 const SERVICE_ID_SUBSTRING_REDUCTION = 73
@@ -31,6 +30,7 @@ const serviceId = /** @type {string} */ (
  *   templateId: string
  *   emailAddress: string
  *   personalisation: { subject: string; body: string }
+ *   notifyReplyToId?: string
  * }} SendNotificationArgs
  */
 
@@ -56,13 +56,14 @@ const NOTIFICATIONS_URL = new URL(
  * @returns {Promise<{response: object, body: unknown}>}
  */
 export async function sendNotification(args) {
-  const { templateId, emailAddress, personalisation } = args
+  const { templateId, emailAddress, personalisation, notifyReplyToId } = args
 
   return postJson(NOTIFICATIONS_URL, {
     payload: {
       template_id: templateId,
       email_address: emailAddress,
-      personalisation
+      personalisation,
+      email_reply_to_id: notifyReplyToId
     },
     headers: {
       Authorization: 'Bearer ' + createToken(serviceId, apiKeyId)

src/service/notify.js

@@ -8,8 +8,9 @@ import { sendNotification } from '~/src/lib/notify.js'
 import { getFormatter } from '~/src/service/mappers/formatters/index.js'
 import { getUserConfirmationEmailBody } from '~/src/service/mappers/user-confirmation.js'
 
-// @ts-expect-error - incorrect typings in convict
-const templateId = /** @type {string} */ (config.get('notifyTemplateId'))
+const templateId = config.get('notifyTemplateId')
+
+const notifyReplyToId = config.get('notifyReplyToId')
 
 const logger = createLogger()
 
@@ -168,7 +169,8 @@ export async function sendUserConfirmationEmail(formSubmissionMessage) {
       personalisation: {
         subject,
         body: getUserConfirmationEmailBody(formName, new Date(), metadata)
-      }
+      },
+      notifyReplyToId
     })
 
     logger.info(logTags, 'User confirmation email sent successfully')

src/service/notify.test.js

@@ -42,6 +42,7 @@ jest.mock('~/src/config/index.js', () => ({
   config: {
     get: jest.fn((key) => {
       if (key === 'notifyTemplateId') return 'notify-template-id-1'
+      if (key === 'notifyReplyToId') return 'notify-reply-to-id-1'
       return 'mock-value'
     })
   }
@@ -678,7 +679,8 @@ describe('notify', () => {
         personalisation: {
           subject: 'Form submitted to Defra',
           body: expect.any(String)
-        }
+        },
+        notifyReplyToId: 'notify-reply-to-id-1'
       })
       const sendNotificationBody = JSON.parse(
         Buffer.from(