969b0847a1
Rewrite src/ and tests/ project paths in docs, CLAUDE.md, README.md, and test-fixture READMEs to the new module-folder layout (Core/Server/Drivers/ Client/Tooling). References to retired v1 projects (Galaxy.Host/Proxy/Shared, the legacy monolithic test projects) are left untouched. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
80 lines
6.4 KiB
Markdown
80 lines
6.4 KiB
Markdown
# Phase 7 Exit Gate — Scripting, Virtual Tags, Scripted Alarms, Historian Sink
|
||
|
||
> **Status**: **FULLY CLOSED** 2026-04-23 audit — the three original follow-ups (#239 / #240 / #241) were all shipped under later branches but this exit-gate doc wasn't updated at the time. All three verified against the repo + tests green.
|
||
>
|
||
> **Compliance script**: `scripts/compliance/phase-7-compliance.ps1`
|
||
> **Plan doc**: `docs/v2/implementation/phase-7-scripting-and-alarming.md`
|
||
|
||
## What shipped
|
||
|
||
| Stream | PR | Summary |
|
||
|--------|-----|---------|
|
||
| A | #177–#179 | `Core.Scripting` — Roslyn sandbox + `DependencyExtractor` + `ForbiddenTypeAnalyzer` + per-script Serilog sink + 63 tests |
|
||
| B | #180 | `Core.VirtualTags` — dep graph (iterative Tarjan) + engine + timer scheduler + `VirtualTagSource` + 36 tests |
|
||
| C | #181 | `Core.ScriptedAlarms` — Part 9 state machine + predicate engine + message template + `ScriptedAlarmSource` + 47 tests |
|
||
| D | #182 | `Core.AlarmHistorian` — SQLite store-and-forward + backoff ladder + dead-letter retention + Galaxy.Host IPC contracts + 14 tests |
|
||
| E | #183 | Config DB schema — `Script` / `VirtualTag` / `ScriptedAlarm` / `ScriptedAlarmState` entities + migration + 12 tests |
|
||
| F | #185 | Admin UI — `ScriptService` / `VirtualTagService` / `ScriptedAlarmService` / `ScriptTestHarnessService` / `HistorianDiagnosticsService` + Monaco editor + `/alarms/historian` page + 13 tests |
|
||
| G | #184 | Walker emits Virtual + ScriptedAlarm variables with `NodeSourceKind` discriminator + 5 tests |
|
||
| G follow-up | #186 | `DriverNodeManager` dispatch routes by `NodeSourceKind` + writes rejected for non-Driver sources + 7 tests |
|
||
|
||
**Phase 7 totals**: ~197 new tests across 7 projects. Plan decisions #1–#22 all realised in code.
|
||
|
||
## Compliance Checks (run at exit gate)
|
||
|
||
Covered by `scripts/compliance/phase-7-compliance.ps1`:
|
||
|
||
- [x] Roslyn sandbox anchored on `ScriptContext` assembly with `ForbiddenTypeAnalyzer` defense-in-depth (plan #6)
|
||
- [x] `DependencyExtractor` rejects non-literal tag paths with source spans (plan #7)
|
||
- [x] Per-script rolling Serilog sink + companion-forwarding Error+ to main log (plan #12)
|
||
- [x] VirtualTag dep graph uses iterative SCC — no stack overflow on 10 000-deep chains
|
||
- [x] `VirtualTagSource` implements `IReadable` + `ISubscribable` per ADR-002
|
||
- [x] Part 9 state machine covers every transition (Apply/Ack/Confirm/Shelve/Unshelve/Enable/Disable/Comment/ShelvingCheck)
|
||
- [x] `AlarmPredicateContext` rejects `SetVirtualTag` at runtime (predicates must be pure)
|
||
- [x] `MessageTemplate` substitutes `{TagPath}` tokens at event emission (plan #13); missing/bad → `{?}`
|
||
- [x] SQLite sink backoff ladder 1s → 2s → 5s → 15s → 60s cap (plan #16)
|
||
- [x] Default 1M-row capacity + 30-day dead-letter retention (plan #21)
|
||
- [x] Per-event outcomes Ack/RetryPlease/PermanentFail on the wire
|
||
- [x] Galaxy.Host IPC contracts (`HistorianAlarmEventRequest` / `Response` / `ConnectivityStatusNotification`)
|
||
- [x] Config DB check constraints: trigger-required, timer-min, severity-range, alarm-type-enum, JSON comments
|
||
- [x] `ScriptedAlarmState` keyed on `ScriptedAlarmId` (not generation-scoped) per plan #14
|
||
- [x] Admin services: SourceHash preserves compile-cache hit on rename; Update recomputes on source change
|
||
- [x] `ScriptTestHarnessService` enforces declared-inputs-only contract (plan #22)
|
||
- [x] Monaco editor via CDN + textarea fallback (plan #18)
|
||
- [x] `/alarms/historian` page with Retry-dead-lettered operator action
|
||
- [x] Walker emits `NodeSourceKind.Virtual` + `NodeSourceKind.ScriptedAlarm` variables
|
||
- [x] `DriverNodeManager` dispatch routes Reads by source; Writes to non-Driver rejected with `BadUserAccessDenied` (plan #6)
|
||
|
||
## Deferred to Post-Gate Follow-ups (all closed as of 2026-04-23 audit)
|
||
|
||
Originally kept out of the capstone so the gate could close cleanly. Each landed as a targeted follow-up PR; audit this session verified them against the repo:
|
||
|
||
- [x] **SealedBootstrap composition root** (task #239) — **CLOSED**. `src/Server/ZB.MOM.WW.OtOpcUa.Server/Phase7/Phase7Composer.cs` instantiates `VirtualTagEngine` + `ScriptedAlarmEngine` via `Phase7EngineComposer.Compose`, and `SqliteStoreAndForwardSink` in `ResolveHistorianSink` when a registered driver provides `IAlarmHistorianWriter` (today: `GalaxyProxyDriver`). `OpcUaServerService.ExecuteAsync` calls `Phase7Composer.PrepareAsync` then `OpcUaApplicationHost.SetPhase7Sources` **before** `applicationHost.StartAsync` so `OtOpcUaServer` + `DriverNodeManager` capture the `VirtualReadable` / `ScriptedAlarmReadable` at construction. 38 tests green under `tests/Server/ZB.MOM.WW.OtOpcUa.Server.Tests/Phase7/` + `SealedBootstrapIntegrationTests`. The work landed under the label "Phase 7 follow-up #246" and was never re-labelled against #239.
|
||
- [x] **Live OPC UA end-to-end smoke** (task #240) — **CLOSED**. `scripts/e2e/test-phase7-virtualtags.ps1` drives a full Client.CLI read of a driver-sourced input, reads the VirtualTag computed off it, triggers a scripted alarm by writing the trigger value, and subscribes to the alarm condition — all through a running OtOpcUa server. Covered in `scripts/e2e/test-all.ps1` + `scripts/e2e/README.md` matrix.
|
||
- [x] **sp_ComputeGenerationDiff extension** (task #241) — **CLOSED**. Migration `20260420232000_ExtendComputeGenerationDiffWithPhase7.cs` extends the stored proc to emit Script / VirtualTag / ScriptedAlarm sections alongside the existing NodeAcl / Tag / Equipment / DriverInstance / Namespace output. Admin DiffViewer picks them up through its existing section-plugin architecture (Phase 6.4 Stream C).
|
||
|
||
## Completion Checklist
|
||
|
||
- [x] Stream A shipped + merged
|
||
- [x] Stream B shipped + merged
|
||
- [x] Stream C shipped + merged
|
||
- [x] Stream D shipped + merged
|
||
- [x] Stream E shipped + merged
|
||
- [x] Stream F shipped + merged
|
||
- [x] Stream G shipped + merged
|
||
- [x] Stream G follow-up (dispatch) shipped + merged
|
||
- [x] `phase-7-compliance.ps1` present and passes
|
||
- [x] Full solution `dotnet test` passes (no new failures beyond pre-existing tolerated CLI flake)
|
||
- [x] Exit-gate doc checked in
|
||
- [x] `SealedBootstrap` composition follow-up shipped (#239 / Phase 7 follow-up #246)
|
||
- [x] Live end-to-end smoke follow-up shipped (#240 — `scripts/e2e/test-phase7-virtualtags.ps1`)
|
||
- [x] `sp_ComputeGenerationDiff` extension follow-up shipped (#241 — migration `ExtendComputeGenerationDiffWithPhase7`)
|
||
|
||
## How to run
|
||
|
||
```powershell
|
||
pwsh ./scripts/compliance/phase-7-compliance.ps1
|
||
```
|
||
|
||
Exit code 0 = all pass; non-zero = failures listed in the preceding `[FAIL]` lines.
|