folder restructure and minor changes

Author: Anmol Binani

cds-plugin.js

@@ -1,41 +1,39 @@
 const cds = require("@sap/cds");
-const fs = require("fs").promises;
-const notifier = require("./srv/notify");
+const notifier = require("./srv/service");
+const {
+  messages,
+  validateNotificationTypes,
+  readFileContent,
+} = require("./lib/utils");
 
 global.alert = {
   notify: notifier.postNotification,
 };
 
-const oErrorMessages = {
-  INVALID_NOTIFICATION_TYPES:
-    "Failed to create Notification Types as they are not valid.",
-};
-
-let fAreNotificationTypesValid = async (aNotificationtypes) => {
-  /**
-   * TODO: write a logic to check all the required fields.
-   */
-  return true;
-};
-
-cds.once("served", async () => {
+cds.once("served", () => {
   /**
    * For local testing initialise VCAP_SERVICES variables for the application
    * process.env.VCAP_SERVICES = Strigified VCAP_SERVICES variable
    */
   /**
    * TODO: Decide the properties to be added in the alerts section for notificationtype files.
    */
-  if (cds.requires.alerts && cds.requires.alerts.notificationTypes) {
-    let notificationTypes = JSON.parse(
-      await fs.readFile(cds.requires.alerts.notificationTypes)
+  if (cds.requires?.notifications?.notificationTypes) {
+    let notificationTypes = readFileContent(
+      cds.requires.alerts.notificationTypes
     );
-    if (fAreNotificationTypesValid) {
+    if (validateNotificationTypes(notificationTypes)) {
       notificationTypes.forEach((oNotificationType) => {
         notifier.postNotificationType(oNotificationType);
       });
     } else {
-      console.log(oErrorMessages.INVALID_NOTIFICATION_TYPES);
+      /**
+       * TODO: Move this message inside the validation function
+       * ? Should we throw error message or warning for the specific invalid NotificationType?
+       * ? e.g., If we have 5 notificationTypes and 1 out of the 5 is invalid type, we should
+       * ? go ahead and create the valid ones and display INFO/Warning for the invalid type
+       */
+      console.log(messages.INVALID_NOTIFICATION_TYPES);
     }
   }
 });

index.cds

@@ -1,8 +1,8 @@
-namespace sap.alert;
+namespace sap.notifications;
 
 service AlertNotificationService {
   /**
    * TODO : connect action to notify api.
    */
   action notify();
-}
+}

lib/notifications.js

@@ -0,0 +1,126 @@
+const cloudSDK = require("@sap-cloud-sdk/core");
+const { getDestination, executeHttpRequest, buildCsrfHeaders } = cloudSDK;
+const { messages } = require("./utils");
+
+const NOTIFICATIONS_DESTINATION_NAME = "SAP_Notifications";
+const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
+const NOTIFICATION_TYPES_API_ENDPOINT = "v2/NotificationType.svc";
+
+async function _getDestination(destinationName) {
+  const notifServiceDest = await getDestination(destinationName);
+  if (!notifServiceDest) {
+    throw new Error(messages.DESTINATION_NOT_FOUND + destinationName);
+  }
+  return notifServiceDest;
+}
+
+async function getNotificationTypes(
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notifServiceDest = await _getDestination(destinationName);
+  const response = await executeHttpRequest(notifServiceDest, {
+    url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes`,
+    method: "get",
+  });
+  return response.data.d.results;
+}
+
+async function postNotificationType(
+  notificationType,
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notifServiceDest = await _getDestination(destinationName);
+  const csrfHeaders = await buildCsrfHeaders(notifServiceDest, {
+    url: NOTIFICATION_TYPES_API_ENDPOINT,
+  });
+  const aExistingNotificationTypes = await this.getNotificationTypes();
+  const bIsDuplicateNotificationType = aExistingNotificationTypes.find(
+    (nType) =>
+      nType.NotificationTypeKey === notificationType.NotificationTypeKey &&
+      nType.NotificationTypeVersion === notificationType.NotificationTypeVersion
+  );
+
+  if (!bIsDuplicateNotificationType) {
+    console.log(
+      `Notification Type of key ${notificationType.NotificationTypeKey} and version ${notificationType.NotificationTypeVersion} was not found. Creating it...`
+    );
+    const response = await executeHttpRequest(notifServiceDest, {
+      url: `${NOTIFICATION_TYPES_API_ENDPOINT}/NotificationTypes`,
+      method: "post",
+      data: notificationType,
+      headers: csrfHeaders,
+    });
+    return response.data.d;
+  } else {
+    return true;
+  }
+}
+
+async function createNotificationObject(
+  recipients,
+  notificationTypeKey,
+  notificationTypeVersion,
+  notificationData,
+  language = "en"
+) {
+  let aProperties = [];
+  if (typeof notificationData === "object") {
+    for (sProperty of Object.keys(notificationData)) {
+      //TODO: recheck if can be sent from application. Check for localization
+      aProperties.push({
+        Key: sProperty,
+        Language: language,
+        Value: notificationData[sProperty],
+        Type: "String",
+        IsSensitive: false,
+      });
+    }
+  }
+  return {
+    NotificationTypeKey: notificationTypeKey,
+    NotificationTypeVersion: notificationTypeVersion,
+    Priority: "High",
+    Properties: aProperties,
+    Recipients: recipients.map((recipient) => ({ RecipientId: recipient })),
+  };
+}
+
+async function postNotification(
+  recipients,
+  notificationTypeKey,
+  notificationTypeVersion,
+  notificationData,
+  language = "en",
+  destinationName = NOTIFICATIONS_DESTINATION_NAME
+) {
+  const notification = await createNotificationObject(
+    recipients,
+    notificationTypeKey,
+    notificationTypeVersion,
+    notificationData,
+    language
+  );
+  const notifServiceDest = await _getDestination(destinationName);
+  const csrfHeaders = await buildCsrfHeaders(notifServiceDest, {
+    url: NOTIFICATIONS_API_ENDPOINT,
+  });
+
+  let response = {};
+  try {
+    response = await executeHttpRequest(notifServiceDest, {
+      url: `${NOTIFICATIONS_API_ENDPOINT}/Notifications`,
+      method: "post",
+      data: notification,
+      headers: csrfHeaders,
+    });
+  } catch (e) {
+    console.log(e);
+  }
+  return response.data.d;
+}
+
+module.exports = {
+  getNotificationTypes,
+  postNotificationType,
+  postNotification,
+};

lib/utils.js

@@ -0,0 +1,26 @@
+const fs = require('fs');
+
+const messages = {
+  INVALID_NOTIFICATION_TYPES:
+    "Failed to create Notification Types as they are not valid.",
+  DESTINATION_NOT_FOUND: "Failed to get destination: ",
+};
+
+function validateNotificationTypes(notificationTypes = {}) {
+  /**
+   * TODO: write a logic to check all the required fields.
+   */
+  return true;
+}
+
+function readFileContent(filePath) {
+  return JSON.parse(
+    fs.readFileSync(cds.requires.alerts.notificationTypes)
+  );
+}
+
+module.exports = {
+  messages,
+  validateNotificationTypes,
+  readFileContent
+};

package.json

@@ -11,11 +11,11 @@
         "lib",
         "srv"
     ],
+    "dependencies": {
+        "@sap-cloud-sdk/core": "^1.54.2"
+    },
     "scripts": {
         "lint": "npx eslint .",
         "test": "npx jest --silent"
-    },
-    "dependencies": {
-        "@sap-cloud-sdk/core": "^1.54.2"
     }
 }