Address comments

Author: ipaunov

lib/notifications.js

@@ -1,5 +1,5 @@
 const { buildCsrfHeaders } = require("@sap-cloud-sdk/core");
-const { getNotificationDestination, getNotificationTypesKeyWithPrefix, executeRequest, createDefaultNotificationObject, POSSIBLE_PRIORITIES } = require("./utils");
+const { getNotificationDestination, executeRequest, createNotification } = require("./utils");
 
 const NOTIFICATIONS_DESTINATION_NAME = cds.env.requires.notifications?.destination ?? "SAP_Notifications";
 const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
@@ -10,30 +10,8 @@ async function postNotification() {
     url: NOTIFICATIONS_API_ENDPOINT,
   });
 
-  if (arguments.length == 1 && typeof arguments[0] === "object") {
-    let notification = arguments[0];
-    notification["NotificationTypeKey"] = getNotificationTypesKeyWithPrefix(notification["NotificationTypeKey"]);
-
-    return (await executeRequest("post", `${NOTIFICATIONS_API_ENDPOINT}/Notifications`, notification, notifServiceDest, csrfHeaders)).data.d;
-  } else {
-    let recipients = arguments[0];
-    let priority = arguments[1];
-    let title = arguments[2];
-    let description = arguments[3] ? arguments[3] : "";
-
-    if (!POSSIBLE_PRIORITIES.includes(priority)) {
-      throw new Error(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
-    }
-
-    let notification = createDefaultNotificationObject(
-      recipients,
-      priority,
-      title,
-      description
-    );
-
-    return (await executeRequest("post", `${NOTIFICATIONS_API_ENDPOINT}/Notifications`, notification, notifServiceDest, csrfHeaders)).data.d;
-  }
+  const notification = createNotification(arguments);
+  return (await executeRequest("post", `${NOTIFICATIONS_API_ENDPOINT}/Notifications`, notification, notifServiceDest, csrfHeaders)).data.d;
 }
 
 module.exports = {

lib/utils.js

@@ -2,11 +2,12 @@ const fs = require('fs');
 const { basename } = require('path')
 const cds = require("@sap/cds");
 const { executeHttpRequest, getDestination } = require("@sap-cloud-sdk/core");
-const POSSIBLE_PRIORITIES = ["LOW", "NEUTRAL", "MEDIUM", "HIGH"];
+const PRIORITIES = ["LOW", "NEUTRAL", "MEDIUM", "HIGH"];
 
 const messages = {
   INVALID_NOTIFICATION_TYPES: "Notification Types must contain the following keys: 'NotificationTypeKey' and 'NotificationTypeVersion'.",
   DESTINATION_NOT_FOUND: "Failed to get destination: ",
+  MANDATORY_PARAMETER_NOT_PASSED: "Recipients, priority and title are mandatory parameters",
 };
 
 function validateNotificationTypes(notificationTypes) {
@@ -17,6 +18,16 @@ function validateNotificationTypes(notificationTypes) {
   });
 }
 
+function validateNotifyParameters(recipients, priority, title) {
+  if (!recipients || !priority || !title) {
+    throw new Error(messages.MANDATORY_PARAMETER_NOT_PASSED);
+  }
+
+  if (!PRIORITIES.includes(priority)) {
+    throw new Error(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
+  }
+}
+
 function doesKeyExist(obj, key) {
   return typeof(key) === 'string' && typeof(obj) === 'object' && key in obj;
 }
@@ -42,12 +53,12 @@ function getNotificationTypesKeyWithPrefix(notificationTypeKey) {
   return `${prefix}/${notificationTypeKey}`;
 }
 
-async function executeRequest(httpmethod, targetUrl, payload, notifServiceDest, csrfHeaders) {
+async function executeRequest(httpMethod, targetUrl, payload, notifServiceDest, csrfHeaders) {
   let response = {};
   try {
     response = await executeHttpRequest(notifServiceDest, {
       url: targetUrl,
-      method: httpmethod,
+      method: httpMethod,
       data: payload,
       headers: csrfHeaders,
     });
@@ -58,13 +69,13 @@ async function executeRequest(httpmethod, targetUrl, payload, notifServiceDest,
   return response;
 }
 
-function createDefaultNotificationObject(
+function createDefaultNotification(
   recipients,
   priority,
   title,
   description
 ) {
-  let properties = [
+  const properties = [
     {
       Key: "title",
       Language: "en",
@@ -90,15 +101,38 @@ function createDefaultNotificationObject(
   };
 }
 
+function createNotification(passedArguments) {
+  let notification;
+  if (passedArguments.length == 1 && typeof passedArguments[0] === "object" && !Array.isArray(passedArguments[0])) {
+    notification = passedArguments[0];
+    notification["NotificationTypeKey"] = getNotificationTypesKeyWithPrefix(notification["NotificationTypeKey"]);
+  } else {
+    const recipients = passedArguments[0];
+    const priority = passedArguments[1];
+    const title = passedArguments[2];
+    const description = passedArguments[3] ? passedArguments[3] : "";
+
+    validateNotifyParameters(recipients, priority, title);
+
+    notification = createDefaultNotification(
+      recipients,
+      priority,
+      title,
+      description
+    );
+  }
+
+  return notification;
+}
+
 module.exports = {
   messages,
-  POSSIBLE_PRIORITIES,
   validateNotificationTypes,
   readFile,
   doesKeyExist,
   getNotificationDestination,
   getPrefix,
   getNotificationTypesKeyWithPrefix,
   executeRequest,
-  createDefaultNotificationObject
+  createNotification
 };

srv/notifyToConsole.js

@@ -1,5 +1,5 @@
 const NotificationService = require('./service');
-const { getNotificationTypesKeyWithPrefix, createDefaultNotificationObject, POSSIBLE_PRIORITIES } = require("./../lib/utils");
+const { createNotification } = require("./../lib/utils");
 
 module.exports = class NotifyToConsole extends NotificationService {
   async init() {
@@ -8,29 +8,7 @@ module.exports = class NotifyToConsole extends NotificationService {
   }
 
   notify() {
-    let notification; 
-    
-    if (arguments.length == 1 && typeof arguments[0] === "object") {
-      notification = arguments[0];
-      notification["NotificationTypeKey"] = getNotificationTypesKeyWithPrefix(notification["NotificationTypeKey"]);
-  
-    } else {
-      let recipients = arguments[0];
-      let priority = arguments[1];
-      let title = arguments[2];
-      let description = arguments[3] ? arguments[3] : "";
-  
-      if (!POSSIBLE_PRIORITIES.includes(priority)) {
-        throw new Error(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
-      }
-  
-      notification = createDefaultNotificationObject(
-        recipients,
-        priority,
-        title,
-        description
-      );
-    }
+    const notification = createNotification(arguments);
 
     console.log(`SAP Alert Notification service notification: ${JSON.stringify(notification, null, 2)}`);
   }