Feat 46 email sendgrid refactor

Dockerfile

@@ -9,6 +9,7 @@ RUN apk add --no-cache bash sed grep curl coreutils nodejs npm
 WORKDIR /cli
 ADD ./package.json ./package-lock.json ./
 ADD ./commands ./commands
+ADD ./libs ./libs
 RUN npm install --production
 
 ENTRYPOINT [ "npm", "start" ]

README.md

@@ -46,6 +46,18 @@ Under the `props` folder, you can set input variables:
 
 These files are designed to replicate the properties that would be mounted in confimaps by the controller service.
 
+### Development guide
+
+#### **Utilities file / functions** [libs/utilities.js](./libs/utilities.js)
+
+**_Descriptions_**: This file contains utility functions that are to be used/reused in other tasks to offer the developer a faster way to check for missing parameters, display missing parameters, unset parameters, removal of specific properties from objects, etc.
+**_Functions_**
+
+- _checkIfEmpty_: Check if param is set or not, in case of mandatory inputs;
+- _unsetField_: Removes every property from object, with the name 'fieldName';
+- _checkParameters_: Validates all attributes of the supplied object. Returns true if all parameters are valid;
+- _checkForJson_: Try to check if valid JSON and convert it to JS Object.
+
 ## Packaging
 
 ### Automatic

commands/http.js

@@ -1,8 +1,9 @@
 const { log, utils } = require("@boomerang-io/worker-core");
 const HttpsProxyAgent = require("https-proxy-agent");
 const https = require("https");
-const Url = require("url");
+const URL = require("url");
 const fs = require("fs");
