chore(api): canon log follow-ups — hardening, unified 422, contract doc

- canon_log.py: stringify jsonschema error-path segments before sorting so a
  future schema mixing array indices and object keys can't TypeError (#1)
- main.py: RequestValidationError handler reshapes pydantic body failures into
  the same {"detail": {"canon_log_errors": [...]}} envelope as schema failures,
  so the client parses ONE 422 shape (#2a) + tests
- pytest.ini: filter the starlette/httpx TestClient deprecation → pristine output (#4)
- docs/canon-log.md: living contract for the client (Plan B) — schemas, the §7
  boundary, the unified error envelope, per-role injection (#3)

Full suite 26 passing, 0 warnings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-07-09 13:03:59 -05:00
parent 0e9d1b2a43
commit 7f1d9fa39a
5 changed files with 136 additions and 1 deletions

View File

@@ -38,7 +38,9 @@ def _validator(schema_name: str) -> Draft202012Validator:
def validation_errors(doc: dict, schema_name: str) -> list[str]:
validator = _validator(schema_name)
return [e.message for e in sorted(validator.iter_errors(doc), key=lambda e: list(e.path))]
# Stringify path segments before sorting: a path can mix str property names
# and int array indices, which are not orderable against each other.
return [e.message for e in sorted(validator.iter_errors(doc), key=lambda e: [str(p) for p in e.path])]
def validate_origin(doc: dict) -> list[str]:

View File

@@ -7,6 +7,8 @@ Prompt routing, model selection, and logging land later.
"""
from fastapi import Depends, FastAPI, HTTPException
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from pydantic import BaseModel
from .canon_log import validate_canon_log
@@ -14,6 +16,16 @@ from .canon_log import validate_canon_log
app = FastAPI(title="coc-rpg proxy", version="0.0.1")
@app.exception_handler(RequestValidationError)
async def unify_validation_errors(request, exc: RequestValidationError) -> JSONResponse:
"""Reshape pydantic body-validation failures into the same envelope as a
canon-log schema failure, so the client parses ONE 422 shape (charter §11):
{"detail": {"canon_log_errors": [...]}}.
"""
errors = [f"{'.'.join(str(loc) for loc in e['loc'])}: {e['msg']}" for e in exc.errors()]
return JSONResponse(status_code=422, content={"detail": {"canon_log_errors": errors}})
class TurnRequest(BaseModel):
canon_log: dict

View File

@@ -1,3 +1,5 @@
[pytest]
pythonpath = .
testpaths = tests
filterwarnings =
ignore:Using `httpx` with `starlette.testclient` is deprecated

View File

@@ -36,3 +36,12 @@ def test_every_role_endpoint_rejects_an_invalid_canon_log():
def test_missing_canon_log_is_a_422():
r = client.post("/dm/narrate", json={})
assert r.status_code == 422
assert "canon_log_errors" in r.json()["detail"]
def test_malformed_body_uses_the_unified_error_shape():
# A pydantic body failure returns the SAME envelope as a schema failure,
# so the client only ever parses one 422 shape.
r = client.post("/dm/narrate", json={"canon_log": "not-a-dict"})
assert r.status_code == 422
assert "canon_log_errors" in r.json()["detail"]