@itentialopensource/adapter-utils 5.3.5 → 5.3.6

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+## 5.3.6 [02-07-2024]
+
+* Add checks for pagination fields
+
+Closes ADAPT-3024
+
+See merge request itentialopensource/adapter-utils!287
+
+---
+
 ## 5.3.5 [01-31-2024]
 
 * Handle integers in extractKeysFromBraces

package/lib/brokerHandler.js

@@ -21,6 +21,7 @@ function getDeviceBrokerArray(allProps) {
   log.trace(origin);
   const brokerCallsArr = ['getDevice', 'getDevicesFiltered', 'isAlive', 'getConfig', 'getCount'];
   const deviceBrokerProps = allProps.devicebroker;
+  let useSampleProps = false;
 
   try {
     const sampleFile = path.join(adapterDir, '/sampleProperties.json');
@@ -39,6 +40,7 @@ function getDeviceBrokerArray(allProps) {
           log.info(`No device broker props found for ${brokerCallsArr[i]}`);
           deviceBrokerProps[brokerCallsArr[i]] = [];
         } else {
+          useSampleProps = true;
           // use the sample properties information
           log.info(`Updating device broker props for ${brokerCallsArr[i]} from sample props`);
           deviceBrokerProps[brokerCallsArr[i]] = sampleProps.devicebroker[brokerCallsArr[i]];
@@ -46,6 +48,15 @@ function getDeviceBrokerArray(allProps) {
       }
     }
 
+    // If sample properties doesn't have enabled flag, set it to false
+    if (useSampleProps) {
+      if (sampleProps.devicebroker.enabled === true) {
+        deviceBrokerProps.enabled = sampleProps.devicebroker.enabled;
+      } else {
+        deviceBrokerProps.enabled = false;
+      }
+    }
+
     log.debug('Device broker array', JSON.stringify(deviceBrokerProps, null, 3));
     return deviceBrokerProps;
   } catch (ex) {
@@ -206,6 +217,13 @@ class BrokerHandler {
     const origin = `${this.myid}-${meth}`;
     log.trace(origin);
 
+    // verify if enabled is set to true in properties, if it doesn't exist assume it's true
+    if (this.allProps.devicebroker.enabled === false) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Device broker is not enabled in deviceBroker properties', null, null, null, null);
+      log.info(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // make sure we are set up for device broker getDevice
     if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevice || this.allProps.devicebroker.getDevice.length === 0 || !this.allProps.devicebroker.getDevice[0].path) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Missing Properties devicebroker.getDevice.path', null, null, null, null);
@@ -293,11 +311,21 @@ class BrokerHandler {
    * @param {getCallback} callback - a callback function to return the result
    *                                 (appliances) or the error
    */
-  getDevicesFiltered(options, callOptions, callback) {
+  getDevicesFiltered(options, callupdatedOptions, callback) {
     const meth = 'brokerHandler-getDevicesFiltered';
     const origin = `${this.myid}-${meth}`;
     log.trace(origin);
 
+    // If no options are passed set to an empty object
+    const updatedOptions = options || {};
+
+    // verify if enabled is set to true in properties, if it doesn't exist assume it's true
+    if (this.allProps.devicebroker.enabled === false) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Device broker is not enabled in deviceBroker properties', null, null, null, null);
+      log.info(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // make sure we are set up for device broker getDevicesFiltered
     if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevicesFiltered || this.allProps.devicebroker.getDevicesFiltered.length === 0 || !this.allProps.devicebroker.getDevicesFiltered[0].path) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Missing Properties devicebroker.getDevicesFiltered.path', null, null, null);
@@ -305,33 +333,27 @@ class BrokerHandler {
       return callback(null, errorObj);
     }
 
-    // verify the required fields have been provided
-    if (options === undefined || options === null || options === '' || options.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Missing Data', ['options'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
+    log.debug(`Device Filter updatedOptions: ${JSON.stringify(updatedOptions)}`);
 
-    if (!(options.start === undefined || options.start === null) && (options.limit === undefined || options.limit === null)) {
+    if (!(updatedOptions.start === undefined || updatedOptions.start === null) && (updatedOptions.limit === undefined || updatedOptions.limit === null)) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Cannot specify start without limit.', null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
-    if ((options.start === undefined || options.start === null) && !(options.limit === undefined || options.limit === null)) {
+    if ((updatedOptions.start === undefined || updatedOptions.start === null) && !(updatedOptions.limit === undefined || updatedOptions.limit === null)) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Cannot specify limit without start.', null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
-    if (typeof options.start === 'string' || typeof options.limit === 'string') {
+    if (typeof updatedOptions.start === 'string' || typeof updatedOptions.limit === 'string') {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Start and Limit must be numbers.', null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
-    if (options.start < 0 || options.limit <= 0) {
+    if (updatedOptions.start < 0 || updatedOptions.limit <= 0) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Limit and/or Start value is too low.', null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
@@ -351,7 +373,7 @@ class BrokerHandler {
         if (res) {
           entityTypeCached = true;
           // Retrieve devices from cache
-          return this.requestHandlerInst.retrieveEntitiesCache('Device', options, (callRet, callErr) => {
+          return this.requestHandlerInst.retrieveEntitiesCache('Device', updatedOptions, (callRet, callErr) => {
             if (callErr) {
               log.error(callErr);
               const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, callErr, null, null, null);
@@ -369,18 +391,18 @@ class BrokerHandler {
     }
 
     try {
-      // const nextToken = options.start;
-      // const maxResults = options.limit;
+      // const nextToken = updatedOptions.start;
+      // const maxResults = updatedOptions.limit;
 
       // set up the filter of Device Names
       let filterName = [];
-      if (options && options.filter && options.filter.name) {
+      if (updatedOptions && updatedOptions.filter && updatedOptions.filter.name) {
         // when this hack is removed, remove the lint ignore above
-        if (Array.isArray(options.filter.name)) {
+        if (Array.isArray(updatedOptions.filter.name)) {
           // eslint-disable-next-line prefer-destructuring
-          filterName = options.filter.name;
+          filterName = updatedOptions.filter.name;
         } else {
-          filterName = [options.filter.name];
+          filterName = [updatedOptions.filter.name];
         }
       }
 
@@ -390,11 +412,11 @@ class BrokerHandler {
         const callProps = this.allProps.devicebroker.getDevicesFiltered[i];
         callProps.headers = {
           ...(callProps.headers || {}),
-          ...(callOptions.headers || {})
+          ...(callupdatedOptions.headers || {})
         };
         callPromises.push(
           new Promise((resolve, reject) => {
-            this.requestHandlerInst.iapMakeGenericCall(callOptions, 'getDevicesFiltered', callProps, [{ fake: 'fakedata' }], filterName, (callRet, callErr) => {
+            this.requestHandlerInst.iapMakeGenericCall(callupdatedOptions, 'getDevicesFiltered', callProps, [{ fake: 'fakedata' }], filterName, (callRet, callErr) => {
               // return an error
               if (callErr) {
                 console.debug(`in cache iap call failed with error ${callErr}`);
@@ -420,7 +442,7 @@ class BrokerHandler {
         });
 
         // sort by name property
-        if (options && options.sort) {
+        if (updatedOptions && updatedOptions.sort) {
           myResult.sort((a, b) => {
             if (a.name > b.name) {
               return 1;
@@ -433,14 +455,14 @@ class BrokerHandler {
         }
 
         // pagination: get entities limit*start to limit*(start+1) - 1
-        if (myResult.length !== 0 && options && options.start >= 0 && options.limit > 0) {
-          const end = Math.min(myResult.length, options.limit * (options.start + 1));
-          if (options.limit * options.start >= end) {
+        if (myResult.length !== 0 && updatedOptions && updatedOptions.start >= 0 && updatedOptions.limit > 0) {
+          const end = Math.min(myResult.length, updatedOptions.limit * (updatedOptions.start + 1));
+          if (updatedOptions.limit * updatedOptions.start >= end) {
             const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Page number too large for limit size.', null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
             return callback(null, errorObj);
           }
-          myResult = myResult.slice(options.limit * options.start, end);
+          myResult = myResult.slice(updatedOptions.limit * updatedOptions.start, end);
         }
         log.debug(`${origin}: Found #${myResult.length} devices.`);
         log.debug(`Devices: ${JSON.stringify(myResult)}`);
@@ -471,6 +493,13 @@ class BrokerHandler {
     const origin = `${this.myid}-${meth}`;
     log.trace(origin);
 
+    // verify if enabled is set to true in properties, if it doesn't exist assume it's true
+    if (this.allProps.devicebroker.enabled === false) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Device broker is not enabled in deviceBroker properties', null, null, null, null);
+      log.info(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // make sure we are set up for device broker isAlive
     if (!this.allProps.devicebroker || !this.allProps.devicebroker.isAlive || this.allProps.devicebroker.isAlive.length === 0 || !this.allProps.devicebroker.isAlive[0].path) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Missing Properties devicebroker.isAlive.path', null, null, null);
@@ -567,6 +596,13 @@ class BrokerHandler {
     const origin = `${this.myid}-${meth}`;
     log.trace(origin);
 
+    // verify if enabled is set to true in properties, if it doesn't exist assume it's true
+    if (this.allProps.devicebroker.enabled === false) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Device broker is not enabled in deviceBroker properties', null, null, null, null);
+      log.info(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // make sure we are set up for device broker getConfig
     if (!this.allProps.devicebroker || !this.allProps.devicebroker.getConfig || this.allProps.devicebroker.getConfig.length === 0 || !this.allProps.devicebroker.getConfig[0].path) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Missing Properties devicebroker.getConfig.path', null, null, null);
@@ -667,6 +703,13 @@ class BrokerHandler {
     const origin = `${this.myid}-${meth}`;
     log.trace(origin);
 
+    // verify if enabled is set to true in properties, if it doesn't exist assume it's true
+    if (this.allProps.devicebroker.enabled === false) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Device broker is not enabled in deviceBroker properties', null, null, null, null);
+      log.info(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // if caching get data from the cache
     if (this.allProps.cache.enabled) { // a bit redundant but just in case errors in cacheHandler
       let entityTypeCached = false;

package/lib/genericHandler.js

@@ -227,7 +227,7 @@ class GenericHandler {
       }
 
       // Does not support AWS adapters due to the auth call above
-      if (metadata && metadata.pagination) {
+      if (metadata && metadata.pagination && metadata.pagination.requestLocation && metadata.pagination.limitVar && metadata.pagination.offsetVar && metadata.pagination.incrementBy) {
         return this.expandedGenericAdapterRequestPaginated(metadata.pagination, action, reqObj, returnF, meth, (returnData, returnError) => {
           if (returnError) {
             /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "5.3.5",
+  "version": "5.3.6",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",