+const HTTPRetryRequest = require("../libs/HTTPRetryRequest");
 
 module.exports = {
   /**
@@ -12,15 +13,52 @@ module.exports = {
    * headers [Text Area - new line delimitered list?]
    * content type [Select - Options: any, text, xml, json, html]
    * body [Text Area - optional depending on method]
+   * @param {string} errorcodes Represents a list of HTTP Status Codes, used either for error or success checks
+   * @param {string} isErrorCodes Represents if the `errorcodes` param is used as failure (true) or success (false)
+   * @param {int} httperrorretry Represents the number of retries that will be perfomed until success is obtained or the number of retries is achived
+   * @param {int} httpRetryDelay Represents the number of miliseconds that will delay the next retry
    * Allow untrusted SSL certs [Boolean Toggle]
    */
-
   execute() {
     log.debug("Started HTTP Call Plugin");
 
     //Destructure and get properties ready.
     const taskProps = utils.resolveInputParameters();
-    const { url, method, header, contentType, body, allowUntrustedCerts, outputFilePath } = taskProps;
+
+    const { url, method, header, contentType, body, allowUntrustedCerts, outputFilePath, errorcodes = "", isErrorCodes = "failure", httperrorretry = 0, httpRetryDelay = 200 } = taskProps;
+
+    // Input force defaults
+    let newisErrorCodes = "failure";
+    let newhttperrorretry = 0;
+    let newhttpRetryDelay = 200;
+    // Input not "empty", set value
+    if (typeof isErrorCodes === "string" && isErrorCodes !== '""' && isErrorCodes !== '" "' && isErrorCodes !== "") {
+      newisErrorCodes = isErrorCodes.trim().toLowerCase(); // Input normalization
+    }
+    if (httperrorretry !== '""' && httperrorretry !== '" "' && httperrorretry !== "") {
+      newhttperrorretry = parseInt(httperrorretry, 10);
+      if (isNaN(newhttperrorretry)) {
+        log.err("Invalid input for: httperrorretry");
+        process.exit(1);
+      }
+      if (newhttperrorretry < 0 || newhttperrorretry > 10) {
+        log.err("Invalid input for: httperrorretry [0,10]");
+        process.exit(1);
+      }
+    }
+    if (httpRetryDelay !== '""' && httpRetryDelay !== '" "' && httpRetryDelay !== "") {
+      newhttpRetryDelay = parseInt(httpRetryDelay, 10);
+      // parse test
+      if (isNaN(newhttpRetryDelay)) {
+        log.err("Invalid input for: httpRetryDelay");
+        process.exit(1);
+      }
+      // bounds exceeded
+      if (newhttpRetryDelay < 100 || newhttpRetryDelay > 30000) {
+        log.err("Invalid input for: httpRetryDelay [100,30000]");
+        process.exit(1);
+      }
+    }
 
     /**
      * turn header into object based upon new line delimeters
@@ -31,9 +69,18 @@ module.exports = {
       let headerSplitArr = header.split("\n");
       log.debug(headerSplitArr);
       headerSplitArr.forEach(line => {
-        let key = line.substring(0, line.indexOf(":"));
-        let value = line.substring(line.indexOf(":") + 1).trim();
-        headerObject[key] = value;
+        let arrHearder = line.split(":");
+        if (arrHearder && arrHearder.length) {
+          let key = arrHearder
+            .shift()
+            .trim()
+            .replace(/("|')/g, ""); //take first string, the header
+          let value = arrHearder
+            .join(":")
+            .trim()
+            .replace(/("|')/g, ""); //rejoin all strings
+          headerObject[key] = value;
+        }
       });
     }
 
@@ -56,7 +103,7 @@ module.exports = {
       } else {
         log.debug("NO_PROXY list detected", process.env.NO_PROXY);
         const noProxyList = process.env.NO_PROXY.split(",");
-        let urltoUrl = new Url.URL(url);
+        let urltoUrl = new URL(url);
         let urlHost = urltoUrl.host.split(":")[0];
         log.debug("urlHost:", urlHost);
         const skipProxy = noProxyList.some(domain => {
@@ -81,65 +128,63 @@ module.exports = {
       allowUntrustedFlag = true;
     }
 
-    const opts = Url.parse(url);
+    const reqURL = new URL.URL(url);
+    let opts = {};
     opts.rejectUnauthorized = !allowUntrustedFlag;
     opts.agent = agent;
     opts.method = method;
     opts.headers = {
       ...headerObject
     };
 
-    log.sys("Commencing to execute HTTP call with", opts);
+    log.sys("Commencing to execute HTTP call with", reqURL, JSON.stringify(opts));
 
-    const req = https.request(opts, res => {
-      log.debug(`statusCode: ${res.statusCode}`);
-      utils.setOutputParameter("statusCode", JSON.stringify(res.statusCode));
-      let output = "";
-
-      res.on("data", d => {
-        output += d;
-      });
+    let config = {
+      ERROR_CODES: errorcodes,
+      MAX_RETRIES: newhttperrorretry,
+      DELAY: newhttpRetryDelay,
+      IS_ERROR: newisErrorCodes === "failure"
+    };
+    if (body && body !== "" && body !== '""' && body !== '" "') {
+      log.debug("writing request body");
+      config.body = body;
+    }
 
-      res.on("end", () => {
+    new HTTPRetryRequest(config, reqURL, opts)
+      .then(res => {
+        log.debug(`statusCode: ${res.statusCode}`);
+        utils.setOutputParameter("statusCode", JSON.stringify(res.statusCode));
         try {
-          log.debug(`output: ${output}`);
+          log.debug(`output: ${res.body.toString()}`);
           //make sure non-empty output is a valid JSON,
           //if not throw exception
-          if (!(output === null || output.match(/^ *$/) !== null)) {
-            JSON.parse(output);
+          if (!(res.body === null || res.body.toString().match(/^ *$/) !== null)) {
+            JSON.parse(res.body.toString());
           }
+          log.sys("Response Received:", res.body.toString());
         } catch (e) {
           log.err(e);
           process.exit(1);
         }
-        log.sys("Response Received:", output);
         if (outputFilePath && outputFilePath.length && outputFilePath !== '""' && outputFilePath !== '" "') {
-          fs.writeFileSync(outputFilePath, output, err => {
-            if (err) {
-              log.err(err);
-              throw err;
-            }
-            log.debug("The task output parameter successfully saved to provided file path.");
+          //https://nodejs.org/docs/latest-v14.x/api/fs.html#fs_fs_writefilesync_file_data_options
+          fs.writeFileSync(outputFilePath, res.body, {
+            encoding: "utf8",
+            mode: 666,
+            flag: "w"
           });
+          log.debug("The task output parameter successfully saved to provided file path.");
         } else {
-          utils.setOutputParameter("response", output);
+          utils.setOutputParameter("response", res.body.toString());
           log.debug("The task output parameter successfully saved to standard response file.");
         }
         log.good("Response successfully received!");
+      })
+      .catch(err => {
+        log.err("HTTP Promise error:", err);
+        process.exit(1);
       });
-    });
-
-    req.on("error", err => {
-      log.err(err);
-      process.exit(1);
-    });
-
-    if (body && body !== "" && body !== '""' && body !== '" "') {
-      log.debug("writing request body");
-      req.write(body);
-    }
 
-    req.end();
     log.debug("Finished HTTP Call File Plugin");
   }
 };