feat: add an option to have bcc recipient for emails sent through proposal status actions

apps/backend/db_patches/0158_BccRecipientAppSetting.sql

@@ -0,0 +1,13 @@
+DO
+$$
+BEGIN
+  IF register_patch('0158_BccRecipientAppSetting.sql', 'Deepak Jaison', 'BCC Recipient App Setting', '2024-07-17') THEN
+    BEGIN
+
+      INSERT INTO settings(settings_id, description) VALUES ('SMTP_BCC_EMAIL', 'Email address for setting bcc recipient for SMTP mails. E.g. ''bcc1@email.com; bcc2@email.com''');
+
+    END;
+  END IF;
+END;
+$$
+LANGUAGE plpgsql;

apps/backend/src/eventHandlers/MailService/SMTPMailService.spec.ts

@@ -1,11 +1,24 @@
 import * as path from 'path';
 
+import EmailTemplates from 'email-templates';
+import { container } from 'tsyringe';
+
+import { Tokens } from '../../config/Tokens';
+import { AdminDataSource } from '../../datasources/AdminDataSource';
+import { SettingsId } from '../../models/Settings';
 import EmailSettings from './EmailSettings';
 import { SMTPMailService } from './SMTPMailService';
 
 jest.mock('email-templates');
+const mockAdminDataSource = container.resolve(
+  Tokens.AdminDataSource
+) as AdminDataSource;
+
+const mockGetSetting = jest.spyOn(mockAdminDataSource, 'getSetting');
 
 test('Return result should indicate all emails were successfully sent', async () => {
+  mockGetSetting.mockResolvedValue(null);
+
   const options: EmailSettings = {
     content: {
       template_id: path.resolve('src', 'eventHandlers', 'emails', 'submit'),
@@ -36,3 +49,59 @@ test('Return result should indicate all emails were successfully sent', async ()
     },
   });
 });
+
+test('All emails with bcc were successfully sent', async () => {
+  mockGetSetting.mockClear();
+  const emailInfo = jest.spyOn(EmailTemplates.prototype, 'send');
+
+  const bccEmail = 'testmail@test.co';
+
+  const substitutionData = {
+    piPreferredname: 'John',
+    piLastname: 'Doe',
+    proposalNumber: '1',
+    proposalTitle: 'Title',
+    coProposers: ['Jane Doe'],
+    call: '',
+  };
+
+  mockGetSetting.mockImplementation(() =>
+    Promise.resolve({
+      settingsValue: bccEmail,
+      description: 'bcc mail',
+      id: SettingsId.SMTP_BCC_EMAIL,
+    })
+  );
+
+  const options: EmailSettings = {
+    content: {
+      template_id: path.resolve('src', 'eventHandlers', 'emails', 'submit'),
+    },
+    substitution_data: substitutionData,
+    recipients: [
+      {
+        address: 'john.doe@email.com',
+      },
+    ],
+  };
+
+  const smtpMailService: SMTPMailService = new SMTPMailService();
+  const result = await smtpMailService.sendMail(options);
+
+  expect(emailInfo).toHaveBeenCalledWith({
+    template: expect.any(String),
+    message: {
+      to: process.env.SINK_EMAIL,
+      bcc: bccEmail,
+    },
+    locals: substitutionData,
+  });
+
+  return expect(result).toStrictEqual({
+    results: {
+      id: 'test',
+      total_accepted_recipients: 1,
+      total_rejected_recipients: 0,
+    },
+  });
+});

apps/backend/src/eventHandlers/MailService/SMTPMailService.ts

@@ -3,7 +3,11 @@ import path from 'path';
 import { logger } from '@user-office-software/duo-logger';
 import EmailTemplates from 'email-templates';
 import * as nodemailer from 'nodemailer';
+import { container } from 'tsyringe';
 
+import { Tokens } from '../../config/Tokens';
+import { AdminDataSource } from '../../datasources/AdminDataSource';
+import { SettingsId } from '../../models/Settings';
 import { isProduction } from '../../utils/helperFunctions';
 import EmailSettings from './EmailSettings';
 import { MailService, STFCEmailTemplate, SendMailResults } from './MailService';
@@ -72,6 +76,14 @@ export class SMTPMailService extends MailService {
   }
 
   async sendMail(options: EmailSettings): ResultsPromise<SendMailResults> {
+    const adminDataSource = container.resolve<AdminDataSource>(
+      Tokens.AdminDataSource
+    );
+
+    const bccAddress = (
+      await adminDataSource.getSetting(SettingsId.SMTP_BCC_EMAIL)
+    )?.settingsValue;
+
     const emailPromises: Promise<SendMailResults>[] = [];
 
     const sendMailResults: SendMailResults = {
@@ -111,11 +123,13 @@ export class SMTPMailService extends MailService {
                       : <string>process.env.SINK_EMAIL,
                     name: participant.address?.header_to,
                   },
+                  bcc: bccAddress,
                 }
               : {
                   to: isProduction
                     ? participant.address
                     : <string>process.env.SINK_EMAIL,
+                  bcc: bccAddress,
                 }),
           },
           locals: options.substitution_data,

apps/backend/src/models/Settings.ts

@@ -36,4 +36,5 @@ export enum SettingsId {
   IDLE_TIMEOUT = 'IDLE_TIMEOUT',
   GRADE_PRECISION = 'GRADE_PRECISION',
   USER_OFFICE_EMAIL = 'USER_OFFICE_EMAIL',
+  SMTP_BCC_EMAIL = 'SMTP_BCC_EMAIL',
 }