docs(archreview): add STATUS.md handoff + per-plan status banners

Track remediation progress: 2 of 4 Criticals done (03/S1 split-brain resolver;
02/U2+U3 VT timeout+ALC) + both CLAUDE.md doc-drifts fixed. STATUS.md is the
single source of truth (branch topology, completed items, task list, next-up,
resume facts). Each plan carries a status banner.
This commit is contained in:
Joseph Doherty
2026-07-08 16:25:39 -04:00
parent 9fadead6a6
commit e31d29c04c
9 changed files with 92 additions and 0 deletions
+4
View File
@@ -1,5 +1,9 @@
# Arch-Review Remediation Plans — Index
> **📊 Remediation status → [`STATUS.md`](STATUS.md).** As of 2026-07-08: **2 of 4 Criticals done**
> (03/S1 split-brain resolver; 02/U2+U3 VT timeout+ALC) + both CLAUDE.md doc-drifts fixed. Each Critical
> is on its own `fix/archreview-crit*` branch off master; plans live only on `docs/archreview-plans-and-drift-fixes`.
Design + implementation plans for every finding in the 2026-07-08 architecture review
(`archreview/*.md`, review commit `9cad9ed0`). Each plan verifies every finding against
the current tree, then gives root cause → design (with alternatives) → concrete file-level
@@ -1,5 +1,8 @@
# Design + Implementation Plan — Core & Composition Pipeline
> **Status (2026-07-08):** not started. Next highest-leverage here: S-1 (AddressSpaceApplyOutcome failure
> field — failure-visibility) and C-1 (`TagConfigIntent.Parse` in Commons). See [`STATUS.md`](STATUS.md).
**Domain report:** `archreview/01-core-composition.md`
**Baseline commit reviewed:** `9cad9ed0` (master)
**Plan author verification date:** 2026-07-08
@@ -1,5 +1,10 @@
# Design + Implementation Plan — 02 Scripting, Virtual Tags, Scripted Alarms, Alarm Historian
> **Status (2026-07-08):** ✅ **U2 (Critical) + U3 (High) DONE** — branch `fix/archreview-crit2-vt-timeout`
> @ `7fd44f0f` (real `TimedScriptEvaluator` timeout + `CompiledScriptCache` + `IScriptCacheOwner` apply-boundary
> clear; VT tests 18/18 + 12/12). Remaining: P1 (memoize `ScriptSandbox.Build`), U1 (retire dormant
> `Core.VirtualTags` engine — after U2/U3 hardened the live path), and the S/C/P batches. See [`STATUS.md`](STATUS.md).
- **Source report:** `archreview/02-scripting-alarms.md`
- **Review commit:** `9cad9ed0` · **Plan verified against tree at:** `9cad9ed0` (master)
- **Scope:** `Core.Scripting`(+`Abstractions`), `Core.VirtualTags`, `Core.ScriptedAlarms`, `Core.AlarmHistorian`, plus the live consumers in `Host`/`Runtime`.
@@ -1,5 +1,11 @@
# Design & Implementation Plan — Server & Runtime Subsystem (Report 03)
> **Status (2026-07-08):****S1 (Critical) activation DONE** — branch `fix/archreview-crit1-split-brain-resolver`
> @ `a81dea10` (typed `KeepOldestOption`, unit guards + e2e config-resolution verified). ✅ **U1 doc DONE**
> (CLAUDE.md KNOWN LIMITATION 2 corrected). ⬜ S1's hard-kill failover **integration test** still pending (task 9,
> effort-M). ⬜ **U2 (reflection forwarding test) pending — MUST land before P1 surgical-adds** / any new sink
> capability. Remaining: P1, S2/S3/S4. See [`STATUS.md`](STATUS.md).
- **Source report:** `archreview/03-server-runtime.md`
- **Review commit:** `9cad9ed0`
- **Verification pass performed against tree at:** current `master` (same tree; all cited files present)
+3
View File
@@ -1,5 +1,8 @@
# Architecture Review 04 — AdminUI: Design + Implementation Plan
> **Status (2026-07-08):** not started. Top item: C-1 (ungated mutating pages → `ConfigEditor` policy +
> reflection guard). No bUnit → live-verify on docker-dev. See [`STATUS.md`](STATUS.md).
- **Source report:** `archreview/04-adminui.md` (commit `9cad9ed0`)
- **Plan author date:** 2026-07-08 · verified against current tree at `9cad9ed0`
- **Scope:** AdminUI pages, ScriptAnalysis backend, tag editors, authorization
@@ -1,5 +1,9 @@
# Design + Implementation Plan — 05 Protocol Drivers
> **Status (2026-07-08):** not started. Holds **2 Criticals** — STAB-1 (S7 no-reconnect, task 4) + STAB-2
> (TwinCAT orphaned ADS subs, task 5); template both off OpcUaClient's reconnect machine; need docker-rig
> fixtures. Then STAB-4/5 (AbCip lock, FOCAS caches) + Part B shared-template consolidation. See [`STATUS.md`](STATUS.md).
**Source report:** `archreview/05-protocol-drivers.md`
**Review commit:** `9cad9ed0` (== current HEAD, so no drift)
**Verification date:** 2026-07-08
@@ -1,5 +1,9 @@
# Plan 06 — Gateway Integrations (Galaxy Driver + Historian Gateway Driver)
> **Status (2026-07-08):****U-1 doc DONE** (CLAUDE.md KNOWN LIMITATION 2 corrected — historized-ref feed
> is wired). Remaining: S-1 (Galaxy write fail-closed — failure-visibility), S-6 (dormant historian health
> surface — built-but-never-wired). See [`STATUS.md`](STATUS.md).
- **Source report:** `archreview/06-gateway-integrations.md`
- **Scope:** `src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy` (+ `.Contracts`, `.Browser`), `src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Gateway`
- **Commit reviewed against:** current tree (report cut at `9cad9ed0`)
@@ -1,5 +1,9 @@
# Plan 07 — Client Tooling, Analyzers & Cross-Cutting Engineering System
> **Status (2026-07-08):** not started (the ScriptAnalysis-policy doc drift it references was fixed in
> CLAUDE.md). Systemic guards: C-1 (wire OTOPCUA0001 analyzer, task 7 — triage before Warning) + S-1/S-2
> (CI to all suites + fail-on-skip, task 8 — pair S-4 flakes). See [`STATUS.md`](STATUS.md).
| | |
|---|---|
| **Source report** | `archreview/07-client-tooling-engineering.md` |
+59
View File
@@ -0,0 +1,59 @@
# Arch-Review Remediation — Status & Handoff
**Snapshot:** 2026-07-08 · **Review baseline:** master `9cad9ed0` · this file is the single source of
truth for remediation progress. Update it as work lands.
## Branch topology (all LOCAL — nothing pushed, nothing on master)
| Branch | Head | Contains |
|---|---|---|
| `master` | `9cad9ed0` | untouched baseline |
| `docs/archreview-plans-and-drift-fixes` | `9fadead6` | the 7 domain plans + `00-INDEX.md` + this `STATUS.md` + the two CLAUDE.md doc-drift fixes. **(the plans live ONLY here)** |
| `fix/archreview-crit1-split-brain-resolver` | `a81dea10` | Critical 1 (03/S1) activation + guard test + Redundancy.md |
| `fix/archreview-crit2-vt-timeout` | `7fd44f0f` | Critical 2 (02/U2 + 02/U3) + tests |
**Decision (user):** one branch per Critical, each off `master`. The plans are only on the docs branch,
so from a critical branch read them via `git show docs/archreview-plans-and-drift-fixes:archreview/plans/0X-<name>.md`.
## Completed
| Item | Finding | Branch @ commit | Verification |
|---|---|---|---|
| **Critical 1 — split-brain resolver activated** | 03/S1 | `fix/archreview-crit1-split-brain-resolver` `a81dea10` | `BuildClusterOptions` sets `KeepOldestOption{DownIfAlone=true}`; 3 unit guards (Cluster.Tests 29/29); **e2e-verified** the resolved ActorSystem config carries `SplitBrainResolverProvider` + `stable-after=15s` survives the HOCON/Hosting merge (throwaway spike, removed). HOCON cross-ref comment + Redundancy.md corrected. |
| **Critical 2a — real VT script timeout** | 02/U2 | `fix/archreview-crit2-vt-timeout` `7fd44f0f` | Routes through `TimedScriptEvaluator`; infinite-loop test (bounded by WaitAsync) proves no hang. Host.Integration VT 18/18. |
| **Critical 2b — ALC-safe compile cache** | 02/U3 | same `7fd44f0f` | Swapped raw dict → `CompiledScriptCache`; new `IScriptCacheOwner` seam; apply-boundary clear in `VirtualTagHostActor`; wiring guard test. Runtime VT 12/12. |
| **Doc drift — KNOWN LIMITATION 2 stale** | 03/U1 = 06/U-1 | `docs/…` `9fadead6` (CLAUDE.md) | historized-ref feed IS wired; rewrote to "value-capture code-complete, live-verify pending". |
| **Doc drift — ScriptAnalysis policy** | theme #5 | same `9fadead6` (CLAUDE.md) | corrected `FleetAdmin``Administrator,Designer` roles. |
## Task list (TaskCreate IDs)
| # | Task | Status |
|---|---|---|
| 1 | Critical 1 — split-brain resolver | ✅ completed |
| 2 | Critical 2a — VT timeout | ✅ completed |
| 3 | Critical 2b — CompiledScriptCache | ✅ completed |
| 4 | Critical 3 — S7 reconnect (05/STAB-1) | ⬜ pending |
| 5 | Critical 4 — TwinCAT ADS re-registration (05/STAB-2) | ⬜ pending |
| 6 | Guard — DeferredAddressSpaceSink reflection forwarding test (03/U2) | ⬜ pending — **must precede** 03/P1 surgical-adds + any new sink capability |
| 7 | Guard — wire OTOPCUA0001 analyzer + triage (07/C-1) | ⬜ pending — triage before Warning severity; C-1 triage → C-2 |
| 8 | Guard — CI to all unit suites + fail-on-skip (07/S-1,S-2, pair S-4) | ⬜ pending |
| 9 | Critical 1 follow-up — hard-kill failover integration test (03/S1) | ⬜ pending — the effort-M harness half; activation itself is done+verified |
## Suggested next (from 00-INDEX execution order)
1. **Critical 3 (05/STAB-1)** + **Critical 4 (05/STAB-2)** — template both off OpcUaClient's reconnect
machine; effort-M, need docker-rig fixtures (`lmxopcua-fix up s7 s7_1500`, TwinCAT sim). New branches each.
2. **Systemic guards** — task 7 (analyzer) then task 8 (CI); task 6 (forwarding test) before any P1/P2 work.
3. **Failure-visibility Highs** — 01/S-1 (AddressSpaceApplyOutcome failure field), 06/S-1 (Galaxy fail-closed),
03/S4 (primary-gate default-deny).
## Key resume facts
- **Verification bar met so far:** each fix has a deterministic unit guard AND (for SBR) an end-to-end
config-resolution check. Follow the same pattern — the review's whole thesis is "unit-green ≠ wired".
- **The forwarding-test guard (task 6) is load-bearing:** 03/P1 (surgical pure-adds) and 02/P-… batch-write
each add new sink capability methods that ship inert unless forwarded through `DeferredAddressSpaceSink`
(F10b/PR#423 precedent). Land task 6 first.
- **Nothing is pushed.** When the user asks to integrate: PR each `fix/archreview-crit*` branch; the docs
branch can merge first (plans + doc fixes are low-risk).
- **Plans are on the docs branch only** — see topology note above for cross-branch reads.