@itentialopensource/adapter-utils 4.48.15 → 4.49.0

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 
+## 4.49.0 [05-15-2023]
+
+* Resolve ADAPT-2362 - Adapter Inventory from Utils Perspective (still more in AdapterBase)
+
+Closes ADAPT-2362
+
+See merge request itentialopensource/adapter-utils!257
+
+---
+
+## 4.48.16 [05-10-2023]
+
+* Fix issue of instantiating AJV, also mock data fix for generic call
+
+Closes ADAPT-2511
+
+See merge request itentialopensource/adapter-utils!243
+
+---
+
 ## 4.48.15 [05-09-2023]
 
 * Add healthcheck headers to adapter properties

package/lib/connectorRest.js

@@ -451,6 +451,13 @@ function returnStub(request, entitySchema, callProperties) {
     const uriArray = uriTemp[0].split('/');
     const actArray = actTemp[0].split('/');
 
+    // if this is one of the generic requests need to pad the actual array or mock data for specific path variable will not work
+    if (entitySchema.entitypath.indexOf('/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}') >= 0) {
+      for (let e = actArray.length; e < uriArray.length; e += 1) {
+        actArray.push('');
+      }
+    }
+
     // the number of items in both should be the same
     if (uriArray.length === actArray.length) {
       for (let i = 0; i < uriArray.length; i += 1) {

package/lib/propertyUtil.js

@@ -442,7 +442,7 @@ class AdapterPropertyUtil {
         // add the specific pieces of the error object
         errorObj.type = 'Missing Data';
         errorObj.vars = ['Entity'];
-        log.error(`${origin}: Entity is required to get entity schema for action`);
+        log.debug(`${origin}: Entity is required to get entity schema for action`);
         errorObj.error = [`${origin}: Entity is required to get entity schema for action`];
         return callback(null, errorObj);
       }
@@ -453,7 +453,7 @@ class AdapterPropertyUtil {
 
         // log (if not system entity) and return the error
         if (entityName !== '.system') {
-          log.error(`${origin}: Action is required to get entity schema for action`);
+          log.debug(`${origin}: Action is required to get entity schema for action`);
           errorObj.error = [`${origin}: Action is required to get entity schema for action`];
         }
         return callback(null, errorObj);
@@ -476,7 +476,7 @@ class AdapterPropertyUtil {
           // add the specific pieces of the error object
           errorObj.type = 'Database Error';
           errorObj.vars = ['dbError'];
-          log.error(`${origin}: Database Error: ${dbError}`);
+          log.debug(`${origin}: Database Error: ${dbError}`);
           errorObj.error = [`${origin}: Database Error: ${dbError}`];
           return callback(null, errorObj);
         }
@@ -484,7 +484,7 @@ class AdapterPropertyUtil {
           // add the specific pieces of the error object
           errorObj.type = 'Missing Data';
           errorObj.vars = ['Entity'];
-          log.error(`${origin}: Entity was not found in the database`);
+          log.debug(`${origin}: Entity was not found in the database`);
           errorObj.error = [`${origin}: Entity was not found in the database`];
           return callback(null, errorObj);
         }
@@ -500,7 +500,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Invalid entity action file, please verify file: ${entityName}`);
+            log.warn(`${origin}: Invalid entity action file, please verify file: ${entityName}`);
             errorObj.error = [`${origin}: Invalid entity action file, please verify file: ${entityName}`];
           }
           return callback(null, errorObj);
@@ -512,7 +512,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Invalid action file syntax ${entityName} - must contain an array of actions`);
+            log.warn(`${origin}: Invalid action file syntax ${entityName} - must contain an array of actions`);
             errorObj.error = [`${origin}: Invalid action file syntax ${entityName} - must contain an array of actions`];
           }
           return callback(null, errorObj);
@@ -535,7 +535,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Entity ${entityName} - action file missing action: ${actionName}`);
+            log.warn(`${origin}: Entity ${entityName} - action file missing action: ${actionName}`);
             errorObj.error = [`${origin}: Entity ${entityName} - action file missing action: ${actionName}`];
           }
           return callback(null, errorObj);
@@ -549,7 +549,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Entity ${entityName} action ${actionName} - missing protocol`);
+            log.warn(`${origin}: Entity ${entityName} action ${actionName} - missing protocol`);
             errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing protocol`];
           }
           return callback(null, errorObj);
@@ -561,7 +561,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Entity ${entityName} action ${actionName} - missing method`);
+            log.warn(`${origin}: Entity ${entityName} action ${actionName} - missing method`);
             errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing method`];
           }
           return callback(null, errorObj);
@@ -573,7 +573,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
+            log.warn(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
             errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing entity path`];
           }
           return callback(null, errorObj);
