YAU.POC/yau-plant-assistant
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix the retired-name guard: it raised TypeError, not an error

Browse source 
ContractViolation takes (rule, detail, offending_output=""). The guard
passed a single string, so every retired name raised

  TypeError: ContractViolation.__init__() missing 1 required positional
  argument: 'detail'

instead of the clean error it was written to produce - a guard that
crashes the request it was meant to explain.

It was not caught before deployment because this machine has neither
fastapi nor psycopg, so the guard could not be imported. It was tested by
lifting its source out of the file and exercising it against a stubbed
ContractViolation - a plain Exception, which accepts one argument. The
stub is what made the test pass. Running it in the built image found it in
one command, which is the argument for running the suite where the
dependencies are rather than reasoning about it where they are not.

Also records what the error actually does: main.py logs the rule, returns
422, and deliberately keeps the detail out of the operator-facing message,
so the explanation lands in the log and in Langfuse rather than on screen.
That is the right trade - an operator asking in plain English never types
one of these names, so the audience is a developer or a stale integration.

Verified in the running container: the retired names and their lowercase
forms are rejected with rule "retired_tag_name"; the poll groups, the item
names, the instrument tags and plain English all pass.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Claude 2026-09-01 20:31:17 +10:00
parent 421c585422
commit e5c5ff8088
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
api/tools/equipment.py
View file

@ -79,11 +79,19 @@ def reject_retired_tag(term: str) -> None:
"""Raise if `term` is one of the retired PS_* names. See the note above."""
candidate = term.strip().upper()
if _RETIRED_TAG.match(candidate) and candidate not in _POLL_GROUPS:
# ContractViolation takes (rule, detail). main.py logs the rule, returns
# 422, and deliberately does NOT put the detail in the operator-facing
# message - an error is not a side channel for content that failed a
# check. So the explanation below lands in the log and in Langfuse, not
# on the screen. That is the right trade here: an operator asking in
# plain English never types one of these names, so the audience for this
# error is a developer or a stale integration, and both read logs.
raise ContractViolation(
"retired_tag_name",
f"{candidate} is a retired name and is not a tag in this system. "
"It came from a superseded SCADA point list; CI Server never used it. "
"Use the CI Server item name instead, for example AID.WRPS.STN.LEVEL. "
"See db/seed/scada-source/README.md."
"See db/seed/scada-source/README.md.",
)