@itentialopensource/adapter-dna_center 0.5.4 → 0.5.7

package/adapterBase.js

@@ -6,11 +6,15 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint no-loop-func: warn */
 /* eslint no-cond-assign: warn */
+/* eslint global-require: warn */
+/* eslint no-unused-vars: warn */
+/* eslint prefer-destructuring: warn */
 
 /* Required libraries.  */
 const fs = require('fs-extra');
 const path = require('path');
 const EventEmitterCl = require('events').EventEmitter;
+const { execSync } = require('child_process');
 
 /* The schema validator */
 const AjvCl = require('ajv');
@@ -19,6 +23,127 @@ const AjvCl = require('ajv');
 const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
 const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHandler;
 
+const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
+const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
+const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
+
+let propUtil = null;
+
+/*
+ * INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
+ */
+function forceFail(packChg) {
+  if (packChg !== undefined && packChg !== null && packChg === true) {
+    execSync(`rm -rf ${__dirname}/node modules`, { encoding: 'utf-8' });
+    execSync(`rm -rf ${__dirname}/package-lock.json`, { encoding: 'utf-8' });
+    execSync('npm install', { encoding: 'utf-8' });
+  }
+  log.error('NEED TO RESTART ADAPTER - FORCE FAIL');
+  const errorObj = {
+    origin: 'adapter-forceFail',
+    type: 'Force Fail so adapter will restart',
+    vars: []
+  };
+  setTimeout(() => {
+    throw new Error(JSON.stringify(errorObj));
+  }, 1000);
+}
+
+/*
+ * INTERNAL FUNCTION: update the action.json
+ */
+function updateAction(entityPath, action, changes) {
+  // if the action file does not exist - error
+  const actionFile = path.join(entityPath, '/action.json');
+  if (!fs.existsSync(actionFile)) {
+    return 'Missing Action File';
+  }
+
+  // read in the file as a json object
+  const ajson = require(path.resolve(entityPath, 'action.json'));
+  let chgAct = {};
+
+  // get the action we need to change
+  for (let a = 0; a < ajson.actions.length; a += 1) {
+    if (ajson.actions[a].name === action) {
+      chgAct = ajson.actions[a];
+      break;
+    }
+  }
+  // merge the changes into the desired action
+  chgAct = propUtil.mergeProperties(changes, chgAct);
+
+  fs.writeFileSync(actionFile, JSON.stringify(ajson, null, 2));
+  return null;
+}
+
+/*
+ * INTERNAL FUNCTION: update the schema file
+ */
+function updateSchema(entityPath, configFile, changes) {
+  // if the schema file does not exist - error
+  const schemaFile = path.join(entityPath, `/${configFile}`);
+  if (!fs.existsSync(schemaFile)) {
+    return 'Missing Schema File';
+  }
+
+  // read in the file as a json object
+  let schema = require(path.resolve(entityPath, configFile));
+
+  // merge the changes into the schema file
+  schema = propUtil.mergeProperties(changes, schema);
+
+  fs.writeFileSync(schemaFile, JSON.stringify(schema, null, 2));
+  return null;
+}
+
+/*
+ * INTERNAL FUNCTION: update the mock data file
+ */
+function updateMock(mockPath, configFile, changes) {
+  // if the mock file does not exist - create it
+  const mockFile = path.join(mockPath, `/${configFile}`);
+  if (!fs.existsSync(mockFile)) {
+    const newMock = {};
+    fs.writeFileSync(mockFile, JSON.stringify(newMock, null, 2));
+  }
+
+  // read in the file as a json object
+  let mock = require(path.resolve(mockPath, configFile));
+
+  // merge the changes into the mock file
+  mock = propUtil.mergeProperties(changes, mock);
+
+  fs.writeFileSync(mockFile, JSON.stringify(mock, null, 2));
+  return null;
+}
+
+/*
+ * INTERNAL FUNCTION: update the package dependencies
+ */
+function updatePackage(changes) {
+  // if the schema file does not exist - error
+  const packFile = path.join(__dirname, '/package.json');
+  if (!fs.existsSync(packFile)) {
+    return 'Missing Pacakge File';
+  }
+
+  // read in the file as a json object
+  const pack = require(path.resolve(__dirname, 'package.json'));
+
+  // only certain changes are allowed
+  if (changes.dependencies) {
+    const keys = Object.keys(changes.dependencies);
+
+    for (let k = 0; k < keys.length; k += 1) {
+      pack.dependencies[keys[k]] = changes.dependencies[keys[k]];
+    }
+  }
+
+  fs.writeFileSync(packFile, JSON.stringify(pack, null, 2));
+  return null;
+}
+
 /* GENERAL ADAPTER FUNCTIONS THESE SHOULD NOT BE DIRECTLY MODIFIED */
 /* IF YOU NEED MODIFICATIONS, REDEFINE THEM IN adapter.js!!! */
 class AdapterBase extends EventEmitterCl {
@@ -30,13 +155,19 @@ class AdapterBase extends EventEmitterCl {
     // Instantiate the EventEmitter super class
     super();
 
+    // IAP home directory injected by core when running the adapter within IAP
+    process.env.iap_home = process.argv[3];
+
     try {
       // Capture the adapter id
       this.id = prongid;
       this.propUtilInst = new PropUtilCl(prongid, __dirname);
-
+      propUtil = this.propUtilInst;
+      this.initProps = properties;
       this.alive = false;
       this.healthy = false;
+      this.suspended = false;
+      this.suspendMode = 'pause';
       this.caching = false;
       this.repeatCacheCount = 0;
       this.allowFailover = 'AD.300';
@@ -54,7 +185,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-
   /**
    * @callback healthCallback
    * @param {Object} result - the result of the get request (contains an id and a status)
@@ -80,7 +210,6 @@ class AdapterBase extends EventEmitterCl {
    * @param {String} error - any error that occured
    */
 
-
   /**
    * refreshProperties is used to set up all of the properties for the connector.
    * It allows properties to be changed later by simply calling refreshProperties rather
@@ -110,14 +239,20 @@ class AdapterBase extends EventEmitterCl {
 
       // if invalid properties throw an error
       if (!result) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Properties', [JSON.stringify(validate.errors)], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        throw new Error(JSON.stringify(errorObj));
+        if (this.requestHandlerInst) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Properties', [JSON.stringify(validate.errors)], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          throw new Error(JSON.stringify(errorObj));
+        } else {
+          log.error(`${origin}: ${JSON.stringify(validate.errors)}`);
+          throw new Error(`${origin}: ${JSON.stringify(validate.errors)}`);
+        }
       }
 
       // properties that this code cares about
       this.healthcheckType = this.allProps.healthcheck.type;
       this.healthcheckInterval = this.allProps.healthcheck.frequency;
+      this.healthcheckQuery = this.allProps.healthcheck.query_object;
 
       // set the failover codes from properties
       if (this.allProps.request.failover_codes) {
@@ -162,9 +297,11 @@ class AdapterBase extends EventEmitterCl {
     // if there is no healthcheck just change the emit to ONLINE
     // We do not recommend no healthcheck!!!
     if (this.healthcheckType === 'none') {
-      // validate all of the action files - normally done in healthcheck
-      this.emit('ONLINE', { id: this.id });
-      this.healthy = true;
+      log.error(`${origin}: Waiting 1 Seconds to emit Online`);
+      setTimeout(() => {
+        this.emit('ONLINE', { id: this.id });
+        this.healthy = true;
+      }, 1000);
     }
 
     // is the healthcheck only suppose to run on startup
@@ -197,8 +334,22 @@ class AdapterBase extends EventEmitterCl {
     const origin = `${this.id}-adapterBase-healthCheck`;
     log.trace(origin);
 
+    // if there is healthcheck query_object property, it needs to be added to the adapter
+    let myRequest = reqObj;
+    if (this.healthcheckQuery && Object.keys(this.healthcheckQuery).length > 0) {
+      if (myRequest && myRequest.uriQuery) {
+        myRequest.uriQuery = { ...myRequest.uriQuery, ...this.healthcheckQuery };
+      } else if (myRequest) {
+        myRequest.uriQuery = this.healthcheckQuery;
+      } else {
+        myRequest = {
+          uriQuery: this.healthcheckQuery
+        };
+      }
+    }
+
     // call to the healthcheck in connector
-    return this.requestHandlerInst.identifyHealthcheck(reqObj, (res, error) => {
+    return this.requestHandlerInst.identifyHealthcheck(myRequest, (res, error) => {
       // unhealthy
       if (error) {
         // if we were healthy, toggle health
@@ -230,6 +381,424 @@ class AdapterBase extends EventEmitterCl {
     });
   }
 
+  /**
+   * iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
+   * @param {array} ignoreThese - additional methods to ignore (optional)
+   *
+   * @function iapGetAdapterWorkflowFunctions
+   */
+  iapGetAdapterWorkflowFunctions(ignoreThese) {
+    const myfunctions = this.getAllFunctions();
+    const wffunctions = [];
+
+    // remove the functions that should not be in a Workflow
+    for (let m = 0; m < myfunctions.length; m += 1) {
+      if (myfunctions[m] === 'addEntityCache') {
+        // got to the second tier (adapterBase)
+        break;
+      }
+      if (myfunctions[m] !== 'iapHasAdapterEntity' && myfunctions[m] !== 'iapVerifyAdapterCapability'
+          && myfunctions[m] !== 'iapUpdateAdapterEntityCache' && myfunctions[m] !== 'healthCheck'
+          && myfunctions[m] !== 'iapGetAdapterWorkflowFunctions'
+          && !(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
+        let found = false;
+        if (ignoreThese && Array.isArray(ignoreThese)) {
+          for (let i = 0; i < ignoreThese.length; i += 1) {
+            if (myfunctions[m].toUpperCase() === ignoreThese[i].toUpperCase()) {
+              found = true;
+            }
+          }
+        }
+        if (!found) {
+          wffunctions.push(myfunctions[m]);
+        }
+      }
+    }
+
+    return wffunctions;
+  }
+
+  /**
+   * iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
+   * allows customers to make changes to adapter configuration without having to be on the
+   * file system.
+   *
+   * @function iapUpdateAdapterConfiguration
+   * @param {string} configFile - the name of the file being updated (required)
+   * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
+   * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
+   * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
+   * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
+   * @param {Callback} callback - The results of the call
+   */
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+    const meth = 'adapterBase-iapUpdateAdapterConfiguration';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // verify the parameters are valid
+    if (changes === undefined || changes === null || typeof changes !== 'object'
+        || Object.keys(changes).length === 0) {
+      const result = {
+        response: 'No configuration updates to make'
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (configFile === undefined || configFile === null || configFile === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // take action based on configFile being changed
+    if (configFile === 'package.json') {
+      const pres = updatePackage(changes);
+      if (pres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const result = {
+        response: 'Package updates completed - restarting adapter'
+      };
+      log.info(result.response);
+      forceFail(true);
+      return callback(result, null);
+    }
+    if (entity === undefined || entity === null || entity === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // this means we are changing an entity file so type is required
+    if (type === undefined || type === null || type === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // if the entity does not exist - error
+    const epath = `${__dirname}/entities/${entity}`;
+    if (!fs.existsSync(epath)) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // take action based on type of file being changed
+    if (type === 'action') {
+      // BACKUP???
+      const ares = updateAction(epath, action, changes);
+      if (ares) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      // AJV CHECK???
+      // RESTORE IF NEEDED???
+      const result = {
+        response: `Action updates completed to entity: ${entity} - ${action}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (type === 'schema') {
+      const sres = updateSchema(epath, configFile, changes);
+      if (sres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const result = {
+        response: `Schema updates completed to entity: ${entity} - ${configFile}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (type === 'mock') {
+      // if the mock directory does not exist - error
+      const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
+      if (!fs.existsSync(mpath)) {
+        fs.mkdirSync(mpath);
+      }
+
+      const mres = updateMock(mpath, configFile, changes);
+      if (mres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const result = {
+        response: `Mock data updates completed to entity: ${entity} - ${configFile}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
+    log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+    return callback(null, errorObj);
+  }
+
+  /**
+   * See if the API path provided is found in this adapter
+   *
+   * @function iapFindAdapterPath
+   * @param {string} apiPath - the api path to check on
+   * @param {Callback} callback - The results of the call
+   */
+  iapFindAdapterPath(apiPath, callback) {
+    const result = {
+      apiPath
+    };
+
+    // verify the path was provided
+    if (!apiPath) {
+      log.error('NO API PATH PROVIDED!');
+      result.found = false;
+      result.message = 'NO PATH PROVIDED!';
+      return callback(null, result);
+    }
+
+    // make sure the entities directory exists
+    const entitydir = path.join(__dirname, 'entities');
+    if (!fs.statSync(entitydir).isDirectory()) {
+      log.error('Could not find the entities directory');
+      result.found = false;
+      result.message = 'Could not find the entities directory';
+      return callback(null, result);
+    }
+
+    const entities = fs.readdirSync(entitydir);
+    const fitems = [];
+
+    // need to go through each entity in the entities directory
+    for (let e = 0; e < entities.length; e += 1) {
+      // make sure the entity is a directory - do not care about extra files
+      // only entities (dir)
+      if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
+        // see if the action file exists in the entity
+        if (fs.existsSync(`${entitydir}/${entities[e]}/action.json`)) {
+          // Read the entity actions from the file system
+          const actions = require(`${entitydir}/${entities[e]}/action.json`);
+
+          // go through all of the actions set the appropriate info in the newActions
+          for (let a = 0; a < actions.actions.length; a += 1) {
+            if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
+              log.info(`  Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
+              log.info(`          method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath}`);
+              const fitem = {
+                entity: entities[e],
+                action: actions.actions[a].name,
+                method: actions.actions[a].method,
+                path: actions.actions[a].entitypath
+              };
+              fitems.push(fitem);
+            }
+          }
+        } else {
+          log.error(`Could not find entities ${entities[e]} action.json file`);
+          result.found = false;
+          result.message = `Could not find entities ${entities[e]} action.json file`;
+          return callback(null, result);
+        }
+      } else {
+        log.error(`Could not find entities ${entities[e]} directory`);
+        result.found = false;
+        result.message = `Could not find entities ${entities[e]} directory`;
+        return callback(null, result);
+      }
+    }
+
+    if (fitems.length === 0) {
+      log.info('PATH NOT FOUND!');
+      result.found = false;
+      result.message = 'API PATH NOT FOUND!';
+      return callback(null, result);
+    }
+
+    result.foundIn = fitems;
+    result.found = true;
+    result.message = 'API PATH FOUND!';
+    return callback(result, null);
+  }
+
+  /**
+   * @summary Suspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   * @function iapSuspendAdapter
+   */
+  iapSuspendAdapter(mode, callback) {
+    const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
+    if (this.suspended) {
+      throw new Error(`${origin}: Adapter is already suspended`);
+    }
+    try {
+      this.suspended = true;
+      this.suspendMode = mode;
+      if (this.suspendMode === 'pause') {
+        const props = JSON.parse(JSON.stringify(this.initProps));
+        // To suspend adapter, enable throttling and set concurrent max to 0
+        props.throttle.throttle_enabled = true;
+        props.throttle.concurrent_max = 0;
+        this.refreshProperties(props);
+      }
+      return callback({ suspended: true });
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary Unsuspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   *
+   * @function iapUnsuspendAdapter
+   */
+  iapUnsuspendAdapter(callback) {
+    const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
+    if (!this.suspended) {
+      throw new Error(`${origin}: Adapter is not suspended`);
+    }
+    if (this.suspendMode === 'pause') {
+      const props = JSON.parse(JSON.stringify(this.initProps));
+      // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
+      props.throttle.throttle_enabled = true;
+      props.throttle.concurrent_max = 1;
+      this.refreshProperties(props);
+      setTimeout(() => {
+        this.getQueue((q, error) => {
+          // console.log("Items in queue: " + String(q.length))
+          if (q.length === 0) {
+            // if queue is empty, return to initial properties state
+            this.refreshProperties(this.initProps);
+            this.suspended = false;
+            return callback({ suspended: false });
+          }
+          // recursive call to check queue again every second
+          return this.iapUnsuspendAdapter(callback);
+        });
+      }, 1000);
+    } else {
+      this.suspended = false;
+      callback({ suspend: false });
+    }
+  }
+
+  /**
+   * iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
+   *
+   * @function iapGetAdapterQueue
+   * @param {Callback} callback - a callback function to return the result (Queue) or the error
+   */
+  iapGetAdapterQueue(callback) {
+    const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getQueue(callback);
+  }
+
+  /**
+   * @summary runs troubleshoot scripts for adapter
+   *
+   * @function iapTroubleshootAdapter
+   * @param {Object} props - the connection, healthcheck and authentication properties
+   * @param {boolean} persistFlag - whether the adapter properties should be updated
+   * @param {Adapter} adapter - adapter instance to troubleshoot
+   * @param {Callback} callback - callback function to return troubleshoot results
+   */
+  async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
+    try {
+      const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
+      if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
+        return callback(result);
+      }
+      return callback(null, result);
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary runs healthcheck script for adapter
+   *
+   * @function iapRunAdapterHealthcheck
+   * @param {Adapter} adapter - adapter instance to troubleshoot
+   * @param {Callback} callback - callback function to return healthcheck status
+   */
+  async iapRunAdapterHealthcheck(adapter, callback) {
+    try {
+      const result = await tbUtils.healthCheck(adapter);
+      if (result) {
+        return callback(result);
+      }
+      return callback(null, result);
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary runs connectivity check script for adapter
+   *
+   * @function iapRunAdapterConnectivity
+   * @param {Adapter} adapter - adapter instance to troubleshoot
+   * @param {Callback} callback - callback function to return connectivity status
+   */
+  async iapRunAdapterConnectivity(callback) {
+    try {
+      const { serviceItem } = await tbUtils.getAdapterConfig();
+      const { host } = serviceItem.properties.properties;
+      const result = tbUtils.runConnectivity(host, false);
+      if (result.failCount > 0) {
+        return callback(null, result);
+      }
+      return callback(result);
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary runs basicGet script for adapter
+   *
+   * @function iapRunAdapterBasicGet
+   * @param {Callback} callback - callback function to return basicGet result
+   */
+  iapRunAdapterBasicGet(callback) {
+    try {
+      const result = tbUtils.runBasicGet(false);
+      if (result.failCount > 0) {
+        return callback(null, result);
+      }
+      return callback(result);
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary moves entities to mongo database
+   *
+   * @function iapMoveAdapterEntitiesToDB
+   *
+   * @return {Callback} - containing the response from the mongo transaction
+   */
+  iapMoveAdapterEntitiesToDB(callback) {
+    const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return callback(entitiesToDB.iapMoveAdapterEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id }), null);
+    } catch (err) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * getAllFunctions is used to get all of the exposed function in the adapter
    *
@@ -242,7 +811,7 @@ class AdapterBase extends EventEmitterCl {
     // find the functions in this class
     do {
       const l = Object.getOwnPropertyNames(obj)
-        .concat(Object.getOwnPropertySymbols(obj).map(s => s.toString()))
+        .concat(Object.getOwnPropertySymbols(obj).map((s) => s.toString()))
         .sort()
         .filter((p, i, arr) => typeof obj[p] === 'function' && p !== 'constructor' && (i === 0 || p !== arr[i - 1]) && myfunctions.indexOf(p) === -1);
       myfunctions = myfunctions.concat(l);
@@ -254,30 +823,6 @@ class AdapterBase extends EventEmitterCl {
     return myfunctions;
   }
 
-  /**
-   * getWorkflowFunctions is used to get all of the workflow function in the adapter
-   *
-   * @function getAllFunctions
-   */
-  getWorkflowFunctions() {
-    const myfunctions = this.getAllFunctions();
-    const wffunctions = [];
-
-    // remove the functions that should not be in a Workflow
-    for (let m = 0; m < myfunctions.length; m += 1) {
-      if (myfunctions[m] === 'addEntityCache') {
-        // got to the second tier (adapterBase)
-        break;
-      }
-      if (myfunctions[m] !== 'hasEntity' && myfunctions[m] !== 'verifyCapability'
-          && myfunctions[m] !== 'updateEntityCache') {
-        wffunctions.push(myfunctions[m]);
-      }
-    }
-
-    return wffunctions;
-  }
-
   /**
    * checkActionFiles is used to update the validation of the action files.
    *
@@ -313,19 +858,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-  /**
-   * getQueue is used to get information for all of the requests currently in the queue.
-   *
-   * @function getQueue
-   * @param {Callback} callback - a callback function to return the result (Queue) or the error
-   */
-  getQueue(callback) {
-    const origin = `${this.id}-adapterBase-getQueue`;
-    log.trace(origin);
-
-    return this.requestHandlerInst.getQueue(callback);
-  }
-
   /**
    * @summary Takes in property text and an encoding/encryption and returns the resulting
    * encoded/encrypted string
@@ -406,7 +938,7 @@ class AdapterBase extends EventEmitterCl {
       const resEntity = [];
 
       for (let e = 0; e < entityId.length; e += 1) {
-        if (data.includes(entityId)) {
+        if (data.includes(entityId[e])) {
           resEntity.push(true);
         } else {
           resEntity.push(false);
@@ -430,7 +962,7 @@ class AdapterBase extends EventEmitterCl {
    *                              desired capability or an error
    */
   capabilityResults(results, callback) {
-    const meth = 'adapterBase-getQueue';
+    const meth = 'adapterBase-capabilityResults';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
     let locResults = results;
@@ -496,6 +1028,272 @@ class AdapterBase extends EventEmitterCl {
       return [];
     }
   }
+
+  /**
+   * @summary Make one of the needed Broker calls - could be one of many
+   *
+   * @function iapMakeBrokerCall
+   * @param {string} brokCall - the name of the broker call (required)
+   * @param {object} callProps - the proeprties for the broker call (required)
+   * @param {object} devResp - the device details to extract needed inputs (required)
+   * @param {string} filterName - any filter to search on (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result of the call
+   */
+  iapMakeBrokerCall(brokCall, callProps, devResp, filterName, callback) {
+    const meth = 'adapter-iapMakeBrokerCall';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      let uriPath = '';
+      let uriMethod = 'GET';
+      let callQuery = {};
+      let callBody = {};
+      let callHeaders = {};
+      let handleFail = 'fail';
+      let ostypePrefix = '';
+      let statusValue = 'true';
+      if (callProps.path) {
+        uriPath = `${callProps.path}`;
+
+        // make any necessary changes to the path
+        if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+          const rqKeys = Object.keys(callProps.requestFields);
+
+          // get the field from the provided device
+          for (let rq = 0; rq < rqKeys.length; rq += 1) {
+            // get the request field we are retrieving
+            const loopField = callProps.requestFields[rqKeys[rq]];
+            const loopArray = loopField.split('.');
+            let nestedValue = devResp;
+
+            // loops through incase the field is nested
+            for (let i = 0; i < loopArray.length; i += 1) {
+              if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                nestedValue = nestedValue[loopArray[i]];
+              } else {
+                // failed to traverse
+                nestedValue = loopField;
+                break;
+              }
+            }
+
+            // put the value into the path - if it has been specified in the path
+            uriPath = uriPath.replace(`{${rqKeys[rq]}}`, nestedValue);
+          }
+        }
+      }
+      if (callProps.method) {
+        uriMethod = callProps.method;
+      }
+      if (callProps.query) {
+        callQuery = callProps.query;
+
+        // go through the query params to check for variable values
+        const cpKeys = Object.keys(callQuery);
+        for (let cp = 0; cp < cpKeys.length; cp += 1) {
+          if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
+            // make any necessary changes to the query params
+            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+              const rqKeys = Object.keys(callProps.requestFields);
+
+              // get the uuid from the device
+              for (let rq = 0; rq < rqKeys.length; rq += 1) {
+                if (cpKeys[cp] === rqKeys[rq]) {
+                  // get the request field we are retrieving
+                  const loopField = callProps.requestFields[rqKeys[rq]];
+                  const loopArray = loopField.split('.');
+                  let nestedValue = devResp;
+
+                  // loops through incase the field is nested
+                  for (let i = 0; i < loopArray.length; i += 1) {
+                    if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                      nestedValue = nestedValue[loopArray[i]];
+                    } else {
+                      // failed to traverse
+                      nestedValue = loopField;
+                      break;
+                    }
+                  }
+
+                  // put the value into the query - if it has been specified in the query
+                  callQuery[cpKeys[cp]] = nestedValue;
+                }
+              }
+            }
+          }
+        }
+      }
+      if (callProps.body) {
+        callBody = callProps.body;
+      }
+      if (callProps.headers) {
+        callHeaders = callProps.headers;
+      }
+      if (callProps.handleFailure) {
+        handleFail = callProps.handleFailure;
+      }
+      if (callProps.responseFields && callProps.responseFields.ostypePrefix) {
+        ostypePrefix = callProps.responseFields.ostypePrefix;
+      }
+      if (callProps.responseFields && callProps.responseFields.statusValue) {
+        statusValue = callProps.responseFields.statusValue;
+      }
+
+      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+      // !! you can also replace with a specific call if that is easier
+      return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
+        // if we received an error or their is no response on the results return an error
+        if (error) {
+          if (handleFail === 'fail') {
+            return callback(null, error);
+          }
+          return callback({}, null);
+        }
+        if (!result.response) {
+          if (handleFail === 'fail') {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', [brokCall], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+          return callback({}, null);
+        }
+
+        // get the keys for the response fields
+        let rfKeys = [];
+        if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
+          rfKeys = Object.keys(callProps.responseFields);
+        }
+
+        // if we got an array returned (e.g. getDevicesFitered)
+        if (Array.isArray(result.response)) {
+          const listDevices = [];
+          for (let a = 0; a < result.response.length; a += 1) {
+            const thisDevice = result.response[a];
+            for (let rf = 0; rf < rfKeys.length; rf += 1) {
+              if (rfKeys[rf] !== 'ostypePrefix') {
+                // get the response field we are retrieving
+                const loopField = callProps.responseFields[rfKeys[rf]];
+                const loopArray = loopField.split('.');
+                let nestedValue = thisDevice;
+
+                // loops through incase the field is nested
+                for (let i = 0; i < loopArray.length; i += 1) {
+                  if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                    nestedValue = nestedValue[loopArray[i]];
+                  } else {
+                    // failed to traverse
+                    nestedValue = '';
+                    break;
+                  }
+                }
+                // if the field is ostype - need to add prefix
+                if (rfKeys[rf] === 'ostype' && typeof nestedValue === 'string') {
+                  nestedValue = ostypePrefix + nestedValue;
+                }
+                // if there is a status to set, set it
+                if (rfKeys[rf] === 'status') {
+                  // if really looking for just a good response
+                  if (loopField === 'return2xx' && result.icode === statusValue.toString()) {
+                    thisDevice.isAlive = true;
+                  } else if (nestedValue.toString() === statusValue.toString()) {
+                    thisDevice.isAlive = true;
+                  } else {
+                    thisDevice.isAlive = false;
+                  }
+                }
+                // if we found a good value
+                thisDevice[rfKeys[rf]] = nestedValue;
+              }
+            }
+
+            // if there is no filter - add the device to the list
+            if (!filterName || filterName.length === 0) {
+              listDevices.push(thisDevice);
+            } else {
+              // if we have to match a filter
+              let found = false;
+              for (let f = 0; f < filterName.length; f += 1) {
+                if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+                  found = true;
+                  break;
+                }
+              }
+              // matching device
+              if (found) {
+                listDevices.push(thisDevice);
+              }
+            }
+          }
+
+          // return the array of devices
+          return callback(listDevices, null);
+        }
+
+        // if this is not an array - just about everything else, just handle as a single object
+        let thisDevice = result.response;
+        for (let rf = 0; rf < rfKeys.length; rf += 1) {
+          // skip ostypePrefix since it is not a field
+          if (rfKeys[rf] !== 'ostypePrefix') {
+            // get the response field we are retrieving
+            const loopField = callProps.responseFields[rfKeys[rf]];
+            const loopArray = loopField.split('.');
+            let nestedValue = thisDevice;
+
+            // loops through incase the field is nested
+            for (let i = 0; i < loopArray.length; i += 1) {
+              if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                nestedValue = nestedValue[loopArray[i]];
+              } else {
+                // failed to traverse
+                nestedValue = '';
+                break;
+              }
+            }
+            // if the field is ostype - need to add prefix
+            if (rfKeys[rf] === 'ostype' && typeof nestedValue === 'string') {
+              nestedValue = ostypePrefix + nestedValue;
+            }
+            // if there is a status to set, set it
+            if (rfKeys[rf] === 'status') {
+              // if really looking for just a good response
+              if (loopField === 'return2xx' && result.icode === statusValue.toString()) {
+                thisDevice.isAlive = true;
+              } else if (nestedValue.toString() === statusValue.toString()) {
+                thisDevice.isAlive = true;
+              } else {
+                thisDevice.isAlive = false;
+              }
+            }
+            // if we found a good value
+            thisDevice[rfKeys[rf]] = nestedValue;
+          }
+        }
+
+        // if there is a filter - check the device is in the list
+        if (filterName && filterName.length > 0) {
+          let found = false;
+          for (let f = 0; f < filterName.length; f += 1) {
+            if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+              found = true;
+              break;
+            }
+          }
+          // no matching device - clear the device
+          if (!found) {
+            thisDevice = {};
+          }
+        }
+
+        return callback(thisDevice, null);
+      });
+    } catch (e) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, e);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
 }
 
 module.exports = AdapterBase;