@itentialopensource/adapter-utils 5.9.0 → 5.9.2

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 5.9.2 [10-07-2024]
+
+* add token logs
+
+See merge request itentialopensource/adapter-utils!306
+
+---
+
+## 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

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

@@ -1309,7 +1309,7 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
 
         // process primary token from header
         if (tokenSchema.responseSchema && tokenSchema.responseSchema.properties && tokenSchema.responseSchema.properties.token
-          && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'HEADER') {
+            && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'HEADER') {
           if (!tokenSchema.responseSchema.properties.token.external_name) {
             const errorObj = transUtilInst.formatErrorObject(origin, 'Unable To Get Primary Token', ['Primary Token', result.code], null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
@@ -1317,6 +1317,7 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
           }
 
           const exName = tokenSchema.responseSchema.properties.token.external_name.toLowerCase();
+          log.debug(`Attempting to get primary token from Header ${exName}`);
           const headKeys = Object.keys(result.headers);
           let fullToken = null;
           let setCookie = null;
@@ -1397,6 +1398,7 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
           }
 
           const exName = tokenSchema.responseSchema.properties.tokenp2.external_name.toLowerCase();
+          log.debug(`Attempting to get second token from Header ${exName}`);
           const headKeys = Object.keys(result.headers);
           let fullToken = null;
           let setCookie = null;
@@ -1470,6 +1472,8 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         // process the body
         // if response is just a string
         if (Object.hasOwnProperty.call(tokenSchema, 'responseDatatype') && tokenSchema.responseDatatype.toUpperCase() === 'PLAIN') {
+          log.debug('Attempting to get tokens from text body repsonse');
+
           if (tokenSchema.responseSchema && tokenSchema.responseSchema.properties && tokenSchema.responseSchema.properties.token
             && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'BODY') {
             currResult.token = result.response;
@@ -1493,6 +1497,8 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
           return resolve(currResult);
         }
         if (Object.hasOwnProperty.call(tokenSchema, 'responseDatatype') && tokenSchema.responseDatatype.toUpperCase() === 'XML') {
+          log.debug('Attempting to get tokens from XML body repsonse');
+
           if (tokenSchema.responseSchema && tokenSchema.responseSchema.properties && tokenSchema.responseSchema.properties.token
             && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'BODY') {
             currResult.token = result.response;
@@ -1510,6 +1516,8 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         let tempResult = null;
         if (result.response) {
           if (Object.hasOwnProperty.call(tokenSchema, 'responseDatatype') && tokenSchema.responseDatatype.toUpperCase() === 'XML2JSON') {
+            log.debug('Attempting to get tokens from XML2JSON repsonse');
+
             try {
               const parser = new xml2js.Parser({ explicitArray: false, attrkey: '_attr' });
               parser.parseString(result.response, (error, presult) => {
@@ -1532,9 +1540,11 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
             }
           }
           if (Object.hasOwnProperty.call(tokenSchema, 'responseDatatype') && tokenSchema.responseDatatype.toUpperCase() === 'URLENCODE') {
+            log.debug('Attempting to get tokens from URLENCODE repsonse');
             tempResult = querystring.parse(result.response.trim());
           } else {
             try {
+              log.debug('Parsing JSON response');
               tempResult = JSON.parse(result.response.trim());
             } catch (exc) {
               log.warn(exc);
@@ -1572,7 +1582,9 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         }
 
         // return the token from the token schema
+        log.debug(`About to Translate Token Response: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tempResult))}`);
         let translated = transUtilInst.mapFromOutboundEntity(tempResult, tokenSchema.responseSchema);
+        log.debug(`Translated response ${JSON.stringify(propUtilInst.scrubSensitiveInfo(translated))}`);
 
         // if what we got back is an array, just return the first element
         // should only have one token!!!
@@ -2131,7 +2143,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
@@ -2203,16 +2215,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
@@ -2525,6 +2538,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
@@ -2551,7 +2594,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 = {};
               }
@@ -2562,48 +2605,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);
             }
           });
         }
@@ -3076,17 +3115,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;
@@ -3581,6 +3622,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);
       }
@@ -3710,6 +3753,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);
         }
@@ -4845,6 +4890,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);
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "5.9.0",
+  "version": "5.9.2",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",
@@ -29,7 +29,7 @@
     "async-lock": "^1.4.0",
     "aws-sdk": "^2.1665.0",
     "aws4": "^1.9.1",
-    "cookie": "^0.5.0",
+    "cookie": "^0.7.1",
     "crypto-js": "^4.1.1",
     "ejs": "^3.1.10",
     "form-data": "^4.0.0",