[Frontend] Consolidate entrypoint exception handler (#52261)
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
This commit is contained in:
@@ -6,18 +6,10 @@ import pytest
|
||||
from vllm.entrypoints.openai.engine.protocol import StreamOptions
|
||||
from vllm.entrypoints.serve.utils.api_utils import (
|
||||
get_max_tokens,
|
||||
sanitize_message,
|
||||
should_include_usage,
|
||||
)
|
||||
|
||||
|
||||
def test_sanitize_message():
|
||||
assert (
|
||||
sanitize_message("<_io.BytesIO object at 0x7a95e299e750>")
|
||||
== "<_io.BytesIO object>"
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("stream_options", "expected"),
|
||||
[
|
||||
@@ -118,49 +110,3 @@ class TestGetMaxTokens:
|
||||
input_length=150,
|
||||
default_sampling_params={"max_tokens": 2048},
|
||||
)
|
||||
|
||||
|
||||
class TestSanitizeMessageFilePaths:
|
||||
"""sanitize_message should also strip file paths and traceback
|
||||
frames, not just memory addresses - see #31683."""
|
||||
|
||||
def test_strips_traceback_style_frame(self):
|
||||
msg = (
|
||||
"1 validation error:\n"
|
||||
" {'type': 'list_type', 'loc': ('body', 'messages')}\n"
|
||||
'\n File "/usr/local/lib/python3.12/dist-packages/vllm/'
|
||||
'entrypoints/serve/utils/api_utils.py", line 40, '
|
||||
"in create_chat_completion\n"
|
||||
" POST /v1/chat/completions"
|
||||
)
|
||||
result = sanitize_message(msg)
|
||||
assert "/usr/local/" not in result
|
||||
assert "api_utils.py" not in result
|
||||
assert "list_type" in result
|
||||
|
||||
def test_strips_arbitrary_absolute_path(self):
|
||||
result = sanitize_message("Error in /home/user/project/vllm/server.py")
|
||||
assert "/home/user" not in result
|
||||
|
||||
def test_strips_single_parent_container_path(self):
|
||||
"""Regression: /app/server.py and /workspace/server.py (common in
|
||||
container deployments) were missed by the original {2,} quantifier."""
|
||||
assert "/app/" not in sanitize_message("Error in /app/server.py")
|
||||
assert "/workspace/" not in sanitize_message("Error in /workspace/server.py")
|
||||
|
||||
def test_preserves_api_endpoint_paths(self):
|
||||
msg = "POST /v1/chat/completions failed"
|
||||
assert "/v1/chat/completions" in sanitize_message(msg)
|
||||
|
||||
def test_preserves_short_field_references(self):
|
||||
msg = "Invalid value for field 'body.messages'"
|
||||
assert sanitize_message(msg) == msg
|
||||
|
||||
def test_strips_both_address_and_path(self):
|
||||
msg = (
|
||||
"<Request at 0x7f123> failed at "
|
||||
"/usr/local/lib/python3.12/dist-packages/vllm/server.py"
|
||||
)
|
||||
result = sanitize_message(msg)
|
||||
assert "0x" not in result
|
||||
assert "/usr/local/" not in result
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
"""Tests that error messages in Anthropic and speech-to-text entrypoints
|
||||
are sanitized to prevent memory address leakage.
|
||||
|
||||
Verifies the fix for the incomplete CVE-2026-22778 remediation where
|
||||
PIL repr addresses leaked via the Anthropic API router and the
|
||||
speech-to-text WebSocket paths.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
|
||||
from vllm.entrypoints.serve.utils.api_utils import sanitize_message
|
||||
|
||||
|
||||
class TestSanitizeMessageCoversLeakPatterns:
|
||||
"""Ensure sanitize_message strips addresses from realistic exceptions."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("raw", "expected"),
|
||||
[
|
||||
(
|
||||
"cannot identify image file <_io.BytesIO object at 0x7a95e299e750>",
|
||||
"cannot identify image file <_io.BytesIO object>",
|
||||
),
|
||||
(
|
||||
"cannot identify image file <_io.BytesIO object at 0x7f3c1a2b4d90>",
|
||||
"cannot identify image file <_io.BytesIO object>",
|
||||
),
|
||||
(
|
||||
"<PIL.PngImagePlugin.PngImageFile image mode=RGB "
|
||||
"size=8x8 at 0x7f3c1a2b4d90>",
|
||||
"<PIL.PngImagePlugin.PngImageFile image mode=RGB size=8x8>",
|
||||
),
|
||||
(
|
||||
"Error processing <_io.BytesIO object at 0xdeadbeef>: invalid header",
|
||||
"Error processing <_io.BytesIO object>: invalid header",
|
||||
),
|
||||
],
|
||||
ids=[
|
||||
"bytesio-standard",
|
||||
"bytesio-different-addr",
|
||||
"pil-image-repr",
|
||||
"mid-string-repr",
|
||||
],
|
||||
)
|
||||
def test_address_stripped(self, raw: str, expected: str):
|
||||
assert sanitize_message(raw) == expected
|
||||
|
||||
def test_safe_message_unchanged(self):
|
||||
msg = "Invalid request: missing 'messages' field"
|
||||
assert sanitize_message(msg) == msg
|
||||
|
||||
def test_multiple_addresses_stripped(self):
|
||||
raw = "<obj at 0xaaa> and <obj at 0xbbb>"
|
||||
result = sanitize_message(raw)
|
||||
assert "0x" not in result
|
||||
|
||||
|
||||
class TestAffectedModulesUseSanitize:
|
||||
"""Verify that affected modules call sanitize_message (source-level)."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"module",
|
||||
[
|
||||
"vllm.entrypoints.anthropic.api_router",
|
||||
"vllm.entrypoints.anthropic.serving",
|
||||
"vllm.entrypoints.speech_to_text.realtime.connection",
|
||||
],
|
||||
)
|
||||
def test_module_calls_sanitize_message(self, module: str):
|
||||
import importlib.util
|
||||
from pathlib import Path
|
||||
|
||||
spec = importlib.util.find_spec(module)
|
||||
assert spec is not None and spec.origin is not None, (
|
||||
f"Cannot locate module {module}"
|
||||
)
|
||||
source = Path(spec.origin).read_text()
|
||||
assert "sanitize_message" in source, f"{module} does not call sanitize_message"
|
||||
assert "import" in source and "sanitize_message" in source
|
||||
@@ -1,153 +0,0 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
"""Tests that validation_exception_handler populates the `param` field
|
||||
in its error response using the Pydantic error's `loc`, even when no
|
||||
custom VLLMValidationError context is present.
|
||||
|
||||
Previously, `param` was only populated for errors carrying a custom
|
||||
VLLMValidationError in their Pydantic `ctx`. Plain validation failures
|
||||
(missing fields, wrong types) left `param` as None, even though the
|
||||
field name was readily available from `error['loc']`.
|
||||
"""
|
||||
|
||||
import json
|
||||
from types import SimpleNamespace
|
||||
|
||||
import pytest
|
||||
from fastapi.exceptions import RequestValidationError
|
||||
|
||||
from vllm.entrypoints.serve.utils.server_utils import (
|
||||
clean_loc_for_param,
|
||||
validation_exception_handler,
|
||||
)
|
||||
|
||||
|
||||
def _fake_request(log_error_stack: bool = False) -> SimpleNamespace:
|
||||
"""Minimal stand-in for a FastAPI Request - just enough for the
|
||||
handler to read req.app.state.args.log_error_stack."""
|
||||
return SimpleNamespace(
|
||||
app=SimpleNamespace(
|
||||
state=SimpleNamespace(args=SimpleNamespace(log_error_stack=log_error_stack))
|
||||
),
|
||||
state=SimpleNamespace(), # no request_metadata -> hasattr(...) is False
|
||||
)
|
||||
|
||||
|
||||
class TestValidationErrorParamFallback:
|
||||
"""Ensure `param` falls back to the Pydantic error's `loc` when no
|
||||
custom VLLMValidationError context is present."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("error_type", "msg"),
|
||||
[
|
||||
("missing", "Field required"),
|
||||
("list_type", "Input should be a valid list"),
|
||||
],
|
||||
ids=["missing-field", "wrong-type"],
|
||||
)
|
||||
@pytest.mark.asyncio
|
||||
async def test_param_falls_back_to_loc(self, error_type: str, msg: str):
|
||||
errors = [{"type": error_type, "loc": ("body", "messages"), "msg": msg}]
|
||||
exc = RequestValidationError(errors)
|
||||
|
||||
response = await validation_exception_handler(_fake_request(), exc)
|
||||
body = json.loads(response.body)
|
||||
|
||||
assert body["error"]["param"] == "body.messages"
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_param_fallback_does_not_crash_on_non_dict_error(self):
|
||||
"""Schemathesis fuzzing found that errors[0] isn't always a dict.
|
||||
The fallback must not crash in that case - it should just leave
|
||||
param as None instead of raising."""
|
||||
exc = RequestValidationError(["some unexpected non-dict error"])
|
||||
|
||||
response = await validation_exception_handler(_fake_request(), exc)
|
||||
body = json.loads(response.body)
|
||||
|
||||
assert body["error"]["param"] is None
|
||||
|
||||
|
||||
class TestCleanLocForParam:
|
||||
"""Guards against PR #1's naive dot-joined `loc` fallback leaking
|
||||
Pydantic-internal wrapper/union-branch markers into `param`, e.g.
|
||||
'body.function-wrap[__log_extra_fields__()].prompt' instead of the
|
||||
clean 'body.prompt' an API consumer would recognize.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"loc,expected",
|
||||
[
|
||||
(("body", "prompt"), "body.prompt"),
|
||||
(("body", "messages", 2, "content"), "body.messages.2.content"),
|
||||
(
|
||||
("body", "function-wrap[__log_extra_fields__()]", "prompt"),
|
||||
"body.prompt",
|
||||
),
|
||||
(("body", "stop", "str"), "body.stop"),
|
||||
(("body", "stop", "list[str]"), "body.stop"),
|
||||
(
|
||||
("body", "prompt", "list[constrained-int]"),
|
||||
"body.prompt",
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_strips_internal_markers(self, loc, expected):
|
||||
assert clean_loc_for_param(loc) == expected
|
||||
|
||||
def test_all_internal_falls_back_to_raw_join(self):
|
||||
"""If every loc segment looks internal, fall back to the raw
|
||||
dot-join rather than returning an empty string."""
|
||||
loc = ("function-wrap[__log_extra_fields__()]",)
|
||||
assert clean_loc_for_param(loc) == "function-wrap[__log_extra_fields__()]"
|
||||
|
||||
|
||||
class TestValidationErrorDoesNotLeakServerPaths:
|
||||
"""FastAPI sets endpoint_file/line/function/path on the exception
|
||||
during routing, not in the constructor - so we set them manually
|
||||
here to reproduce the real leak. See #31683."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_handler_strips_endpoint_file_context(self):
|
||||
errors = [
|
||||
{
|
||||
"type": "list_type",
|
||||
"loc": ("body", "messages"),
|
||||
"msg": "Input should be a valid list",
|
||||
"input": "not-a-list",
|
||||
}
|
||||
]
|
||||
exc = RequestValidationError(errors)
|
||||
exc.endpoint_file = (
|
||||
"/usr/local/lib/python3.12/dist-packages/vllm/"
|
||||
"entrypoints/serve/utils/api_utils.py"
|
||||
)
|
||||
exc.endpoint_line = 40
|
||||
exc.endpoint_function = "create_chat_completion"
|
||||
exc.endpoint_path = "POST /v1/chat/completions"
|
||||
|
||||
response = await validation_exception_handler(_fake_request(), exc)
|
||||
body = json.loads(response.body)
|
||||
message = body["error"]["message"]
|
||||
|
||||
assert "/usr/local/" not in message
|
||||
assert "api_utils.py" not in message
|
||||
assert "create_chat_completion" not in message
|
||||
assert "list_type" in message
|
||||
assert "Input should be a valid list" in message
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_handler_strips_endpoint_path_only_variant(self):
|
||||
"""Covers the branch where only endpoint_path is set."""
|
||||
errors = [
|
||||
{"type": "missing", "loc": ("body", "messages"), "msg": "Field required"}
|
||||
]
|
||||
exc = RequestValidationError(errors)
|
||||
exc.endpoint_path = "POST /v1/chat/completions"
|
||||
|
||||
response = await validation_exception_handler(_fake_request(), exc)
|
||||
body = json.loads(response.body)
|
||||
message = body["error"]["message"]
|
||||
|
||||
assert "missing" in message
|
||||
assert "Field required" in message
|
||||
Reference in New Issue
Block a user