@itentialopensource/adapter-128technology 0.2.1 → 0.3.0

package/adapterBase.js

@@ -6,11 +6,14 @@
 /* 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 */
 
 /* 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 +22,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 {
@@ -34,9 +158,12 @@ class AdapterBase extends EventEmitterCl {
       // 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 +181,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-
   /**
    * @callback healthCallback
    * @param {Object} result - the result of the get request (contains an id and a status)
@@ -80,7 +206,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
@@ -123,6 +248,7 @@ class AdapterBase extends EventEmitterCl {
       // 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) {
@@ -151,6 +277,129 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
+  /**
+   * updateAdapterConfiguration 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 updateAdapterConfiguration
+   * @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
+   */
+  updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+    const meth = 'adapterBase-updateAdapterConfiguration';
+    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);
+  }
+
   /**
    * @summary Connect function is used during Pronghorn startup to provide instantiation feedback.
    *
@@ -204,6 +453,20 @@ 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) => {
       // unhealthy
@@ -237,6 +500,68 @@ class AdapterBase extends EventEmitterCl {
     });
   }
 
+  /**
+   * @summary Suspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   * @function suspend
+   */
+  suspend(mode, callback) {
+    const origin = `${this.id}-adapterBase-suspend`;
+    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 unsuspend
+   */
+  unsuspend(callback) {
+    const origin = `${this.id}-adapterBase-unsuspend`;
+    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.unsuspend(callback);
+        });
+      }, 1000);
+    } else {
+      this.suspended = false;
+      callback({ suspend: false });
+    }
+  }
+
   /**
    * getAllFunctions is used to get all of the exposed function in the adapter
    *
@@ -263,10 +588,11 @@ class AdapterBase extends EventEmitterCl {
 
   /**
    * getWorkflowFunctions is used to get all of the workflow function in the adapter
+   * @param {array} ignoreThese - additional methods to ignore (optional)
    *
-   * @function getAllFunctions
+   * @function getWorkflowFunctions
    */
-  getWorkflowFunctions() {
+  getWorkflowFunctions(ignoreThese) {
     const myfunctions = this.getAllFunctions();
     const wffunctions = [];
 
@@ -277,8 +603,19 @@ class AdapterBase extends EventEmitterCl {
         break;
       }
       if (myfunctions[m] !== 'hasEntity' && myfunctions[m] !== 'verifyCapability' && myfunctions[m] !== 'updateEntityCache'
-          && myfunctions[m] !== 'healthCheck' && !(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
-        wffunctions.push(myfunctions[m]);
+          && myfunctions[m] !== 'healthCheck' && myfunctions[m] !== 'getWorkflowFunctions'
+          && !(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]);
+        }
       }
     }
 
@@ -302,6 +639,89 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
+  /**
+   * See if the API path provided is found in this adapter
+   *
+   * @function findPath
+   * @param {string} apiPath - the api path to check on
+   * @param {Callback} callback - The results of the call
+   */
+  findPath(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);
+  }
+
   /**
    * checkProperties is used to validate the adapter properties.
    *
@@ -353,6 +773,85 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.encryptProperty(property, technique, callback);
   }
 
+  /**
+   * @summary runs troubleshoot scripts for adapter
+   *
+   * @function troubleshoot
+   * @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 troubleshoot(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 runHealthcheck
+   * @param {Adapter} adapter - adapter instance to troubleshoot
+   * @param {Callback} callback - callback function to return healthcheck status
+   */
+  async runHealthcheck(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 runConnectivity
+   * @param {Adapter} adapter - adapter instance to troubleshoot
+   * @param {Callback} callback - callback function to return connectivity status
+   */
+  async runConnectivity(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 runBasicGet
+   * @param {Callback} callback - callback function to return basicGet result
+   */
+  runBasicGet(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 take the entities and add them to the cache
    *
@@ -413,7 +912,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);
@@ -437,7 +936,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;
@@ -503,6 +1002,27 @@ class AdapterBase extends EventEmitterCl {
       return [];
     }
   }
+
+  /**
+   * @summary moves entities to mongo database
+   *
+   * @function moveEntitiesToDB
+   *
+   * @return {Callback} - containing the response from the mongo transaction
+   */
+  moveEntitiesToDB(callback) {
+    const meth = 'adapterBase-moveEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return callback(entitiesToDB.moveEntitiesToDB(__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);
+    }
+  }
 }
 
 module.exports = AdapterBase;