Files
scriptorium/docs/roadmap/remediation.md

137 lines
6.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Implementation Review Remediation
## ConfigKit v0.5.0 Review
Reviewed on 2026-10-03 at `bcf2ddf`, covering the five implementation
commits after `e1ce526`. The ConfigKit adoption and runtime ownership
boundaries match the accepted roadmap. No runtime defect, missing application
feature, or unrequested strengthening of contracts was identified. One
documentation handoff issue remains open below.
### R2: Correct The Completed Plan's Introductory Status
Priority: P3 (low). Status: Open.
Location: `docs/roadmap/implementation.md:5–9`.
The introduction still says "All five stages are pending" and directs the
reader to implement Stage 1 through Stage 5. Each stage is actually marked
Complete with completion evidence, and the feature roadmap identifies the
adoption as delivered. These contradictory directions leave the overall
handoff inaccurate and could lead a later coding agent to repeat completed
work.
This is a completion-documentation issue, not an unfinished runtime feature.
The [documentation policy](../policy/documentation.md) assigns implementation
status to roadmaps; the overall status should agree with the stage evidence.
Required change: update the introduction to state that all five stages are
complete. Describe the retained steps as implementation history and acceptance
evidence rather than instructions to start the work again. Preserve the
original planning baseline, completed stage records, deferred scope, and
separate release handoff. Do not change application code or rerun the feature
implementation to repair the wording.
Acceptance: the overall status, individual stages, and feature roadmap agree
that implementation is complete, while release preparation remains separate.
Review the documentation diff and run `git diff --check`; this correction
does not require new tests.
### Review Verification
- `go test -race -count=1 ./...` passed, including the new configuration,
inspection, and engine-adoption tests and existing shared-capacity coverage.
- `go vet ./...`, a native build outside the repository, and diff checks passed.
- All five maintained inheritance example commands succeeded with
`LOCAL_GPU_API_KEY` absent: validate, show, sources, explain, and render.
The child selected its own backend ID with the inherited endpoint, zero queue
capacity and false parameter remained explicit, and explanation retained
the parent/destination/directive relationship.
- Changed upstream documentation and notice links, affected local paths,
and the historical policy-plan reference resolved.
- The work set changes dependency pins, tests, examples, and documentation;
no production Go implementation was changed. ConfigKit v0.5.0 owns inheritance
through the existing single-load integration; Promptkit remains v0.11.2.
- The `extends` reservation is the explicitly accepted upstream compatibility
change, not a new Scriptorium restriction. Parameter and credential-reference
visibility, working-directory-relative paths, ordinary parent registration,
and existing shared server capacity remain as selected.
## Earlier Promptkit Upgrade Review (Resolved)
### Scope And Status
Review baseline: `e177d7c`, covering implementation commits after `5c3b0cf`.
This document records a resolved test-contract issue; it does not authorize
unrelated implementation changes. No runtime defect or missing planned feature
was identified in this review. Release preparation remains separate work.
### R1: Remove The Unrequested Context-Identity Invariant
Priority: P3 (low). Status: Complete.
Original location: `internal/adapter/http/handler_test.go:334–349`,
`TestHandlerRunTimeoutValidationAndContextMapping`, introduced in `7de2b02`.
The test's `child` field and `(ctx != parent) != tc.child` assertion required
the exact parent context object for omitted/null/zero timeouts and a distinct
object for a positive timeout. The requested contract concerns effective
deadlines and cancellation propagation, not Go interface identity. In
particular, a harmless derived context that preserves the parent's deadline,
values, and cancellation would fail the omission cases despite satisfying the
application contract.
This elevated an incidental implementation choice into a test-enforced
invariant, contrary to the [agent policy](../policy/agents.md) and
[testing policy](../policy/testing.md). The current handler's context behavior
is correct; this is a maintainability issue, not a runtime cancellation bug.
#### Required Change
Remove the identity comparison and the identity-only table field. Retain
behavioral assertions that an earlier parent deadline is not extended and
parent cancellation reaches execution. For omitted/null/zero values, verify
that no deadline is introduced when the parent has none. Retain coverage of
positive deadlines and the distinction between a canceled execution context
and a provider-attempt timeout while the execution context remains live.
Use the existing runner seam and focused cases; do not introduce a context
wrapper framework, timer abstraction, new public guarantee, or production
refactor solely to change this test.
#### Completion Criteria
- Tests protect effective deadline/cancellation behavior without requiring
context object identity.
- A semantically equivalent derived context does not fail merely because it
is a different object.
- Existing timeout validation and HTTP outcome coverage remains intact.
#### Resolution And Validation
Removed the identity-only table field and context comparisons. The test now
checks effective deadlines, including omitted/null/zero requests with no
parent deadline, and explicitly checks that parent cancellation reaches the
runner. Existing positive-deadline integration tests and live-context
provider-timeout mapping remain intact. No production code changed.
Focused HTTP timeout tests, `go test ./...`, `go test -race ./...`,
`go vet ./...`, a native build outside the repository, and `git diff --check`
all passed after remediation.
### Original Review Verification
- `go test -race -count=1 ./...` passed, including retry, shared-capacity,
deadline, report, definition-conformance, and architecture-boundary tests.
- `go vet ./...` passed.
- A native `cmd/scriptorium` build passed, with output outside the repository.
- The selected dependency is Promptkit v0.11.0 with its intended v2 catalogs.
- Application code, tests, release automation, and historical releases were
not changed during this review.
The runtime ownership boundaries remain as intended: Promptkit owns framework
formats, execution, retries, and backend admission; Scriptorium owns executable
adapters, application settings, HTTP artifact policy, deadlines, and terminal
report presentation. No additional runtime restrictions, durable workflow
state, or extra release compliance gates were identified in the reviewed diff.