|
| 1 | +"""Tests for rate limit retry behavior on file write operations.""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import time |
| 6 | +from typing import Any |
| 7 | +from unittest.mock import Mock, patch |
| 8 | + |
| 9 | +import httpx |
| 10 | +import pytest |
| 11 | +import respx |
| 12 | + |
| 13 | +from runloop_api_client import Runloop, AsyncRunloop |
| 14 | +from runloop_api_client._exceptions import RateLimitError |
| 15 | +from runloop_api_client.types import DevboxExecutionDetailView |
| 16 | + |
| 17 | +base_url = "http://127.0.0.1:4010" |
| 18 | + |
| 19 | + |
| 20 | +class TestRateLimitRetry: |
| 21 | + """Test rate limit retry behavior for file write operations.""" |
| 22 | + |
| 23 | + def test_write_file_contents_retries_on_429(self, respx_mock: respx.MockRouter) -> None: |
| 24 | + """Test that write_file_contents retries when encountering 429 errors.""" |
| 25 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=3) |
| 26 | + |
| 27 | + # Mock the first two requests to return 429, then succeed |
| 28 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 29 | + |
| 30 | + route.side_effect = [ |
| 31 | + # First attempt: 429 |
| 32 | + httpx.Response( |
| 33 | + status_code=429, |
| 34 | + json={ |
| 35 | + "error": { |
| 36 | + "message": "Write operations for this devbox are currently rate limited. Please retry in a few seconds." |
| 37 | + } |
| 38 | + }, |
| 39 | + ), |
| 40 | + # Second attempt: 429 |
| 41 | + httpx.Response( |
| 42 | + status_code=429, |
| 43 | + json={ |
| 44 | + "error": { |
| 45 | + "message": "Write operations for this devbox are currently rate limited. Please retry in a few seconds." |
| 46 | + } |
| 47 | + }, |
| 48 | + ), |
| 49 | + # Third attempt: success |
| 50 | + httpx.Response( |
| 51 | + status_code=200, |
| 52 | + json={ |
| 53 | + "id": "exec-123", |
| 54 | + "devbox_id": "test-devbox-id", |
| 55 | + "status": "completed", |
| 56 | + "exit_status": 0, |
| 57 | + }, |
| 58 | + ), |
| 59 | + ] |
| 60 | + |
| 61 | + start_time = time.time() |
| 62 | + result = client.devboxes.write_file_contents( |
| 63 | + id="test-devbox-id", |
| 64 | + contents="test content", |
| 65 | + file_path="/tmp/test.txt", |
| 66 | + ) |
| 67 | + elapsed_time = time.time() - start_time |
| 68 | + |
| 69 | + # Verify the request succeeded |
| 70 | + assert result.id == "exec-123" |
| 71 | + assert result.status == "completed" |
| 72 | + |
| 73 | + # Verify retry happened (should have taken at least some time due to backoff) |
| 74 | + assert elapsed_time > 0.1 # At least some delay from retries |
| 75 | + |
| 76 | + # Verify all three requests were made |
| 77 | + assert route.call_count == 3 |
| 78 | + |
| 79 | + def test_write_file_contents_respects_retry_after_header(self, respx_mock: respx.MockRouter) -> None: |
| 80 | + """Test that write_file_contents respects Retry-After header.""" |
| 81 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=2) |
| 82 | + |
| 83 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 84 | + |
| 85 | + route.side_effect = [ |
| 86 | + # First attempt: 429 with Retry-After header |
| 87 | + httpx.Response( |
| 88 | + status_code=429, |
| 89 | + headers={"Retry-After": "1"}, # Retry after 1 second |
| 90 | + json={ |
| 91 | + "error": { |
| 92 | + "message": "Write operations for this devbox are currently rate limited." |
| 93 | + } |
| 94 | + }, |
| 95 | + ), |
| 96 | + # Second attempt: success |
| 97 | + httpx.Response( |
| 98 | + status_code=200, |
| 99 | + json={ |
| 100 | + "id": "exec-456", |
| 101 | + "devbox_id": "test-devbox-id", |
| 102 | + "status": "completed", |
| 103 | + "exit_status": 0, |
| 104 | + }, |
| 105 | + ), |
| 106 | + ] |
| 107 | + |
| 108 | + start_time = time.time() |
| 109 | + result = client.devboxes.write_file_contents( |
| 110 | + id="test-devbox-id", |
| 111 | + contents="test content", |
| 112 | + file_path="/tmp/test.txt", |
| 113 | + ) |
| 114 | + elapsed_time = time.time() - start_time |
| 115 | + |
| 116 | + # Verify the request succeeded |
| 117 | + assert result.id == "exec-456" |
| 118 | + |
| 119 | + # Verify it waited approximately 1 second (Retry-After value) |
| 120 | + assert elapsed_time >= 0.9 # Allow slight timing variance |
| 121 | + assert elapsed_time < 2.0 # Should not take too long |
| 122 | + |
| 123 | + # Verify two requests were made |
| 124 | + assert route.call_count == 2 |
| 125 | + |
| 126 | + def test_write_file_contents_exhausts_retries(self, respx_mock: respx.MockRouter) -> None: |
| 127 | + """Test that write_file_contents fails after exhausting retries.""" |
| 128 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=2) |
| 129 | + |
| 130 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 131 | + |
| 132 | + # All attempts return 429 |
| 133 | + for _ in range(3): # max_retries + 1 |
| 134 | + route.mock( |
| 135 | + return_value=httpx.Response( |
| 136 | + status_code=429, |
| 137 | + json={ |
| 138 | + "error": { |
| 139 | + "message": "Write operations for this devbox are currently rate limited." |
| 140 | + } |
| 141 | + }, |
| 142 | + ) |
| 143 | + ) |
| 144 | + |
| 145 | + # Should raise RateLimitError after exhausting retries |
| 146 | + with pytest.raises(RateLimitError) as exc_info: |
| 147 | + client.devboxes.write_file_contents( |
| 148 | + id="test-devbox-id", |
| 149 | + contents="test content", |
| 150 | + file_path="/tmp/test.txt", |
| 151 | + ) |
| 152 | + |
| 153 | + # Verify error message |
| 154 | + assert "rate limit" in str(exc_info.value).lower() |
| 155 | + |
| 156 | + # Verify all retry attempts were made |
| 157 | + assert route.call_count == 3 # initial + 2 retries |
| 158 | + |
| 159 | + def test_upload_file_retries_on_429(self, respx_mock: respx.MockRouter) -> None: |
| 160 | + """Test that upload_file retries when encountering 429 errors.""" |
| 161 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=3) |
| 162 | + |
| 163 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/upload_file") |
| 164 | + |
| 165 | + route.side_effect = [ |
| 166 | + # First attempt: 429 |
| 167 | + httpx.Response( |
| 168 | + status_code=429, |
| 169 | + json={ |
| 170 | + "error": { |
| 171 | + "message": "Write operations for this devbox are currently rate limited." |
| 172 | + } |
| 173 | + }, |
| 174 | + ), |
| 175 | + # Second attempt: success |
| 176 | + httpx.Response( |
| 177 | + status_code=200, |
| 178 | + json={"success": True}, |
| 179 | + ), |
| 180 | + ] |
| 181 | + |
| 182 | + result = client.devboxes.upload_file( |
| 183 | + id="test-devbox-id", |
| 184 | + path="/tmp/test.bin", |
| 185 | + file=b"binary content", |
| 186 | + ) |
| 187 | + |
| 188 | + # Verify the request succeeded |
| 189 | + assert result == {"success": True} |
| 190 | + |
| 191 | + # Verify retry happened |
| 192 | + assert route.call_count == 2 |
| 193 | + |
| 194 | + def test_write_file_contents_with_custom_max_retries(self, respx_mock: respx.MockRouter) -> None: |
| 195 | + """Test that custom max_retries configuration is respected.""" |
| 196 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=5) |
| 197 | + |
| 198 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 199 | + |
| 200 | + # Return 429 for first 4 attempts, then succeed |
| 201 | + route.side_effect = [ |
| 202 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 203 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 204 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 205 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 206 | + httpx.Response( |
| 207 | + status_code=200, |
| 208 | + json={ |
| 209 | + "id": "exec-789", |
| 210 | + "devbox_id": "test-devbox-id", |
| 211 | + "status": "completed", |
| 212 | + "exit_status": 0, |
| 213 | + }, |
| 214 | + ), |
| 215 | + ] |
| 216 | + |
| 217 | + result = client.devboxes.write_file_contents( |
| 218 | + id="test-devbox-id", |
| 219 | + contents="test content", |
| 220 | + file_path="/tmp/test.txt", |
| 221 | + ) |
| 222 | + |
| 223 | + # Verify success after 5 attempts (initial + 4 retries) |
| 224 | + assert result.id == "exec-789" |
| 225 | + assert route.call_count == 5 |
| 226 | + |
| 227 | + def test_write_file_contents_no_retry_when_disabled(self, respx_mock: respx.MockRouter) -> None: |
| 228 | + """Test that retries can be disabled by setting max_retries=0.""" |
| 229 | + client = Runloop(base_url=base_url, bearer_token="test-token", max_retries=0) |
| 230 | + |
| 231 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 232 | + route.mock( |
| 233 | + return_value=httpx.Response( |
| 234 | + status_code=429, |
| 235 | + json={"error": {"message": "Rate limited"}}, |
| 236 | + ) |
| 237 | + ) |
| 238 | + |
| 239 | + # Should fail immediately without retry |
| 240 | + with pytest.raises(RateLimitError): |
| 241 | + client.devboxes.write_file_contents( |
| 242 | + id="test-devbox-id", |
| 243 | + contents="test content", |
| 244 | + file_path="/tmp/test.txt", |
| 245 | + ) |
| 246 | + |
| 247 | + # Verify only one request was made (no retries) |
| 248 | + assert route.call_count == 1 |
| 249 | + |
| 250 | + |
| 251 | +class TestAsyncRateLimitRetry: |
| 252 | + """Test async rate limit retry behavior for file write operations.""" |
| 253 | + |
| 254 | + @pytest.mark.asyncio |
| 255 | + async def test_write_file_contents_retries_on_429(self, respx_mock: respx.MockRouter) -> None: |
| 256 | + """Test that async write_file_contents retries when encountering 429 errors.""" |
| 257 | + client = AsyncRunloop(base_url=base_url, bearer_token="test-token", max_retries=3) |
| 258 | + |
| 259 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 260 | + |
| 261 | + route.side_effect = [ |
| 262 | + # First two attempts: 429 |
| 263 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 264 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 265 | + # Third attempt: success |
| 266 | + httpx.Response( |
| 267 | + status_code=200, |
| 268 | + json={ |
| 269 | + "id": "exec-async-123", |
| 270 | + "devbox_id": "test-devbox-id", |
| 271 | + "status": "completed", |
| 272 | + "exit_status": 0, |
| 273 | + }, |
| 274 | + ), |
| 275 | + ] |
| 276 | + |
| 277 | + start_time = time.time() |
| 278 | + result = await client.devboxes.write_file_contents( |
| 279 | + id="test-devbox-id", |
| 280 | + contents="test content", |
| 281 | + file_path="/tmp/test.txt", |
| 282 | + ) |
| 283 | + elapsed_time = time.time() - start_time |
| 284 | + |
| 285 | + # Verify the request succeeded |
| 286 | + assert result.id == "exec-async-123" |
| 287 | + |
| 288 | + # Verify retry happened (should have taken some time) |
| 289 | + assert elapsed_time > 0.1 |
| 290 | + |
| 291 | + # Verify all three requests were made |
| 292 | + assert route.call_count == 3 |
| 293 | + |
| 294 | + @pytest.mark.asyncio |
| 295 | + async def test_upload_file_retries_on_429(self, respx_mock: respx.MockRouter) -> None: |
| 296 | + """Test that async upload_file retries when encountering 429 errors.""" |
| 297 | + client = AsyncRunloop(base_url=base_url, bearer_token="test-token", max_retries=2) |
| 298 | + |
| 299 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/upload_file") |
| 300 | + |
| 301 | + route.side_effect = [ |
| 302 | + # First attempt: 429 |
| 303 | + httpx.Response(status_code=429, json={"error": {"message": "Rate limited"}}), |
| 304 | + # Second attempt: success |
| 305 | + httpx.Response(status_code=200, json={"success": True}), |
| 306 | + ] |
| 307 | + |
| 308 | + result = await client.devboxes.upload_file( |
| 309 | + id="test-devbox-id", |
| 310 | + path="/tmp/test.bin", |
| 311 | + file=b"binary content", |
| 312 | + ) |
| 313 | + |
| 314 | + # Verify the request succeeded |
| 315 | + assert result == {"success": True} |
| 316 | + assert route.call_count == 2 |
| 317 | + |
| 318 | + @pytest.mark.asyncio |
| 319 | + async def test_write_file_contents_exhausts_retries(self, respx_mock: respx.MockRouter) -> None: |
| 320 | + """Test that async write_file_contents fails after exhausting retries.""" |
| 321 | + client = AsyncRunloop(base_url=base_url, bearer_token="test-token", max_retries=2) |
| 322 | + |
| 323 | + route = respx_mock.post(f"{base_url}/v1/devboxes/test-devbox-id/write_file_contents") |
| 324 | + |
| 325 | + # All attempts return 429 |
| 326 | + for _ in range(3): |
| 327 | + route.mock( |
| 328 | + return_value=httpx.Response( |
| 329 | + status_code=429, |
| 330 | + json={"error": {"message": "Rate limited"}}, |
| 331 | + ) |
| 332 | + ) |
| 333 | + |
| 334 | + # Should raise RateLimitError |
| 335 | + with pytest.raises(RateLimitError): |
| 336 | + await client.devboxes.write_file_contents( |
| 337 | + id="test-devbox-id", |
| 338 | + contents="test content", |
| 339 | + file_path="/tmp/test.txt", |
| 340 | + ) |
| 341 | + |
| 342 | + # Verify all retry attempts were made |
| 343 | + assert route.call_count == 3 |
0 commit comments