[SAC-27535] Updated http.py to improve rate limit handling

Author: gl-romil

tap_frontapp/http.py

@@ -1,3 +1,5 @@
+"""HTTP client for FrontApp tap with rate limit handling."""
+
 import json
 import time
 import requests
@@ -7,85 +9,97 @@
 
 LOGGER = singer.get_logger()
 
+
 class RateLimitException(Exception):
-    pass
+    """Exception raised when rate limit is exceeded."""
+
 
 class MetricsRateLimitException(Exception):
-    pass
+    """Exception raised for 423 locked error specific to metrics."""
+
 
-class Client(object):
-    BASE_URL = 'https://api2.frontapp.com'
+class Client:
+    """Client to make authenticated requests to the FrontApp API."""
+    BASE_URL = "https://api2.frontapp.com"
 
     def __init__(self, config):
-        self.token = 'Bearer ' + config.get('token')
+        self.token = "Bearer " + config.get("token")
         self.session = requests.Session()
         self.calls_remaining = None
         self.limit_reset = None
 
     def url(self, path):
+        """Return full API URL."""
         return self.BASE_URL + path
 
-    # Log backoff retries
-    def log_backoff(details):
-        LOGGER.warning(f"[Backoff] Retrying {details['target'].__name__} in {details['wait']}s due to {details['exception']}")
-
-    # Retry strategy: Max 5 retries or 60 seconds total
-    @backoff.on_exception(backoff.expo,
-                          RateLimitException,
-                          max_tries=5,
-                          max_time=60,
-                          on_backoff=log_backoff)
+    def log_backoff(self, details):
+        """
+        Logs backoff retry information.
+
+        Args:
+            details (dict): Backoff details including 'wait' and 'value'.
+        """
+        wait_time = details.get("wait", "unknown")
+        reason = details.get("value", "unknown")
+        LOGGER.warning("Retrying request in %ss due to %s", wait_time, reason)
+
+    @backoff.on_exception(
+        backoff.expo,
+        RateLimitException,
+        max_tries=5,
+        max_time=60,
+        on_backoff=lambda details: Client.log_backoff(Client, details),
+    )
     def request(self, method, url, **kwargs):
-        if self.calls_remaining is not None and self.calls_remaining == 0:
+        """Make an HTTP request with retry and rate limit handling."""
+        if self.calls_remaining == 0 and self.limit_reset:
             wait = self.limit_reset - int(time.monotonic())
             if 0 < wait <= 300:
                 time.sleep(wait)
 
-        if 'headers' not in kwargs:
-            kwargs['headers'] = {}
-        if self.token:
-            kwargs['headers']['Authorization'] = self.token
-
-        kwargs['headers']['Content-Type'] = 'application/json'
+        kwargs.setdefault("headers", {})
+        kwargs["headers"]["Authorization"] = self.token
+        kwargs["headers"]["Content-Type"] = "application/json"
 
-        if 'endpoint' in kwargs:
-            endpoint = kwargs['endpoint']
-            del kwargs['endpoint']
+        if "endpoint" in kwargs:
+            endpoint = kwargs.pop("endpoint")
             with metrics.http_request_timer(endpoint) as timer:
-                response = requests.request(method, url, **kwargs)
+                response = requests.request(method, url, timeout=30, **kwargs)
                 timer.tags[metrics.Tag.http_status_code] = response.status_code
         else:
-            response = requests.request(method, url, **kwargs)
+            response = requests.request(method, url, timeout=30, **kwargs)
 
-        #Handled missing headers to avoid KeyError
-        self.calls_remaining = int(response.headers.get('X-Ratelimit-Remaining', 1))
-        self.limit_reset = int(float(response.headers.get('X-Ratelimit-Reset', time.monotonic() + 1)))
+        self.calls_remaining = int(response.headers.get("X-Ratelimit-Remaining", 0))
+        self.limit_reset = int(float(
+            response.headers.get("X-Ratelimit-Reset", time.monotonic() + 60)))
 
         if response.status_code in [429, 503]:
             raise RateLimitException(response.text)
         if response.status_code == 423:
             raise MetricsRateLimitException()
+
         try:
             response.raise_for_status()
-        except:
-            LOGGER.error('{} - {}'.format(response.status_code, response.text))
+        except requests.HTTPError:
+            LOGGER.error("HTTP %s - %s", response.status_code, response.text)
             raise
 
         return response
 
     def get_report_metrics(self, url, **kwargs):
-        response = self.request('get', url, **kwargs)
-        return response.json().get('metrics', [])
+        """Fetch analytics metrics from a report endpoint."""
+        response = self.request("get", url, **kwargs)
+        return response.json().get("metrics", [])
 
     def create_report(self, path, data, **kwargs):
+        """Create a report on FrontApp and return its URL."""
         url = self.url(path)
-        kwargs['data'] = json.dumps(data)
-        response = self.request('post', url, **kwargs)
-        if response.json().get('_links', {}).get('self'):
-            return response.json()['_links']['self']
-        return {}
+        kwargs["data"] = json.dumps(data)
+        response = self.request("post", url, **kwargs)
+        return response.json().get("_links", {}).get("self", {})
 
     def list_metrics(self, path, **kwargs):
+        """List available metrics from an endpoint."""
         url = self.url(path)
-        response = self.request('get', url, **kwargs)
-        return response.json().get('_results', [])
+        response = self.request("get", url, **kwargs)
+        return response.json().get("_results", [])