Merge pull request #15 from cap-js/fix_signature

Change Notify

Author: ipaunov

lib/notifications.js

@@ -2,13 +2,13 @@ const { buildHeadersForDestination } = require("@sap-cloud-sdk/connectivity");
 const { getNotificationDestination, executeRequest, buildNotification } = require("./utils");
 const NOTIFICATIONS_API_ENDPOINT = "v2/Notification.svc";
 
-async function postNotification() {
+async function postNotification(notificationData) {
   const notificationDestination = await getNotificationDestination();
   const csrfHeaders = await buildHeadersForDestination(notificationDestination, {
     url: NOTIFICATIONS_API_ENDPOINT,
   });
 
-  const notification = buildNotification(arguments);
+  const notification = buildNotification(notificationData);
 
   if (notification) {
     const response = await executeRequest("post", `${NOTIFICATIONS_API_ENDPOINT}/Notifications`, notification, notificationDestination, csrfHeaders);
@@ -19,3 +19,4 @@ async function postNotification() {
 module.exports = {
   postNotification
 };
+

lib/utils.js

@@ -9,7 +9,15 @@ const messages = {
   TYPES_FILE_NOT_EXISTS: "Notification Types file path is incorrect.",
   INVALID_NOTIFICATION_TYPES: "Notification Types must contain the following key: 'NotificationTypeKey'.",
   DESTINATION_NOT_FOUND: "Failed to get destination: ",
-  MANDATORY_PARAMETER_NOT_PASSED: "Recipients, priority and title are mandatory parameters",
+  MANDATORY_PARAMETER_NOT_PASSED_FOR_DEFAULT_NOTIFICATION: "Recipients and title are mandatory parameters",
+  MANDATORY_PARAMETER_NOT_PASSED_FOR_CUSTOM_NOTIFICATION: "Recipients, type are mandatory parameters",
+  RECIPIENTS_IS_NOT_ARRAY: "Recipients is not an array or it is empty",
+  TITLE_IS_NOT_STRING: "Title is not a string",
+  DESCRIPTION_IS_NOT_STRING: "Description is not a string",
+  PROPERTIES_IS_NOT_OBJECT: "Properties is not an object",
+  NAVIGATION_IS_NOT_OBJECT: "Navigation is not an object",
+  PAYLOAD_IS_NOT_OBJECT: "Payload is not an object",
+  EMPTY_OBJECT_FOR_NOTIFY: "Empty object is passed a single parameter to notify function"
 };
 
 function validateNotificationTypes(notificationTypes) {
@@ -23,17 +31,66 @@ function validateNotificationTypes(notificationTypes) {
   return true;
 }
 
-function validateNotifyParameters(recipients, priority, title) {
-  if (!recipients || !priority || !title) {
-    console.log(messages.MANDATORY_PARAMETER_NOT_PASSED);
+function validateDefaultNotifyParameters(recipients, priority, title, description) {
+  if (!recipients || !title) {
+    console.log(messages.MANDATORY_PARAMETER_NOT_PASSED_FOR_DEFAULT_NOTIFICATION);
     return false;
   }
 
-  if (!PRIORITIES.includes(priority)) {
+  if (!Array.isArray(recipients) || recipients.length == 0) {
+    console.log(messages.RECIPIENTS_IS_NOT_ARRAY);
+    return false;
+  }
+
+  if (typeof title !== "string") {
+    console.log(messages.TITLE_IS_NOT_STRING);
+    return false;
+  }
+
+  if (priority && !PRIORITIES.includes(priority.toUpperCase())) {
+    console.log(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
+    return false;
+  }
+
+  if (description && typeof description !== "string") {
+    console.log(messages.DESCRIPTION_IS_NOT_STRING);
+    return false;
+  }
+
+  return true;
+}
+
+function validateCustomNotifyParameters(type, recipients, properties, navigation, priority, payload) {
+  if (!recipients || !type) {
+    console.log(messages.MANDATORY_PARAMETER_NOT_PASSED_FOR_CUSTOM_NOTIFICATION);
+    return false;
+  }
+
+  if (!Array.isArray(recipients) || recipients.length == 0) {
+    console.log(messages.RECIPIENTS_IS_NOT_ARRAY);
+    return false;
+  }
+
+  if (priority && !PRIORITIES.includes(priority.toUpperCase())) {
     console.log(`Invalid priority ${priority}. Allowed priorities are LOW, NEUTRAL, MEDIUM, HIGH`);
     return false;
   }
 
+  if (properties && !Array.isArray(properties)) {
+    console.log(messages.PROPERTIES_IS_NOT_OBJECT);
+    return false;
+  }
+
+  if (navigation && typeof navigation !== "object") {
+    console.log(messages.NAVIGATION_IS_NOT_OBJECT);
+    return false;
+  }
+
+  if (payload && typeof payload !== "object") {
+    console.log(messages.PAYLOAD_IS_NOT_OBJECT);
+    return false;
+  }
+
   return true;
 }
 
@@ -87,9 +144,9 @@ async function executeRequest(httpMethod, targetUrl, payload, notificationDestin
 
 function buildDefaultNotification(
   recipients,
-  priority,
+  priority = "NEUTRAL",
   title,
-  description
+  description = ""
 ) {
   const properties = [
     {
@@ -117,30 +174,58 @@ function buildDefaultNotification(
   };
 }
 
-function buildNotification(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] : "";
+function buildCustomNotification(notificationData) {
+  return {
+    Id: notificationData["payload"] ? notificationData["payload"]["Id"] : undefined,
+    OriginId: notificationData["payload"] ? notificationData["payload"]["OriginId"] : undefined,
+    NotificationTypeId: notificationData["payload"] ? notificationData["payload"]["NotificationTypeId"] : undefined,
+    NotificationTypeKey: getNotificationTypesKeyWithPrefix(notificationData["type"]),
+    NotificationTypeVersion: notificationData["payload"] ? notificationData["payload"]["NotificationTypeVersion"] : "1",
+    NavigationTargetAction: notificationData["navigation"] ? notificationData["navigation"]["NavigationTargetAction"] : undefined,
+    NavigationTargetObject: notificationData["navigation"] ? notificationData["navigation"]["NavigationTargetObject"] : undefined,
+    Priority: notificationData["priority"] ? notificationData["priority"] : "NEUTRAL",
+    ProviderId: notificationData["payload"] ? notificationData["payload"]["ProviderId"] : undefined,
+    ActorId: notificationData["payload"] ? notificationData["payload"]["ActorId"] : undefined,
+    ActorDisplayText: notificationData["payload"] ? notificationData["payload"]["ActorDisplayText"] : undefined,
+    ActorImageURL: notificationData["payload"] ? notificationData["payload"]["ActorImageURL"] : undefined,
+    NotificationTypeTimestamp: notificationData["payload"] ? notificationData["payload"]["NotificationTypeTimestamp"] : undefined,
+    Recipients: notificationData["recipients"].map((recipient) => ({ RecipientId: recipient })),
+    Properties: notificationData["properties"] ? notificationData["properties"] : undefined,
+    TargetParameters: notificationData["payload"] ? notificationData["payload"]["TargetParameters"] : undefined
+  };
+}
+
+function buildNotification(notificationData) {
+  let notification
+
+  if (Object.keys(notificationData).length === 0) {
+    console.log(messages.EMPTY_OBJECT_FOR_NOTIFY);
+    return;
+  }
 
-    if (!validateNotifyParameters(recipients, priority, title)) {
+  if (notificationData["type"]) {
+    if (!validateCustomNotifyParameters(notificationData["type"], notificationData["recipients"], notificationData["properties"], notificationData["navigation"], notificationData["priority"], notificationData["payload"])) {
+      return;
+    }
+
+    notification = buildCustomNotification(notificationData)
+  } else if (notificationData["NotificationTypeKey"]) {
+    notificationData["NotificationTypeKey"] = getNotificationTypesKeyWithPrefix(notificationData["NotificationTypeKey"])
+    notification = notificationData;
+  } else {
+    if (!validateDefaultNotifyParameters(notificationData["recipients"], notificationData["priority"], notificationData["title"], notificationData["description"])) {
       return;
     }
 
     notification = buildDefaultNotification(
-      recipients,
-      priority,
-      title,
-      description
-    );
+      notificationData["recipients"],
+      notificationData["priority"],
+      notificationData["title"],
+      notificationData["description"]
+    )
   }
 
-  return notification;
+  return JSON.parse(JSON.stringify(notification));
 }
 
 module.exports = {

srv/notifyToConsole.js

@@ -10,7 +10,7 @@ module.exports = class NotifyToConsole extends NotificationService {
 
   notify() {
 
-    const notification = buildNotification(arguments);
+    const notification = buildNotification(arguments[0]);
 
     if (notification) {
       console.log(`SAP Alert Notification service notification: ${JSON.stringify(notification, null, 2)}`);