zendesk rate limiting

Author: evan-onyx

backend/onyx/connectors/zendesk/connector.py

@@ -1,5 +1,6 @@
 import copy
 import time
+from collections.abc import Callable
 from collections.abc import Iterator
 from typing import Any
 from typing import cast
@@ -14,6 +15,9 @@
 from onyx.connectors.cross_connector_utils.miscellaneous_utils import (
     time_str_to_utc,
 )
+from onyx.connectors.cross_connector_utils.rate_limit_wrapper import (
+    rate_limit_builder,
+)
 from onyx.connectors.exceptions import ConnectorValidationError
 from onyx.connectors.exceptions import CredentialExpiredError
 from onyx.connectors.exceptions import InsufficientPermissionsError
@@ -47,14 +51,30 @@ def __init__(self) -> None:
 
 
 class ZendeskClient:
-    def __init__(self, subdomain: str, email: str, token: str):
+    def __init__(
+        self,
+        subdomain: str,
+        email: str,
+        token: str,
+        calls_per_minute: int | None = None,
+    ):
         self.base_url = f"https://{subdomain}.zendesk.com/api/v2"
         self.auth = (f"{email}/token", token)
+        self.make_request = request_with_rate_limit(self, calls_per_minute)
 
+
+def request_with_rate_limit(
+    client: ZendeskClient, max_calls_per_minute: int | None = None
+) -> Callable[[str, dict[str, Any]], dict[str, Any]]:
     @retry_builder()
-    def make_request(self, endpoint: str, params: dict[str, Any]) -> dict[str, Any]:
+    @(
+        rate_limit_builder(max_calls=max_calls_per_minute, period=60)
+        if max_calls_per_minute
+        else lambda x: x
+    )
+    def make_request(endpoint: str, params: dict[str, Any]) -> dict[str, Any]:
         response = requests.get(
-            f"{self.base_url}/{endpoint}", auth=self.auth, params=params
+            f"{client.base_url}/{endpoint}", auth=client.auth, params=params
         )
 
         if response.status_code == 429:
@@ -72,6 +92,8 @@ def make_request(self, endpoint: str, params: dict[str, Any]) -> dict[str, Any]:
         response.raise_for_status()
         return response.json()
 
+    return make_request
+
 
 class ZendeskPageResponse(BaseModel):
     data: list[dict[str, Any]]
@@ -359,11 +381,13 @@ class ZendeskConnector(
     def __init__(
         self,
         content_type: str = "articles",
+        calls_per_minute: int | None = None,
     ) -> None:
         self.content_type = content_type
         self.subdomain = ""
         # Fetch all tags ahead of time
         self.content_tags: dict[str, str] = {}
+        self.calls_per_minute = calls_per_minute
 
     def load_credentials(self, credentials: dict[str, Any]) -> dict[str, Any] | None:
         # Subdomain is actually the whole URL
@@ -375,7 +399,10 @@ def load_credentials(self, credentials: dict[str, Any]) -> dict[str, Any] | None
         self.subdomain = subdomain
 
         self.client = ZendeskClient(
-            subdomain, credentials["zendesk_email"], credentials["zendesk_token"]
+            subdomain,
+            credentials["zendesk_email"],
+            credentials["zendesk_token"],
+            calls_per_minute=self.calls_per_minute,
         )
         return None
 

backend/tests/unit/onyx/connectors/zendesk/test_zendesk_rate_limit.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+import types
+from typing import Any
+from typing import Dict
+
+import pytest
+
+
+class _FakeTime:
+    """A controllable time module replacement.
+
+    - monotonic(): returns an internal counter (seconds)
+    - sleep(x): advances the internal counter by x seconds
+    """
+
+    def __init__(self) -> None:
+        self._t = 0.0
+
+    def monotonic(self) -> float:  # type: ignore[override]
+        return self._t
+
+    def sleep(self, seconds: float) -> None:  # type: ignore[override]
+        # advance time without real waiting
+        self._t += float(seconds)
+
+
+class _FakeResponse:
+    def __init__(self, json_payload: Dict[str, Any], status_code: int = 200) -> None:
+        self._json = json_payload
+        self.status_code = status_code
+        self.headers: Dict[str, str] = {}
+
+    def json(self) -> Dict[str, Any]:
+        return self._json
+
+    def raise_for_status(self) -> None:
+        # simulate OK
+        return None
+
+
+@pytest.mark.unit
+def test_zendesk_client_per_minute_rate_limiting(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    # Import here to allow monkeypatching modules safely
+    from onyx.connectors.zendesk.connector import ZendeskClient
+    import onyx.connectors.cross_connector_utils.rate_limit_wrapper as rlw
+    import onyx.connectors.zendesk.connector as zendesk_mod
+
+    fake_time = _FakeTime()
+
+    # Patch time in both the rate limit wrapper and the zendesk connector module
+    monkeypatch.setattr(rlw, "time", fake_time, raising=True)
+    monkeypatch.setattr(zendesk_mod, "time", fake_time, raising=True)
+
+    # Stub out requests.get to avoid network and return a minimal valid payload
+    calls: list[str] = []
+
+    def _fake_get(url: str, auth: Any, params: Dict[str, Any]) -> _FakeResponse:
+        calls.append(url)
+        # minimal Zendesk list response (articles path)
+        return _FakeResponse({"articles": [], "meta": {"has_more": False}})
+
+    monkeypatch.setattr(
+        zendesk_mod, "requests", types.SimpleNamespace(get=_fake_get), raising=True
+    )
+
+    # Build client with a small limit: 2 calls per 60 seconds
+    client = ZendeskClient("subd", "e", "t", calls_per_minute=2)
+
+    # Make three calls in quick succession. The third should be rate limited
+    client.make_request("help_center/articles", {"page[size]": 1})
+    client.make_request("help_center/articles", {"page[size]": 1})
+
+    # At this point we've used up the 2 allowed calls within the 60s window
+    # The next call should trigger sleeps with exponential backoff until >60s elapsed
+    client.make_request("help_center/articles", {"page[size]": 1})
+
+    # Ensure we did not actually wait in real time but logically advanced beyond a minute
+    assert fake_time.monotonic() >= 60
+    # Ensure the HTTP function was invoked three times
+    assert len(calls) == 3

web/src/lib/connectors/connectors.tsx

@@ -1071,7 +1071,16 @@ For example, specifying .*-support.* as a "channel" will cause the connector to
         default: "articles",
       },
     ],
-    advanced_values: [],
+    advanced_values: [
+      {
+        type: "number",
+        label: "API Calls per Minute",
+        name: "calls_per_minute",
+        optional: true,
+        description:
+          "Restricts how many Zendesk API calls this connector can make per minute (applies only to this connector). See defaults: https://developer.zendesk.com/api-reference/introduction/rate-limits/",
+      },
+    ],
   },
   linear: {
     description: "Configure Linear connector",
@@ -1770,7 +1779,10 @@ export interface XenforoConfig {
   base_url: string;
 }
 
-export interface ZendeskConfig {}
+export interface ZendeskConfig {
+  content_type?: "articles" | "tickets";
+  calls_per_minute?: number;
+}
 
 export interface DropboxConfig {}