@itentialopensource/adapter-utils 4.44.9 → 4.45.2

package/CHANGELOG.md

@@ -1,4 +1,54 @@
 
+## 4.45.2 [12-09-2021]
+
+* change for sending content-length with empty token body
+
+Closes ADAPT-1889
+
+See merge request itentialopensource/adapter-utils!228
+
+---
+
+## 4.45.1 [12-08-2021]
+
+* Modified response handling on error to use the translator
+
+Closes ADAPT-1876
+
+See merge request itentialopensource/adapter-utils!225
+
+---
+
+## 4.45.0 [12-08-2021]
+
+* changes for uriOptions and not encoding query params
+
+Closes ADAPT-1866
+
+See merge request itentialopensource/adapter-utils!227
+
+---
+
+## 4.44.11 [10-25-2021]
+
+* change to the npm registry url
+
+Closes ADAPT-1793
+
+See merge request itentialopensource/adapter-utils!224
+
+---
+
+## 4.44.10 [10-25-2021]
+
+* fixes for dbUtils, proxy, misspelling
+
+Closes ADAPT-1019
+
+See merge request itentialopensource/adapter-utils!223
+
+---
+
 ## 4.44.9 [09-14-2021]
 
 * Refactor storage handling

package/lib/connectorRest.js

@@ -640,7 +640,7 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
     } else if (proxyEnabled) {
       let proxy = `${proxyProtocol}://${proxyHost}:${proxyPort}`;
       if (proxyUser && proxyPassword) {
-        proxy = `${callProperties.proxy.protocol}://${proxyUser}:${proxyPassword}@${callProperties.proxy.host}:${callProperties.proxy.port}`;
+        proxy = `${proxyProtocol}://${proxyUser}:${proxyPassword}@${proxyHost}:${proxyPort}`;
       }
       request.header.agent = new HttpsProxyAgent(proxy);
 
@@ -1760,6 +1760,20 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
         }
       }
 
