base-layer/promptkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Record backend inspection error decision

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-06 03:29:41 +00:00
parent 52287ab2d1
commit c669f14610
1 changed files with 29 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/roadmap/inspect-backend.md
View File

@@ -153,7 +153,8 @@ backend scope, pass qualified IDs through, and report the selected full ID.
Use the same identity rules for bundled and caller-supplied backends. The new Use the same identity rules for bundled and caller-supplied backends. The new
operation should follow existing inspection conventions for invalid engines, operation should follow existing inspection conventions for invalid engines,
invalid selections, and context cancellation, without adding cross-error invalid selections, and context cancellation, without adding cross-error
precedence guarantees. Missing-backend classification is open decision 1. precedence guarantees. Missing-backend classification follows accepted decision 1
below.
### Effective Diagnostic Destinations ### Effective Diagnostic Destinations
@@ -233,18 +234,37 @@ remains separate. Live capacity monitoring, provider health guarantees, and
source round-tripping are not selected deliverables, rather than permanent source round-tripping are not selected deliverables, rather than permanent
prohibitions on future work. prohibitions on future work.
## Open Decisions ## Decisions
Decision 1 is accepted; decisions 2–5 remain open. Implementation is pending.
### 1. How Should An Unknown Backend Be Classified? ### 1. How Should An Unknown Backend Be Classified?
**Recommendation:** Add public `ErrBackendNotFound`, analogous to the existing **Status:** Accepted; implementation pending.
prompt/profile sentinels. The registry already identifies missing backends;
public mapping lets consumers distinguish a missing ID without parsing text.
Keep existing operations' classifications unless a change is explicitly chosen.
**Alternative:** Use `ErrInvalidRequest`, avoiding another exported sentinel but **Decision:** Add public `ErrBackendNotFound` for an absent backend selected by
combining malformed selection and a well-formed missing identity. Consumers that `InspectBackend`, following the existing prompt/profile sentinel pattern.
need the distinction would require inventory lookup or other error detail. An ordinary missing-backend lookup should match `ErrBackendNotFound` through
`errors.Is` and should not also match `ErrInvalidRequest`. Reuse the registry's
existing internal missing-backend classification at the public boundary.
Invalid selections follow existing ID rules and match `ErrInvalidRequest`;
invalid engines match `ErrInvalidConfig`. Preserve context cancellation through
the existing inspection conventions. Invalid backend definitions remain an
engine-construction concern. Exact error wording is not a new contract.
Initially apply the new public classification to `InspectBackend`; do not
implicitly reclassify construction or smoke-test failures. CommandKit owns
operator wording and exit-status selection.
**Rationale:** This gives consumers a useful distinction with a small addition
consistent with prompt and profile inspection, without a new error hierarchy.
**Alternatives considered:** Using `ErrInvalidRequest` saves one public sentinel
but combines malformed selections and missing identities. A typed generic
resource-not-found error could carry resource kind and ID, but adds a broader
contract and integration questions for existing sentinels. Neither is selected;
the caller already knows the operation and requested ID.
### 2. How Much Engine-Policy Reporting Belongs In This Round? ### 2. How Much Engine-Policy Reporting Belongs In This Round?