8 Commits

Author	SHA1	Message	Date
Joseph Doherty	b815446940	refactor(drivers): delete GetMemoryFootprint / FlushOptionalCachesAsync (#525) ... Both `IDriver` members had no production call site. Their only consumer was `MemoryTracking`, deleted with the driver-tier recycle machinery in #522, and `GetMemoryFootprint`'s doc-comment claimed "polled every 30s by Core" — which had not been true since v3, even before #522 removed the poller. Owner decision on #525 was (a) delete rather than (b) build the process-wide watchdog that would consume them. The driver-side implementations are in git history and were mostly reusable; what was always missing is the trigger, and a member nobody calls is how the misleading doc-comment survived this long. Removed from `IDriver`, all 12 driver implementations, and every test stub — plus the support code that existed only to feed them, which is the part a member-only deletion would have left behind as dead weight: - MTConnect's three per-entry byte-weight constants, its cached `ProbeModelDataItemCount`, and `CountDataItems` — a full device-tree walk run on every cache fill to populate a number with no remaining reader. - OpcUaClient's `_discoveredNodeCount` field and the discovery-pass write to it. - MQTT's `ApproxBytesPerAuthoredTag`. Two behavioural notes, neither a change in what the software does: - `AbCipTemplateCache` now has no production reset path. Its only caller was AB CIP's flush, which itself had no caller — so nothing changes except how visible the fact is. Recorded on the type, along with the correction that its comment's claim about a device `ReinitializeAsync` also flushing it was never true. A UDT redefined on a live controller keeps its stale shape until the driver instance is rebuilt. - MTConnect's `/probe` cache is still dropped, by `InvalidateProbeModel()` on an Agent restart. That is now `internal` rather than `private` so the tests which used the flush purely to empty the cache drive the real path instead — they now cover a case that actually occurs in production. Several unrelated doc comments cited `FlushOptionalCachesAsync` as the canonical CAS example and are repointed to it. Tests: the ones that existed only to assert on the removed members are deleted (3 OpcUaClient, 3 Galaxy, 2 MQTT, 1 MTConnect, 1 AbCip). Worth noting one was vacuous — `FlushOptionalCachesAsync_resets_footprint_counter` asserted a footprint of 0 before the flush and 0 after with no discovery in between, so it would have passed against a flush that did nothing at all. Full suite green except 7 failures verified identical on master before and after (4 AbLegacy integration with the compose profile down, 3 Host.IntegrationTests), checked by name rather than assumed. Docs corrected where they described this as live: `DriverLifecycle.md` (which carried the #525 placeholder), `drivers/AbCip.md`, `drivers/AbLegacy.md`, and `v2/driver-stability.md` — whose "polls this every 30 s" + per-driver `DriverConfig` memory budget were never built as written and are now banner-ed as design intent rather than description. Claude-Session: https://claude.ai/code/session_015p7wGqy3YpZNCpDzTpGMKo	2026-07-31 09:07:11 -04:00
Joseph Doherty	2d20aeb779	fix(opcua,drivers): carry driver status sub-codes to clients (#519) + health-write ordering (#517) ... #519 — a driver's OPC UA status code now reaches a client with its sub-code intact. DriverInstanceActor projected the driver's uint onto a 3-state Good/Uncertain/Bad enum and OtOpcUaNodeManager re-expanded Bad to a bare 0x80000000, so BadNoCommunication, BadTypeMismatch and BadNotSupported were indistinguishable on the wire and every driver's status constants (incl. the 16 #497 had just corrected) were diagnostic in logs only. Resolved by option (b): the raw uint rides AttributeValuePublished -> AttributeValueUpdate -> IOpcUaAddressSpaceSink.WriteValue, OpcUaQuality is deleted, and severity classification is a helper (OpcUaStatus.IsGood/IsUncertain/IsBad). The surface was wider than the issue costed (41 files, not "the sink and 3 implementations"): OpcUaQuality had non-driver producers with no uint to carry. Each got its natural code — BadInternalError for a failed virtual-tag script, BadNoCommunication for driver comms loss — and ScriptedAlarmHostActor's pair of mutually-inverse uint<->enum mappers is deleted, having round-tripped a code the engine already held. AddressSpaceApplier's removal writes deliberately keep the generic Bad: not losing a code the driver had is this issue; inventing one for the deploy path is a separate call. Behaviour change: WriteAlarmQuality fires its Part 9 event on a status-code change rather than a severity-bucket change. While the annotation was 3-state those were the same predicate; now a move between two Bad reasons changes what a subscriber reads. New SDK-free named constants live on Commons.OpcUa.OpcUaStatus, and StatusCodeParityTests is widened to cover them — that guard is reflection-driven, so it can only see a named constant, never an inline literal. #517 — the symptom is real but the issue named the wrong path and its fix was unsafe. ShutdownAsync cannot race: DriverInstanceActor calls it from PostStop, after the mailbox drains. (Core/Hosting/DriverHost, the one class with a concurrent GetHealth, has no production call site.) InitializeAsync can: it runs on a fire-and-forget Task.Run, and MTConnectDriver writes Healthy then starts loops that can throw into a catch which disposes the client before writing Faulted. Moving the write earlier, as suggested, inverts the terminal state — teardown drains in-flight loops that write health as they unwind, so a late loop could leave Healthy at rest with every connection closed. The fix is a bracket (conservative before, terminal after), applied to MTConnect's init-failure path only; shutdown keeps its single trailing write, and the rule plus the reachability table are documented on IDriver.ShutdownAsync. CalculationDriver.GetHealth returned a hard-coded Healthy that consulted nothing — Healthy before initialize, after shutdown and after dispose. Now derived from _running. Its test, named Health_is_always_Connected, asserted the defect and is replaced. Every new guard was falsified by breaking the production code and watching it go red. The two sub-code tests each assert two different Bad codes, since a single-code assertion could pass against a hard-coded constant under the old projection. Pre-existing failures, verified unchanged on a stashed tree and not chased: 4 in Driver.AbLegacy.IntegrationTests (slc500/micrologix/plc5 fixtures not up) and 3 in Host.IntegrationTests. Closes #517 Closes #519 Claude-Session: https://claude.ai/code/session_015p7wGqy3YpZNCpDzTpGMKo	2026-07-31 05:25:27 -04:00
Joseph Doherty	cbb882293b	refactor(drivers): delete the inert driver-tier recycle machinery (#522) ... The tier system was documented, operator-authorable, and inert. Deleted rather than activated, because its premise is gone rather than merely unused. "Tier C" meant a driver running out-of-process behind an IDriverSupervisor that could restart its Host without tearing down the OPC UA session. No such process exists anywhere: Galaxy reaches MXAccess over gRPC to the external mxaccessgw sidecar (PR 7.2 retired the in-process Galaxy.Host/Proxy/Shared projects) and FOCAS has run in-process since its managed wire client landed 2026-04-24. Consistently, IDriverSupervisor had ZERO implementations and there was nothing for one to implement against. The issue understated the inertness. It says the Tier-C-only protections never engaged, implying the Tier A/B parts did. They did not: nothing constructs MemoryTracking, MemoryRecycle or ScheduledRecycleScheduler outside their own unit tests, so the whole Core/Stability recycle layer was dead — meaning option (a), "pass real tiers", was never a flag flip. It would have meant writing the wiring that never existed AND arming it. Deleted: MemoryTracking, MemoryRecycle, ScheduledRecycleScheduler, IDriverSupervisor, the vestigial DriverTypeRegistry (referenced only by its own tests), and the RecycleIntervalSeconds knob — which the AdminUI let an operator author and the parser validated while it configured nothing. DriverTier itself SURVIVES and is load-bearing: DriverResilienceOptions.GetTierDefaults supplies the real per-capability timeout/retry/breaker policies via DriverFactoryRegistry.GetTier and DriverCapabilityInvokerFactory. Only the isolation-and-recycle layer above it is gone. Deliberately NOT deleted: - WedgeDetector came along in the same directory and is equally dead in production, but it is tier-agnostic and is not recycle machinery — it only shares the folder. Restored rather than swept up in a decision that was not about it. - IDriver.GetMemoryFootprint() and FlushOptionalCachesAsync() lose their only consumer here. Removing them touches all 12 drivers and every test stub, so they are documented as consumerless and filed as #525 instead of buried in this diff. Compatibility: a deployed ResilienceConfig blob still carrying "recycleIntervalSeconds" parses cleanly (unknown keys are ignored — guarded by a new test, because a blob that suddenly failed to parse would fall back to tier defaults and silently discard the operator's real overrides), and the AdminUI's preserve-unknown-keys bag keeps the key rather than rewriting stored config on an unrelated edit. The 01/U-6 knob-inertness guard carried an explicit carve-out admitting RecycleIntervalSeconds was dormant and out of scope; that carve-out is now gone, so the expected set is literally what the test's name claims. Note: Host.IntegrationTests has 2 failures (DriverProbeRegistrationTests.is_idempotent, PrimaryGateFailoverTests) — verified pre-existing by reproducing both on clean master dc9d947b. Claude-Session: https://claude.ai/code/session_015p7wGqy3YpZNCpDzTpGMKo	2026-07-30 04:44:04 -04:00
Joseph Doherty	9cad9ed0fc	docs(xmldoc): fill missing XML docs + strip tracking-ID comments across src ... Adds <summary>/<param>/<returns>/<inheritdoc> where missing and removes project bookkeeping IDs (task/tracking refs) from shipped code comments, so the docs read cleanly and CommentChecker is quiet except for known false positives (PLC/protocol terms, event/IEqualityComparer inheritdoc). Doc/comment-only; no logic changed; solution builds clean.	2026-07-07 12:38:39 -04:00
Joseph Doherty	a40c77de87	fix(adminui): flip remaining ModbusTcp test seeds + doc comments to Modbus (review)	2026-06-16 19:51:56 -04:00
Joseph Doherty	64e3fbe035	docs: backfill XML documentation across 756 files ... Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public members surfaced by commentchecker — resolves 5,847 of 5,869 issues (99.6%) across three /fixdocs passes.	2026-05-28 08:10:17 -04:00
Joseph Doherty	1ddf8bb50e	refactor(configdb): delete v1 Apply pipeline (replaced by AdminOperationsActor) ... Phase 1c of the v2 entity-model rewrite. Deletes the draft/publish lifecycle machinery that v2 replaces with AdminOperationsActor + ConfigComposer + DriverInstanceActor.ApplyDelta. Deleted (6 files): src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Apply/ IGenerationApplier.cs — interface for the apply pipeline GenerationApplier.cs — the v1 applier coordinating per-driver hook-back GenerationDiff.cs — typed wrapper over the sp_ComputeGenerationDiff SQL output ApplyCallbacks.cs — per-driver hook surface invoked by the applier ChangeKind.cs — enum {Added, Modified, Removed, Unchanged} tests/Core/ZB.MOM.WW.OtOpcUa.Configuration.Tests/GenerationApplierTests.cs The empty Apply/ directory is removed. Kept (repurposed in Task 39 for stale-config fallback): src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/GenerationSealedCache.cs src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/ResilientConfigReader.cs tests/Core/ZB.MOM.WW.OtOpcUa.Configuration.Tests/GenerationSealedCacheTests.cs tests/Core/ZB.MOM.WW.OtOpcUa.Configuration.Tests/ResilientConfigReaderTests.cs Naming rename (GenerationSealedCache -> DeploymentArtifactCache) deferred to Task 39 (DriverHostActor stale-config fallback) where the consumer is written. The type stays available under its v1 name until then. IDriver.cs doc-comment: replaced the "Used by IGenerationApplier..." sentence with "Invoked by the v2 DriverInstanceActor when ApplyDelta reports that only this driver's config changed in the new deployment." Server/Admin breakage from Task 14b unchanged (70 errors). Configuration + Core.Tests + Configuration.Tests stay green. src/Core/ZB.MOM.WW.OtOpcUa.Configuration -> 0 errors tests/Core/ZB.MOM.WW.OtOpcUa.Configuration.Tests -> 0 errors whole solution -> 70 errors (all in Server/Admin)	2026-05-26 04:09:17 -04:00
Joseph Doherty	a25593a9c6	chore: organize solution into module folders (Core/Server/Drivers/Client/Tooling) ... Group all 69 projects into category subfolders under src/ and tests/ so the Rider Solution Explorer mirrors the module structure. Folders: Core, Server, Drivers (with a nested Driver CLIs subfolder), Client, Tooling. - Move every project folder on disk with git mv (history preserved as renames). - Recompute relative paths in 57 .csproj files: cross-category ProjectReferences, the lib/ HintPath+None refs in Driver.Historian.Wonderware, and the external mxaccessgw refs in Driver.Galaxy and its test project. - Rebuild ZB.MOM.WW.OtOpcUa.slnx with nested solution folders. - Re-prefix project paths in functional scripts (e2e, compliance, smoke SQL, integration, install). Build green (0 errors); unit tests pass. Docs left for a separate pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-17 01:55:28 -04:00