fix: repeat requests after timeout with too_many_requests (#37)

Author: bensteUEM

churchtools_api/churchtools_api.py

@@ -62,8 +62,8 @@ def __init__(
 
         """
         super().__init__()
-        self.session = None
-        self.domain = domain
+        self.session : None | RateLimitedSession = None
+        self.domain : str = domain
 
         if ct_token is not None:
             self.login_ct_rest_api(ct_token=ct_token)

churchtools_api/ratelimitedsession.py

@@ -1,14 +1,15 @@
 """This code is used to wrap the most common requests into a rate limited model.
 
-ChurchTools API usually accepts X / sec requests and will return an error if exceeded
+ChurchTools API usually responds code 429 on excessive use
+ - repeating request after timeout will suceed
 """
-#TODO@bensteUEM: inquiry to CT Team 147987 for configured thresholds
-# https://github.com/bensteUEM/ChurchToolsAPI/issues/37
-
+import logging
+from time import sleep
 from typing import override
 
 import requests
-from ratelimit import limits, sleep_and_retry
+
+logger = logging.getLogger(__name__)
 
 
 class RateLimitedSession(requests.Session):
@@ -17,18 +18,21 @@ class RateLimitedSession(requests.Session):
     with rate limits and retry
     """
 
-    MAX_CALLS = 50
-    LIMIT_PERIOD_SECONDS = 2
-
     def __init__(self) -> None:
         """Inits session with additional params."""
+        logger.debug("init rate limited session")
         super().__init__()
 
-    @sleep_and_retry
-    @limits(calls=MAX_CALLS, period=LIMIT_PERIOD_SECONDS)
     def _rate_limited_request(self, method, url, **kwargs) -> requests.Response:  # noqa: ANN001, ANN003
         """Rate limiting execution of original request method."""
-        return super().request(method, url, **kwargs)
+        result = super().request(method, url, **kwargs)
+
+        while result.status_code == requests.codes.too_many_requests:
+            logger.info("rate limit reached - waiting 15 sec before repeating request")
+            sleep(15.0)
+            result = self._rate_limited_request(method=method, url=url, **kwargs)
+
+        return result
 
     @override
     def request(self, method, url, **kwargs) -> requests.Response:  # noqa: ANN001, ANN003

tests/test_ratelimitedsession.py

@@ -1,17 +1,13 @@
 """This test module is used to verify integrity of the Ratelimited session."""
-#TODO@bensteUEM: inquiry to CT Team 147987 for configured threshold
-# https://github.com/bensteUEM/ChurchToolsAPI/issues/37
 
 import json
 import logging
 import logging.config
-import time
 from pathlib import Path
 
 import pytest
-import requests
 
-from churchtools_api.ratelimitedsession import RateLimitedSession
+from tests.test_churchtools_api_abstract import TestsChurchToolsApiAbstract
 
 logger = logging.getLogger(__name__)
 
@@ -23,41 +19,19 @@
         log_directory.mkdir(parents=True)
     logging.config.dictConfig(config=logging_config)
 
-# Make sure test values are adjusted
-#  - e.g. 250* google.com with 10 req per 2seconds ~= 50 sec
-#  - e.g. 250* google.com with no threshold ~= 30 sec
-SAMPLE_URL = "https://google.com"
-EXPECTED_TIME = 30
 
+class TestsRateLimitedSession(TestsChurchToolsApiAbstract):
+    """Test for Rate limits."""
 
-@pytest.mark.skip("execute only if ratelimit is decreased")
-def test_no_rate_limit() -> None:
-    """Reference time for 250 requests without throttle using google.com.
+    def test_no_rate_limit(self, caplog: pytest.LogCaptureFixture) -> None:
+        """Reference time for 250 requests without throttle using google.com."""
+        SAMPLE_SONG_ID = 408
 
-    Actual time might depend on internet speed!
+        with caplog.at_level(logging.INFO, logger="ratelimitedsession"):
+            for _i in range(750):
+                self.api.get_songs(song_id=SAMPLE_SONG_ID)
+        EXPECTED_MESSAGES = [
+            "rate limit reached - waiting 15 sec before repeating request"
+        ]
 
-    Only checks GET request for simplification.
-    """
-    session = requests.Session()
-
-    start = time.perf_counter()
-    for _i in range(250):
-        session.get(url=SAMPLE_URL)
-    end = time.perf_counter()
-
-    assert end - start < EXPECTED_TIME
-
-@pytest.mark.skip("execute only if ratelimit is decreased")
-def test_rate_limited() -> None:
-    """Reference time for 250 requests with throttle using google.com.
-
-    Only checks GET request for simplification.
-    """
-    session = RateLimitedSession()
-
-    start = time.perf_counter()
-    for _i in range(250):
-        session.get(url=SAMPLE_URL)
-    end = time.perf_counter()
-
-    assert end-start > EXPECTED_TIME
+        assert caplog.messages == EXPECTED_MESSAGES