@itentialopensource/adapter-utils 4.48.16 → 4.49.0

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+## 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

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/package.json

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