Merge pull request #4 from hisptz/feature/mailing-util

Feature/mailing util

Author: ericchingalo

.env.example

@@ -1,4 +1,10 @@
+#  DHIS2 Configuration
 DHIS2_BASE_URL=
 DHIS2_USERNAME=
 DHIS2_PASSWORD=
 PREDICTOR_GROUPS=
+
+#  Email Configuration
+EMAIL_SENDER=
+EMAIL_SENDER_PASSWORD=
+EMAIL_RECIPIENTS=

README.md

@@ -45,10 +45,16 @@ yarn install
 Environment variables can be set by creating `.env` file with contents similar as `.env.example` Or as shown below:
 
 ```
+#  DHIS2 Configuration
 DHIS2_BASE_URL=<url-for-dhis2-instance>
 DHIS2_USERNAME=<dhis2-username>
 DHIS2_PASSWORD=<dhis2-password>
 PREDICTOR_GROUPS=<comma-separated-uids>
+
+#  Email Configuration
+EMAIL_SENDER=<email-notification-sender>
+EMAIL_SENDER_PASSWORD=<sender-password>
+EMAIL_RECIPIENTS=<comma-separated-recipients>
 ```
 
 ### Running the application

build-readme.md

@@ -27,10 +27,16 @@ yarn install
 Environment variables can be set by creating `.env` file with contents similar as `.env.example` Or as shown below:
 
 ```
+#  DHIS2 Configuration
 DHIS2_BASE_URL=<url-for-dhis2-instance>
 DHIS2_USERNAME=<dhis2-username>
 DHIS2_PASSWORD=<dhis2-password>
 PREDICTOR_GROUPS=<comma-separated-uids>
+
+#  Email Configuration
+EMAIL_SENDER=<email-notification-sender>
+EMAIL_SENDER_PASSWORD=<sender-password>
+EMAIL_RECIPIENTS=<comma-separated-recipients>
 ```
 
 ### 3. Running the application

package.json

@@ -1,7 +1,7 @@
 {
   "name": "somalia-lmis-predictors-script",
   "description": "A custom script that evaluates the predictors from the specified DHIS2 instance",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
@@ -11,6 +11,7 @@
     "dotenv": "^16.0.3",
     "lodash": "^4.17.21",
     "luxon": "^3.3.0",
+    "nodemailer": "^7.0.11",
     "winston": "^3.8.2"
   },
   "scripts": {
@@ -24,6 +25,7 @@
     "@types/lodash": "^4.17.13",
     "@types/luxon": "^3.3.1",
     "@types/node": "^20.2.4",
+    "@types/nodemailer": "^7.0.4",
     "bestzip": "^2.2.1",
     "rimraf": "^5.0.1",
     "ts-loader": "^9.4.3",

src/commands/index.ts

@@ -1,5 +1,4 @@
 import { Command } from "commander";
-import appDetails from "../../package.json";
 import logger from "../logging";
 import { printDHIS2Info } from "../clients/sysInfo";
 import {
@@ -35,9 +34,32 @@ program
         endDate
       );
     }
+
+    const evaluationResults: string[] = [];
+
     for (const { startDate, endDate } of dateIntervals) {
-      await initiatePredictorEvaluationProcess(startDate, endDate);
+      try {
+        const result = await initiatePredictorEvaluationProcess(
+          startDate,
+          endDate
+        );
+        result && evaluationResults.push(result);
+      } catch (error) {
+        logger.error(
+          `Failed to run predictor evaluation for period ${startDate} to ${endDate}`
+        );
+        logger.error(error);
+      }
     }
+
+    logger.info("Predictor data generation process completed.");
+
+    // send notification emails
+    await import("../utils/predictor-notifications").then(
+      async ({ sendNotifications }) => {
+        await sendNotifications(evaluationResults);
+      }
+    );
   });
 
 program

src/services/index.ts

@@ -8,18 +8,45 @@ import { getPredictorGroups, runPredictorGroup } from "../utils/predictors";
 export async function initiatePredictorEvaluationProcess(
   startDate?: string,
   endDate?: string
-) {
+): Promise<string | undefined> {
+  const results: any[] = [];
   startDate = startDate ?? getDefaultStartDateForPredictorEvaluation();
   endDate = endDate ?? getDefaultLastDateForPredictorEvaluation();
   logger.info(`Started running the predictors from ${startDate} to ${endDate}`);
 
   try {
     const predictorGroups = await getPredictorGroups();
     for (let predictorGroup of predictorGroups) {
-      await runPredictorGroup(predictorGroup, startDate, endDate);
+      const result = await runPredictorGroup(
+        predictorGroup,
+        startDate,
+        endDate
+      );
+      results.push({
+        ...predictorGroup,
+        result,
+      });
     }
+    let htmlTable = `<h3>Predictions Results from ${startDate} to ${endDate}</h3><table border="1" cellpadding="5" cellspacing="0">
+      <tr>
+        <th>ID</th>
+        <th>Name</th>
+        <th>Result</th>
+      </tr>`;
+    results.forEach((res) => {
+      htmlTable += `<tr>
+        <td>${res.id}</td>
+        <td>${res.name}</td>
+        <td>${res.result}</td>
+      </tr>`;
+    });
+
+    htmlTable += `</table>`;
+
+    return htmlTable;
   } catch (error) {
     logger.error(`Failed to evaluate Predictors! check the error below.`);
     logger.error(`${JSON.stringify(error)}`);
+    throw error;
   }
 }

