|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import uuid |
| 4 | +from dataclasses import dataclass |
| 5 | +from typing import Any |
| 6 | +from unittest.mock import AsyncMock |
| 7 | + |
| 8 | +import pytest |
| 9 | +from aiohttp import web |
| 10 | +from aiohttp.test_utils import make_mocked_request |
| 11 | +from pytest_mock import MockerFixture |
| 12 | + |
| 13 | +from ai.backend.common.clients.valkey_client.valkey_rate_limit.client import ValkeyRateLimitClient |
| 14 | +from ai.backend.common.identifier.user import UserID |
| 15 | +from ai.backend.web import ratelimit |
| 16 | +from ai.backend.web.ratelimit import rate_limit_middleware |
| 17 | + |
| 18 | +_USER_ID = UserID(uuid.UUID("12345678-1234-5678-1234-567812345678")) |
| 19 | +_RATE_LIMIT = 1000 |
| 20 | + |
| 21 | + |
| 22 | +@pytest.fixture |
| 23 | +def mock_valkey_rate_limit_client() -> AsyncMock: |
| 24 | + client = AsyncMock(spec=ValkeyRateLimitClient) |
| 25 | + client.execute_rate_limit_logic.return_value = 1 |
| 26 | + return client |
| 27 | + |
| 28 | + |
| 29 | +@pytest.fixture |
| 30 | +def handler_response() -> web.Response: |
| 31 | + return web.Response(text="ok") |
| 32 | + |
| 33 | + |
| 34 | +@pytest.fixture |
| 35 | +def handler(handler_response: web.Response) -> AsyncMock: |
| 36 | + return AsyncMock(return_value=handler_response) |
| 37 | + |
| 38 | + |
| 39 | +@dataclass(frozen=True) |
| 40 | +class _PassThroughCase: |
| 41 | + id: str |
| 42 | + path: str |
| 43 | + session: dict[str, Any] |
| 44 | + |
| 45 | + |
| 46 | +@pytest.mark.parametrize( |
| 47 | + "case", |
| 48 | + [ |
| 49 | + _PassThroughCase( |
| 50 | + id="non-proxied-path", |
| 51 | + path="/server/login", |
| 52 | + session={ |
| 53 | + "authenticated": True, |
| 54 | + "token": {"user_id": str(_USER_ID), "rate_limit": _RATE_LIMIT}, |
| 55 | + }, |
| 56 | + ), |
| 57 | + _PassThroughCase( |
| 58 | + id="unauthenticated", |
| 59 | + path="/func/session", |
| 60 | + session={}, |
| 61 | + ), |
| 62 | + _PassThroughCase( |
| 63 | + id="no-user-id-in-token", |
| 64 | + path="/func/session", |
| 65 | + session={"authenticated": True, "token": {"access_key": "AKTEST"}}, |
| 66 | + ), |
| 67 | + ], |
| 68 | + ids=lambda case: case.id, |
| 69 | +) |
| 70 | +async def test_pass_through_without_rate_limiting( |
| 71 | + case: _PassThroughCase, |
| 72 | + mocker: MockerFixture, |
| 73 | + mock_valkey_rate_limit_client: AsyncMock, |
| 74 | + handler: AsyncMock, |
| 75 | + handler_response: web.Response, |
| 76 | +) -> None: |
| 77 | + mocker.patch.object(ratelimit, "get_session", AsyncMock(return_value=case.session)) |
| 78 | + request = make_mocked_request( |
| 79 | + "GET", case.path, app={"valkey_rate_limit": mock_valkey_rate_limit_client} |
| 80 | + ) |
| 81 | + |
| 82 | + response = await rate_limit_middleware(request, handler) |
| 83 | + |
| 84 | + assert response is handler_response |
| 85 | + handler.assert_awaited_once_with(request) |
| 86 | + mock_valkey_rate_limit_client.execute_rate_limit_logic.assert_not_called() |
| 87 | + assert "X-RateLimit-Limit" not in response.headers |
| 88 | + |
| 89 | + |
| 90 | +async def test_counts_request_per_user_and_sets_headers( |
| 91 | + mocker: MockerFixture, |
| 92 | + mock_valkey_rate_limit_client: AsyncMock, |
| 93 | + handler: AsyncMock, |
| 94 | + handler_response: web.Response, |
| 95 | +) -> None: |
| 96 | + session = { |
| 97 | + "authenticated": True, |
| 98 | + "token": {"user_id": str(_USER_ID), "rate_limit": _RATE_LIMIT}, |
| 99 | + } |
| 100 | + mocker.patch.object(ratelimit, "get_session", AsyncMock(return_value=session)) |
| 101 | + request = make_mocked_request( |
| 102 | + "GET", "/func/session", app={"valkey_rate_limit": mock_valkey_rate_limit_client} |
| 103 | + ) |
| 104 | + |
| 105 | + response = await rate_limit_middleware(request, handler) |
| 106 | + |
| 107 | + assert response is handler_response |
| 108 | + mock_valkey_rate_limit_client.execute_rate_limit_logic.assert_awaited_once_with( |
| 109 | + user_id=_USER_ID, |
| 110 | + window=ratelimit._rlim_window, |
| 111 | + ) |
| 112 | + assert response.headers["X-RateLimit-Limit"] == str(_RATE_LIMIT) |
| 113 | + assert response.headers["X-RateLimit-Remaining"] == str(_RATE_LIMIT - 1) |
| 114 | + assert response.headers["X-RateLimit-Window"] == str(ratelimit._rlim_window) |
| 115 | + |
| 116 | + |
| 117 | +async def test_rejects_over_limit_request_with_429( |
| 118 | + mocker: MockerFixture, |
| 119 | + mock_valkey_rate_limit_client: AsyncMock, |
| 120 | + handler: AsyncMock, |
| 121 | +) -> None: |
| 122 | + session = { |
| 123 | + "authenticated": True, |
| 124 | + "token": {"user_id": str(_USER_ID), "rate_limit": _RATE_LIMIT}, |
| 125 | + } |
| 126 | + mocker.patch.object(ratelimit, "get_session", AsyncMock(return_value=session)) |
| 127 | + mock_valkey_rate_limit_client.execute_rate_limit_logic.return_value = _RATE_LIMIT + 1 |
| 128 | + request = make_mocked_request( |
| 129 | + "GET", "/func/session", app={"valkey_rate_limit": mock_valkey_rate_limit_client} |
| 130 | + ) |
| 131 | + |
| 132 | + response = await rate_limit_middleware(request, handler) |
| 133 | + |
| 134 | + handler.assert_not_called() |
| 135 | + assert isinstance(response, web.HTTPTooManyRequests) |
| 136 | + assert response.content_type == "application/problem+json" |
| 137 | + assert response.headers["X-RateLimit-Limit"] == str(_RATE_LIMIT) |
| 138 | + assert response.headers["X-RateLimit-Remaining"] == "0" |
| 139 | + |
| 140 | + |
| 141 | +async def test_null_rate_limit_counts_but_never_rejects( |
| 142 | + mocker: MockerFixture, |
| 143 | + mock_valkey_rate_limit_client: AsyncMock, |
| 144 | + handler: AsyncMock, |
| 145 | + handler_response: web.Response, |
| 146 | +) -> None: |
| 147 | + session = { |
| 148 | + "authenticated": True, |
| 149 | + "token": {"user_id": str(_USER_ID), "rate_limit": None}, |
| 150 | + } |
| 151 | + mocker.patch.object(ratelimit, "get_session", AsyncMock(return_value=session)) |
| 152 | + mock_valkey_rate_limit_client.execute_rate_limit_logic.return_value = 10_000_000 |
| 153 | + request = make_mocked_request( |
| 154 | + "GET", "/func/session", app={"valkey_rate_limit": mock_valkey_rate_limit_client} |
| 155 | + ) |
| 156 | + |
| 157 | + response = await rate_limit_middleware(request, handler) |
| 158 | + |
| 159 | + assert response is handler_response |
| 160 | + handler.assert_awaited_once_with(request) |
| 161 | + mock_valkey_rate_limit_client.execute_rate_limit_logic.assert_awaited_once() |
| 162 | + assert response.headers["X-RateLimit-Remaining"] == "10000000" |
0 commit comments