docs+code: close Theme 1 — 24 design-doc / XML-doc drift findings
Doc/XML-comment drift + small adherence fixes across 17 modules. Highlights: - Host-017: site CoordinatedShutdown ordering — SiteStreamGrpcServer gains CancelAllStreams() (refuse new streams, cancel active), wired into Program.cs site branch via ApplicationStopping. - InboundAPI-021: ParentExecutionId now travels on RouteToGet/SetAttributes symmetric with RouteToCallRequest; RouteHelper stamps from _parentExecutionId. - ClusterInfra-012: ClusterOptionsValidator now requires both seed nodes. - Comm-018: SiteCommunicationActor.HeartbeatMessage.IsActive derived from cluster leader check (was hardcoded true). - DM-020: reconciliation audit row attributes the current user, not prior deployer. - SEL-019: EventLogPurgeService early-exits on standby via active-node check. - Plus comment/XML-doc accuracy fixes across AuditLog, ConfigurationDatabase, NotificationOutbox, SiteRuntime, SiteCallAudit; doc refreshes for Component- Commons / -ManagementService / -CLI / -ExternalSystemGateway / -HealthMonitoring / -Transport / -ConfigurationDatabase; CD-023 index-name doc alignment. 11 new regression tests (RouteHelper x4, SiteStreamGrpcServer x2, ClusterOptionsValidator x1, SiteCommunicationActor x1, DeploymentService x1, EventLogPurgeService x3). Build clean (0 warnings); InboundAPI/Communication/ Host suites all green. README regenerated: 112 open (was 136).
This commit is contained in:
@@ -8,7 +8,7 @@
|
||||
| Last reviewed | 2026-05-28 |
|
||||
| Reviewer | claude-agent |
|
||||
| Commit reviewed | `1eb6e97` |
|
||||
| Open findings | 10 |
|
||||
| Open findings | 8 |
|
||||
|
||||
## Summary
|
||||
|
||||
@@ -1212,7 +1212,7 @@ boundary lookup resolves to the expected partition.
|
||||
|--|--|
|
||||
| Severity | Low |
|
||||
| Category | Documentation & comments |
|
||||
| Status | Open |
|
||||
| Status | Resolved |
|
||||
| Location | `src/ScadaLink.ConfigurationDatabase/Repositories/DeploymentManagerRepository.cs:8-14` |
|
||||
|
||||
**Description**
|
||||
@@ -1236,13 +1236,21 @@ snapshots, and the Restrict-FK-aware `DeleteInstanceAsync` for the
|
||||
deployment pipeline. Cross-reference the optimistic-concurrency contract on
|
||||
`DeploymentRecord.RowVersion`.
|
||||
|
||||
**Resolution (2026-05-28):**
|
||||
|
||||
Replaced the stale "WP-24: Stub level sufficient for diff/staleness support" XML
|
||||
doc with an accurate one-paragraph summary covering `DeploymentRecord` CRUD
|
||||
(plus the `RowVersion` optimistic-concurrency contract), `SystemArtifactDeploymentRecord`
|
||||
CRUD, `DeployedConfigSnapshot` CRUD, and the Restrict-FK-aware `DeleteInstanceAsync`.
|
||||
No behaviour change.
|
||||
|
||||
### ConfigurationDatabase-023 — `AuditLog` correlation-index name drifts from design doc (`IX_AuditLog_CorrelationId` vs `IX_AuditLog_Correlation`)
|
||||
|
||||
| | |
|
||||
|--|--|
|
||||
| Severity | Low |
|
||||
| Category | Design-document adherence |
|
||||
| Status | Open |
|
||||
| Status | Resolved |
|
||||
| Location | `src/ScadaLink.ConfigurationDatabase/Configurations/AuditLogEntityTypeConfiguration.cs:99-101`, `Migrations/20260520142214_AddAuditLogTable.cs:103-107` |
|
||||
|
||||
**Description**
|
||||
@@ -1268,6 +1276,14 @@ preserves the existing migration; renaming the index in the database requires a
|
||||
migration that does `sp_rename`. Document-aligning is the lower-cost option and
|
||||
matches the resolution pattern used for CD-005.
|
||||
|
||||
**Resolution (2026-05-28):**
|
||||
|
||||
Doc-aligns-to-code, preserving the existing migration. `docs/requirements/Component-AuditLog.md`
|
||||
already lists the index as `IX_AuditLog_CorrelationId` (line 109). The stale
|
||||
`IX_AuditLog_Correlation` reference in `docs/requirements/Component-ConfigurationDatabase.md`
|
||||
line 64 (AuditLog table prose) was updated to `IX_AuditLog_CorrelationId`. Code unchanged;
|
||||
index name remains `IX_AuditLog_CorrelationId`.
|
||||
|
||||
### ConfigurationDatabase-024 — Missing test coverage for SPLIT-RANGE failure-continuation and production-shape rowversion delete
|
||||
|
||||
| | |
|
||||
|
||||
Reference in New Issue
Block a user