feat: add configurable email templates

.github/workflows/test-build.yml

@@ -412,6 +412,7 @@ jobs:
           EMAIL_AUTH_HOST: exchsmtp.stfc.ac.uk
           EMAIL_TEMPLATE_PATH: /config/emails/
           EMAIL_FOOTER_IMAGE_PATH: /config/logos/STFC-Logo-small.png
+          SKIP_SMTP_EMAIL_SENDING: true
           EXTERNAL_AUTH_LOGIN_URL: http://localhost:9003/auth/Login.aspx
           EXTERNAL_AUTH_LOGOUT_URL: http://localhost:9003/auth/Login.aspx
           EXTERNAL_UOWS_API_URL: http://localhost:1080/users-service

apps/backend/db_patches/0202_CreateEmailTemplatesTable.sql

@@ -0,0 +1,100 @@
+DO
+$$
+DECLARE 
+      email_template_id_var int;
+      connection_loop_var record;
+      array_size_var int;
+      array_loop_var int;
+      template_name varchar(200);
+BEGIN
+	IF register_patch('CreateEmailTemplatesTable.sql', 'Gergely Nyiri', 'Create email templates table', '2025-07-15') THEN
+
+            CREATE TABLE IF NOT EXISTS email_templates (
+                  email_template_id serial PRIMARY KEY,
+                  created_by INT NOT NULL REFERENCES users(user_id),
+                  created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+                  name varchar(100) NOT NULL UNIQUE,
+                  description varchar(255) NOT NULL, 
+                  subject varchar(160) NOT NULL, 
+                  body text
+            ); 
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'CLF PI Co-I Submission Email', 'CLF PI Co-I Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS PI Co-I Submission Email', 'ISIS PI Co-I Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Rapid PI Co-I Submission Email', 'ISIS Rapid PI Co-I Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Rapid User Office Submission Email', 'ISIS Rapid User Office Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress PI Co-I Submission Email', 'ISIS Xpress PI Co-I Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress Scientist Submission Email', 'ISIS Xpress Scientist Submission Email', '= `Proposal submitted`', 'Proposal submitted');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress PI Co-I Under Review Email', 'ISIS Xpress PI Co-I Under Review Email', '= `Proposal under review`', 'Proposal under review');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress PI Co-I Approval Email', 'ISIS Xpress PI Co-I Approval Email', '= `Proposal approved`', 'Proposal approved');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress SRA Request Email', 'ISIS Xpress SRA Request Email', '= `Proposal SRA request`', 'Proposal SRA request');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress PI Co-I Reject Email', 'ISIS Xpress PI Co-I Reject Email', '= `Proposal unsuccessful`', 'Proposal unsuccessful');
+
+            INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'ISIS Xpress PI Co-I Finish Email', 'ISIS Xpress PI Co-I Finish Email', '= `Proposal finished`', 'Proposal finished');
+
+            FOR connection_loop_var IN
+                  SELECT * FROM workflow_connection_has_actions
+            LOOP
+                  IF connection_loop_var.config IS NOT NULL THEN
+                        SELECT jsonb_array_length(connection_loop_var.config->'recipientsWithEmailTemplate') INTO array_size_var;
+
+                        IF array_size_var IS NULL THEN
+                              array_size_var := 0;
+                        END IF;
+
+                        FOR array_loop_var IN 0..array_size_var-1 LOOP
+                              SELECT connection_loop_var.config->'recipientsWithEmailTemplate'->array_loop_var->'emailTemplate'->>'name' INTO template_name;
+
+                              IF template_name IS NOT NULL THEN
+                                    -- RAISE NOTICE 'Processing connection % % with template % to %', array_loop_var, connection_loop_var.connection_id, template_name,  update_config;
+
+                                    SELECT email_templates.email_template_id INTO email_template_id_var FROM email_templates WHERE name = template_name;
+
+                                    IF email_template_id_var IS NOT NULL THEN
+                                          UPDATE workflow_connection_has_actions 
+                                          SET config = jsonb_set(config::jsonb, ('{recipientsWithEmailTemplate, ' || array_loop_var || ', emailTemplate, id}')::text[], to_jsonb(email_template_id_var), false)
+                                          WHERE connection_id = connection_loop_var.connection_id;
+                                    -- ELSE
+                                    --       RAISE WARNING 'No email template found for name %', template_name;
+                                    END IF;
+                              -- ELSE
+                              --       RAISE WARNING 'No email template found for connection %', template_name;
+                              END IF;
+                        END LOOP;
+                  END IF;
+            END LOOP;
+      END IF;
+END;
+$$
+LANGUAGE plpgsql;

apps/backend/db_patches/db_seeds/0007_EmailTemplates.sql

