[RFQ] Add maxRetrySeconds configuration and RetryTooLong exception

zscaler/__init__.py

@@ -33,3 +33,4 @@
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa
+from zscaler.exceptions.exceptions import RetryTooLong  # noqa

zscaler/config/config_setter.py

@@ -39,6 +39,7 @@ class ConfigSetter:
             "proxy": {"port": "", "host": "", "username": "", "password": ""},
             "rateLimit": {
                 "maxRetries": 2,
+                "maxRetrySeconds": 0,
             },
             "testing": {"disableHttpsCheck": ""},
         }
@@ -136,7 +137,7 @@ def _apply_default_values(self):
 
         self._config["client"]["userAgent"] = ""
         self._config["client"]["requestTimeout"] = 0
-        self._config["client"]["rateLimit"] = {"maxRetries": 2}
+        self._config["client"]["rateLimit"] = {"maxRetries": 2, "maxRetrySeconds": 0}
 
         # Add a check for the 'testing' key before accessing it
         if "testing" not in self._config:

zscaler/exceptions/exceptions.py

@@ -84,3 +84,10 @@ class TokenRefreshError(Exception):
 
 class HeaderUpdateError(Exception):
     pass
+
+
+class RetryTooLong(Exception):
+    def __init__(self, retry_seconds, max_seconds):
+        self.retry_seconds = retry_seconds
+        self.max_seconds = max_seconds
+        super().__init__(f"Retry time of {retry_seconds} seconds exceeds maximum allowed retry time of {max_seconds} seconds")

zscaler/request_executor.py

@@ -73,6 +73,11 @@ def __init__(
         if self._max_retries < 0:
             raise ValueError(f"Invalid max retries: {self._max_retries}. Must be 0 or greater.")
 
+        # Validate and set max retry seconds for rate limiting
+        self._max_retry_seconds = config["client"]["rateLimit"].get("maxRetrySeconds", 0)
+        if self._max_retry_seconds < 0:
+            raise ValueError(f"Invalid max retry seconds: {self._max_retry_seconds}. Must be 0 or greater.")
+
         # Set configuration and cache
         self._config = config
         self._cache = cache
@@ -500,6 +505,12 @@ def fire_request_helper(self, request, attempts, request_start_time):
             if backoff_seconds is None:
                 return None, response, response.text, Exception(ERROR_MESSAGE_429_MISSING_DATE_X_RESET)
 
+            # Check if backoff time exceeds maximum retry seconds limit
+            if self._max_retry_seconds > 0 and backoff_seconds > self._max_retry_seconds:
+                logger.warning(f"Retry time of {backoff_seconds} seconds exceeds maximum allowed retry time of {self._max_retry_seconds} seconds.")
+                from zscaler.exceptions.exceptions import RetryTooLong
+                return request, response, response.text, RetryTooLong(backoff_seconds, self._max_retry_seconds)
+
             logger.info(f"Hit rate limit or retryable status {response.status_code}. "
                         f"Retrying request in {backoff_seconds} seconds.")
             time.sleep(backoff_seconds)