revised the retrystrategy

snowflakedb · Nov 2, 2023 · b1be52e · b1be52e
1 parent 6cc2fda
commit b1be52e
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 18 deletions.
diff --git a/lib/connection/connection_config.js b/lib/connection/connection_config.js
@@ -51,7 +51,7 @@ const DEFAULT_PARAMS =
   'forceStageBindError',
   'includeRetryReason',
   'disableQueryContextCache',
-  'loginTimeout',
+  'retryTimeout',
 ];
 const Logger = require('../logger');
 
@@ -485,12 +485,12 @@ function ConnectionConfig(options, validateCredentials, qaMode, clientInfo)
     disableQueryContextCache = options.disableQueryContextCache;
   }
 
-  let loginTimeout = 300;
-  if (Util.exists(options.loginTimeout)) {
-    Errors.checkArgumentValid(Util.isNumber(options.loginTimeout),
-    ErrorCodes.ERR_CONN_CREATE_INVALID_MAX_LOGIN_TIMEOUT);
+  let retryTimeout = 300;
+  if (Util.exists(options.retryTimeout)) {
+    Errors.checkArgumentValid(Util.isNumber(options.retryTimeout),
+    ErrorCodes.ERR_CONN_CREATE_INVALID_MAX_RETRY_TIMEOUT);
 
-    loginTimeout = Math.max(loginTimeout,options.loginTimeout);
+    retryTimeout = Math.max(retryTimeout,options.retryTimeout);
   }
 
   if (validateDefaultParameters)
@@ -808,8 +808,8 @@ function ConnectionConfig(options, validateCredentials, qaMode, clientInfo)
    *
    * @returns {Number}
    */
-  this.getLoginTimeout = function () {
-    return loginTimeout;
+  this.getRetryTimeout = function () {
+    return retryTimeout;
   }
 
   // save config options
@@ -978,7 +978,7 @@ function createParameters()
     },
     {
       name: PARAM_RETRY_SF_STARTING_SLEEP_TIME,
-      defaultValue: 4,
+      defaultValue: 1,
       validate: isNonNegativeNumber
     },
     {

diff --git a/lib/constants/error_messages.js b/lib/constants/error_messages.js
@@ -68,7 +68,7 @@ exports[404040] = 'Invalid browser timeout value. The specified value must be a
 exports[404041] = 'Invalid disablQueryContextCache. The specified value must be a boolean.';
 exports[404042] = 'Invalid includeRetryReason. The specified value must be a boolean.'
 exports[404043] = 'Invalid clientConfigFile value. The specified value must be a string.';
-exports[404044] = 'Invalid loginTimeout value. The specified value must be a number.';
+exports[404044] = 'Invalid retryTimeout value. The specified value must be a number.';
 
 // 405001
 exports[405001] = 'Invalid callback. The specified value must be a function.';

diff --git a/lib/errors.js b/lib/errors.js
@@ -73,7 +73,7 @@ codes.ERR_CONN_CREATE_INVALID_BROWSER_TIMEOUT = 404040;
 codes.ERR_CONN_CREATE_INVALID_DISABLED_QUERY_CONTEXT_CACHE = 404041
 codes.ERR_CONN_CREATE_INVALID_INCLUDE_RETRY_REASON =404042
 codes.ERR_CONN_CREATE_INVALID_CLIENT_CONFIG_FILE = 404043;
-codes.ERR_CONN_CREATE_INVALID_LOGIN_TIMEOUT = 404044;
+codes.ERR_CONN_CREATE_INVALID_RETRY_TIMEOUT = 404044;
 
 // 405001
 codes.ERR_CONN_CONNECT_INVALID_CALLBACK = 405001;

diff --git a/lib/services/sf.js b/lib/services/sf.js
@@ -1179,10 +1179,10 @@ StateConnecting.prototype.continue = function ()
   const startTime = connectionConfig.accessUrl.startsWith('https://') ?
     Date.now() : 'FIXEDTIMESTAMP';
   const maxLoginRetries = connectionConfig.getRetrySfMaxLoginRetries();
-  const maxLoginTimeout = connectionConfig.getLoginTimeout();
+  const maxLoginTimeout = connectionConfig.getRetryTimeout();
   let sleep = connectionConfig.getRetrySfStartingSleepTime();;
   let totalTimeout = sleep;
-  Logger.getInstance().debug("Total loginTimeout is for the retries = " + maxLoginTimeout);
+  Logger.getInstance().debug("Total retryTimeout is for the retries = " + maxLoginTimeout);
   const parent = this;
   const requestCallback = function (err, body)
   {

diff --git a/lib/util.js b/lib/util.js
@@ -473,7 +473,7 @@ exports.getNextSleepTime = getNextSleepTime;
  * @returns {Boolean} true if it is loginRequest, otherwise false.
  */
 exports.isLoginRequest = function (loginUrl) {
-  const endPoints = ['/v1/login-request', '/authenticator-request'];
+  const endPoints = ['/v1/login-request', '/authenticator-request',];
   return endPoints.some((endPoint) => loginUrl.includes(endPoint));
 }
 

diff --git a/test/unit/connection/connection_config_test.js b/test/unit/connection/connection_config_test.js
@@ -547,12 +547,12 @@ describe('ConnectionConfig: basic', function ()
         errorCode: ErrorCodes.ERR_CONN_CREATE_INVALID_CLIENT_CONFIG_FILE
       },
       {
-        name: 'invalid maxLoginTimeout',
+        name: 'invalid retryTimeout',
         options: {
             account: 'account',
             username: 'username',
             password: 'password',
-            loginTimeout: 'invalud'
+            retryTimeout: 'invalud'
         },
         errorCode: ErrorCodes.ERR_CONN_CREATE_INVALID_MAX_LOGIN_TIMEOUT
       },
@@ -925,13 +925,13 @@ describe('ConnectionConfig: basic', function ()
           }
       },
       {
-        name: 'login time out',
+        name: 'retry time out',
         input:
           {
             account: 'account',
             username: 'username',
             password: 'password',
-            loginTimeout: 1234,
+            retryTimeout: 1234,
           },
         options:
           {