@@ -0,0 +1,15 @@
+DO
+$DO$
+BEGIN
+
+    INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'template-name-1', 'template-description-1', 'template-subject-1', 'template-body-1');
+
+    INSERT INTO email_templates (created_by, name, description, subject, body)
+            VALUES
+                  (0, 'template-name-2', 'template-description-2', 'template-subject-2', 'template-body-2');            
+
+END;
+$DO$
+LANGUAGE plpgsql;

apps/backend/package.json

@@ -92,6 +92,7 @@
     "@types/content-disposition": "^0.5.4",
     "@types/cors": "^2.8.13",
     "@types/cron": "^1.7.3",
+    "@types/ejs": "^3.1.5",
     "@types/email-templates": "^8.0.4",
     "@types/express": "^4.17.13",
     "@types/express-jwt": "^6.0.4",
@@ -104,6 +105,7 @@
     "@types/node": "^22.13.10",
     "@types/pg": "^8.11.5",
     "@types/pg-large-object": "^2.0.7",
+    "@types/pug": "^2.0.10",
     "@types/sanitize-html": "^2.6.2",
     "@types/simple-oauth2": "^4.1.1",
     "@types/sinon": "^9.0.11",
@@ -129,4 +131,4 @@
     "npm": ">=10.9.2",
     "node": ">=22.0.0"
   }
-}
+}

apps/backend/src/asyncJobs/jobs/checkInviteReminderJob.spec.ts

@@ -1,10 +1,10 @@
-import 'reflect-metadata';
 import { faker } from '@faker-js/faker';
+import 'reflect-metadata';
 import sinon from 'sinon';
 import { container } from 'tsyringe';
 
 import { Tokens } from '../../config/Tokens';
-import { EmailTemplateId } from '../../eventHandlers/email/essEmailHandler';
+import { EmailTemplateId } from '../../eventHandlers/email/emailTemplateId';
 import { Invite } from '../../models/Invite';
 import { RoleClaim } from '../../models/RoleClaim';
 import { SettingsId } from '../../models/Settings';

apps/backend/src/asyncJobs/jobs/checkInviteReminderJob.ts

