docs(M11): closeout — run2, summary, audit, ledger, M12 seed
Made-with: Cursorpull/17338/head
Michael Cahill
parent
08ac1c0e24
commit
1f2d642a47
|
|
@ -0,0 +1,133 @@
|
|||
# M11 Audit — Runner Lifecycle Surface
|
||||
|
||||
**Milestone:** M11
|
||||
**Title:** Runner lifecycle surface
|
||||
**Mode:** DELTA AUDIT
|
||||
**Range:** 8b256784 (M10 closeout) → 08ac1c0e (M11 merge)
|
||||
**CI Status:** Green (Quality 22989978348)
|
||||
**Refactor Posture:** Behavior-Preserving
|
||||
**Audit Verdict:** 🟢 Milestone objectives met. Lifecycle surface established. Proceed to M12.
|
||||
|
||||
---
|
||||
|
||||
## 1. Executive Summary (Delta-First)
|
||||
|
||||
**Wins:**
|
||||
* ProcessingRunner now exposes prepare → execute → finalize lifecycle stages
|
||||
* run() delegates through stages; pass-through behavior; identical outputs
|
||||
* test_runner_lifecycle_order verifies lifecycle structure; test_processing_runner_delegates verifies pipeline delegation
|
||||
* Stable execution surface enables M12 instrumentation, progress hooks, cancellation, queue runners
|
||||
|
||||
**Risks:** None identified. Merge conflict resolved; Smoke Tests not run for PR acceptable per governance.
|
||||
|
||||
**Next action:** Proceed to M12 (Runner instrumentation surface).
|
||||
|
||||
---
|
||||
|
||||
## 2. Delta Map & Blast Radius
|
||||
|
||||
| Changed | Impact |
|
||||
|---------|--------|
|
||||
| modules/runtime/runner.py | Added prepare(), execute(), finalize(); refactored run() |
|
||||
| test/quality/test_processing_runner.py | Added test_runner_lifecycle_order |
|
||||
| docs/milestones/M11/* | Plan, toolcalls, run1, run2, summary, audit |
|
||||
|
||||
**Consumer surfaces touched:** None. API, CLI, file formats, extension API unchanged.
|
||||
|
||||
**Blast radius:** Internal refactor only. Call graph: process_images → runner.run → prepare → execute → finalize → process_images_inner. Breakage would require lifecycle or delegation failure — covered by contract tests and quality tests.
|
||||
|
||||
---
|
||||
|
||||
## 3. Architecture & Modularity Review
|
||||
|
||||
* **Boundary violations:** None. Lifecycle stages are internal to runner.
|
||||
* **Coupling added:** None. prepare/execute/finalize are pass-through.
|
||||
* **Dead abstractions:** None. Lifecycle enables M12+ instrumentation.
|
||||
* **Layering leaks:** None.
|
||||
|
||||
**Keep:** Current structure. **Fix now:** None. **Defer:** None.
|
||||
|
||||
---
|
||||
|
||||
## 4. CI/CD & Workflow Audit
|
||||
|
||||
| Check | Result |
|
||||
|-------|--------|
|
||||
| Linter (PR #30) | ✓ ruff, eslint |
|
||||
| Smoke Tests (PR #30) | Not triggered |
|
||||
| Quality Tests (post-merge) | 22989978348 ✓ |
|
||||
| Coverage | ≥40% gate satisfied |
|
||||
| verify_pinned_deps | ✓ Passed |
|
||||
| pip-audit | Informational (M27) |
|
||||
|
||||
**CI Root Cause Summary:** Smoke Tests did not run for PR; likely workflow trigger. Quality Tests passed post-merge. Acceptable per governance.
|
||||
|
||||
**Minimal Fix Set:** None required.
|
||||
**Guardrails:** None added.
|
||||
|
||||
---
|
||||
|
||||
## 5. Tests, Coverage, and Invariants (Delta-Only)
|
||||
|
||||
* **Coverage delta:** Lifecycle paths covered by test_runner_lifecycle_order; overall ≥40% maintained.
|
||||
* **New tests:** test_runner_lifecycle_order (lifecycle contract).
|
||||
* **Invariant verification:** PASS — generation behavior, file output, API, CLI preserved.
|
||||
* **Flaky tests:** None introduced.
|
||||
|
||||
**Missing Invariants:** None.
|
||||
**Missing Tests:** None for M11 scope.
|
||||
**Fast Fixes:** None.
|
||||
|
||||
---
|
||||
|
||||
## 6. Security & Supply Chain (Delta-Only)
|
||||
|
||||
* **Dependency deltas:** None. No new dependencies.
|
||||
* **Secrets exposure:** None.
|
||||
* **Workflow trust boundary:** Unchanged.
|
||||
* **pip-audit:** Informational; vulns deferred to M27 (M04 baseline).
|
||||
|
||||
---
|
||||
|
||||
## 7. Refactor Guardrail Compliance Check
|
||||
|
||||
| Guardrail | Status |
|
||||
|-----------|--------|
|
||||
| Invariant declaration | PASS — M11 plan declared invariants; verified by CI |
|
||||
| Baseline discipline | PASS — Range 8b256784...08ac1c0e; delta vs M10 closeout documented |
|
||||
| Consumer contract protection | PASS — API/CLI/schema unchanged; contract tests exercise lifecycle |
|
||||
| Extraction/split safety | N/A |
|
||||
| No silent CI weakening | PASS — All gates enforced |
|
||||
|
||||
---
|
||||
|
||||
## 8. Top Issues (Max 7, Ranked)
|
||||
|
||||
None.
|
||||
|
||||
---
|
||||
|
||||
## 9. PR-Sized Action Plan
|
||||
|
||||
| ID | Task | Category | Acceptance Criteria | Risk | Est |
|
||||
|----|------|----------|---------------------|------|-----|
|
||||
| — | None required | — | — | — | — |
|
||||
|
||||
---
|
||||
|
||||
## 10. Deferred Issues Registry (Cumulative)
|
||||
|
||||
| ID | Issue | Discovered | Deferred To | Reason | Blocker? | Exit Criteria |
|
||||
|----|-------|------------|-------------|--------|----------|---------------|
|
||||
| (none new) | | | | | | |
|
||||
|
||||
---
|
||||
|
||||
## 11. Score Trend (Cumulative)
|
||||
|
||||
| Milestone | Invariants | Compat | Arch | CI | Sec | Tests | DX | Docs | Overall |
|
||||
|-----------|------------|--------|------|-----|-----|-------|-----|------|---------|
|
||||
| M10 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 |
|
||||
| M11 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 | 5.0 |
|
||||
|
||||
M11: Lifecycle surface (prepare/execute/finalize) introduced. Mechanical refactor; behavior preserved. Quality Tests passed post-merge.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# M11 — Runner Lifecycle Surface
|
||||
|
||||
Phase: **Phase III — Runner & Service Boundary**
|
||||
Status: In Progress
|
||||
Status: Completed
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,43 @@
|
|||
# M11 CI Run 2 — Post-Merge Quality Tests
|
||||
|
||||
**Date:** 2026-03-12
|
||||
**Branch:** main
|
||||
**Merge commit:** 08ac1c0e (PR #30)
|
||||
**Trigger:** push to main
|
||||
|
||||
---
|
||||
|
||||
## 1. Workflow Identity
|
||||
|
||||
| Workflow | Run ID | Trigger | Status |
|
||||
|----------|--------|---------|--------|
|
||||
| Linter | (PR run) | pull_request | ✓ success |
|
||||
| Quality Tests | 22989978348 | push | ✓ success |
|
||||
|
||||
---
|
||||
|
||||
## 2. Run 1 → Run 2 Delta
|
||||
|
||||
**Run 1 (M11_run1.md):** Linter passed (ruff, eslint). Smoke Tests did not run for PR (workflow trigger). Quality Tests run post-merge only.
|
||||
|
||||
**Run 2 (22989978348):** Quality Tests passed on push to main after merge. All checks green.
|
||||
|
||||
---
|
||||
|
||||
## 3. Quality Tests Summary
|
||||
|
||||
| Check | Result |
|
||||
|-------|--------|
|
||||
| Smoke tests | ✓ |
|
||||
| Quality tests | ✓ |
|
||||
| Coverage | ≥40% gate satisfied |
|
||||
| verify_pinned_deps | ✓ |
|
||||
| pip-audit | Informational (M27) |
|
||||
|
||||
---
|
||||
|
||||
## 4. Verdict
|
||||
|
||||
**CI Status:** ✓ Green — All post-merge checks pass.
|
||||
|
||||
M11 closeout can proceed: summary, audit, ledger, tag.
|
||||
|
|
@ -0,0 +1,172 @@
|
|||
# M11 Summary — Runner Lifecycle Surface
|
||||
|
||||
📌 Milestone Summary — M11: Runner Lifecycle Surface
|
||||
==========================================================
|
||||
|
||||
**Project:** Serena
|
||||
**Phase:** Phase III — Runner & Service Boundary
|
||||
**Milestone:** M11 — Runner lifecycle surface
|
||||
**Timeframe:** 2026-03-11 → 2026-03-12
|
||||
**Status:** Closed
|
||||
**Baseline:** 8b256784 (M10 closeout)
|
||||
**Refactor Posture:** Behavior-Preserving
|
||||
|
||||
---
|
||||
|
||||
## 1. Milestone Objective
|
||||
|
||||
M11 existed to introduce a **lifecycle structure** on ProcessingRunner. The runner previously exposed a single `run(request)` method. This milestone refactored the internal implementation into three lifecycle stages: prepare → execute → finalize.
|
||||
|
||||
**What would remain unsafe or ungoverned if this refactor did not occur?** The runner would remain a single-method black box. Phase III goals (progress hooks, cancellation, instrumentation, queue runners, distributed execution) would lack a stable execution surface to instrument. No lifecycle seam would exist for future milestones.
|
||||
|
||||
---
|
||||
|
||||
## 2. Scope Definition
|
||||
|
||||
### In Scope
|
||||
|
||||
* `modules/runtime/runner.py` — Add prepare(), execute(), finalize(); refactor run() to delegate
|
||||
* `test/quality/test_processing_runner.py` — Add test_runner_lifecycle_order
|
||||
* `docs/milestones/M11/*` — Plan, toolcalls, run1, run2, summary, audit
|
||||
|
||||
### Out of Scope
|
||||
|
||||
* No API changes
|
||||
* No CLI changes
|
||||
* No async / threading
|
||||
* No cancellation implementation (M12+)
|
||||
* No instrumentation hooks (M12)
|
||||
* No txt2img path through runner (M13)
|
||||
|
||||
---
|
||||
|
||||
## 3. Refactor Classification
|
||||
|
||||
### Change Type
|
||||
|
||||
**Mechanical refactor** — Decomposed run() into three pass-through stages. No logic change; structure only.
|
||||
|
||||
### Observability
|
||||
|
||||
* **API responses:** Unchanged
|
||||
* **CLI output:** Unchanged
|
||||
* **File formats / save paths:** Unchanged
|
||||
* **Model outputs:** Unchanged
|
||||
|
||||
---
|
||||
|
||||
## 4. Work Executed
|
||||
|
||||
* Refactored ProcessingRunner.run() to delegate: state = prepare(request); result = execute(state); return finalize(state, result)
|
||||
* Added prepare(request) → returns request (pass-through)
|
||||
* Added execute(state) → calls process_images_inner(state.processing)
|
||||
* Added finalize(state, result) → returns result (pass-through)
|
||||
* Added test_runner_lifecycle_order (subclass verifies prepare → execute → finalize order)
|
||||
* Kept test_processing_runner_delegates (protects pipeline delegation)
|
||||
* Merged main to resolve M11 doc conflicts (M10 closeout had seeded M11 folder)
|
||||
|
||||
---
|
||||
|
||||
## 5. Invariants & Compatibility
|
||||
|
||||
### Declared Invariants (must by default Not Change)
|
||||
|
||||
* CLI behavior identical
|
||||
* API responses unchanged schemas
|
||||
* Processing results identical images / metadata
|
||||
* Runtime context still created inside process_images_inner
|
||||
* CI coverage ≥40%
|
||||
|
||||
### Compatibility Notes
|
||||
|
||||
* Backward compatibility preserved: Yes
|
||||
* Breaking changes introduced: No
|
||||
* Deprecations introduced: No
|
||||
|
||||
---
|
||||
|
||||
## 6. Validation & Evidence
|
||||
|
||||
| Evidence Type | Tool/Workflow | Result | Notes |
|
||||
|--------------|---------------|--------|-------|
|
||||
| Linter | ruff, eslint | ✓ | PR #30 |
|
||||
| Smoke Tests | pytest test/smoke | Not run for PR | Workflow trigger; acceptable per governance |
|
||||
| Quality Tests | pytest test/smoke test/quality | ✓ | Post-merge 22989978348 |
|
||||
| Coverage | ≥40% gate | ✓ | Quality Tests |
|
||||
| verify_pinned_deps | scripts/ci/verify_pinned_deps.sh | ✓ | Quality Tests |
|
||||
| pip-audit | Informational | ⚠ | Deferred M27 |
|
||||
|
||||
---
|
||||
|
||||
## 7. CI / Automation Impact
|
||||
|
||||
* Workflows affected: None (unchanged)
|
||||
* Checks added/removed: None
|
||||
* Enforcement: Unchanged
|
||||
* Signal drift: None observed
|
||||
|
||||
---
|
||||
|
||||
## 8. Issues, Exceptions, and Guardrails
|
||||
|
||||
**Issue:** Merge conflict when merging PR #30 — main had M10 closeout that seeded M11 folder with shorter plan/toolcalls. Our branch had full implementation and detailed docs.
|
||||
|
||||
**Resolution:** Merged main into m11-runner-lifecycle; resolved conflicts keeping full plan and toolcalls. Pushed; PR merged successfully.
|
||||
|
||||
**Issue:** Smoke Tests did not run for PR #30. Likely workflow trigger filter (pull_request vs push).
|
||||
|
||||
**Resolution:** Acceptable per Serena governance. Linter passed; Quality Tests passed post-merge.
|
||||
|
||||
---
|
||||
|
||||
## 9. Deferred Work
|
||||
|
||||
* Smoke Tests workflow trigger investigation — deferred; not blocking
|
||||
* Instrumentation hooks — M12
|
||||
* Cancellation — later Phase III
|
||||
* ProcessingState object — may appear Phase IV
|
||||
|
||||
---
|
||||
|
||||
## 10. Governance Outcomes
|
||||
|
||||
* Lifecycle surface is now explicit and contract-tested
|
||||
* prepare/execute/finalize order verified by test_runner_lifecycle_order
|
||||
* Runner is ready for instrumentation (M12), progress hooks, cancellation, queue runners
|
||||
|
||||
---
|
||||
|
||||
## 11. Exit Criteria Evaluation
|
||||
|
||||
| Criterion | Met | Evidence |
|
||||
|-----------|-----|----------|
|
||||
| PR CI passes | Yes | Linter ✓ |
|
||||
| post-merge Quality Tests pass | Yes | 22989978348 ✓ |
|
||||
| lifecycle runner merged | Yes | PR #30 merged |
|
||||
| ledger updated | Pending | docs/serena.md |
|
||||
| tag created | Pending | v0.0.11-m11 |
|
||||
|
||||
---
|
||||
|
||||
## 12. Final Verdict
|
||||
|
||||
Milestone objectives met. Refactor verified safe. Proceed to M12.
|
||||
|
||||
---
|
||||
|
||||
## 13. Authorized Next Step
|
||||
|
||||
**M12 — Runner Instrumentation Surface**
|
||||
|
||||
Add optional instrumentation hooks to the lifecycle (on_prepare, on_execute, on_finalize). Still behavior-preserving.
|
||||
|
||||
---
|
||||
|
||||
## 14. Canonical References
|
||||
|
||||
* Merge commit: 08ac1c0e
|
||||
* PR: #30
|
||||
* Quality Tests run: 22989978348
|
||||
* Plan: docs/milestones/M11/M11_plan.md
|
||||
* Run1: docs/milestones/M11/M11_run1.md
|
||||
* Run2: docs/milestones/M11/M11_run2.md
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# M12 — Runner Instrumentation Surface
|
||||
|
||||
Phase: **Phase III — Runner & Service Boundary**
|
||||
Status: Planned
|
||||
|
||||
---
|
||||
|
||||
# 1. Intent / Target
|
||||
|
||||
Add optional instrumentation hooks to the lifecycle stages.
|
||||
|
||||
(To be expanded.)
|
||||
|
||||
---
|
||||
|
||||
# 2. Scope Boundaries
|
||||
|
||||
### In scope
|
||||
|
||||
(To be defined.)
|
||||
|
||||
### Out of scope
|
||||
|
||||
(To be defined.)
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# M12 Toolcalls — Runner Instrumentation Surface
|
||||
|
||||
Implementation toolcalls for Cursor execution.
|
||||
|
||||
| Timestamp | Tool | Purpose | Files/Target | Status |
|
||||
|-----------|------|---------|--------------|--------|
|
||||
|
|
@ -141,6 +141,7 @@ Core principles:
|
|||
| M08 | Opts snapshot threading | Completed | m08-snapshot-threading | #24 | 710a0abd | Quality 22984445599 ✓ | 5.0 / 5 | 2026-03-12 |
|
||||
| M09 | Execution context introduction | Completed | m09-execution-context | #26 | 2c6a2510 | Quality 22986731960 ✓ | 5.0 / 5 | 2026-03-12 |
|
||||
| M10 | ProcessingRunner skeleton | Completed | m10-processing-runner | #27 (+ #28 fix) | 0d11b587 | Quality 22988627838 ✓ | 5.0 / 5 | 2026-03-12 |
|
||||
| M11 | Runner lifecycle surface | Completed | m11-runner-lifecycle | #30 | 08ac1c0e | Quality 22989978348 ✓ | 5.0 / 5 | 2026-03-12 |
|
||||
|
||||
**M05:** Introduced `temporary_opts()` context manager — first Phase II runtime seam. Isolates override_settings mutation from global `shared.opts`; preserves behavior (opts.set, setattr restore, k in opts.data). Model/VAE reload and token merging remain in process_images. Enables future opts snapshot injection (M07).
|
||||
|
||||
|
|
@ -154,6 +155,8 @@ Core principles:
|
|||
|
||||
**M10:** Introduced ProcessingRunner in modules/runtime/runner.py. First Phase III execution boundary. process_images delegates through runner; ProcessingRequest wraps StableDiffusionProcessing. Zero blast radius; all callers unchanged. Phase III roadmap updated (M11 lifecycle, M12 instrumentation, M13 txt2img, M14 API, M15 queue). Enables M11 Runner lifecycle surface.
|
||||
|
||||
**M11:** Introduced lifecycle surface on ProcessingRunner: prepare → execute → finalize. run() delegates through stages; pass-through behavior; identical outputs. test_runner_lifecycle_order verifies lifecycle structure. Stable execution surface enables M12 instrumentation, progress hooks, cancellation, queue runners.
|
||||
|
||||
---
|
||||
|
||||
## 5. Standing Invariants
|
||||
|
|
|
|||
Loading…
Reference in New Issue