fiftyone.pipeline.cloudrequestengine 4.4.54 → 4.4.56

package/cloudEngine.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const engines = require('fiftyone.pipeline.engines');
@@ -38,55 +38,61 @@ class CloudEngine extends Engine {
   constructor () {
     super(...arguments);
 
-    this.dataKey = 'CloudEngineBase'; // This should be overriden
+    this.dataKey = 'CloudEngineBase'; // This should be overridden
 
-    const engine = this;
-
-    this.registrationCallbacks.push(function (pipeline, flowElement) {
-      const cloudRequestEngine = pipeline.flowElements.cloud;
-
-      if (!cloudRequestEngine) {
-        pipeline.log('error', 'No CloudRequestEngine in Pipeline');
-      }
+    this.registrationCallbacks.push((pipeline, flowElement) => {
+      this.handlePipelineRegistration(pipeline, flowElement);
+    });
+  }
 
-      cloudRequestEngine.ready().then(function () {
-        flowElement.properties = cloudRequestEngine.flowElementProperties[flowElement.dataKey];
-        engine.updateProperties();
-        flowElement.evidenceKeyFilter = new BasicListEvidenceKeyFilter(cloudRequestEngine.evidenceKeys);
-        engine.initialised = true;
-      }).catch(function (error) {
-        // throw error;
+  /**
+   * Handles the registration of the Cloud Engine in a pipeline.
+   * This method is called when a pipeline is registered,
+   * and it ensures that the CloudRequestEngine is present in the pipeline.
+   *
+   * @param {Pipeline} pipeline - The pipeline being registered.
+   * @param {FlowElement} flowElement - The flow element associated with the Cloud Engine.
+   */
+  handlePipelineRegistration (pipeline, flowElement) {
+    if (!pipeline.flowElements.cloud) {
+      pipeline.log('error', 'No CloudRequestEngine in Pipeline');
+    }
 
-        engine.errors = error;
+    this._cloudRequestEngine = pipeline.flowElements.cloud;
+    this._flowElement = flowElement;
+  }
 
-        engine.initialised = false;
+  /**
+   * Updates the Cloud Engine when the CloudRequestEngine is ready.
+   * This method fetches properties and evidence keys from the CloudRequestEngine,
+   * updating the Cloud Engine accordingly.
+   *
+   * @param {Function} resolve - Callback to be called on successful completion.
+   * @param {Function} reject - Callback to be called if there is an error.
+   */
+  updateEngineWhenCloudRequestEngineReady (resolve, reject) {
+    this._cloudRequestEngine.ready()
+      .then(() => {
+        this._flowElement.properties = this._cloudRequestEngine.flowElementProperties[this._flowElement.dataKey];
+        this.updateProperties();
+        this._flowElement.evidenceKeyFilter = new BasicListEvidenceKeyFilter(this._cloudRequestEngine.evidenceKeys);
+        resolve(this);
+      })
+      .catch((error) => {
+        this.errors = error;
+        reject(this.errors);
       });
-    });
   }
 
   /**
-   * Function for testing if the cloud engine is ready
-   * Checks to see if properties and evidence keys have been fetched
+   * Checks if the Cloud Engine is ready.
+   * This method returns a Promise that resolves if the CloudRequestEngine is ready,
+   * indicating that properties and evidence keys have been successfully fetched.
    *
-   * @returns {Promise} whether ready
+   * @returns {Promise} A Promise that resolves if the CloudRequestEngine is ready and rejects if there is an error.
    */
   ready () {
-    const self = this;
-    return new Promise(function (resolve, reject) {
-      if (self.initialised === true) {
-        resolve(self);
-      } else {
-        const readyCheck = setInterval(function () {
-          if (self.initialised === true) {
-            clearInterval(readyCheck);
-            resolve(self);
-          } else if (self.initialised === false) {
-            clearInterval(readyCheck);
-            reject(self.errors);
-          }
-        });
-      }
-    });
+    return new Promise((resolve, reject) => this.updateEngineWhenCloudRequestEngineReady(resolve, reject));
   }
 
   /**

package/cloudRequestEngine.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const util = require('util');
@@ -97,25 +97,47 @@ class CloudRequestEngine extends Engine {
 
     // Properties of connected FlowElements
     this.flowElementProperties = {};
+  }
 
-    const self = this;
+  /**
+   * Check if the keys and properties have been fetched.
+   *
+   * This computed property determines whether the keys of a 'flowElementProperties' object and the 'evidenceKeyFilter'
+   * array both have elements, indicating that the necessary data has been fetched and is ready for use.
+   *
+   * @returns {boolean} True if the keys and properties are fetched and ready; otherwise, false.
+   */
+  get keysAndPropertiesFetched () {
+    return Object.keys(this.flowElementProperties).length > 0 && this.evidenceKeyFilter.length > 0;
+  }
 
+  /**
+   * Fetches evidence keys and properties data.
+   *
+   * This method asynchronously fetches evidence keys and properties required for the operation.
+   * It uses Promises to handle data retrieval and provides callback functions for success and failure scenarios.
+   *
+   * @param {Function} resolveCallback - A callback function to be called when the data is successfully fetched.
+   * It will receive the current instance as a parameter.
+   *
+   * @param {Function} rejectCallback - A callback function to be called when an error occurs during data retrieval.
+   * It will receive the error information as a parameter.
+   */
+  fetchEvidenceKeysAndProperties (resolveCallback, rejectCallback) {
+    const self = this;
     Promise.all([this.getEvidenceKeys(), this.fetchProperties()]).then(function () {
-      self.initialised = true;
+      resolveCallback(self);
     }).catch(function (errors) {
-      self.initialised = false;
-
       self.errors = errors;
-
       if (self.pipelines) {
         // Log error on all pipelines engine is attached to
-
         self.pipelines.map(function (pipeline) {
           pipeline.log('error', {
             source: 'CloudRequestEngine',
             message: self.errors
           });
         });
+        rejectCallback(self.errors);
       }
     });
   }
@@ -129,20 +151,10 @@ class CloudRequestEngine extends Engine {
   ready () {
     const self = this;
     return new Promise(function (resolve, reject) {
-      if (self.initialised === true) {
+      if (self.keysAndPropertiesFetched) {
         resolve(self);
-      } else if (self.initialised === false) {
-        reject(self.errors);
       } else {
-        const readyCheck = setInterval(function () {
-          if (self.initialised === true) {
-            clearInterval(readyCheck);
-            resolve(self);
-          } else if (self.initialised === false) {
-            reject(self.errors);
-            clearInterval(readyCheck);
-          }
-        });
+        self.fetchEvidenceKeysAndProperties(resolve, reject);
       }
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.cloudrequestengine",
-  "version": "4.4.54",
+  "version": "4.4.56",
   "description": "Cloud request engine for the 51Degrees Pipeline API",
   "main": "index.js",
   "directories": {

package/tests/cloudResponse.test.js

@@ -21,6 +21,7 @@
  * ********************************************************************* */
 
 const path = require('path');
+const http = require('http');
 const MockRequestClient = require('./classes/mockRequestClient');
 const CloudRequestEngine = require('../cloudRequestEngine');
 const CloudRequestError = require('../cloudRequestError');
@@ -41,7 +42,7 @@ const testResourceKey = 'AAAAAAAAAAAA';
  * Test cloud request engine adds correct information to post request
  * and returns the response in the ElementData
  */
-test('process', done => {
+test('process', done => {
   const jsonResponse = { device: { value: 51 } };
   const client = new MockRequestClient({ json: jsonResponse });
   const engine = new CloudRequestEngine({
@@ -130,7 +131,7 @@ test('sub properties', () => {
     expect(Object.entries(devicesProperties).length).toBe(1);
     propertiesContainName(devicesProperties.devices.itemproperties, 'IsMobile');
     propertiesContainName(devicesProperties.devices.itemproperties, 'IsTablet');
-  });
+  });
 });
 
 /**
@@ -155,11 +156,69 @@ test('validate error handling JSON errors', async () => {
   await expect(e()).rejects.toEqual([new CloudRequestError(errorMessage)]);
 });
 
-/**
- *
- * @param properties
- * @param name
- */
+/**
+ * Test cloud request engine handles unavailability of cloud service
+ * as expected.
+ * An exception should be thrown by the cloud request engine
+ * containing the errors from the cloud service in the JSON object.
+ */
+
+test('validate case when cloud unavailable', (done) => {
+  const SERVER_PORT = 3000;
+  const errorMessage = 'Cloud server internal error';
+
+  const server = http.createServer((req, res) => {
+    const client = new MockRequestClient({
+      resourceKey: 'resourceKey',
+      error: '{ "status":"500", "errors": ["' + errorMessage + '"] }'
+    });
+
+    const requestEngine = new CloudRequestEngine({
+      resourceKey: testResourceKey,
+      requestClient: client
+    });
+
+    requestEngine.ready().then(engine => {
+      res.statusCode = 200;
+      res.setHeader('Content-Type', 'application/json');
+      res.end(JSON.stringify(engine.device));
+    }).catch(error => {
+      res.statusCode = 200;
+      res.setHeader('Content-Type', 'application/json');
+      res.end(JSON.stringify(error));
+    });
+  }).listen(SERVER_PORT, () => {
+    const options = {
+      hostname: 'localhost',
+      port: SERVER_PORT,
+      path: '/',
+      method: 'GET'
+    };
+
+    const req = http.request(options, (res) => {
+      let response = '';
+
+      res.on('data', (chunk) => {
+        response += chunk;
+      });
+
+      res.on('end', () => {
+        const error = JSON.parse(response)[0];
+        expect(error.errorMessage).toBe(errorMessage);
+        expect(error.name).toBe('CloudRequestError');
+        server.close(); // Close the server after the request is complete.
+        done();
+      });
+    });
+    req.end();
+  });
+});
+
+/**
+ *
+ * @param properties
+ * @param name
+ */
 function propertiesContainName (properties, name) {
   expect(properties[name.toLowerCase()]).not.toBeUndefined();
   expect(properties[name.toLowerCase()]).not.toBeNull();