claude-proxy / tests /core /test_trace.py
dheraingoud's picture
Copilot App
Sync upstream v6.19.35 and preserve custom addons
a9e27c0
Raw History Blame Contribute Delete
8.37 kB
"""Structured TRACE logging assertions."""
import json
from pathlib import Path
import pytest
from loguru import logger
from free_claude_code.config.logging_config import configure_logging
from free_claude_code.core.trace import (
TRACE_PAYLOAD_BINDING,
trace_event,
traced_async_stream,
)
class _CloseTrackingIterator:
def __init__(
self,
chunks: list[str],
*,
iteration_error: Exception | None = None,
close_error: Exception | None = None,
) -> None:
self._chunks = iter(chunks)
self._iteration_error = iteration_error
self._close_error = close_error
self.close_calls = 0
def __aiter__(self) -> _CloseTrackingIterator:
return self
async def __anext__(self) -> str:
try:
return next(self._chunks)
except StopIteration:
if self._iteration_error is not None:
error = self._iteration_error
self._iteration_error = None
raise error from None
raise StopAsyncIteration from None
async def aclose(self) -> None:
self.close_calls += 1
if self._close_error is not None:
raise self._close_error
def _json_log_rows(log_file: str) -> list[dict]:
logger.complete()
text = Path(log_file).read_text(encoding="utf-8").strip()
if not text:
return []
return [json.loads(line) for line in text.split("\n")]
def _trace_payloads(log_file: str) -> list[dict]:
return [
row["record"]["extra"][TRACE_PAYLOAD_BINDING]
for row in _json_log_rows(log_file)
if TRACE_PAYLOAD_BINDING in row["record"]["extra"]
]
def test_trace_payload_preserved_in_native_json(tmp_path) -> None:
log_file = str(tmp_path / "t.log")
configure_logging(log_file, force=True, level="DEBUG")
trace_event(stage="s", event="e.v1", source="unit", hello="world", n=42)
row = _json_log_rows(log_file)[-1]
assert row["record"]["level"]["name"] == "DEBUG"
row = row["record"]["extra"][TRACE_PAYLOAD_BINDING]
assert row["stage"] == "s"
assert row["event"] == "e.v1"
assert row["source"] == "unit"
assert row["hello"] == "world"
assert row["n"] == 42
assert TRACE_PAYLOAD_BINDING == "trace_payload"
def test_trace_payload_excluded_from_default_info_logs(tmp_path) -> None:
log_file = str(tmp_path / "default.log")
configure_logging(log_file, force=True)
trace_event(stage="s", event="hidden", source="unit")
logger.info("visible lifecycle event")
rows = _json_log_rows(log_file)
assert [row["record"]["message"] for row in rows] == ["visible lifecycle event"]
def test_sanitize_masks_nested_api_key_strings() -> None:
"""Credential-shaped keys redact without touching normal message text."""
from free_claude_code.core.trace import sanitize_trace_value
out = sanitize_trace_value(
{"outer": {"api_key": "secret", "text": "visible"}},
)
assert out["outer"]["api_key"] == "<redacted>"
assert out["outer"]["text"] == "visible"
def test_trace_redacts_credential_lists_and_all_catalog_aliases():
from free_claude_code.config.provider_catalog import PROVIDER_CATALOG
from free_claude_code.core.trace import sanitize_trace_value
owners = {
name
for descriptor in PROVIDER_CATALOG.values()
for name in (descriptor.credential_env, descriptor.credential_attr)
if name
}
values = {
name: ["trace-first-sentinel", "trace-inactive-sentinel"] for name in owners
}
payload = {
"values": values,
"custom_provider": {
"values": {
"api_keys": {"entries": [{"value": "custom-trace-sentinel"}]},
"display_name": "Visible",
}
},
}
public = sanitize_trace_value(payload)
encoded = json.dumps(public)
for secret in (
"trace-first-sentinel",
"trace-inactive-sentinel",
"custom-trace-sentinel",
):
assert secret not in encoded
assert public["custom_provider"]["values"]["display_name"] == "Visible"
@pytest.mark.parametrize(
"header", ["x-goog-api-key", "X-Goog-Api-Key", "api-key", "Api-Key"]
)
def test_trace_redacts_provider_api_keys_in_json(tmp_path: Path, header: str) -> None:
log_file = str(tmp_path / "credentials.log")
configure_logging(log_file, force=True, level="DEBUG")
headers = {header: "dummy-provider-secret", "content-type": "application/json"}
trace_event(
stage="ingress",
event="request.received",
source="unit",
requests=[{"headers": headers}],
)
payload = _trace_payloads(log_file)[0]
assert payload["requests"] == [
{"headers": {header: "<redacted>", "content-type": "application/json"}}
]
assert "dummy-provider-secret" not in Path(log_file).read_text(encoding="utf-8")
assert headers[header] == "dummy-provider-secret"
@pytest.mark.asyncio
async def test_traced_async_stream_logs_completion(tmp_path) -> None:
log_file = str(tmp_path / "complete.log")
configure_logging(log_file, force=True, level="DEBUG")
source = _CloseTrackingIterator(["hello", " world"])
chunks = [
chunk
async for chunk in traced_async_stream(
source,
stage="egress",
source="unit",
complete_event="stream.completed",
interrupted_event="stream.interrupted",
extra={"request_id": "req_complete"},
)
]
assert chunks == ["hello", " world"]
assert source.close_calls == 1
rows = _trace_payloads(log_file)
completed = [row for row in rows if row.get("event") == "stream.completed"]
assert len(completed) == 1
assert completed[0]["request_id"] == "req_complete"
assert completed[0]["stream_chunks"] == 2
assert completed[0]["outcome"] == "ok"
@pytest.mark.asyncio
async def test_traced_async_stream_logs_real_exception(tmp_path) -> None:
log_file = str(tmp_path / "error.log")
configure_logging(log_file, force=True, level="DEBUG")
source = _CloseTrackingIterator(
["before"],
iteration_error=RuntimeError("boom"),
close_error=RuntimeError("close boom"),
)
with pytest.raises(RuntimeError, match="boom"):
async for _chunk in traced_async_stream(
source,
stage="egress",
source="unit",
complete_event="stream.completed",
interrupted_event="stream.interrupted",
extra={"request_id": "req_error"},
):
pass
assert source.close_calls == 1
rows = _trace_payloads(log_file)
interrupted = [row for row in rows if row.get("event") == "stream.interrupted"]
assert len(interrupted) == 1
assert interrupted[0]["request_id"] == "req_error"
assert interrupted[0]["stream_chunks"] == 1
assert interrupted[0]["outcome"] == "error"
assert interrupted[0]["exc_type"] == "RuntimeError"
close_failed = [
row["record"]
for row in _json_log_rows(log_file)
if row["record"]["extra"].get("event") == "stream.input.close_failed"
]
assert len(close_failed) == 1
assert close_failed[0]["level"]["name"] == "WARNING"
assert close_failed[0]["exception"]["value"] == "close boom"
assert close_failed[0]["extra"]["owner"] == "traced_async_stream"
assert close_failed[0]["extra"]["close_exc_type"] == "RuntimeError"
assert close_failed[0]["extra"]["preserved_exc_type"] == "RuntimeError"
@pytest.mark.asyncio
async def test_traced_async_stream_closes_quietly_on_generator_exit(tmp_path) -> None:
log_file = str(tmp_path / "generator_exit.log")
configure_logging(log_file, force=True, level="DEBUG")
source = _CloseTrackingIterator(["first", "second"])
stream = traced_async_stream(
source,
stage="egress",
source="unit",
complete_event="stream.completed",
interrupted_event="stream.interrupted",
extra={"request_id": "req_closed"},
)
assert await anext(stream) == "first"
await stream.aclose()
assert source.close_calls == 1
rows = _trace_payloads(log_file)
events = {row.get("event") for row in rows}
assert "stream.completed" not in events
assert "stream.interrupted" not in events