@itentialopensource/adapter-utils 5.3.7 → 5.3.8

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+## 5.3.8 [02-13-2024]
+
+* Handle missing keys for device broker props
+
+Closes ADAPT-3265
+
+See merge request itentialopensource/adapter-utils!290
+
+---
+
 ## 5.3.7 [02-09-2024]
 
 * Fix to STSParams for AWS Adapters

package/lib/requestHandler.js

@@ -84,14 +84,14 @@ function validateProperties(properties) {
 
     // need to decode/decrypt the static token if it is encoded/encrypted
     if (combinedProps.authentication && combinedProps.authentication.token
-        && (combinedProps.authentication.token.indexOf('{code}') === 0
+      && (combinedProps.authentication.token.indexOf('{code}') === 0
         || combinedProps.authentication.token.indexOf('{crypt}') === 0)) {
       combinedProps.authentication.token = propUtilInst.decryptProperty(combinedProps.authentication.token);
     }
 
     // need to decode/decrypt the password if it is encoded/encrypted
     if (combinedProps.authentication && combinedProps.authentication.password
-        && (combinedProps.authentication.password.indexOf('{code}') === 0
+      && (combinedProps.authentication.password.indexOf('{code}') === 0
         || combinedProps.authentication.password.indexOf('{crypt}') === 0)) {
       combinedProps.authentication.password = propUtilInst.decryptProperty(combinedProps.authentication.password);
     }
@@ -220,14 +220,14 @@ function walkThroughActionFiles(directory) {
 
               // check that the action is in the schemas
               if (!reqSchema || !reqSchema.properties || !reqSchema.properties.ph_request_type
-                  || !reqSchema.properties.ph_request_type.enum || !reqSchema.properties.ph_request_type.enum.includes(act.name)) {
+                || !reqSchema.properties.ph_request_type.enum || !reqSchema.properties.ph_request_type.enum.includes(act.name)) {
                 let msg = `${origin}: Error on validation of actions for entity `;
                 msg += `${entities[e]}: ${act.name} - missing from ph_request_type in request schema`;
                 clean.push(msg);
                 log.warn(msg);
               }
               if (!respSchema || !respSchema.properties || !respSchema.properties.ph_request_type
-                  || !respSchema.properties.ph_request_type.enum || !respSchema.properties.ph_request_type.enum.includes(act.name)) {
+                || !respSchema.properties.ph_request_type.enum || !respSchema.properties.ph_request_type.enum.includes(act.name)) {
                 let msg = `${origin}: Error on validation of actions for entity `;
                 msg += `${entities[e]}: ${act.name} - missing from ph_request_type in response schema`;
                 clean.push(msg);
@@ -348,9 +348,13 @@ function getDataFromSources(loopField, sources, props) {
   // Check for field in adapter properties
   if (!foundProp && props && props[loopField]) {
     fieldValue = props[loopField];
+    foundProp = true;
   }
 
-  return fieldValue;
+  if (foundProp) {
+    return fieldValue;
+  }
+  return null;
 }
 
 /**
@@ -394,7 +398,7 @@ function setConditionalValue(valueField, sources, props) {
   let finalValue = operands[0]; // {name}
   for (let i = 0; i < operandA.length; i += 1) {
     const fieldValue = getDataFromSources(operandA[i], sources, props);
-    if (fieldValue === operandA[i]) {
+    if (fieldValue === operandA[i] || fieldValue === null) {
       // did not find value - break here to try second part of conditional
       [, finalValue] = operands;
       break;
@@ -410,12 +414,11 @@ function setConditionalValue(valueField, sources, props) {
   // Look for values for keys to the right of {||}
   for (let j = 0; j < operandB.length; j += 1) {
     const fieldValue = getDataFromSources(operandB[j], sources, props);
-    if (fieldValue === operandB[j]) {
+    if (fieldValue === operandB[j] || fieldValue === null) {
       throw new Error(`Could not find value in sources for ${operandA} or ${operandB}`);
     }
     finalValue = finalValue.replace(`{${operandB[j]}}`, fieldValue);
   }
-
   return finalValue;
 }
 
@@ -429,9 +432,10 @@ function setResponseDataFromSources(loopField, sources, props) {
   for (let k = 0; k < keys.length; k += 1) {
     const responseKey = keys[k];
     const fieldValue = getDataFromSources(responseKey, sources, props);
-    myField = myField.replace(`{${responseKey}}`, fieldValue);
+    if (fieldValue) {
+      myField = myField.replace(`{${responseKey}}`, fieldValue);
+    }
   }
-
   return myField;
 }
 
@@ -510,7 +514,7 @@ class RequestHandler {
       this.failoverCodes = [];
 
       if (this.props.request && this.props.request.failover_codes
-          && Array.isArray(this.props.request.failover_codes)) {
+        && Array.isArray(this.props.request.failover_codes)) {
         this.failoverCodes = this.props.request.failover_codes;
       }
 
@@ -650,6 +654,9 @@ class RequestHandler {
           const pathKeys = extractKeysFromBraces(uriPath);
           for (let pathKey = 0; pathKey < pathKeys.length; pathKey += 1) {
             const fieldValue = getDataFromSources(pathKeys[pathKey], sources, this.props);
+            if (fieldValue === null) {
+              return callback(null, `Value for path key {${pathKeys[pathKey]}} not found`);
+            }
             uriPath = uriPath.replace(`{${pathKeys[pathKey]}}`, fieldValue);
           }
         }
@@ -667,6 +674,9 @@ class RequestHandler {
           for (let m = 0; m < matches.length; m += 1) {
             const queryKey = matches[m];
             const fieldValue = getDataFromSources(queryKey, sources, this.props);
+            if (fieldValue === null) {
+              return callback(null, `Value for query key {${queryKey}} not found`);
+            }
             callQuery[cpKeys[cp]] = callQuery[cpKeys[cp]].replace(`{${queryKey}}`, fieldValue);
           }
         }
@@ -678,9 +688,12 @@ class RequestHandler {
         for (let cb = 0; cb < cbKeys.length; cb += 1) {
           const matches = extractKeysFromBraces(callBody[cbKeys[cb]]);
           for (let m = 0; m < matches.length; m += 1) {
-          // make any necessary changes to the query params
+            // make any necessary changes to the query params
             const bodyKey = matches[m];
             const fieldValue = getDataFromSources(bodyKey, sources, this.props);
+            if (fieldValue === null) {
+              return callback(null, `Value for body key {${bodyKey}} not found`);
+            }
             callBody[cbKeys[cb]] = callBody[cbKeys[cb]].replace(`{${bodyKey}}`, fieldValue);
           }
         }
@@ -695,6 +708,9 @@ class RequestHandler {
             const headerKey = matches[m];
             // make any necessary changes to the query params
             const fieldValue = getDataFromSources(headerKey, sources, this.props);
+            if (fieldValue === null) {
+              return callback(null, `Value for header key {${headerKey}} not found`);
+            }
             callHeaders[chKeys[ch]] = callQuery[chKeys[ch]].replace(`{${headerKey}}`, fieldValue);
           }
         }
@@ -756,7 +772,6 @@ class RequestHandler {
               if (rfKeys[rf] !== 'ostypePrefix') {
                 // devResp removed due to conditional issues
                 let fieldValue = setResponseDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, callProps.requestFields]);
-
                 // if the field is ostype - need to add prefix
                 if (rfKeys[rf] === 'ostype' && typeof fieldValue === 'string') {
                   fieldValue = ostypePrefix + fieldValue;
@@ -920,15 +935,15 @@ class RequestHandler {
           if (requestObj && requestObj.datatype) {
             // must have a legitimate request data type
             if (requestObj.datatype.request && (requestObj.datatype.request.toUpperCase() === 'JSON'
-                || requestObj.datatype.request.toUpperCase() === 'XML' || requestObj.datatype.request.toUpperCase() === 'URLENCODE'
-                || requestObj.datatype.request.toUpperCase() === 'URLQUERY' || requestObj.datatype.request.toUpperCase() === 'FORM'
-                || requestObj.datatype.request.toUpperCase() === 'JSON2XML' || requestObj.datatype.request.toUpperCase() === 'PLAIN')) {
+              || requestObj.datatype.request.toUpperCase() === 'XML' || requestObj.datatype.request.toUpperCase() === 'URLENCODE'
+              || requestObj.datatype.request.toUpperCase() === 'URLQUERY' || requestObj.datatype.request.toUpperCase() === 'FORM'
+              || requestObj.datatype.request.toUpperCase() === 'JSON2XML' || requestObj.datatype.request.toUpperCase() === 'PLAIN')) {
               entitySchema.requestDatatype = requestObj.datatype.request;
             }
             // must have a legitimate response data type
             if (requestObj.datatype.response && (requestObj.datatype.response.toUpperCase() === 'JSON'
-                || requestObj.datatype.response.toUpperCase() === 'XML' || requestObj.datatype.response.toUpperCase() === 'URLENCODE'
-                || requestObj.datatype.response.toUpperCase() === 'XML2JSON' || requestObj.datatype.response.toUpperCase() === 'PLAIN')) {
+              || requestObj.datatype.response.toUpperCase() === 'XML' || requestObj.datatype.response.toUpperCase() === 'URLENCODE'
+              || requestObj.datatype.response.toUpperCase() === 'XML2JSON' || requestObj.datatype.response.toUpperCase() === 'PLAIN')) {
               entitySchema.responseDatatype = requestObj.datatype.response;
             }
           }

package/package.json

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