+      // only add global options if there are global options to add
+      if (globalRequest && globalRequest.uriOptions
+          && Object.keys(globalRequest.uriOptions).length > 0) {
+        const optionString = querystring.stringify(globalRequest.uriOptions);
+
+        // if no query paramters yet - start with ?
+        if (options.path.indexOf('?') < 0) {
+          options.path += `?${optionString}`;
+        } else {
+          // if already have query parameters, add on to end
+          options.path += `&${optionString}`;
+        }
+      }
+
       // remove the path vars from the reqBody
       const actReqBody = Object.assign({}, reqBody);
       if (actReqBody && actReqBody.uriPathVars) {
@@ -1917,7 +1931,7 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
 
           // if there is a body, set the content length of the body and add it to
           // the header
-          if (Object.keys(tokenEntity).length > 0) {
+          if (Object.keys(tokenEntity).length > 0 || tokenSchema.sendEmpty) {
             options.headers['Content-length'] = Buffer.byteLength(bodyString);
           }
 

package/lib/dbUtil.js

@@ -14,6 +14,7 @@ const { MongoClient } = require('mongodb');
 let adapterDir = '';
 let saveFS = false;
 let storDir = `${adapterDir}/storage`;
+let entityDir = `${adapterDir}/entities`;
 let id = null;
 
 const Storage = {
@@ -60,6 +61,55 @@ function getFromJson(fileName, filter) {
   }
 
   try {
+    if (fileName === 'adapter_configs') {
+      const retEntity = filter.entity;
+      if (!retEntity || !fs.existsSync(`${entityDir}`) || !fs.existsSync(`${entityDir}/${retEntity}`)) {
+        log.warn(`${origin}: Could not find adapter entity directory ${retEntity} - nothing to retrieve`);
+        return null;
+      }
+      if (!fs.existsSync(`${entityDir}/${retEntity}/action.json`)) {
+        log.warn(`${origin}: Could not find action.json for entity ${retEntity} - nothing to retrieve`);
+        return null;
+      }
+
+      // load the mockdatafiles
+      let files = fs.readdirSync(`${entityDir}/${retEntity}`);
+      const mockdatafiles = {};
+      if (files.includes('mockdatafiles') && fs.lstatSync(`${entityDir}/${retEntity}/mockdatafiles`).isDirectory()) {
+        fs.readdirSync(`${entityDir}/${retEntity}/mockdatafiles`).forEach((file) => {
+          if (file.split('.').pop() === 'json') {
+            const mockpath = `${entityDir}/${retEntity}/mockdatafiles/${file}`;
+            const data = JSON.parse(fs.readFileSync(mockpath));
+            mockdatafiles[mockpath.split('/').pop()] = data;
+          }
+        });
+      }
+
+      // load the action data
+      let actions;
+      if (files.includes('action.json')) {
+        actions = JSON.parse(fs.readFileSync(`${entityDir}/${retEntity}/action.json`));
+      }
+
+      // Load schema.json and other schemas in remaining json files
+      files = files.filter((f) => (f !== 'action.json') && f.endsWith('.json'));
+      const schema = [];
+      files.forEach((file) => {
+        const data = JSON.parse(fs.readFileSync(`${entityDir}/${retEntity}/${file}`));
+        schema.push({
+          name: file,
+          schema: data
+        });
+      });
+
+      // return the data
+      return {
+        actions: actions.actions,
+        schema,
+        mockdatafiles
+      };
+    }
+
     // make sure what we need exists and has been provided
     if (!fs.existsSync(`${storDir}`)) {
       log.warn(`${origin}: Could not find adapter storage directory - nothing to retrieve`);
@@ -80,21 +130,29 @@ function getFromJson(fileName, filter) {
         });
       } else {
         // if not metric must match the items in the filter
-        const key = Object.keys(useFilter);
+        // if no filter, match everything
+        let key = [];
+        if (useFilter && useFilter.length > 0) {
+          key = Object.keys(useFilter);
+        }
         content.table.forEach((item) => {
           let push = true;
+          // check each key - if it does not match a key do not add to return data
           key.forEach((fil) => {
             if (useFilter[fil] !== item[fil]) push = false;
           });
           if (push) toReturn.push(item);
         });
       }
+      // not sure why we do this - a little different than above.
       const filtered = content.table.filter((el) => {
-        Object.keys(useFilter).forEach((obj) => {
-          if (el[obj] !== useFilter[obj]) {
-            return false;
-          }
-        });
+        if (useFilter) {
+          Object.keys(useFilter).forEach((obj) => {
+            if (el[obj] !== useFilter[obj]) {
+              return false;
+            }
+          });
+        }
         return true;
       });
       return toReturn;
@@ -401,6 +459,7 @@ class DBUtil {
     this.baseDir = directory;
     adapterDir = this.baseDir;
     storDir = `${adapterDir}/storage`;
+    entityDir = `${adapterDir}/entities`;
     this.props = properties;
     this.adapterMongoClient = null;
 
@@ -1190,7 +1249,11 @@ class DBUtil {
         // if using file storage
         if (storage === Storage.FILESYSTEM) {
           // Find it from file in the adapter
-          let toReturn = getFromJson(collectionName, filter);
+          let toReturn = getFromJson(collectionName, options);
+          if (collectionName === 'adapter_configs') {
+            log.debug(`${origin}: Data retrieved from file storage`);
+            return callback(null, [toReturn]);
+          }
           if (toReturn && toReturn.length > limit) {
             let curEnd = start + limit;
             if (curEnd < toReturn.length) {
@@ -1198,7 +1261,7 @@ class DBUtil {
             }
             toReturn = toReturn.slice(start, curEnd);
           }
-          log.trace(`${origin}: Data retrieved from file storage`);
+          log.debug(`${origin}: Data retrieved from file storage`);
           return callback(null, toReturn);
         }
 

package/lib/propertyUtil.js

@@ -187,6 +187,7 @@ class AdapterPropertyUtil {
       // get the path for the specific schema file
       const reqSchemaFile = path.join(this.baseDir, `/entities/${entityName}/${reqSchemaName}`);
       const respSchemaFile = path.join(this.baseDir, `/entities/${entityName}/${respSchemaName}`);
+      const errorSchemaFile = path.join(this.baseDir, '/entities/.system/errorSchema');
 
       // if the file does not exist - error
       if (!fs.existsSync(reqSchemaFile)) {
@@ -244,6 +245,16 @@ class AdapterPropertyUtil {
         throw new Error(JSON.stringify(errorObj));
       }
 
+      // if the error schema file exist - read it in
+      if (fs.existsSync(errorSchemaFile)) {
+        entitySchema.errorSchema = JSON.parse(fs.readFileSync(errorSchemaFile, 'utf-8'));
+
+        // if the error schema file is bad, warn about it but continue and use the global on!
+        if (entitySchema.errorSchema && typeof entitySchema.errorSchema !== 'object') {
+          log.warn(`${origin}: Invalid error schema, please verify file: ${errorSchemaFile}`);
+        }
+      }
+
       // Merge the information into the entity schema
       entitySchema.protocol = actionInfo.protocol;
       entitySchema.method = actionInfo.method;
@@ -428,7 +439,8 @@ class AdapterPropertyUtil {
         filter: {
           id: this.myid,
           entity: entityName
-        }
+        },
+        entity: entityName
       };
 
       // call to get the adapter schema from the database

package/lib/requestHandler.js

@@ -51,7 +51,7 @@ function validateProperties(properties) {
 
   try {
     // get the path for the specific action file
-    const propertyFile = path.join(__dirname, '/../propertiesSchema.json');
+    const propertyFile = path.join(__dirname, '/../schemas/propertiesSchema.json');
 
     // Read the action from the file system
     const propertySchema = JSON.parse(fs.readFileSync(propertyFile, 'utf-8'));
@@ -113,7 +113,7 @@ function walkThroughActionFiles(directory) {
 
   try {
     // Read the action schema from the file system
-    const actionSchemaFile = path.join(__dirname, '/../actionSchema.json');
+    const actionSchemaFile = path.join(__dirname, '/../schemas/actionSchema.json');
     const actionSchema = JSON.parse(fs.readFileSync(actionSchemaFile, 'utf-8'));
     const entitydir = `${directory}/entities`;
 

package/lib/restHandler.js

@@ -9,6 +9,8 @@ const jsonQuery = require('json-query');
 const jsonxml = require('jsontoxml');
 const xml2js = require('xml2js');
 
+const globalSchema = JSON.parse(require('fs').readFileSync(require('path').join(__dirname, '/../schemas/globalSchema.json')));
+
 let transUtilInst = null;
 let connectorInst = null;
 
@@ -19,6 +21,7 @@ let basepathGl = null;
 let globalRequestGl = null;
 let returnRawGl = false;
 let encodePath = true;
+let encodeUri = true;
 
 // INTERNAL FUNCTIONS
 /*
@@ -178,7 +181,13 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
 
         // if the return error message was JSON then return the parsed object
         if (retError !== null) {
-          retErrorObj.response = retError;
+          // if there is a local error schema in the entity use that one
+          if (Object.hasOwnProperty.call(entitySchema, 'errorSchema')) {
+            retErrorObj.response = transUtilInst.mapFromOutboundEntity(retError, entitySchema.errorSchema);
+          } else {
+            // if there is a no local error schema in the entity use that one
+            retErrorObj.response = transUtilInst.mapFromOutboundEntity(retError, globalSchema);
+          }
         }
 
         // return the error response
@@ -460,6 +469,9 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
         return callback(retObject);
       }
 
+      // Apply global schema
+      // retResponse = transUtilInst.mapFromOutboundEntity(retResponse, globalSchema);
+
       // added the translated response to the return Object
       retObject.response = transUtilInst.mapFromOutboundEntity(retResponse, entitySchema.responseSchema);
 
@@ -677,7 +689,23 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           addquery = entitySchema.querykey;
         }
         if (systemQuery !== null) {
-          addquery += querystring.stringify(systemQuery);
+          // if we are encoding - use querystring since it does it all!
+          if (encodeUri === true) {
+            addquery += querystring.stringify(systemQuery);
+          } else {
+            // if not encoding we need to build
+            const qkeys = Object.keys(systemQuery);
+
+            // add each query parameter and its value
+            for (let k = 0; k < qkeys.length; k += 1) {
+              // need to add separator for everything after the first one
+              if (k > 0) {
+                addquery += '&';
+              }
+              // adds key=value
+              addquery += `${qkeys[k]}=${systemQuery[qkeys[k]]}`;
+            }
+          }
         }
       }
 
@@ -897,7 +925,7 @@ function buildPayload(entity, action, entitySchema, payload) {
           }
         }
       } else {
-        log.warn(`${origin}: Payload and Gloabl Payload can not be merged!`);
+        log.warn(`${origin}: Payload and Global Payload can not be merged!`);
       }
     }
 
@@ -988,6 +1016,8 @@ class RestHandler {
     this.globalRequest = null;
     this.encode = properties.encode_pathvars;
     encodePath = this.encode;
+    this.encodeQ = properties.encode_queryvars;
+    encodeUri = this.encodeQ;
 
     // only need to set returnRaw if the property is true - defaults to false
     if (properties.request && properties.request.return_raw) {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "4.44.9",
+  "version": "4.45.2",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "preinstall": "node utils/setup.js",
     "lint": "eslint . --ext .json --ext .js",
     "lint:errors": "eslint --quiet . --ext .json --ext .js",
-    "test:unit": "mocha test/unit/lib/requestHandlerTest.js --LOG=error && mocha test/unit/lib/restHandlerTest.js --LOG=error && mocha test/unit/lib/propertyUtilTest.js --LOG=error && mocha test/unit/lib/translatorUtilTest.js --LOG=error && mocha test/unit/lib/dbUtilTest.js --LOG=error",
+    "test:unit": "mocha test/unit/lib/requestHandlerTest.js --LOG=error && mocha test/unit/lib/restHandlerTest.js --LOG=error && mocha test/unit/lib/propertyUtilTest.js --LOG=error && mocha test/unit/lib/translatorUtilTest.js --LOG=error && mocha test/unit/lib/dbUtilTest.js --LOG=debug",
     "test:integration": "mocha test/integration/lib/requestHandlerTest.js --LOG=error && mocha test/integration/lib/restHandlerTest.js --LOG=error",
     "test:cover": "nyc --reporter html --reporter text mocha --recursive --reporter dot test/*",
     "test": "npm run test:unit && npm run test:integration",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "license": "Apache-2.0",
@@ -51,7 +51,7 @@
     "eslint-plugin-json": "^3.0.0",
     "mocha": "^9.0.1",
     "nyc": "^15.1.0",
-    "strip-ansi": "^7.0.0",
+    "strip-ansi": "^7.0.1",
     "strip-ansi-cli": "^3.0.1",
     "testdouble": "^3.16.1",
     "winston": "^3.3.3"

package/schemas/globalSchema.json

@@ -0,0 +1,19 @@
+{
+    "$id": "schema.json",
+    "type": "object",
+    "schema": "http://json-schema.org/draft-07/schema#",
+    "translate": true,
+    "dynamicfields": true,
+    "properties": {
+      "id": {
+        "type": "string",
+        "description": "Restricted for: special use within mongo",
+        "encrypt": {
+          "type": "AES",
+          "key": ""
+        },
+        "external_name": "$id"
+      }
+    },
+    "definitions": {}
+  }

package/{propertiesSchema.json → schemas/propertiesSchema.json}

@@ -51,6 +51,11 @@
       "description": "When true the path variables are encoded in the url",
       "default": true
     },
+    "encode_queryvars": {
+      "type": "boolean",
+      "description": "When true the query variables are encoded in the url",
+      "default": true
+    },
     "save_metric": {
       "type": [
         "boolean",