Merge pull request #1174 from Kiln-AI/dchiang/KIL-498/add-copilot-timeout

Increase timeout for spec and add timeout error

Author: chiang-daniel

app/desktop/studio_server/api_client/kiln_server_client.py

@@ -46,7 +46,7 @@ def get_authenticated_client(api_key: str) -> AuthenticatedClient:
         base_url=_get_base_url(),
         token=api_key,
         headers=_get_common_headers(),
-        timeout=httpx.Timeout(timeout=300.0, connect=30.0),
+        timeout=httpx.Timeout(timeout=900.0, connect=30.0),
     )
 
 

app/desktop/studio_server/api_client/test_kiln_server_client.py

@@ -204,5 +204,5 @@ def test_client_has_appropriate_timeout(self):
         """Verify the client has a reasonable timeout for long-running requests."""
         client = get_authenticated_client("test_api_key")
         assert client._timeout is not None
-        assert client._timeout.read == 300.0
+        assert client._timeout.read == 900.0
         assert client._timeout.connect == 30.0

libs/server/kiln_server/custom_errors.py

@@ -1,6 +1,7 @@
 import json
 import logging
 
+import httpx
 from fastapi import FastAPI, HTTPException, Request, status
 from fastapi.exceptions import RequestValidationError
 from fastapi.responses import JSONResponse
@@ -86,6 +87,18 @@ async def http_exception_handler(request: Request, exc: HTTPException):
             content={"message": exc.detail},
         )
 
+    @app.exception_handler(httpx.TimeoutException)
+    async def timeout_error_handler(request: Request, exc: httpx.TimeoutException):
+        logger.warning(
+            f"Request timed out on {request.method} {request.url.path}",
+            exc_info=exc,
+        )
+        return JSONResponse(
+            status_code=status.HTTP_408_REQUEST_TIMEOUT,
+            headers={"Access-Control-Allow-Origin": "*"},
+            content={"message": "Request timed out. Please try again."},
+        )
+
     # Fallback error handler for any other exception
     @app.exception_handler(Exception)
     async def fallback_error_handler(request: Request, exc: Exception):

libs/server/kiln_server/test_custom_error.py

@@ -1,3 +1,4 @@
+import httpx
 import pytest
 from fastapi import FastAPI
 from fastapi.testclient import TestClient
@@ -22,6 +23,14 @@ class Item(BaseModel):
     async def create_item(item: Item):
         return item
 
+    @app.get("/timeout")
+    async def raise_timeout():
+        raise httpx.TimeoutException("Request timed out")
+
+    @app.get("/generic-error")
+    async def raise_generic_error():
+        raise RuntimeError("Something went wrong")
+
     return app
 
 
@@ -30,6 +39,11 @@ def client(app):
     return TestClient(app)
 
 
+@pytest.fixture
+def client_no_raise(app):
+    return TestClient(app, raise_server_exceptions=False)
+
+
 def test_validation_error_single_field(client):
     response = client.post("/items", json={"name": "ab", "price": 10})
     assert response.status_code == 422
@@ -92,3 +106,23 @@ def test_format_error_loc_with_none():
 
 def test_format_error_loc_with_empty_string():
     assert format_error_loc(("container", "", "field")) == "Container.Field"
+
+
+class TestTimeoutErrorHandler:
+    def test_timeout_exception_returns_408(self, client_no_raise):
+        response = client_no_raise.get("/timeout")
+        assert response.status_code == 408
+
+    def test_timeout_exception_message(self, client_no_raise):
+        response = client_no_raise.get("/timeout")
+        body = response.json()
+        assert body["message"] == "Request timed out. Please try again."
+        assert "raw_error" not in body
+
+    def test_timeout_exception_has_cors_header(self, client_no_raise):
+        response = client_no_raise.get("/timeout")
+        assert response.headers.get("access-control-allow-origin") == "*"
+
+    def test_other_exceptions_still_return_500(self, client_no_raise):
+        response = client_no_raise.get("/generic-error")
+        assert response.status_code == 500