@itentialopensource/adapter-utils 5.8.0 → 5.9.1

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 5.9.1 [09-26-2024]
+
+* Update refresh token logic
+
+See merge request itentialopensource/adapter-utils!304
+
+---
+
+## 5.9.0 [09-23-2024]
+
+* Cache ssl file contents in memory
+
+See merge request itentialopensource/adapter-utils!303
+
+---
+
 ## 5.8.0 [09-09-2024]
 
 * Add support for RESTCONF endpoints

package/error.json

@@ -144,6 +144,12 @@
       "displayString": "The Adapter has run out of time for the request",
       "recommendation": "Increase your adapter request.attempt_timeout property"
     },
+    {
+      "key": "Disconnect",
+      "icode": "AD.502",
+      "displayString": "The connection was terminated by the network or external system",
+      "recommendation": "Check connectivity to the external system and that the system is up"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/lib/connectorRest.js

@@ -127,6 +127,9 @@ let crest = null;
 let cacheHHead = null;
 let cacheHSchema = null;
 let cacheHPay = null;
+let sslCAFilePath = null;
+let sslKeyFilePath = null;
+let sslCertFilePath = null;
 
 const mfaStepsResults = []; // keeps requested result for each step
 
@@ -2028,34 +2031,32 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
             options.rejectUnauthorized = false;
           } else {
             // if we are not accepting invalid certs, need the ca file in the options
-            try {
-              options.rejectUnauthorized = true;
-              if (sslCAFileContent && sslCAFileContent !== '') {
-                options.ca = [sslCAFileContent];
-              } else {
-                options.ca = [fs.readFileSync(sslCAFile)];
-              }
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+            options.rejectUnauthorized = true;
+            if (sslCAFileContent && sslCAFileContent !== '') {
+              options.ca = [sslCAFileContent];
+            } else if (sslCAFile) {
+              options.ca = sslCAFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return reject(errorObj);
             }
             // if there is a cert file, try to read in a cert file in the options
-            if (sslCertFile) {
-              try {
-                options.cert = [fs.readFileSync(sslCertFile)];
-              } catch (e) {
-                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+            if (sslCertFilePath) {
+              if (sslCertFile) {
+                options.cert = sslCertFile;
+              } else {
+                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
                 log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
                 return reject(errorObj);
               }
             }
             // if there is a key file, try to read in a key file in the options
-            if (sslKeyFile) {
-              try {
-                options.key = [fs.readFileSync(sslKeyFile)];
-              } catch (e) {
-                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+            if (sslKeyFilePath) {
+              if (sslKeyFile) {
+                options.key = sslKeyFile;
+              } else {
+                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
                 log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
                 return reject(errorObj);
               }
@@ -2130,7 +2131,7 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
 
           // if this is not a get, need to add the info to the request
           if (options.method !== 'GET') {
-            if (authMethod !== 'multi_step_authentication') {
+            if (authMethod !== 'multi_step_authentication' && !runRefreshToken) {
               creds = {
                 username: useUser,
                 password: usePass
@@ -2202,16 +2203,17 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
               Object.assign(creds, body);
               // If there are query variables, add them to the path
               if (Object.keys(query).length > 0) {
+                const systemQuery = transUtilInst.mapToOutboundEntity(query, tokenSchema.requestSchema);
                 let refTokenQueryString = '';
                 if (encodeUri === true) {
-                  refTokenQueryString += querystring.stringify(query);
+                  refTokenQueryString += querystring.stringify(systemQuery);
                 } else {
-                  const refTokenQueryKeys = Object.keys(query);
+                  const refTokenQueryKeys = Object.keys(systemQuery);
                   for (let k = 0; k < refTokenQueryKeys.length; k += 1) {
                     if (k > 0) {
                       refTokenQueryString += '&';
                     }
-                    refTokenQueryString += `${refTokenQueryKeys[k]}=${query[refTokenQueryKeys[k]]}`;
+                    refTokenQueryString += `${refTokenQueryKeys[k]}=${systemQuery[refTokenQueryKeys[k]]}`;
                   }
                 }
                 // append to the path
@@ -2524,6 +2526,36 @@ function getCachedRefToken(cachedTokenIdentifier, invalidToken) {
   });
 }
 
+function handleToken(dyntoken, user, reqBody, done) {
+  let timeout = tokenTimeout;
+  // if we should use the timeout from the token request
+  if (timeout === 0) {
+    timeout = findExpireInResult(dyntoken);
+  } else {
+    // otherwise add the timeout to the current time
+    timeout += new Date().getTime();
+  }
+
+  const tokenObj = {
+    token: findPrimaryTokenInResult(dyntoken, dyntoken.front, dyntoken.end),
+    tokenp2: findSecondaryTokenInResult(dyntoken, dyntoken.front, dyntoken.end),
+    refreshToken: dyntoken.refreshToken
+  };
+
+  // if this is worth caching
+  if (timeout && timeout > 0) {
+    // since this is adding the token for future use, do not care when it comes back
+    addTokenItem(user, reqBody, tokenObj, timeout, (addedtoken, aerror) => {
+      if (aerror) {
+        return done(null, aerror);
+      }
+      done(tokenObj, null);
+    });
+  } else {
+    done(tokenObj, null);
+  }
+}
+
 /*
  * INTERNAL FUNCTION: getTokenItem is used to retrieve a token items from
  *    memory based on the user provided
@@ -2550,7 +2582,7 @@ function getTokenItem(pathForToken, user, reqBody, invalidToken, callProperties,
               done(null, rerror);
             }
             if (refToken !== null) {
-              log.debug(`${origin}-returning cached refresh token`);
+              log.debug(`${origin}: Returning cached refresh token`);
               if (!callProperties) {
                 callProperties = {};
               }
@@ -2561,48 +2593,44 @@ function getTokenItem(pathForToken, user, reqBody, invalidToken, callProperties,
                 // Refresh the token if getRefreshToken entity exists
                 if (tokenSchema) {
                   runRefreshToken = true;
+                } else {
+                  log.debug(`${origin}: Refresh token schema does not exist, will not refresh token`);
+                  runRefreshToken = false;
                 }
               });
-            } else runRefreshToken = false;
+            } else {
+              runRefreshToken = false;
+            }
           });
           // No valid token found, Need to get a new token and add it to the token list
           buildTokenRequest(pathForToken, reqBody, callProperties, (dyntoken, berror) => {
-            if (berror) {
-              // done(null, berror);
-              return done(berror);
-            }
-            if (!dyntoken) {
-              // done(null, 'No Token returned');
-              return done(new Error('No Token returned'));
-            }
-
-            let timeout = tokenTimeout;
-
-            // if we should use the timeout from the token request
-            if (timeout === 0) {
-              timeout = findExpireInResult(dyntoken);
-            } else {
-              // otherwise add the timeout to the current time
-              timeout += new Date().getTime();
-            }
-
-            const tokenObj = {
-              token: findPrimaryTokenInResult(dyntoken, dyntoken.front, dyntoken.end),
-              tokenp2: findSecondaryTokenInResult(dyntoken, dyntoken.front, dyntoken.end),
-              refreshToken: dyntoken.refreshToken
-            };
-
-            // if this is worth caching
-            if (timeout && timeout > 0) {
-              // since this is adding the token for future use, do not care when it comes back
-              addTokenItem(user, reqBody, tokenObj, timeout, (addedtoken, aerror) => {
-                if (aerror) {
-                  done(null, aerror);
+            if (berror || !dyntoken) {
+              if (runRefreshToken) {
+                log.debug(`${origin}: Failed to refresh token, use auth steps to get a new token`);
+                runRefreshToken = false;
+                buildTokenRequest(pathForToken, reqBody, callProperties, (innerDyntoken, innerBerror) => {
+                  if (innerBerror) {
+                    // done(null, innerBerror);
+                    return done(innerBerror);
+                  }
+                  if (!innerDyntoken) {
+                    // done(null, 'No Token returned');
+                    return done(new Error('No Token returned'));
+                  }
+                  handleToken(innerDyntoken, user, reqBody, done);
+                });
+              } else {
+                if (berror) {
+                  // done(null, berror);
+                  return done(berror);
                 }
-                done(tokenObj, null);
-              });
+                if (!dyntoken) {
+                  // done(null, 'No Token returned');
+                  return done(new Error('No Token returned'));
+                }
+              }
             } else {
-              done(tokenObj, null);
+              handleToken(dyntoken, user, reqBody, done);
             }
           });
         }
@@ -3075,17 +3103,19 @@ async function getMfaFinalTokens(request, callProperties, invalidToken) {
         // If cached refresh token is valid and there is action for getRefreshToken, run refresh token
         if (tokenSchema) {
           runRefreshToken = true;
+        } else {
+          log.debug(`${origin}: Refresh token schema does not exist, will not refresh token`);
+          runRefreshToken = false;
         }
       });
       if (runRefreshToken) {
         finalTokens = await buildTokenRequest(request.header.path, request.authData, callProperties).catch((error) => { // eslint-disable-line no-await-in-loop
-          log.error(error);
-          throw error;
+          log.debug(`${origin}: Failed to refresh token, run auth steps to obtain a new token`);
         });
         if (finalTokens) {
           await cacheMfaToken(cachedTokenIdentifier, finalTokens).catch((error) => log.error(error));
+          return;
         }
-        return;
       }
     }
     runRefreshToken = false;
@@ -3580,6 +3610,8 @@ function handleEndResponse(request, makeResp, overallTime, callback) {
 
       if (makeResp.code === -2) {
         errorObj = transUtilInst.formatErrorObject(origin, 'Request Timeout', [makeResp.code], makeResp.code, makeResp, null);
+      } else if (makeResp.code === -1) {
+        errorObj = transUtilInst.formatErrorObject(origin, 'Disconnect', [makeResp.code], makeResp.code, makeResp, null);
       } else {
         errorObj = transUtilInst.formatErrorObject(origin, 'Error On Request', [makeResp.code], makeResp.code, makeResp, null);
       }
@@ -3709,6 +3741,8 @@ function handleEndThrottleResponse(request, myTransTime, claimedLic, makeResp, r
 
         if (makeResp.code === -2) {
           errorObj = transUtilInst.formatErrorObject(origin, 'Request Timeout', [makeResp.code], makeResp.code, makeResp, null);
+        } else if (makeResp.code === -1) {
+          errorObj = transUtilInst.formatErrorObject(origin, 'Disconnect', [makeResp.code], makeResp.code, makeResp, null);
         } else {
           errorObj = transUtilInst.formatErrorObject(origin, 'Error On Request', [makeResp.code], makeResp.code, makeResp, null);
         }
@@ -4453,22 +4487,40 @@ class ConnectorRest {
       }
 
       // set the ssl ca file (optional - default is null)
-      if (typeof props.ssl.ca_file === 'string') {
-        sslCAFile = props.ssl.ca_file;
+      if (typeof props.ssl.ca_file === 'string' && props.ssl.ca_file.trim() !== '') {
+        sslCAFilePath = props.ssl.ca_file;
+        try {
+          sslCAFile = [fs.readFileSync(props.ssl.ca_file)];
+        } catch (err) {
+          log.error(`Failed to read CA file: ${err.message}`);
+          sslCAFile = null;
+        }
       }
 
-      if (typeof props.ssl.ca_file_content === 'string') {
+      if (typeof props.ssl.ca_file_content === 'string' && props.ssl.ca_file_content.trim() !== '') {
         sslCAFileContent = props.ssl.ca_file_content;
       }
 
       // set the ssl key file (optional - default is null)
-      if (typeof props.ssl.key_file === 'string') {
-        sslKeyFile = props.ssl.key_file;
+      if (typeof props.ssl.key_file === 'string' && props.ssl.key_file.trim() !== '') {
+        sslKeyFilePath = props.ssl.key_file;
+        try {
+          sslKeyFile = [fs.readFileSync(props.ssl.key_file)];
+        } catch (err) {
+          log.error(`Failed to read SSL file: ${err.message}`);
+          sslKeyFile = null;
+        }
       }
 
       // set the ssl cert file (optional - default is null)
-      if (typeof props.ssl.cert_file === 'string') {
-        sslCertFile = props.ssl.cert_file;
+      if (typeof props.ssl.cert_file === 'string' && props.ssl.cert_file.trim() !== '') {
+        sslCertFilePath = props.ssl.cert_file;
+        try {
+          sslCertFile = [fs.readFileSync(props.ssl.cert_file)];
+        } catch (err) {
+          log.error(`Failed to read SSL Cert file: ${err.message}`);
+          sslCertFile = null;
+        }
       }
 
       // set the ssl ciphers (optional - default is null)
@@ -4741,34 +4793,32 @@ class ConnectorRest {
           options.rejectUnauthorized = false;
         } else {
           // if we are not accepting invalid certs, need the ca file in the options
-          try {
-            options.rejectUnauthorized = true;
-            if (sslCAFileContent && sslCAFileContent !== '') {
-              options.ca = [sslCAFileContent];
-            } else {
-              options.ca = [fs.readFileSync(sslCAFile)];
-            }
-          } catch (e) {
-            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+          options.rejectUnauthorized = true;
+          if (sslCAFileContent && sslCAFileContent !== '') {
+            options.ca = [sslCAFileContent];
+          } else if (sslCAFile) {
+            options.ca = sslCAFile;
+          } else {
+            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
             return callback(null, errorObj);
           }
           // if there is a cert file, try to read in a cert file in the options
-          if (sslCertFile) {
-            try {
-              options.cert = [fs.readFileSync(sslCertFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+          if (sslCertFilePath) {
+            if (sslCertFile) {
+              options.cert = sslCertFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
           }
           // if there is a key file, try to read in a key file in the options
-          if (sslKeyFile) {
-            try {
-              options.key = [fs.readFileSync(sslKeyFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+          if (sslKeyFilePath) {
+            if (sslKeyFile) {
+              options.key = sslKeyFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
@@ -4828,6 +4878,8 @@ class ConnectorRest {
 
           if (pres.code === -2) {
             errorObj = transUtilInst.formatErrorObject(origin, 'Request Timeout', [pres.code], pres.code, pres, null);
+          } else if (pres.code === -1) {
+            errorObj = transUtilInst.formatErrorObject(origin, 'Disconnect', [pres.code], pres.code, pres, null);
           } else {
             errorObj = transUtilInst.formatErrorObject(origin, 'Error On Request', [pres.code], pres.code, pres, null);
           }
@@ -4938,34 +4990,32 @@ class ConnectorRest {
           options.rejectUnauthorized = false;
         } else {
           // if we are not accepting invalid certs, need the ca file in the options
-          try {
-            options.rejectUnauthorized = true;
-            if (sslCAFileContent && sslCAFileContent !== '') {
-              options.ca = [sslCAFileContent];
-            } else {
-              options.ca = [fs.readFileSync(sslCAFile)];
-            }
-          } catch (e) {
-            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+          options.rejectUnauthorized = true;
+          if (sslCAFileContent && sslCAFileContent !== '') {
+            options.ca = [sslCAFileContent];
+          } else if (sslCAFile) {
+            options.ca = sslCAFile;
+          } else {
+            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
             return callback(null, errorObj);
           }
           // if there is a cert file, try to read in a cert file in the options
-          if (sslCertFile) {
-            try {
-              options.cert = [fs.readFileSync(sslCertFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+          if (sslCertFilePath) {
+            if (sslCertFile) {
+              options.cert = sslCertFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
           }
           // if there is a key file, try to read in a key file in the options
-          if (sslKeyFile) {
-            try {
-              options.key = [fs.readFileSync(sslKeyFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+          if (sslKeyFilePath) {
+            if (sslKeyFile) {
+              options.key = sslKeyFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }

package/lib/propertyUtil.js

@@ -1023,7 +1023,7 @@ class AdapterPropertyUtil {
       errorObj.exception = e;
 
       // return the error message
-      log.info(`unable to get adapter config from database: ${e}`);
+      log.info(`unable to get adapter config from database: ${e}, using config from file system`);
       return callback(null, errorObj);
     }
   }

package/lib/restHandler.js

@@ -683,6 +683,10 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           // with the provided id
           let idString = '';
 
+          // if encoding is changed in call properties that overrides the default
+          if (callProperties && Object.hasOwnProperty.call(callProperties, 'encode_pathvars')) {
+            encodePath = callProperties.encode_pathvars;
+          }
           // check if the current URI path ends with a slash (may require
           // slash at end)
           if (uriPath[hindex - 2] === '/' || uriPath[hindex - 2] === ':') {
@@ -793,6 +797,10 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           addquery = entitySchema.querykey;
         }
         if (systemQuery !== null) {
+          // if encoding is changed in call properties that overrides the default
+          if (callProperties && Object.hasOwnProperty.call(callProperties, 'encode_queryvars')) {
+            encodeUri = callProperties.encode_queryvars;
+          }
           // if we are encoding - use querystring since it does it all!
           if (encodeUri === true) {
             addquery += querystring.stringify(systemQuery);

package/package.json

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

package/compliance-report.json

@@ -1,9 +0,0 @@
-{
-  "ComplianceEntries": [
-    {
-      "name": "Compliance Summary",
-      "numInvalidProjects": 0,
-      "numValidProjects": 0
-    }
-  ]
-}

package/compliance-report.txt

@@ -1,5 +0,0 @@
----------------------------------------------------------------------------------------------
-**** Project Compliance Summary ****
-0 project(s) are not valid
-0 project(s) are valid
----------------------------------------------------------------------------------------------