fiftyone.pipeline.cloudrequestengine 4.4.7 → 4.4.9

package/cloudEngine.js

@@ -99,23 +99,22 @@ class CloudEngine extends Engine {
     const engine = this;
 
     return engine.ready().then(function () {
-
       let cloudData = flowData.get('cloud').get('cloud');
 
       cloudData = JSON.parse(cloudData);
       const result = {};
 
       if (cloudData && cloudData[engine.dataKey] === null) {
-        flowData.pipeline.log('error', engine.dataKey + " not populated. " +
-        cloudData[engine.dataKey + 'nullreason'] !== null ? cloudData[engine.dataKey + 'nullreason'] : "" +
-        "\n" + "This may be because the provided API key is not authorised for " + engine.dataKey + " queries.");
-      } 
-      else {
-
+        flowData.pipeline.log('error', engine.dataKey + ' not populated. ' +
+        cloudData[engine.dataKey + 'nullreason'] !== null
+          ? cloudData[engine.dataKey + 'nullreason']
+          : '' +
+        '\n' + 'This may be because the provided API key is not authorised for ' + engine.dataKey + ' queries.');
+      } else {
       // Loop over cloudData.device properties to check if they have a value
         Object.entries(cloudData[engine.dataKey]).forEach(function ([key, value]) {
           result[key] = new AspectPropertyValue();
-  
+
           if (cloudData[engine.dataKey][key + 'nullreason']) {
             result[key].noValueMessage = cloudData[engine.dataKey][key + 'nullreason'];
           } else {

package/cloudRequestEngine.js

@@ -20,13 +20,6 @@
  * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
-const require51 = (requestedPackage) => {
-  try {
-    return require(__dirname + '/../' + requestedPackage);
-  } catch (e) {
-    return require(requestedPackage);
-  }
-};
 const util = require('util');
 const Engine = require('fiftyone.pipeline.engines').Engine;
 const AspectDataDictionary = require('fiftyone.pipeline.engines')
@@ -53,12 +46,13 @@ class CloudRequestEngine extends Engine {
    * @param {string} options.licenseKey licensekey for cloud service
    * @param {string} options.baseURL url the cloud service is located at
    * if overriding default
-   * @param {string} options.cloudRequestOrigin The value to set for the Origin 
+   * @param {string} options.cloudRequestOrigin The value to set for the Origin
    * header when making requests to the cloud service.
-   * This is used by the cloud service to check that the request is being 
+   * This is used by the cloud service to check that the request is being
    * made from a origin matching those allowed by the resource key.
-   * For more detail, see the 'Request Headers' section in the 
+   * For more detail, see the 'Request Headers' section in the
    * <a href="https://cloud.51degrees.com/api-docs/index.html">cloud documentation</a>.
+   * @param options.requestClient
    */
   constructor (
     {
@@ -78,11 +72,10 @@ class CloudRequestEngine extends Engine {
 
     this.resourceKey = resourceKey;
     this.licenseKey = licenseKey;
-    this.cloudRequestOrigin = cloudRequestOrigin
+    this.cloudRequestOrigin = cloudRequestOrigin;
     if (requestClient !== undefined) {
       this.requestClient = requestClient;
-    }
-    else {
+    } else {
       this.requestClient = new RequestClient();
     }
 
@@ -170,49 +163,52 @@ class CloudRequestEngine extends Engine {
    * Typically, cloud will return errors as JSON.
    * However, transport level errors or other failures can result in
    * responses that are plain text. This function handles these cases.
-   * 
-   * @param {String} response the response data to process
+   *
+   * @param {string} response the response data to process
+   * @param responseBody
    * @returns {Array} The error messages
    */
-  getErrorMessages(responseBody){
+  getErrorMessages (responseBody) {
     let errors = [];
     try {
-      errors = JSON.parse(responseBody).errors;  
+      errors = JSON.parse(responseBody).errors;
     } catch (parseError) {
-      errors = [ 'Error parsing response - ' + responseBody ];
+      errors = ['Error parsing response - ' + responseBody];
     }
-    if(responseBody.length == 0) {
-      errors = [ 'No data in response from cloud service' ];
+    if (responseBody.length === 0) {
+      errors = ['No data in response from cloud service'];
     }
     return errors;
   }
 
   /**
    * Used to handle errors from http requests
+   *
+   * @param response
    */
-   getErrorsFromResponse(response) {    
+  getErrorsFromResponse (response) {
     let content = response;
-    if(response.content) {
+    if (response.content) {
       content = response.content;
     }
 
-    let errors = this.getErrorMessages(content); 
-    let cloudErrors = [];
-    errors.forEach(function(errorText) {
+    const errors = this.getErrorMessages(content);
+    const cloudErrors = [];
+    errors.forEach(function (errorText) {
       cloudErrors.push(new CloudRequestError(
-        errorText, 
-        response.headers, 
-        response.statusCode));           
+        errorText,
+        response.headers,
+        response.statusCode));
     });
 
-    if(cloudErrors.length == 0 &&
+    if (cloudErrors.length === 0 &&
       response.statusCode > 299) {
-        let message = 'Cloud service returned status code ' + 
+      const message = 'Cloud service returned status code ' +
           response.statusCode + ' with content ' + content + '.';
-        cloudErrors.push(new CloudRequestError(
-          message, 
-          response.headers, 
-          response.statusCode)); 
+      cloudErrors.push(new CloudRequestError(
+        message,
+        response.headers,
+        response.statusCode));
     }
 
     return cloudErrors;
@@ -238,29 +234,29 @@ class CloudRequestEngine extends Engine {
       }
 
       engine.requestClient.get(url, engine.cloudRequestOrigin)
-      .then(function (properties) {
-        const propertiesOutput = {};
+        .then(function (properties) {
+          const propertiesOutput = {};
 
-        properties = JSON.parse(properties);
+          properties = JSON.parse(properties);
 
-        const products = properties.Products;
+          const products = properties.Products;
 
-        for (const product in products) {
-          propertiesOutput[product] = engine.propertiesTransform(
-            products[product].Properties);
-        }
+          for (const product in products) {
+            propertiesOutput[product] = engine.propertiesTransform(
+              products[product].Properties);
+          }
 
-        engine.flowElementProperties = propertiesOutput;
-        resolve(propertiesOutput);
-      }).catch(function(response) {
-        reject(engine.getErrorsFromResponse(response));
-      });
+          engine.flowElementProperties = propertiesOutput;
+          resolve(propertiesOutput);
+        }).catch(function (response) {
+          reject(engine.getErrorsFromResponse(response));
+        });
     });
   }
 
-  propertiesTransform(properties) {
-    let result = {};
-    let self = this;
+  propertiesTransform (properties) {
+    const result = {};
+    const self = this;
     properties
       .forEach(function (property) {
         result[property
@@ -274,18 +270,18 @@ class CloudRequestEngine extends Engine {
               property[metaKey]);
         }
       });
-      return result;
+    return result;
   }
 
-  metaPropertyTransform(key, value) {
+  metaPropertyTransform (key, value) {
     switch (key) {
-      case "itemproperties":
+      case 'itemproperties':
         return this.propertiesTransform(value);
       default:
         return value;
-
     }
   }
+
   /**
    * Internal function to get data from cloud service
    *
@@ -308,11 +304,10 @@ class CloudRequestEngine extends Engine {
     const self = this;
 
     return new Promise(function (resolve, reject) {
-
       engine.requestClient.post(
-          url,
-          engine.getContent(flowData),
-          engine.cloudRequestOrigin)
+        url,
+        engine.getContent(flowData),
+        engine.cloudRequestOrigin)
         .then(function (body) {
           const data = new AspectDataDictionary({
             flowElement: engine,
@@ -325,8 +320,8 @@ class CloudRequestEngine extends Engine {
           flowData.setElementData(data);
 
           resolve();
-        }).catch(function(response) {
-          self.errors = engine.getErrorsFromResponse(response)
+        }).catch(function (response) {
+          self.errors = engine.getErrorsFromResponse(response);
           reject(self.errors);
         });
     });
@@ -342,79 +337,80 @@ class CloudRequestEngine extends Engine {
     const url = this.baseURL + 'evidencekeys';
     return new Promise(function (resolve, reject) {
       engine.requestClient.get(url, engine.cloudRequestOrigin)
-      .then(function (body) {
-        engine.evidenceKeyFilter = new BasicListEvidenceKeyFilter(
-          JSON.parse(body)
-        );
-
-        resolve();
-      }).catch(function(response) {
-        reject(engine.getErrorsFromResponse(response));
-      });
+        .then(function (body) {
+          engine.evidenceKeyFilter = new BasicListEvidenceKeyFilter(
+            JSON.parse(body)
+          );
+
+          resolve();
+        }).catch(function (response) {
+          reject(engine.getErrorsFromResponse(response));
+        });
     });
   }
 
   /**
    * Generate the Content to send in the POST request. The evidence keys
    * e.g. 'query.' and 'header.' have an order of precedence. These are
-   * added to the evidence in reverse order, if there is conflict then 
-   * the queryData value is overwritten. 
+   * added to the evidence in reverse order, if there is conflict then
+   * the queryData value is overwritten.
    * 'query.' evidence should take precedence over all other evidence.
    * If there are evidence keys other than 'query.' that conflict then
    * this is unexpected so a warning will be logged.
+   *
    * @param {FlowData} flowData
    * @returns {Evidence} Evidence Dictionary
    */
-  getContent(flowData) {
-    let queryData = {};
+  getContent (flowData) {
+    const queryData = {};
 
     const evidence = flowData.evidence.getAll();
 
-    // Add evidence in reverse alphabetical order, excluding special keys. 
-    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, "other"));
+    // Add evidence in reverse alphabetical order, excluding special keys.
+    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, 'other'));
     // Add cookie evidence.
-    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, "cookie"));
+    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, 'cookie'));
     // Add header evidence.
-    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, "header"));
+    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, 'header'));
     // Add query evidence.
-    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, "query"));
+    this.addQueryData(flowData, queryData, evidence, this.getSelectedEvidence(evidence, 'query'));
 
     return queryData;
   }
 
   /**
    * Add query data to the evidence.
+   *
+   * @param flowData
    * @param {object} queryData The destination dictionary to add query data to.
    * @param {Evidence} allEvidence All evidence in the flow data. This is used to
    * report which evidence keys are conflicting.
    * @param {object} evidence Evidence to add to the query Data.
    */
-  addQueryData(flowData, queryData, allEvidence, evidence) {
-
+  addQueryData (flowData, queryData, allEvidence, evidence) {
     for (const [evidenceKey, evidenceValue] of Object.entries(evidence)) {
       // Get the key parts
-      const evidenceKeyParts = evidenceKey.split('.')
-      const prefix = evidenceKeyParts[0]
+      const evidenceKeyParts = evidenceKey.split('.');
+      const prefix = evidenceKeyParts[0];
       const suffix = evidenceKeyParts[1];
 
       // Check and add the evidence to the query parameters.
-      if ((suffix in queryData) == false) {
-        queryData[suffix] = evidenceValue
-      }
-      else {
+      if ((suffix in queryData) === false) {
+        queryData[suffix] = evidenceValue;
+      } else {
         // If the queryParameter exists already.
-        // Get the conflicting pieces of evidence and then log a 
+        // Get the conflicting pieces of evidence and then log a
         // warning, if the evidence prefix is not query. Otherwise a
-        // warning is not needed as query evidence is expected 
+        // warning is not needed as query evidence is expected
         // to overwrite any existing evidence with the same suffix.
-        if (prefix !== "query") {
-          let conflicts = {}
+        if (prefix !== 'query') {
+          const conflicts = {};
           for (const [key, value] of Object.entries(allEvidence)) {
             if (key !== evidenceKey && key.includes(suffix)) {
-              conflicts[key] = value
+              conflicts[key] = value;
             }
           }
-          
+
           let conflictStr = '';
           for (const [key, value] of Object.entries(conflicts)) {
             if (conflictStr.length > 0) {
@@ -422,8 +418,8 @@ class CloudRequestEngine extends Engine {
             }
             conflictStr += util.format('%s:%s', key, value);
           }
-          
-          let warningMessage = util.format(
+
+          const warningMessage = util.format(
             errorMessages.evidenceConflict,
             evidenceKey,
             evidenceValue,
@@ -431,53 +427,54 @@ class CloudRequestEngine extends Engine {
           flowData.pipeline.log('warn', warningMessage);
         }
         // Overwrite the existing queryParameter value.
-        queryData[suffix] = evidenceValue
+        queryData[suffix] = evidenceValue;
       }
     }
   }
 
   /**
    * Get evidence with specified prefix.
+   *
    * @param {Evidence} evidence All evidence in the flow data.
    * @param {stirng} type Required evidence key prefix
    */
-  getSelectedEvidence(evidence, type) {
-    let selectedEvidence = {}
-
-    if (type === "other") {
-        for (const [key, value] of Object.entries(evidence)) {
-          if (this.hasKeyPrefix(key, "query") === false &&
-            this.hasKeyPrefix(key, "header") === false &&
-            this.hasKeyPrefix(key, "cookie") === false ) {
-              selectedEvidence[key] = value
-            }
+  getSelectedEvidence (evidence, type) {
+    let selectedEvidence = {};
+
+    if (type === 'other') {
+      for (const [key, value] of Object.entries(evidence)) {
+        if (this.hasKeyPrefix(key, 'query') === false &&
+            this.hasKeyPrefix(key, 'header') === false &&
+            this.hasKeyPrefix(key, 'cookie') === false) {
+          selectedEvidence[key] = value;
         }
-        selectedEvidence = Object.keys(selectedEvidence).sort().reverse().reduce(
-          (obj, key) => { 
-            obj[key] = selectedEvidence[key]; 
-            return obj;
-          }, 
-          {}
-        );
-    }
-    else {
+      }
+      selectedEvidence = Object.keys(selectedEvidence).sort().reverse().reduce(
+        (obj, key) => {
+          obj[key] = selectedEvidence[key];
+          return obj;
+        },
+        {}
+      );
+    } else {
       for (const [key, value] of Object.entries(evidence)) {
         if (this.hasKeyPrefix(key, type)) {
-          selectedEvidence[key] = value
+          selectedEvidence[key] = value;
         }
       }
     }
-    return selectedEvidence
+    return selectedEvidence;
   }
-  
+
   /**
    * Check that the key of a KeyValuePair has the given prefix.
+   *
    * @param {string} itemKey Key to check
    * @param {string} prefix The prefix to check for.
    * @returns True if the key has the prefix.
    */
-  hasKeyPrefix(itemKey, prefix) {
-    return itemKey.startsWith(prefix + '.')
+  hasKeyPrefix (itemKey, prefix) {
+    return itemKey.startsWith(prefix + '.');
   }
 }
 

package/cloudRequestError.js

@@ -21,17 +21,17 @@
  * ********************************************************************* */
 
 class CloudRequestError extends Error {
-  constructor(message, responseHeaders, httpStatusCode){
-      super(message);
-      this.name = this.constructor.name
-	  this.errorMessage = message;
-      this.responseHeaders = responseHeaders;
-      this.httpStatusCode = httpStatusCode;
-      // This clips the constructor invocation from the stack trace.
-      // It's not absolutely essential, but it does make the stack 
-      // trace a little nicer.
-      Error.captureStackTrace(this, this.constructor);
+  constructor (message, responseHeaders, httpStatusCode) {
+    super(message);
+    this.name = this.constructor.name;
+    this.errorMessage = message;
+    this.responseHeaders = responseHeaders;
+    this.httpStatusCode = httpStatusCode;
+    // This clips the constructor invocation from the stack trace.
+    // It's not absolutely essential, but it does make the stack
+    // trace a little nicer.
+    Error.captureStackTrace(this, this.constructor);
   }
 }
 
-module.exports = CloudRequestError;
+module.exports = CloudRequestError;

package/errorMessages.js

@@ -21,6 +21,6 @@
  * ********************************************************************* */
 
 module.exports = {
-    // warning message to be shown for conflicted evidences
-    evidenceConflict: "WARNING: '%s:%s' evidence conflicts with %s"
-}
+  // warning message to be shown for conflicted evidences
+  evidenceConflict: "WARNING: '%s:%s' evidence conflicts with %s"
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.cloudrequestengine",
-  "version": "4.4.7",
+  "version": "4.4.9",
   "description": "Cloud request engine for the 51Degrees Pipeline API",
   "main": "index.js",
   "directories": {
@@ -13,15 +13,15 @@
   "devDependencies": {
     "eslint": "^6.8.0",
     "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "jest": "^27.0.6"
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-standard": "^4.1.0",
+    "jest": "^27.5.1"
   },
   "dependencies": {
-    "fiftyone.pipeline.core": "^4.4.7",
-    "fiftyone.pipeline.engines": "^4.4.7"
+    "fiftyone.pipeline.core": "^4.4.8",
+    "fiftyone.pipeline.engines": "^4.4.8"
   },
   "contributors": [
     "Filip Hnízdo <filip@octophin.com> (https://octophindigital.com/)",