@itentialopensource/adapter-utils 4.45.0 → 4.45.1

package/CHANGELOG.md

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

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;

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;
 
@@ -179,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
@@ -461,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);
 

package/package.json

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

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": {}
+  }