Add backoff factor validation (#1641)

* setting backofffactor to 2 when it's smaller than 2

* add test for backoff factor validation

* pre-commit fixes

* clean test

* pre-commit fixes

* change the backoff factor type

---------

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: HantingZhang2

.generator/src/generator/templates/configuration.j2

@@ -139,7 +139,7 @@ class Configuration:
         the backoff factor.
     :type enable_retry: bool
     :param retry_backoff_factor: Factor used to space out retried requests on backend errors.
-    :type retry_backoff_factor: int
+    :type retry_backoff_factor: float
     :param max_retries: The maximum number of times a single request can be retried.
     :type max_retries: int
     """
@@ -361,6 +361,26 @@ class Configuration:
         self._logger_format = value
         self.logger_formatter = logging.Formatter(self._logger_format)
 
+    @property
+    def retry_backoff_factor(self):
+        """Retry backoff factor.
+
+        :return: The backoff factor, float
+        :rtype: float
+        """
+        return self._retry_backoff_factor
+
+    @retry_backoff_factor.setter
+    def retry_backoff_factor(self, value):
+        """Retry backoff factor.
+        
+        :param value: The backoff factor used to calculate intervals between retry attempts
+        :type value: float
+        """
+        if value < 2:
+            raise ValueError("Retry backoff factor cannot be smaller than 2")
+        self._retry_backoff_factor = value
+
     def get_api_key_with_prefix(self, identifier, alias=None):
         """Gets API key (with prefix if set).
 

.generator/src/generator/templates/rest.j2

@@ -69,8 +69,8 @@ class RESTClientObject:
 
         if configuration.enable_retry:
             retries = ClientRetry(
-                total=configuration.max_retries,
-                backoff_factor=configuration.retry_backoff_factor,
+                total = configuration.max_retries,
+                backoff_factor = configuration.retry_backoff_factor,
             )
             addition_pool_args["retries"] = retries
 

src/datadog_api_client/configuration.py

@@ -140,7 +140,7 @@ class Configuration:
         the backoff factor.
     :type enable_retry: bool
     :param retry_backoff_factor: Factor used to space out retried requests on backend errors.
-    :type retry_backoff_factor: int
+    :type retry_backoff_factor: float
     :param max_retries: The maximum number of times a single request can be retried.
     :type max_retries: int
     """
@@ -397,6 +397,26 @@ def logger_format(self, value):
         self._logger_format = value
         self.logger_formatter = logging.Formatter(self._logger_format)
 
+    @property
+    def retry_backoff_factor(self):
+        """Retry backoff factor.
+
+        :return: The backoff factor, float
+        :rtype: float
+        """
+        return self._retry_backoff_factor
+
+    @retry_backoff_factor.setter
+    def retry_backoff_factor(self, value):
+        """Retry backoff factor.
+
+        :param value: The backoff factor used to calculate intervals between retry attempts
+        :type value: float
+        """
+        if value < 2:
+            raise ValueError("Retry backoff factor cannot be smaller than 2")
+        self._retry_backoff_factor = value
+
     def get_api_key_with_prefix(self, identifier, alias=None):
         """Gets API key (with prefix if set).
 

tests/test_retry.py

@@ -1,4 +1,5 @@
 from unittest import mock
+import pytest
 import vcr
 
 from datadog_api_client.api_client import ApiClient
@@ -33,3 +34,11 @@ def test_retry_rate_limit(sleep_mock):
             assert sleep_mock.call_args_list[0][0][0] == 3
             assert sleep_mock.call_args_list[1][0][0] == 2
             assert sleep_mock.call_args_list[2][0][0] == 1
+
+
+def test_retry_backoff_factor_validation():
+    configuration = Configuration()
+    with pytest.raises(ValueError):
+        configuration.retry_backoff_factor = 1
+
+    configuration.retry_backoff_factor = 3