feat: add configurable decorator to email substitution data

apps/backend/src/config/Tokens.ts

@@ -27,6 +27,9 @@ export const Tokens = {
   ),
   PostToMessageQueue: Symbol('PostToMessageQueue'),
   ProposalDataSource: Symbol('ProposalDataSource'),
+  ProposalEmailActionSubstitutionDataDecorator: Symbol(
+    'ProposalEmailActionSubstitutionDataDecorator'
+  ),
   ProposalEsiDataSource: Symbol('ProposalEsiDataSource'),
   ProposalSettingsDataSource: Symbol('ProposalSettingsDataSource'),
   StatusActionsDataSource: Symbol('StatusActionsDataSource'),

apps/backend/src/config/dependencyConfigDLS.ts

@@ -48,6 +48,7 @@ import PostgresVisitDataSource from '../datasources/postgres/VisitDataSource';
 import PostgresVisitRegistrationClaimDataSource from '../datasources/postgres/VisitRegistrationClaimDataSource';
 import PostgresWorkflowDataSource from '../datasources/postgres/WorkflowDataSource';
 import { DLSEmailHandler } from '../eventHandlers/email/DLS/DLSEmailHandler';
+import { decorateDLSProposalEmailActionSubstitutionData } from '../eventHandlers/email/DLS/DLSProposalEmailActionSubstitutionDataDecorator';
 import createLoggingHandler from '../eventHandlers/logging';
 import { SMTPMailService } from '../eventHandlers/MailService/SMTP/SMTPMailService';
 import {
@@ -87,6 +88,10 @@ mapClass(
   PostgresExperimentSafetyPdfTemplateDataSource
 );
 mapClass(Tokens.ProposalDataSource, PostgresProposalDataSource);
+mapValue(
+  Tokens.ProposalEmailActionSubstitutionDataDecorator,
+  decorateDLSProposalEmailActionSubstitutionData
+);
 mapClass(
   Tokens.ProposalInternalCommentsDataSource,
   PostgresProposalInternalCommentsDataSource

apps/backend/src/eventHandlers/email/DLS/DLSProposalEmailActionSubstitutionDataDecorator.ts

@@ -0,0 +1,27 @@
+import { container } from 'tsyringe';
+
+import { Tokens } from '../../../config/Tokens';
+import { CallDataSource } from '../../../datasources/CallDataSource';
+import { EmailReadyType } from '../../workflowEntities/proposal/utils';
+import { EmailTemplateId } from '../emailTemplateId';
+
+export const decorateDLSProposalEmailActionSubstitutionData = async (
+  emailTemplateName: string,
+  recipientWithData: EmailReadyType
+): Promise<Record<string, unknown>> => {
+  if (emailTemplateName !== EmailTemplateId.ACCEPTED_PROPOSAL) {
+    return {};
+  }
+
+  const callDataSource = container.resolve<CallDataSource>(
+    Tokens.CallDataSource
+  );
+  const proposalContexts = await Promise.all(
+    recipientWithData.proposals.map(async (proposal) => ({
+      proposal,
+      call: await callDataSource.getCall(proposal.callId),
+    }))
+  );
+
+  return { proposalContexts };
+};

apps/backend/src/eventHandlers/workflowEntities/proposal/emailActionHandler.ts

@@ -91,6 +91,7 @@ export const emailStatusActionRecipient = async (
 ) => {
   const proposalPks = proposals.map((proposal) => proposal.primaryKey);
   const emailTemplateId = recipientWithTemplate.emailTemplate.id;
+  const emailTemplateName = recipientWithTemplate.emailTemplate.name;
   const successfulMessage = statusActionsLogId
     ? 'Email successfully sent on status action replay'
     : 'Email successfully sent';
@@ -116,6 +117,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -141,6 +143,7 @@ export const emailStatusActionRecipient = async (
           successfulMessage,
           failMessage,
           emailTemplateId,
+          emailTemplateName,
           loggedInUserId
         ));
 
@@ -165,6 +168,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -189,6 +193,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -214,6 +219,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -289,6 +295,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -314,6 +321,7 @@ export const emailStatusActionRecipient = async (
         successfulMessage,
         failMessage,
         emailTemplateId,
+        emailTemplateName,
         loggedInUserId
       );
 
@@ -347,6 +355,7 @@ export const emailStatusActionRecipient = async (
           successfulMessage,
           failMessage,
           emailTemplateId,
+          emailTemplateName,
           loggedInUserId
         );
       }
@@ -367,6 +376,7 @@ const sendMail = async (
   successfulMessage: string,
   failMessage: string,
   emailTemplateId: string,
+  emailTemplateName: string,
   loggedInUserId?: number | null
 ) => {
   const mailService = container.resolve<MailService>(Tokens.MailService);
@@ -389,23 +399,48 @@ const sendMail = async (
     const mailServiceResponse = await Promise.all(
       recipientsWithData.map(async (recipientWithData) => {
         try {
+          const defaultSubstitutionData = {
+            proposals: recipientWithData.proposals,
+            pi: recipientWithData.pi,
+            coProposers: recipientWithData.coProposers,
+            instruments: recipientWithData.instruments,
+            firstName: recipientWithData.firstName,
+            lastName: recipientWithData.lastName,
+            preferredName: recipientWithData.preferredName,
+            techniques: recipientWithData.techniques,
+            proposalTemplate: recipientWithData.proposalTemplate,
+            samples: recipientWithData.samples,
+            hazards: recipientWithData.hazards,
+          };
+          let additionalSubstitutionData: Record<string, unknown> = {};
+
+          if (
+            container.isRegistered(
+              Tokens.ProposalEmailActionSubstitutionDataDecorator
+            )
+          ) {
+            const decorateSubstitutionData = container.resolve<
+              (
+                emailTemplateName: string,
+                recipientWithData: EmailReadyType
+              ) => Promise<Record<string, unknown>>
+            >(Tokens.ProposalEmailActionSubstitutionDataDecorator);
+            additionalSubstitutionData = await decorateSubstitutionData(
+              emailTemplateName,
+              recipientWithData
+            );
+          }
+
+          const substitutionData = {
+            ...defaultSubstitutionData,
+            ...additionalSubstitutionData,
+          };
+
           const res = await mailService.sendMail({
             content: {
               template: emailTemplateId,
             },
-            substitution_data: {
-              proposals: recipientWithData.proposals,
-              pi: recipientWithData.pi,
-              coProposers: recipientWithData.coProposers,
-              instruments: recipientWithData.instruments,
-              firstName: recipientWithData.firstName,
-              lastName: recipientWithData.lastName,
-              preferredName: recipientWithData.preferredName,
-              techniques: recipientWithData.techniques,
-              proposalTemplate: recipientWithData.proposalTemplate,
-              samples: recipientWithData.samples,
-              hazards: recipientWithData.hazards,
-            },
+            substitution_data: substitutionData,
             recipients: [{ address: recipientWithData.email }],
           });
           logger.logInfo('Email sent:', {