-
Notifications
You must be signed in to change notification settings - Fork 725
refactor: code-blue source rate limit config management #1595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
felixschmetz
wants to merge
1
commit into
main
Choose a base branch
from
refactor/source-rate-limits
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| """Source rate limiter adapters.""" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| """Fake source rate limiter for testing — records calls, supports error injection.""" | ||
|
|
||
| from typing import Optional | ||
| from uuid import UUID | ||
|
|
||
|
|
||
| class FakeSourceRateLimiter: | ||
| """In-memory fake that records calls and optionally rejects.""" | ||
|
|
||
| def __init__(self) -> None: | ||
| """Initialize with empty call log.""" | ||
| self._calls: list[tuple] = [] | ||
| self._should_raise: Optional[Exception] = None | ||
|
|
||
| def set_error(self, error: Exception) -> None: | ||
| """Force subsequent calls to raise the given exception.""" | ||
| self._should_raise = error | ||
|
|
||
| def clear_error(self) -> None: | ||
| """Stop raising on subsequent calls.""" | ||
| self._should_raise = None | ||
|
|
||
| async def check_and_increment( | ||
| self, | ||
| org_id: UUID, | ||
| source_short_name: str, | ||
| source_connection_id: Optional[UUID] = None, | ||
| ) -> None: | ||
| self._calls.append(("check_and_increment", org_id, source_short_name, source_connection_id)) | ||
| if self._should_raise: | ||
| raise self._should_raise | ||
|
|
||
| async def check_pipedream_proxy_limit(self, org_id: UUID) -> None: | ||
| self._calls.append(("check_pipedream_proxy_limit", org_id)) | ||
| if self._should_raise: | ||
| raise self._should_raise | ||
|
|
||
| @property | ||
| def call_count(self) -> int: | ||
| """Total number of check calls recorded.""" | ||
| return len(self._calls) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| """Null source rate limiter — always allows. For local dev or disabled rate limiting.""" | ||
|
|
||
| from typing import Optional | ||
| from uuid import UUID | ||
|
|
||
|
|
||
| class NullSourceRateLimiter: | ||
| """No-op source rate limiter. Every request is allowed.""" | ||
|
|
||
| async def check_and_increment( | ||
| self, | ||
| org_id: UUID, | ||
| source_short_name: str, | ||
| source_connection_id: Optional[UUID] = None, | ||
| ) -> None: | ||
| """Always allow.""" | ||
|
|
||
| async def check_pipedream_proxy_limit(self, org_id: UUID) -> None: | ||
| """Always allow.""" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,280 @@ | ||
| """Redis-backed source rate limiter using sliding window (sorted sets + Lua). | ||
|
|
||
| Prevents Airweave from exhausting customer API quotas by enforcing adjusted | ||
| rate limits on external source API calls. Supports both org-level (e.g., Google Drive) | ||
| and connection-level (e.g., Notion per-user) rate limiting. | ||
|
|
||
| Constructor-injected Redis client; config lookups use lazy crud imports | ||
| (the adapter runs on the hot path without a caller-provided DB session). | ||
| """ | ||
|
|
||
| import json | ||
| import logging | ||
| import time | ||
| from typing import Any, Optional | ||
| from uuid import UUID, uuid4 | ||
|
|
||
| from airweave.core.exceptions import SourceRateLimitExceededException | ||
| from airweave.core.shared_models import RateLimitLevel | ||
| from airweave.domains.source_rate_limits.types import ( | ||
| PIPEDREAM_PROXY_LIMIT, | ||
| PIPEDREAM_PROXY_WINDOW, | ||
| ) | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
| # Lua script for atomic check-and-increment. | ||
| # Returns [count, 0] on success, [-1, retry_after] when over limit. | ||
| _LUA_CHECK_AND_INCREMENT = """ | ||
| local key = KEYS[1] | ||
| local limit = tonumber(ARGV[1]) | ||
| local window_start = tonumber(ARGV[2]) | ||
| local current_time = tonumber(ARGV[3]) | ||
| local window_seconds = tonumber(ARGV[4]) | ||
| local expire_seconds = tonumber(ARGV[5]) | ||
| local unique_id = ARGV[6] | ||
|
|
||
| redis.call('ZREMRANGEBYSCORE', key, 0, window_start) | ||
|
|
||
| local current_count = redis.call('ZCOUNT', key, window_start, current_time) | ||
|
|
||
| if current_count >= limit then | ||
| local oldest = redis.call('ZRANGE', key, 0, 0, 'WITHSCORES') | ||
| local retry_after = window_seconds | ||
|
|
||
| if oldest and oldest[2] then | ||
| local oldest_timestamp = tonumber(oldest[2]) | ||
| retry_after = math.max(0.1, (oldest_timestamp + window_seconds) - current_time) | ||
| end | ||
|
|
||
| return {-1, retry_after} | ||
| end | ||
|
|
||
| redis.call('ZADD', key, current_time, unique_id) | ||
| redis.call('EXPIRE', key, expire_seconds) | ||
|
|
||
| return {current_count + 1, 0} | ||
| """ | ||
|
|
||
| KEY_PREFIX = "source_rate_limit" | ||
| CONFIG_CACHE_PREFIX = "source_rate_limit_config" | ||
| CONFIG_CACHE_TTL = 300 # 5 minutes | ||
|
|
||
|
|
||
| class RedisSourceRateLimiter: | ||
| """Sliding-window source rate limiter backed by Redis sorted sets. | ||
|
|
||
| Uses a Lua script for atomic check-and-increment to prevent race | ||
| conditions when concurrent requests check limits simultaneously. | ||
| """ | ||
|
|
||
| def __init__(self, redis_client: Any) -> None: | ||
| """Initialize with an async Redis client instance.""" | ||
| self._redis = redis_client | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Public API (matches SourceRateLimiter protocol) | ||
| # ------------------------------------------------------------------ | ||
|
|
||
| async def check_and_increment( | ||
| self, | ||
| org_id: UUID, | ||
| source_short_name: str, | ||
| source_connection_id: Optional[UUID] = None, | ||
| ) -> None: | ||
| """Check rate limit and increment counter if allowed. | ||
|
|
||
| Reads rate_limit_level from Source table to determine counting strategy: | ||
| - Connection-level (Notion): Tracks count per user connection | ||
| - Org-level (Google Drive): Tracks count for entire org | ||
| - None: No rate limiting | ||
|
|
||
| Raises: | ||
| SourceRateLimitExceededException: If rate limit is exceeded. | ||
| """ | ||
| rate_limit_level = await self._get_source_rate_limit_level(source_short_name) | ||
|
|
||
| logger.debug( | ||
| "[SourceRateLimit] Checking: org=%s source=%s connection=%s level=%s", | ||
| org_id, | ||
| source_short_name, | ||
| source_connection_id, | ||
| rate_limit_level, | ||
| ) | ||
|
|
||
| if not rate_limit_level: | ||
| return | ||
|
|
||
| limit_config = await self._get_limit_config(org_id, source_short_name) | ||
| if not limit_config: | ||
| return | ||
|
|
||
| limit = limit_config["limit"] | ||
| window_seconds = limit_config["window_seconds"] | ||
|
|
||
| redis_key = _build_redis_key( | ||
| org_id, source_short_name, rate_limit_level, source_connection_id | ||
| ) | ||
| await self._lua_check_and_increment(redis_key, limit, window_seconds, source_short_name) | ||
|
|
||
| async def check_pipedream_proxy_limit(self, org_id: UUID) -> None: | ||
| """Check Pipedream proxy rate limit (configurable, defaults to 1000 req/5min). | ||
|
|
||
| Raises: | ||
| SourceRateLimitExceededException: If Pipedream proxy limit exceeded. | ||
| """ | ||
| limit_config = await self._get_limit_config(org_id, "pipedream_proxy") | ||
|
|
||
| if not limit_config: | ||
| limit = PIPEDREAM_PROXY_LIMIT | ||
| window_seconds = PIPEDREAM_PROXY_WINDOW | ||
| else: | ||
| limit = limit_config["limit"] | ||
| window_seconds = limit_config["window_seconds"] | ||
|
|
||
| redis_key = f"pipedream_proxy_rate_limit:{org_id}" | ||
| await self._lua_check_and_increment(redis_key, limit, window_seconds, "pipedream_proxy") | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Private: Lua execution | ||
| # ------------------------------------------------------------------ | ||
|
|
||
| async def _lua_check_and_increment( | ||
| self, | ||
| redis_key: str, | ||
| limit: int, | ||
| window_seconds: int, | ||
| source_short_name: str, | ||
| ) -> None: | ||
| """Execute atomic Lua check-and-increment, raise on over-limit.""" | ||
| current_time = time.time() | ||
| window_start = current_time - window_seconds | ||
| expire_seconds = window_seconds * 2 | ||
| unique_id = str(uuid4()) | ||
|
|
||
| result = await self._redis.eval( | ||
| _LUA_CHECK_AND_INCREMENT, | ||
| 1, | ||
| redis_key, | ||
| limit, | ||
| window_start, | ||
| current_time, | ||
| window_seconds, | ||
| expire_seconds, | ||
| unique_id, | ||
| ) | ||
|
|
||
| count_or_error = int(result[0]) | ||
| retry_after = float(result[1]) | ||
|
|
||
| if count_or_error == -1: | ||
| logger.warning( | ||
| "Source rate limit exceeded for %s: %d/%d in %ds window, retry %.2fs", | ||
| source_short_name, | ||
| limit, | ||
| limit, | ||
| window_seconds, | ||
| retry_after, | ||
| ) | ||
| raise SourceRateLimitExceededException( | ||
| retry_after=retry_after, | ||
| source_short_name=source_short_name, | ||
| ) | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Private: config / metadata lookups (lazy crud imports) | ||
| # ------------------------------------------------------------------ | ||
|
|
||
| async def _get_source_rate_limit_level(self, source_short_name: str) -> Optional[str]: | ||
| """Get rate_limit_level from Source table (Redis-cached, 10min TTL).""" | ||
| cache_key = f"source_metadata:{source_short_name}:rate_limit_level" | ||
|
|
||
| try: | ||
| cached = await self._redis.get(cache_key) | ||
| if cached: | ||
| return cached if cached != "None" else None | ||
| except Exception: | ||
| pass | ||
|
|
||
| try: | ||
| from airweave import crud | ||
| from airweave.db.session import get_db_context | ||
|
|
||
| async with get_db_context() as db: | ||
| source = await crud.source.get_by_short_name(db, source_short_name) | ||
| rate_limit_level = source.rate_limit_level | ||
|
|
||
| try: | ||
| await self._redis.setex(cache_key, 600, rate_limit_level or "None") | ||
| except Exception: | ||
Check noticeCode scanning / CodeQL Empty except Note
'except' clause does nothing but pass and there is no explanatory comment.
|
||
| pass | ||
|
|
||
| return rate_limit_level | ||
|
|
||
| except Exception as e: | ||
| logger.error("Failed to fetch source metadata for %s: %s", source_short_name, e) | ||
| return None | ||
|
|
||
| async def _get_limit_config( | ||
| self, org_id: UUID, source_short_name: str | ||
| ) -> Optional[dict[str, Any]]: | ||
| """Get rate limit configuration from Redis cache or database.""" | ||
| cache_key = f"{CONFIG_CACHE_PREFIX}:{org_id}:{source_short_name}" | ||
|
|
||
| try: | ||
| cached = await self._redis.get(cache_key) | ||
| if cached: | ||
| return json.loads(cached) | ||
| except Exception as e: | ||
| logger.warning("Failed to get rate limit config from cache: %s", e) | ||
|
|
||
| try: | ||
| from airweave import crud | ||
| from airweave.db.session import get_db_context | ||
|
|
||
| async with get_db_context() as db: | ||
| rate_limit_obj = await crud.source_rate_limit.get_limit( | ||
| db, | ||
| org_id=org_id, | ||
| source_short_name=source_short_name, | ||
| ) | ||
|
|
||
| if not rate_limit_obj: | ||
| try: | ||
| await self._redis.setex(cache_key, CONFIG_CACHE_TTL, "{}") | ||
| except Exception: | ||
Check noticeCode scanning / CodeQL Empty except Note
'except' clause does nothing but pass and there is no explanatory comment.
|
||
| pass | ||
| return None | ||
|
|
||
| config = { | ||
| "limit": rate_limit_obj.limit, | ||
| "window_seconds": rate_limit_obj.window_seconds, | ||
| } | ||
|
|
||
| try: | ||
| await self._redis.setex(cache_key, CONFIG_CACHE_TTL, json.dumps(config)) | ||
| except Exception as e: | ||
| logger.warning("Failed to cache rate limit config: %s", e) | ||
|
|
||
| return config | ||
|
|
||
| except Exception as e: | ||
| logger.error("Failed to fetch rate limit config from database: %s", e) | ||
| return None | ||
|
|
||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Module-level helpers (pure functions, no state) | ||
| # ------------------------------------------------------------------ | ||
|
|
||
|
|
||
| def _build_redis_key( | ||
| org_id: UUID, | ||
| source_short_name: str, | ||
| rate_limit_level: str, | ||
| source_connection_id: Optional[UUID] = None, | ||
| ) -> str: | ||
| """Build Redis key for rate limit counting.""" | ||
| if rate_limit_level == RateLimitLevel.CONNECTION.value: | ||
| return f"{KEY_PREFIX}:{org_id}:{source_short_name}:connection:{source_connection_id}" | ||
| return f"{KEY_PREFIX}:{org_id}:{source_short_name}:org:org" | ||
Empty file.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check notice
Code scanning / CodeQL
Empty except Note