@itentialopensource/adapter-utils 5.9.5 → 5.10.1

package/CHANGELOG.md

@@ -1,4 +1,22 @@
 
+## 5.10.1 [11-18-2024]
+
+* mask values in the STS log
+
+Closes ENG-7296
+
+See merge request itentialopensource/adapter-utils!311
+
+---
+
+## 5.10.0 [11-15-2024]
+
+* query without keys
+
+See merge request itentialopensource/adapter-utils!310
+
+---
+
 ## 5.9.5 [11-06-2024]
 
 * more role chain changes for AWS

package/lib/authenticationHandler.js

@@ -19,10 +19,11 @@ class AuthenticationHandler {
    * Adapter Authentication Handler
    * @constructor
    */
-  constructor(prongId, properties, reqH) {
+  constructor(prongId, properties, reqH, propUtilCl) {
     this.myid = prongId;
     this.allProps = properties;
     this.requestHandlerInst = reqH;
+    this.propUtil = propUtilCl;
 
     // set up the properties I care about
     this.refreshProperties(properties);
@@ -101,7 +102,7 @@ class AuthenticationHandler {
       // set the original AWS access information (from properties)
       AWS.config.update(configObj);
       const sts = new AWS.STS();
-      log.debug(`STS OPTIONS: ${JSON.stringify(configObj)}`);
+      log.debug(`STS OPTIONS: ${this.propUtil.scrubSensitiveInfo(JSON.stringify(configObj))}`);
 
       // use STS to get the AWS access information for the user defined in STWS Params
       const stsData = {

package/lib/requestHandler.js

@@ -466,7 +466,7 @@ class RequestHandler {
       this.transUtil = new TransUtilCl(prongId, this.propUtil);
       transUtilInst = this.transUtil;
 
-      this.authHandler = new AuthHandlerCl(this.myid, this.props, this);
+      this.authHandler = new AuthHandlerCl(this.myid, this.props, this, this.propUtil);
       // validate the action files for the adapter
       this.clean = walkThroughActionFiles(this.directory);
 

package/lib/restHandler.js

@@ -23,6 +23,7 @@ let globalRequestGl = null;
 let returnRawGl = false;
 let encodePath = true;
 let encodeUri = true;
+let queryKeyGl = true;
 let stripEscapes = false;
 let returnResponseHeaders = true;
 let healthcheckHeaders = null;
@@ -797,12 +798,20 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           addquery = entitySchema.querykey;
         }
         if (systemQuery !== null) {
+          // do not want to change the global only change this call so use a local var
+          let localEncode = encodeUri;
+          let localKey = queryKeyGl;
+
           // if encoding is changed in call properties that overrides the default
           if (callProperties && Object.hasOwnProperty.call(callProperties, 'encode_queryvars')) {
-            encodeUri = callProperties.encode_queryvars;
+            localEncode = callProperties.encode_queryvars;
+          }
+          if (callProperties && Object.hasOwnProperty.call(callProperties, 'query_keys')) {
+            localKey = callProperties.query_keys;
           }
-          // if we are encoding - use querystring since it does it all!
-          if (encodeUri === true) {
+
+          // if we are encoding with keys - use querystring since it does it all!
+          if (localEncode === true && localKey === true) {
             addquery += querystring.stringify(systemQuery);
           } else {
             // if not encoding we need to build
@@ -814,8 +823,17 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
               if (k > 0) {
                 addquery += '&';
               }
-              // adds key=value
-              addquery += `${qkeys[k]}=${systemQuery[qkeys[k]]}`;
+
+              if (localKey === true) {
+                // adds key=value
+                addquery += `${qkeys[k]}=${systemQuery[qkeys[k]]}`;
+              } else if (localEncode === true) {
+                // adds value but encoded
+                addquery += encodeURIComponent(systemQuery[qkeys[k]]);
+              } else {
+                // adds value
+                addquery += `${systemQuery[qkeys[k]]}`;
+              }
             }
           }
         }
@@ -1147,6 +1165,11 @@ class RestHandler {
     encodePath = this.encode;
     this.encodeQ = properties.encode_queryvars;
     encodeUri = this.encodeQ;
+    this.queryKey = true;
+    if (Object.hasOwnProperty.call(properties, 'query_keys')) {
+      this.queryKey = properties.query_keys;
+    }
+    queryKeyGl = this.queryKey;
 
     // optional to strip extra escapes - default is false
     if (properties.stripEscapes) {

package/package.json

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

package/schemas/propertiesSchema.json

@@ -69,6 +69,11 @@
       "description": "When true the query parameters are encoded in the url",
       "default": true
     },
+    "query_keys": {
+      "type": "boolean",
+      "description": "When true the query keys are put into the url (e.g. key=value)",
+      "default": true
+    },
     "save_metric": {
       "type": [
         "boolean",