Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

fix(server): accept slash in X-Request-ID and regenerate invalid ids instead of 400 (#4827)

Nguyễn Đăng Minh Lực75deb0904b1f
diff --git a/openviking/server/request_id.py b/openviking/server/request_id.py
index 74b82bc80..c7fcca39a 100644
--- a/openviking/server/request_id.py
+++ b/openviking/server/request_id.py
@@ -10,25 +10,20 @@ import re
import time
import uuid
-from starlette.responses import JSONResponse
from starlette.types import ASGIApp, Message, Receive, Scope, Send
from openviking_cli.utils.logger import bind_log_request_id
REQUEST_ID_HEADER = "X-Request-ID"
_REQUEST_ID_HEADER_BYTES = b"x-request-id"
-_REQUEST_ID_PATTERN = re.compile(r"[A-Za-z0-9._:-]{1,128}")
+_REQUEST_ID_PATTERN = re.compile(r"[A-Za-z0-9._:/-]{1,128}")
_IGNORED_COMPLETION_ROUTES = frozenset({"/health", "/ready", "/metrics"})
_completion_logger = logging.getLogger("openviking.observability.http")
def _resolve_request_id(scope: Scope) -> tuple[str, bool]:
- values = [
- value
- for name, value in scope["headers"]
- if name.lower() == _REQUEST_ID_HEADER_BYTES
- ]
+ values = [value for name, value in scope["headers"] if name.lower() == _REQUEST_ID_HEADER_BYTES]
invalid = bool(values)
if len(values) == 1:
try:
@@ -80,22 +75,15 @@ class RequestIdMiddleware:
with bind_log_request_id(request_id):
try:
if invalid:
- response = JSONResponse(
- status_code=400,
- content={
- "status": "error",
- "error": {
- "code": "INVALID_ARGUMENT",
- "message": (
- "X-Request-ID must be supplied once and contain 1-128 "
- "characters from [A-Za-z0-9._:-]"
- ),
- },
- },
+ # Regenerated ids from _resolve_request_id are used as-is;
+ # reject-by-HTTP-400 broke legitimate gateways (e.g. OpenAI
+ # Secure MCP Tunnel) that forward trace ids like
+ # "<uuid>/<suffix>". Never log the raw invalid value.
+ _completion_logger.warning(
+ "HTTP request arrived with missing or invalid "
+ "X-Request-ID header; generated replacement"
)
- await response(scope, receive, send_with_request_id)
- else:
- await self.app(scope, receive, send_with_request_id)
+ await self.app(scope, receive, send_with_request_id)
finally:
if scope["path"] not in _IGNORED_COMPLETION_ROUTES:
duration_ms = (time.perf_counter() - started_at) * 1000
diff --git a/tests/server/test_request_id.py b/tests/server/test_request_id.py
index c8204b413..ab03406e7 100644
--- a/tests/server/test_request_id.py
+++ b/tests/server/test_request_id.py
@@ -99,7 +99,7 @@ async def test_missing_request_id_generates_uuid_for_health_and_cors_exposes_it(
assert REQUEST_ID_HEADER.lower() in response.headers["Access-Control-Expose-Headers"].lower()
-async def test_invalid_request_ids_are_rejected_without_logging_raw_values() -> None:
+async def test_invalid_request_ids_are_replaced_without_logging_raw_values() -> None:
app = _make_test_app()
records: list[logging.LogRecord] = []
server_logger = logging.getLogger("openviking")
@@ -117,18 +117,34 @@ async def test_invalid_request_ids_are_rejected_without_logging_raw_values() ->
finally:
server_logger.removeHandler(handler)
- assert all(response.status_code == 400 for response in responses)
- assert all(response.json()["error"]["code"] == "INVALID_ARGUMENT" for response in responses)
+ assert all(response.status_code == 404 for response in responses)
for response in responses:
_assert_generated_request_id(response.headers[REQUEST_ID_HEADER])
completion_records = [
record for record in records if record.name == "openviking.observability.http"
]
assert all(record.request_id for record in completion_records)
- rendered = "\n".join(record.getMessage() for record in completion_records)
+ rendered = "\n".join(record.getMessage() for record in records)
assert all(raw not in rendered for raw in ("contains spaces", "x" * 129, "first", "second"))
+async def test_request_id_with_slash_suffix_is_accepted_verbatim() -> None:
+ app = _make_test_app()
+
+ @app.get("/items/{item_id}")
+ async def item(item_id: str):
+ return {"item_id": item_id}
+
+ response = await _request(
+ app,
+ "/items/42",
+ headers={REQUEST_ID_HEADER: "4257d51f-61c7-49d4-b78d-773e19a2c461/g6hr"},
+ )
+
+ assert response.status_code == 200
+ assert response.headers[REQUEST_ID_HEADER] == "4257d51f-61c7-49d4-b78d-773e19a2c461/g6hr"
+
+
async def test_unhandled_500_keeps_request_id_for_log_and_response(monkeypatch) -> None:
app = create_app(config=ServerConfig(), service=SimpleNamespace())
records: list[logging.LogRecord] = []