omnata-plugin-runtime 0.4.5a100__tar.gz → 0.4.6a101__tar.gz

{omnata_plugin_runtime-0.4.5a100 → omnata_plugin_runtime-0.4.6a101}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.4.5a100
+Version: 0.4.6a101
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.4.5a100 → omnata_plugin_runtime-0.4.6a101}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.4.5-a100"
+version = "0.4.6-a101"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.4.5a100 → omnata_plugin_runtime-0.4.6a101}/src/omnata_plugin_runtime/rate_limiting.py

@@ -8,7 +8,7 @@ import re
 import threading
 from email.utils import parsedate_to_datetime
 from logging import getLogger
-from typing import List, Literal, Optional, Dict, Tuple
+from typing import Any, List, Literal, Optional, Dict, Tuple
 import requests
 from pydantic import Field, root_validator
 from pydantic.json import pydantic_encoder
@@ -349,6 +349,32 @@ class RetryLaterException(Exception):
         self.message = message
         super().__init__(self.message)
 
+class RetryWithLogging(Retry):
+    """
+        Adding extra logs before making a retry request     
+    """
+    def __call__(self, *args: Any, thread_cancellation_token:threading.Event, **kwargs: Any) -> Any:
+        self.thread_cancellation_token = thread_cancellation_token
+        return super().__call__(*args, **kwargs)
+    
+    def sleep_for_retry(self, response=None):
+        retry_after = self.get_retry_after(response)
+        if retry_after:
+            logger.info(f"Retrying after {retry_after} seconds due to Retry-After header")
+            if self.thread_cancellation_token.wait(retry_after):
+                raise InterruptedWhileWaitingException(message="The sync was interrupted while waiting for rate limiting to expire")
+            return True
+        return False
+
+    def _sleep_backoff(self):
+        backoff = self.get_backoff_time()
+        if backoff <= 0:
+            return
+        logger.info(f"Retrying after {backoff} seconds due to backoff time")
+        if self.thread_cancellation_token.wait(backoff):
+            raise InterruptedWhileWaitingException(message="The sync was interrupted while waiting for rate limiting to expire")
+
+
 class RateLimitedSession(requests.Session):
     """
     Creates a requests session that will automatically handle rate limiting.
@@ -366,7 +392,7 @@ class RateLimitedSession(requests.Session):
         self.thread_cancellation_token = thread_cancellation_token
         self.statuses_to_include = statuses_to_include
 
-        retry_strategy = Retry(
+        retry_strategy = RetryWithLogging(
             total=max_retries,
             backoff_factor=backoff_factor,
             status_forcelist=statuses_to_include,
@@ -398,7 +424,7 @@ class RateLimitedSession(requests.Session):
     def request(self, method, url, **kwargs):
         while True:
             response = super().request(method, url, **kwargs)
-            
+            # TODO: this is probably all redundant as the Retry object should handle this at a lower level (urllib3)
             if response.status_code in self.statuses_to_include:
                 if 'Retry-After' in response.headers:
                     retry_after = response.headers['Retry-After']