@@ -124,7 +124,7 @@ const checkInviteReminder = async () => {
       try {
         await mailService.sendMail({
           content: {
-            template_id: templateId,
+            template: templateId,
           },
           substitution_data: {
             email: invite.email,

apps/backend/src/buildContext.ts

@@ -7,6 +7,7 @@ import PDFServices from './middlewares/factory/factoryServices';
 import AdminMutations from './mutations/AdminMutations';
 import CallMutations from './mutations/CallMutations';
 import DataAccessUsersMutations from './mutations/DataAccessUsersMutations';
+import EmailTemplateMutations from './mutations/EmailTemplateMutations';
 import ExperimentMutations from './mutations/ExperimentMutation';
 import ExperimentSafetyPdfTemplateMutations from './mutations/ExperimentSafetyPdfTemplateMutations';
 import FapMutations from './mutations/FapMutations';
@@ -36,6 +37,7 @@ import WorkflowMutations from './mutations/WorkflowMutations';
 import AdminQueries from './queries/AdminQueries';
 import CallQueries from './queries/CallQueries';
 import DataAccessUsersQueries from './queries/DataAccessUsersQueries';
+import EmailTemplateQueries from './queries/EmailTemplateQueries';
 import EventLogQueries from './queries/EventLogQueries';
 import ExperimentQueries from './queries/ExperimentQueries';
 import ExperimentSafetyPdfTemplateQueries from './queries/ExperimentSafetyPdfTemplateQueries';
@@ -104,6 +106,7 @@ const context: BasicResolverContext = {
     settings: container.resolve(SettingsQueries),
     tag: container.resolve(TagQueries),
     experiment: container.resolve(ExperimentQueries),
+    emailTemplate: container.resolve(EmailTemplateQueries),
   },
   mutations: {
     admin: container.resolve(AdminMutations),
@@ -137,6 +140,7 @@ const context: BasicResolverContext = {
     workflow: container.resolve(WorkflowMutations),
     tag: container.resolve(TagMutations),
     experiment: container.resolve(ExperimentMutations),
+    emailTemplate: container.resolve(EmailTemplateMutations),
   },
   clients: {
     scheduler: async () => {

apps/backend/src/config/Tokens.ts

@@ -9,6 +9,7 @@ export const Tokens = {
   DataAccessUsersDataSource: Symbol('DataAccessUsersDataSource'),
   DataAccessUsersAuthorization: Symbol('DataAccessUsersAuthorization'),
   EmailEventHandler: Symbol('EmailEventHandler'),
+  EmailTemplateDataSource: Symbol('EmailTemplateDataSource'),
   EventBus: Symbol('EventBus'),
   EventLogsDataSource: Symbol('EventLogsDataSource'),
   FeedbackDataSource: Symbol('FeedbackDataSource'),

apps/backend/src/config/dependencyConfigDefault.ts

@@ -14,6 +14,7 @@ import { PostgresAdminDataSourceWithAutoUpgrade } from '../datasources/postgres/
 import PostgresCallDataSource from '../datasources/postgres/CallDataSource';
 import PostgresCoProposerClaimDataSource from '../datasources/postgres/CoProposerClaimDataSource';
 import PostgresDataAccessUsersDataSource from '../datasources/postgres/DataAccessUsersDataSource';
+import PostgresEmailTemplateDataSource from '../datasources/postgres/EmailTemplateDataSource';
 import PostgresEventLogsDataSource from '../datasources/postgres/EventLogsDataSource';
 import PostgresExperimentDataSource from '../datasources/postgres/ExperimentDataSource';
 import PostgresExperimentSafetyPdfTemplateDataSource from '../datasources/postgres/ExperimentSafetyPdfTemplateDataSource';
@@ -124,6 +125,7 @@ mapClass(Tokens.WorkflowDataSource, PostgresWorkflowDataSource);
 mapClass(Tokens.StatusDataSource, PostgresStatusDataSource);
 mapClass(Tokens.ExperimentDataSource, PostgresExperimentDataSource);
 mapClass(Tokens.TagDataSource, PostgresTagDataSource);
+mapClass(Tokens.EmailTemplateDataSource, PostgresEmailTemplateDataSource);
 
 mapClass(Tokens.UserAuthorization, OAuthAuthorization);
 mapClass(Tokens.ProposalAuthorization, ProposalAuthorization);

apps/backend/src/config/dependencyConfigE2E.ts

@@ -10,6 +10,7 @@ import PostgresAdminDataSource from '../datasources/postgres/AdminDataSource';
 import PostgresCallDataSource from '../datasources/postgres/CallDataSource';
 import PostgresCoProposerClaimDataSource from '../datasources/postgres/CoProposerClaimDataSource';
 import PostgresDataAccessUsersDataSource from '../datasources/postgres/DataAccessUsersDataSource';
+import PostgresEmailTemplateDataSource from '../datasources/postgres/EmailTemplateDataSource';
 import PostgresEventLogsDataSource from '../datasources/postgres/EventLogsDataSource';
 import PostgresExperimentDataSource from '../datasources/postgres/ExperimentDataSource';
 import PostgresExperimentSafetyPdfTemplateDataSource from '../datasources/postgres/ExperimentSafetyPdfTemplateDataSource';
@@ -114,6 +115,7 @@ mapClass(Tokens.StatusActionsLogsDataSource, StatusActionsLogsDataSource);
 mapClass(Tokens.WorkflowDataSource, PostgresWorkflowDataSource);
 mapClass(Tokens.StatusDataSource, PostgresStatusDataSource);
 mapClass(Tokens.TagDataSource, PostgresTagDataSource);
+mapClass(Tokens.EmailTemplateDataSource, PostgresEmailTemplateDataSource);
 
 mapClass(Tokens.ExperimentDataSource, PostgresExperimentDataSource);
 mapClass(Tokens.UserAuthorization, OAuthAuthorization);

apps/backend/src/config/dependencyConfigELI.ts

@@ -9,6 +9,7 @@ import { PostgresAdminDataSourceWithAutoUpgrade } from '../datasources/postgres/
 import PostgresCallDataSource from '../datasources/postgres/CallDataSource';
 import PostgresCoProposerClaimDataSource from '../datasources/postgres/CoProposerClaimDataSource';
 import PostgresDataAccessUsersDataSource from '../datasources/postgres/DataAccessUsersDataSource';
+import PostgresEmailTemplateDataSource from '../datasources/postgres/EmailTemplateDataSource';
 import PostgresEventLogsDataSource from '../datasources/postgres/EventLogsDataSource';
 import PostgresExperimentDataSource from '../datasources/postgres/ExperimentDataSource';
 import PostgresExperimentSafetyPdfTemplateDataSource from '../datasources/postgres/ExperimentSafetyPdfTemplateDataSource';
@@ -117,6 +118,7 @@ mapClass(Tokens.StatusActionsLogsDataSource, StatusActionsLogsDataSource);
 mapClass(Tokens.WorkflowDataSource, PostgresWorkflowDataSource);
 mapClass(Tokens.StatusDataSource, PostgresStatusDataSource);
 mapClass(Tokens.TagDataSource, PostgresTagDataSource);
+mapClass(Tokens.EmailTemplateDataSource, PostgresEmailTemplateDataSource);
 
 mapClass(Tokens.ExperimentDataSource, PostgresExperimentDataSource);
 mapClass(Tokens.UserAuthorization, OAuthAuthorization);

apps/backend/src/config/dependencyConfigESS.ts

@@ -10,6 +10,7 @@ import { PostgresAdminDataSourceWithAutoUpgrade } from '../datasources/postgres/
 import PostgresCallDataSource from '../datasources/postgres/CallDataSource';
 import PostgresCoProposerClaimDataSource from '../datasources/postgres/CoProposerClaimDataSource';
 import PostgresDataAccessUsersDataSource from '../datasources/postgres/DataAccessUsersDataSource';
+import PostgresEmailTemplateDataSource from '../datasources/postgres/EmailTemplateDataSource';
 import PostgresEventLogsDataSource from '../datasources/postgres/EventLogsDataSource';
 import PostgresExperimentDataSource from '../datasources/postgres/ExperimentDataSource';
 import PostgresExperimentSafetyPdfTemplateDataSource from '../datasources/postgres/ExperimentSafetyPdfTemplateDataSource';
@@ -118,6 +119,7 @@ mapClass(Tokens.TagDataSource, PostgresTagDataSource);
 mapClass(Tokens.WorkflowDataSource, PostgresWorkflowDataSource);
 mapClass(Tokens.StatusDataSource, PostgresStatusDataSource);
 mapClass(Tokens.ExperimentDataSource, PostgresExperimentDataSource);
+mapClass(Tokens.EmailTemplateDataSource, PostgresEmailTemplateDataSource);
 
 mapClass(Tokens.UserAuthorization, OAuthAuthorization);
 mapClass(Tokens.ProposalAuthorization, ProposalAuthorization);

apps/backend/src/config/dependencyConfigSTFC.ts

@@ -9,6 +9,7 @@ import { PostgresAdminDataSourceWithAutoUpgrade } from '../datasources/postgres/
 import PostgresCallDataSource from '../datasources/postgres/CallDataSource';
 import PostgresCoProposerClaimDataSource from '../datasources/postgres/CoProposerClaimDataSource';
 import PostgresDataAccessUsersDataSource from '../datasources/postgres/DataAccessUsersDataSource';
+import PostgresEmailTemplateDataSource from '../datasources/postgres/EmailTemplateDataSource';
 import PostgresEventLogsDataSource from '../datasources/postgres/EventLogsDataSource';
 import PostgresExperimentDataSource from '../datasources/postgres/ExperimentDataSource';
 import PostgresExperimentSafetyPdfTemplateDataSource from '../datasources/postgres/ExperimentSafetyPdfTemplateDataSource';
@@ -114,6 +115,7 @@ mapClass(Tokens.StatusActionsLogsDataSource, StatusActionsLogsDataSource);
 mapClass(Tokens.WorkflowDataSource, PostgresWorkflowDataSource);
 mapClass(Tokens.StatusDataSource, PostgresStatusDataSource);
 mapClass(Tokens.TagDataSource, PostgresTagDataSource);
+mapClass(Tokens.EmailTemplateDataSource, PostgresEmailTemplateDataSource);
 
 mapClass(Tokens.ExperimentDataSource, PostgresExperimentDataSource);
 mapClass(Tokens.UserAuthorization, StfcUserAuthorization);

apps/backend/src/config/dependencyConfigTest.ts

@@ -11,6 +11,7 @@ import { AdminDataSourceMock } from '../datasources/mockups/AdminDataSource';
 import { CallDataSourceMock } from '../datasources/mockups/CallDataSource';
 import { CoProposerClaimDataSourceMock } from '../datasources/mockups/CoProposerClaimDataSource';
 import MockDataAccessUsersDataSource from '../datasources/mockups/DataAccessUsersDataSource';
+import { EmailTemplateDataSourceMock } from '../datasources/mockups/EmailTemplateDataSource';
 import { EventLogsDataSourceMock } from '../datasources/mockups/EventLogsDataSource';
 import { ExperimentDataSourceMock } from '../datasources/mockups/ExperimentDataSource';
 import { ExperimentSafetyPdfTemplateDataSourceMock } from '../datasources/mockups/ExperimentSafetyPdfTemplateDataSource';
@@ -106,6 +107,7 @@ mapClass(Tokens.VisitRegistrationAuthorization, VisitRegistrationAuthorization);
 mapClass(Tokens.PredefinedMessageDataSource, PredefinedMessageDataSourceMock);
 mapClass(Tokens.StatusActionsLogsDataSource, StatusActionsLogsDataSourceMock);
 mapClass(Tokens.TagDataSource, TagDataSourceMock);
+mapClass(Tokens.EmailTemplateDataSource, EmailTemplateDataSourceMock);
 
 mapClass(Tokens.UserAuthorization, UserAuthorizationMock);
 mapClass(Tokens.ProposalAuthorization, ProposalAuthorization);