src/utils/email-notifications.ts

@@ -0,0 +1,55 @@
+import { config } from "dotenv";
+import nodemailer from "nodemailer";
+import logger from "../logging";
+
+config();
+
+const emailSender = {
+  email: process.env.EMAIL_SENDER,
+  password: process.env.EMAIL_SENDER_PASSWORD,
+};
+
+const transporter = nodemailer.createTransport({
+  service: "gmail",
+  auth: {
+    type: "login",
+    user: emailSender.email || "",
+    pass: emailSender.password || "",
+  },
+});
+
+type EmailNotificationParams = {
+  to: string;
+  subject: string;
+  htmlContent?: string;
+  textContent?: string;
+  attachments?: Array<{
+    filename: string;
+    path: string;
+  }>;
+};
+
+export const sendEmailNotification = async ({
+  to,
+  subject,
+  htmlContent = "",
+  textContent = "",
+  attachments = [],
+}: EmailNotificationParams): Promise<void> => {
+  const mailOptions = {
+    from: emailSender.email,
+    to,
+    subject,
+    text: textContent,
+    html: htmlContent,
+    attachments,
+  };
+
+  try {
+    await transporter.sendMail(mailOptions);
+    logger.info(`Email sent to ${to} with subject: ${subject}`);
+  } catch (error) {
+    logger.error(`Failed to send email to ${to}`);
+    logger.error(error);
+  }
+};

src/utils/predictor-notifications.ts

@@ -0,0 +1,47 @@
+import { config } from "dotenv";
+import logger from "../logging";
+
+config();
+
+export async function sendNotifications(
+  evaluationResults: string[]
+): Promise<void> {
+  const emailRecipients = process.env.EMAIL_RECIPIENTS;
+  try {
+    if (evaluationResults.length) {
+      const finalHtml =
+        "<p>The predictor evaluation results are as follows:</p>" +
+        evaluationResults.join("<br/>");
+      if (emailRecipients) {
+        await import("../utils/email-notifications").then(
+          async ({ sendEmailNotification }) => {
+            await sendEmailNotification({
+              to: emailRecipients,
+              subject: `Predictor Evaluation Results`,
+              htmlContent: finalHtml,
+            });
+          }
+        );
+        logger.info(`Prediction results email sent to: ${emailRecipients}`);
+      }
+    } else {
+      logger.info("No predictor evaluation results to display.");
+      if (emailRecipients) {
+        await import("../utils/email-notifications").then(
+          async ({ sendEmailNotification }) => {
+            await sendEmailNotification({
+              to: emailRecipients,
+              subject: `ERROR: Predictor Evaluation Results`,
+              textContent:
+                "There were no predictor evaluation results. To see more details, please check the server logs.",
+            });
+          }
+        );
+        logger.info(`Notification email sent to: ${emailRecipients}`);
+      }
+    }
+  } catch (error) {
+    logger.error(`Failed to send notification emails! check the error below.`);
+    logger.error(error);
+  }
+}

src/utils/predictors.ts

@@ -53,7 +53,7 @@ export async function runPredictorGroup(
   predictorGroup: PredictorGroup,
   startDate: string,
   endDate: string
-): Promise<void> {
+): Promise<string> {
   logger.info(
     `Generating predictions for ${predictorGroup.name} Group from ${startDate} to ${endDate}`
   );
@@ -65,16 +65,17 @@ export async function runPredictorGroup(
       logger.error(
         `Failed to generate the predictions! ${response?.data?.message ?? ""}`
       );
-      return;
+      return "Failed to generate predictions";
     }
-
     const message =
       response?.data?.message ?? "Successfully generated the predictions";
     logger.info(message);
+    return message;
   } catch (error) {
     logger.error(
       `Failed to run ${predictorGroup.name} group! See the error below.`
     );
     logger.error(`${JSON.stringify(error)}`);
+    return "Failed to generate predictions";
   }
 }