@@ -585,7 +585,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Entity ${entityName} action ${actionName} - missing schema`);
+            log.warn(`${origin}: Entity ${entityName} action ${actionName} - missing schema`);
             errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing schema`];
           }
           return callback(null, errorObj);
@@ -611,7 +611,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Invalid schema file syntax ${reqSchemaName} - must contain an array of schemas`);
+            log.warn(`${origin}: Invalid schema file syntax ${reqSchemaName} - must contain an array of schemas`);
             errorObj.error = [`${origin}: Invalid schema file syntax ${reqSchemaName} - must contain an array of schemas`];
           }
           return callback(null, errorObj);
@@ -638,7 +638,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Could not find file - ${reqSchemaName}`);
+            log.warn(`${origin}: Could not find file - ${reqSchemaName}`);
             errorObj.error = [`${origin}: Could not find file - ${reqSchemaName}`];
           }
           return callback(null, errorObj);
@@ -652,7 +652,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Could not find file - ${respSchemaName}`);
+            log.warn(`${origin}: Could not find file - ${respSchemaName}`);
             errorObj.error = [`${origin}: Could not find file - ${respSchemaName}`];
           }
           return callback(null, errorObj);
@@ -666,7 +666,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Invalid entity request schema, please verify file: ${reqSchemaInfo}`);
+            log.warn(`${origin}: Invalid entity request schema, please verify file: ${reqSchemaInfo}`);
             errorObj.error = [`${origin}: Invalid entity request schema, please verify file: ${reqSchemaInfo}`];
           }
           return callback(null, errorObj);
