Merge pull request #2196 from bluewave-labs/Test-mail-backend-implementation

Initial push for the test email

server/controllers/monitorController.js

@@ -27,11 +27,12 @@ const SERVICE_NAME = "monitorController";
 import pkg from "papaparse";
 
 class MonitorController {
-	constructor(db, settingsService, jobQueue, stringService) {
+	constructor(db, settingsService, jobQueue, stringService, emailService) {
 		this.db = db;
 		this.settingsService = settingsService;
 		this.jobQueue = jobQueue;
 		this.stringService = stringService;
+		this.emailService = emailService;
 	}
 
 	/**
@@ -636,6 +637,50 @@ class MonitorController {
 		}
 	};
 
+	/**
+	 * Sends a test email to verify email delivery functionality.
+	 * @async
+	 * @param {Object} req - The Express request object.
+	 * @property {Object} req.body - The body of the request.
+	 * @property {string} req.body.to - The email address to send the test email to.
+	 * @param {Object} res - The Express response object.
+	 * @param {function} next - The next middleware function.
+	 * @returns {Object} The response object with a success status and the email delivery message ID.
+	 * @throws {Error} If there is an error while sending the test email.
+	 */
+	sendTestEmail = async (req, res, next) => {
+		try {
+			const { to } = req.body;
+
+			if (!to || typeof to !== "string") {
+				return res.error({ msg: this.stringService.errorForValidEmailAddress });
+			}
+
+			const subject = this.stringService.testEmailSubject;
+			const context = { testName: "Monitoring System" };
+
+			const messageId = await this.emailService.buildAndSendEmail(
+				"testEmailTemplate",
+				context,
+				to,
+				subject
+			);
+
+			if (!messageId) {
+				return res.error({
+					msg: "Failed to send test email.",
+				});
+			}
+
+			return res.success({
+				msg: this.stringService.sendTestEmail,
+				data: { messageId },
+			});
+		} catch (error) {
+			next(handleError(error, SERVICE_NAME, "sendTestEmail"));
+		}
+	};
+
 	getMonitorsByTeamId = async (req, res, next) => {
 		try {
 			await getMonitorsByTeamIdParamValidation.validateAsync(req.params);

server/index.js

@@ -231,7 +231,8 @@ const startApp = async () => {
 		ServiceRegistry.get(MongoDB.SERVICE_NAME),
 		ServiceRegistry.get(SettingsService.SERVICE_NAME),
 		ServiceRegistry.get(JobQueue.SERVICE_NAME),
-		ServiceRegistry.get(StringService.SERVICE_NAME)
+		ServiceRegistry.get(StringService.SERVICE_NAME),
+		ServiceRegistry.get(EmailService.SERVICE_NAME),
 	);
 
 	const settingsController = new SettingsController(

server/locales/en.json

@@ -158,5 +158,8 @@
 	"platformRequired": "Platform is required",
 	"testNotificationFailed": "Failed to send test notification",
 	"monitorUpAlert": "Uptime Alert: One of your monitors is back online.\n📌 Monitor: {monitorName}\n📅 Time: {time}\n⚠️ Status: UP\n📟 Status Code: {code}\n\u200B\n",
-  	"monitorDownAlert": "Downtime Alert: One of your monitors went offline.\n📌 Monitor: {monitorName}\n📅 Time: {time}\n⚠️ Status: DOWN\n📟 Status Code: {code}\n\u200B\n"
+  	"monitorDownAlert": "Downtime Alert: One of your monitors went offline.\n📌 Monitor: {monitorName}\n📅 Time: {time}\n⚠️ Status: DOWN\n📟 Status Code: {code}\n\u200B\n",
+	"sendTestEmail": "Test email sent successfully",
+	"errorForValidEmailAddress": "A valid recipient email address is required.",
+	"testEmailSubject": "Test Email from Monitoring System"
 }

server/routes/monitorRoute.js

@@ -99,6 +99,12 @@ class MonitorRoutes {
 		);
 
 		this.router.post("/seed", isAllowed(["superadmin"]), this.monitorController.seedDb);
+
+		this.router.post(
+			"/test-email",
+			isAllowed(["admin", "superadmin"]),
+			this.monitorController.sendTestEmail
+		);
 	}
 
 	getRouter() {

server/service/emailService.js

@@ -67,6 +67,7 @@ class EmailService {
 			serverIsUpTemplate: this.loadTemplate("serverIsUp"),
 			passwordResetTemplate: this.loadTemplate("passwordReset"),
 			hardwareIncidentTemplate: this.loadTemplate("hardwareIncident"),
+			testEmailTemplate: this.loadTemplate("testEmailTemplate")
 		};
 
 		/**

server/templates/testEmailTemplate.mjml

@@ -0,0 +1,17 @@
+<mjml>
+  <mj-body>
+    <mj-section>
+      <mj-column>
+        <mj-text font-size="20px" font-family="Helvetica Neue">
+          Hello!
+        </mj-text>
+        <mj-text font-size="16px" font-family="Helvetica Neue">
+          This is a test email from the Monitoring System.
+        </mj-text>
+        <mj-text font-size="14px" font-family="Helvetica Neue">
+          If you're receiving this, your email configuration is working correctly.
+        </mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>