Local testing (#4)

* add log2rest kind and implement log2console

* rename files

* update profiles

* rename alert to notify

* track notifications types for local

* throw error if notification type is invalid

---------

Co-authored-by: Anmol Binani <[email protected]>

Author: sidakphull

cds-plugin.js

@@ -1,9 +1,9 @@
 const cds = require("@sap/cds");
 const notifier = require("./lib/notifications");
 const {
-  messages,
   validateNotificationTypes,
-  readFileContent,
+  readFile,
+  doesKeyExist
 } = require("./lib/utils");
 
 cds.once("served", () => {
@@ -14,23 +14,33 @@ cds.once("served", () => {
   /**
    * TODO: Decide the properties to be added in the alerts section for notificationtype files.
    */
-  if (cds.requires?.notifications?.types) {
-    let notificationTypes = readFileContent(
-      cds.requires.notifications.types
-    );
-    if (validateNotificationTypes(notificationTypes)) {
+  const profiles = cds.env.profiles ?? [];
+  const production = profiles.includes('production');
+  if (cds.env.requires?.notifications?.types) {
+    // read notification types
+    const notificationTypes = readFile(cds.env.requires.notifications.types);
+
+    // validate notification types
+    validateNotificationTypes(notificationTypes);
+
+    // create notification types
+    if (production) {
       notificationTypes.forEach((oNotificationType) => {
         notifier.postNotificationType(oNotificationType);
       });
     } else {
-      /**
-       * 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);
+      const types = {};
+      notificationTypes.forEach((oNotificationType) => {
+        if (!doesKeyExist(types, oNotificationType.NotificationTypeKey)) {
+          types[oNotificationType.NotificationTypeKey] = {};
+        }
+
+        types[oNotificationType.NotificationTypeKey][oNotificationType.NotificationTypeVersion] = oNotificationType;
+      });
+
+      cds.notifications = { local: { types }};
     }
+  } else if (!production) {
+    cds.notifications = { local: { types: {} }};
   }
 });
-

lib/notifications.js

@@ -56,7 +56,7 @@ async function postNotificationType(
   }
 }
 
-async function createNotificationObject(
+function createNotificationObject(
   recipients,
   notificationTypeKey,
   notificationTypeVersion,
@@ -93,7 +93,7 @@ async function postNotification(
   language = "en",
   destinationName = NOTIFICATIONS_DESTINATION_NAME
 ) {
-  const notification = await createNotificationObject(
+  const notification = createNotificationObject(
     recipients,
     notificationTypeKey,
     notificationTypeVersion,
@@ -122,5 +122,6 @@ async function postNotification(
 module.exports = {
   getNotificationTypes,
   postNotificationType,
+  createNotificationObject,
   postNotification,
 };

lib/utils.js

@@ -6,21 +6,29 @@ const messages = {
   DESTINATION_NOT_FOUND: "Failed to get destination: ",
 };
 
+// we should at least verify that NotificationTypeKey and NotificationTypeVersion is present
 function validateNotificationTypes(notificationTypes = {}) {
   /**
    * TODO: write a logic to check all the required fields.
    */
+
+  // throw error in case types are invalid
+  // throw new Error(messages.INVALID_NOTIFICATION_TYPES);
+
   return true;
 }
 
-function readFileContent(filePath) {
-  return JSON.parse(
-    fs.readFileSync(cds.requires.notifications.types)
-  );
+function doesKeyExist(obj, key) {
+  return typeof(key) === 'string' && typeof(obj) === 'object' && key in obj;
+}
+
+function readFile(filePath) {
+  return JSON.parse(fs.readFileSync(filePath));
 }
 
 module.exports = {
   messages,
   validateNotificationTypes,
-  readFileContent
+  readFile,
+  doesKeyExist
 };

package.json

@@ -1,39 +1,46 @@
 {
-    "name": "@cap-js/alert-notification",
-    "version": "0.0.1",
-    "description": "CDS plugin providing integration to the SAP BTP Alert Notification Service.",
-    "repository": "cap-js/alert-notification",
-    "author": "SAP SE (https://www.sap.com)",
-    "homepage": "https://cap.cloud.sap/",
-    "license": "SEE LICENSE IN LICENSE",
-    "main": "cds-plugin.js",
-    "files": [
-        "lib",
-        "srv"
-    ],
-    "dependencies": {
-      "@sap-cloud-sdk/core": "^1.54.2"
-    },
-    "devDependencies": {
-        "jest": "^29.6.4"
-    },
-    "scripts": {
-        "lint": "npx eslint .",
-        "test": "npx jest --silent"
-    },
-    "cds": {
-        "requires": {
-          "kinds": {
-            "notifications": {
-              "[development]": {
-                "kind": "notify-to-console"
-              }
-            },
-            "notify-to-console": {
-              "impl": "@cap-js/alert-notification/srv/notifyToConsole",
-              "outbox": false
-            }
+  "name": "@cap-js/alert-notification",
+  "version": "0.0.1",
+  "description": "CDS plugin providing integration to the SAP BTP Alert Notification Service.",
+  "repository": "cap-js/alert-notification",
+  "author": "SAP SE (https://www.sap.com)",
+  "homepage": "https://cap.cloud.sap/",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "cds-plugin.js",
+  "files": [
+    "lib",
+    "srv"
+  ],
+  "dependencies": {
+    "@sap-cloud-sdk/core": "^1.54.2"
+  },
+  "devDependencies": {
+    "jest": "^29.6.4"
+  },
+  "scripts": {
+    "lint": "npx eslint .",
+    "test": "npx jest --silent"
+  },
+  "cds": {
+    "requires": {
+      "kinds": {
+        "notifications": {
+          "[development]": {
+            "kind": "notify-to-console"
+          },
+          "[production]": {
+            "kind": "notify-to-rest"
           }
+        },
+        "notify-to-console": {
+          "impl": "@cap-js/alert-notification/srv/notifyToConsole",
+          "outbox": false
+        },
+        "notify-to-rest": {
+          "impl": "@cap-js/alert-notification/srv/notifyToRest",
+          "outbox": true
         }
       }
-}
+    }
+  }
+}

srv/notifyToConsole.js

@@ -1,9 +1,40 @@
-const AlertNotificationService = require('./service')
+const NotificationService = require('./service');
 
-module.exports = class NotifyToConsole extends AlertNotificationService {
+const cds = require("@sap/cds");
+const notifier = require("../lib/notifications");
+const { doesKeyExist } = require('../lib/utils');
+
+module.exports = class NotifyToConsole extends NotificationService {
   async init() {
+    // call NotificationService's init
+    await super.init();
+  }
+
+  notify (
+    recipients,
+    notificationTypeKey,
+    notificationTypeVersion,
+    notificationData,
+    language = "en"
+  ) {
+
+    const types = cds.notifications.local.types;
+    if (!doesKeyExist(types, notificationTypeKey)) {
+      throw new Error(`Invalid Notification Type Key: ${notificationTypeKey}`);
+    }
+
+    if (!doesKeyExist(types[notificationTypeKey], notificationTypeVersion)) {
+      throw new Error(`Invalid Notification Type Version for Key ${notificationTypeKey}: ${notificationTypeVersion}`);
+    }
+
+    const notification = notifier.createNotificationObject(
+      recipients,
+      notificationTypeKey,
+      notificationTypeVersion,
+      notificationData,
+      language
+    );
 
-    // call AlertNotificationService's init
-    await super.init()
+    console.log(`[ans] - ${notificationTypeKey} - ${notificationTypeVersion}:`, notification);
   }
 }

srv/notifyToRest.js

@@ -0,0 +1,13 @@
+const NotificationService = require('./service');
+
+const notifier = require("../lib/notifications");
+
+module.exports = class NotifyToRest extends NotificationService {
+  async init() {
+
+    this.notify = notifier.postNotification;
+
+    // call NotificationService's init
+    await super.init();
+  }
+}

srv/service.js

@@ -3,18 +3,13 @@
  * We will branch out for development and production profile here
  */
 
-const cds = require('@sap/cds')
-const notifier = require("../lib/notifications");
-
 // REVISIT: cds.OutboxService or technique to avoid extending OutboxService
-const OutboxService = require('@sap/cds/libx/_runtime/messaging/Outbox')
+const OutboxService = require('@sap/cds/libx/_runtime/messaging/Outbox');
 
-module.exports = class AlertNotificationService extends OutboxService {
+module.exports = class NotificationService extends OutboxService {
   async init() {
-    
-    // call OutboxService's init
-    await super.init()
 
-    this.notify = notifier.postNotification
+    // call OutboxService's init
+    await super.init();
   }
 }