@@ -678,7 +678,7 @@ class AdapterPropertyUtil {
 
           // log (if not system entity) and return the error
           if (entityName !== '.system') {
-            log.error(`${origin}: Invalid entity response schema, please verify file: ${respSchemaInfo}`);
+            log.warn(`${origin}: Invalid entity response schema, please verify file: ${respSchemaInfo}`);
             errorObj.error = [`${origin}: Invalid entity response schema, please verify file: ${respSchemaInfo}`];
           }
           return callback(null, errorObj);
@@ -720,7 +720,7 @@ class AdapterPropertyUtil {
 
             // log (if not system entity) and return the error
             if (entityName !== '.system') {
-              log.error(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
+              log.warn(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
               errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing entity path`];
             }
             return callback(null, errorObj);

package/lib/requestHandler.js

@@ -1175,6 +1175,103 @@ class RequestHandler {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @summary provide inventory information abbout the adapter
+   *
+   * @function getAdapterInventory
+   *
+   * @return {Object} - containing the adapter inventory information
+   */
+  getAdapterInventory(callback) {
+    const origin = `${this.myid}-requestHandler-getAdapterInventory`;
+    log.trace(origin);
+
+    try {
+      const adapterInv = {
+        issues: {}
+      };
+
+      // are the utils within the adapter
+      if (__dirname.indexOf(this.directory) === 0) {
+        adapterInv.issues.embedUtils = true;
+      } else {
+        adapterInv.issues.embedUtils = false;
+      }
+
+      // get the adapter package.json
+      if (fs.existsSync(path.join(this.directory, 'package.json'))) {
+        const adaptPackage = require(path.join(this.directory, 'package.json'));
+
+        // Namespace - package & directory
+        const [tempNS, tempName] = adaptPackage.name.split('/');
+        adapterInv.namespace = tempNS;
+        if (this.directory.indexOf(adapterInv.namespace) > 0) {
+          adapterInv.issues.inNamespace = true;
+        } else {
+          adapterInv.issues.inNamespace = false;
+        }
+
+        // Name - package & directory
+        adapterInv.name = tempName;
+        if (this.directory.indexOf(adapterInv.name) > 0) {
+          adapterInv.issues.inName = true;
+        } else {
+          adapterInv.issues.inName = false;
+        }
+
+        // Version - package
+        adapterInv.version = adaptPackage.version;
+      } else {
+        adapterInv.namespace = 'TBD';
+        adapterInv.issues.inNamespace = false;
+        adapterInv.name = 'TBD';
+        adapterInv.issues.inName = false;
+        adapterInv.version = 'TBD';
+      }
+
+      // get the adapter pronghorn.json
+      adapterInv.brokerDefined = false;
+      adapterInv.cacheDefined = false;
+      if (fs.existsSync(path.join(this.directory, 'pronghorn.json'))) {
+        const adaptPronghorn = require(path.join(this.directory, 'pronghorn.json'));
+
+        // Active WF Tasks - pronghorn.json
+        let wfCount = 0;
+        for (let i = 0; i < adaptPronghorn.methods.length; i += 1) {
+          if (adaptPronghorn.methods[i].task === true) {
+            wfCount += 1;
+          }
+          if (adaptPronghorn.methods[i].name === 'getDevicesFiltered') {
+            adapterInv.brokerDefined = true;
+          }
+          if (adaptPronghorn.methods[i].name === 'iapUpdateAdapterCache') {
+            adapterInv.cacheDefined = true;
+          }
+        }
+        adapterInv.activeWFTasks = wfCount;
+      } else {
+        adapterInv.activeWFTasks = -1;
+      }
+
+      // get the utils package.json
+      if (fs.existsSync('../package.json')) {
+        const utilsPackage = require('../package.json');
+
+        // Version of adapter-utils - utils package
+        adapterInv.utilVersion = utilsPackage.version;
+      } else {
+        adapterInv.utilVersion = 'TBD';
+      }
+
+      // return the results
+      return callback(adapterInv);
+    } catch (e) {
+      // handle any exception
+      const errorObj = this.transUtil.checkAndReturn(e, origin, 'Issue getting Inventory information');
+      return callback(null, errorObj);
+    }
+  }
 }
 
 module.exports = RequestHandler;

package/lib/restHandler.js

@@ -176,7 +176,7 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
               retError = JSON.parse(perror.response.trim());
             } catch (ex) {
               // otherwise log parse failure but still return the unparsed error
-              log.error(`${origin}: An error occurred parsing the error JSON: ${ex}`);
+              log.warn(`${origin}: An error occurred parsing the error JSON: ${ex}: Error Response is: ${perror}`);
             }
           }
         }
@@ -429,7 +429,7 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
           retResponse = JSON.parse(resObj.response.trim());
         } catch (ex) {
           // otherwise log parse failure and return the unparsed response
-          log.warn(`${origin}: An error occurred parsing the resulting JSON: ${ex}`);
+          log.warn(`${origin}: An error occurred parsing the resulting JSON: ${ex}: Actual Response is: ${resObj}`);
           return callback(retObject);
         }
       }

package/lib/translatorUtil.js

@@ -423,7 +423,7 @@ function parseFields(retObject, dataSchema) {
  *
  * @return {Object} the IAP Entity
  */
-function extractJSONEntity(dataObj, entitySchema) {
+function extractJSONEntity(dataObj, entitySchema, ajvInstance) {
   const origin = `${id}-translatorUtil-extractJSONEntity`;
   log.trace(origin);
   const returnObj = extractObject(dataObj, entitySchema, false);
@@ -433,7 +433,10 @@ function extractJSONEntity(dataObj, entitySchema) {
     let combinedEntity = propUtilInst.mergeProperties(returnObj, propUtilInst.setDefaults(entitySchema));
 
     // validate the entity against the schema
-    const ajvInst = new AjvCl();
+    let ajvInst = ajvInstance;
+    if (!ajvInst) {
+      ajvInst = new AjvCl();
+    }
     const validate = ajvInst.compile(entitySchema);
     const result = validate(combinedEntity);
 
@@ -664,7 +667,7 @@ function buildObject(dataObj, entitySchema, dynamicFields) {
  *
  * @return {Object} the Entity for the other system
  */
-function buildJSONEntity(dataObj, entitySchema) {
+function buildJSONEntity(dataObj, entitySchema, ajvInstance) {
   const origin = `${id}-translatorUtil-buildJSONEntity`;
   log.trace(origin);
 
@@ -673,7 +676,10 @@ function buildJSONEntity(dataObj, entitySchema) {
     const combinedEntity = propUtilInst.mergeProperties(dataObj, propUtilInst.setDefaults(entitySchema));
 
     // validate the entity against the schema
-    const ajvInst = new AjvCl();
+    let ajvInst = ajvInstance;
+    if (!ajvInst) {
+      ajvInst = new AjvCl();
+    }
     const validate = ajvInst.compile(entitySchema);
     const result = validate(combinedEntity);
 
@@ -789,6 +795,7 @@ class AdapterTranslatorUtil {
 
       // make sure we are working with a JSON object instead of strigified object
       const transObj = this.formatInputData(inEntity);
+      const ajvInst = new AjvCl();
 
       // if an array of Entities, just translate the data (no objects)
       if (Array.isArray(transObj)) {
@@ -798,7 +805,7 @@ class AdapterTranslatorUtil {
           // is this just an array of data or something that needs to be translated?
           if (typeof transObj[i] === 'object') {
             // move the fields we care about into a IAP Entity Object
-            outEntities.push(extractJSONEntity(transObj[i], entitySchema));
+            outEntities.push(extractJSONEntity(transObj[i], entitySchema, ajvInst));
           } else {
             outEntities.push(transObj[i]);
           }
@@ -809,7 +816,7 @@ class AdapterTranslatorUtil {
 
       // if a single System Entity, should translate data and get value for objects
       // move the fields we care about into a IAP Entity Object
-      return extractJSONEntity(transObj, entitySchema);
+      return extractJSONEntity(transObj, entitySchema, ajvInst);
     } catch (e) {
       return this.checkAndThrow(e, origin, 'Issue mapping from outbound entity');
     }
@@ -870,6 +877,7 @@ class AdapterTranslatorUtil {
 
       // make sure we are working with a JSON object instead of strigified object
       const transObj = this.formatInputData(outEntity);
+      const ajvInst = new AjvCl();
 
       // if this is an array of Objects, translate each of the objects
       if (Array.isArray(transObj)) {
@@ -877,7 +885,7 @@ class AdapterTranslatorUtil {
 
         for (let i = 0; i < transObj.length; i += 1) {
           // move the fields the other system cares about into the Object
-          retObjects.push(buildJSONEntity(transObj[i], entitySchema));
+          retObjects.push(buildJSONEntity(transObj[i], entitySchema, ajvInst));
         }
 
         return retObjects;
@@ -885,7 +893,7 @@ class AdapterTranslatorUtil {
 
       // if a single Object, should translate data and get value for objects
       // move the fields the other system cares about into the Object
-      return buildJSONEntity(transObj, entitySchema);
+      return buildJSONEntity(transObj, entitySchema, ajvInst);
     } catch (e) {
       return this.checkAndThrow(e, origin, 'Issue mapping to outbound entity');
     }

package/package.json

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