A.3 (alarm-ack-by-name): public AcknowledgeAlarm now accepts Provider!Group.Tag references

Closes the gap where the public AcknowledgeAlarm RPC required canonical GUIDs but OnAlarmTransitionEvent.AlarmFullReference is "Provider!Group.Tag". Adds an AVEVA AlarmAckByName path that wraps wwAlarmConsumerClass.AlarmAckByName so callers can ack with the natural reference. Proto: - New MxCommandKind.AcknowledgeAlarmByName (=29). - New AcknowledgeAlarmByNameCommand(alarm_name, provider_name, group_name, comment, operator_user/node/domain/full_name) on MxCommand oneof. - AcknowledgeAlarmReplyPayload (existing) carries the AVEVA native status; reused for the by-name path. Worker: - IMxAccessAlarmConsumer + WnWrapAlarmConsumer + AlarmDispatcher + AlarmCommandHandler all gain an AcknowledgeByName(name, provider, group, comment, operator-identity) overload that maps to wwAlarmConsumerClass.AlarmAckByName. - MxAccessCommandExecutor: new switch arm routes MxCommandKind.AcknowledgeAlarmByName to the handler. Empty alarm_name yields InvalidRequest; handler exceptions surface as MxaccessFailure. Gateway: - WorkerAlarmRpcDispatcher.TryParseAlarmReference: parses "Provider!Group.Tag" with the convention that the FIRST '!' separates provider, the FIRST '.' after '!' separates group; tag may contain more dots. - AcknowledgeAsync now branches: GUID input → AcknowledgeAlarm command (existing path); reference input → AcknowledgeAlarmByName command (new path); neither parses → InvalidRequest with a clear diagnostic. Tests: 13 new unit tests cover each layer end-to-end: - WorkerAlarmRpcDispatcher.TryParseAlarmReference (3 valid + 8 invalid forms) including the realistic 4-component "Galaxy!TestArea. TestMachine_001.TestAlarm001" reference. - WorkerAlarmRpcDispatcher.AcknowledgeAsync routes references through AcknowledgeAlarmByName + propagates the full operator tuple. - Executor switch arm carries the by-name tuple and rejects empty alarm_name. - AlarmDispatcher.AcknowledgeByName forwards to consumer. - Existing fakes extended for the new overload. Counts: server 308/0, worker 195/3 skip / 1 pre-existing structure-fail (untouched). Solution builds clean. End-to-end alarms-over-gateway now serves the full lmxopcua flow: client.AcknowledgeAlarm(reference="Galaxy!TestArea.TestMachine_001.TestAlarm001", operator_user="alice") → gateway parses → IPC AcknowledgeAlarmByName → worker AlarmAckByName → AVEVA history. The remaining piece for full parity is a live dev-rig smoke test. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-01 11:17:15 -04:00
parent 47b1fd422c
commit 4e02927f01
12 changed files with 1390 additions and 421 deletions
@@ -36,33 +36,6 @@ public sealed class WorkerAlarmRpcDispatcherTests
        Assert.Equal(ProtocolStatusCode.SessionNotFound, reply.ProtocolStatus.Code);
    }

-    [Fact]
-    public async Task AcknowledgeAsync_returns_invalid_request_when_reference_is_not_a_guid()
-    {
-        SessionRegistry registry = new SessionRegistry();
-        FakeAlarmWorkerClient worker = new FakeAlarmWorkerClient();
-        GatewaySession session = NewSession("s1");
-        session.AttachWorkerClient(worker);
-        session.MarkReady();
-        registry.TryAdd(session);
-
-        WorkerAlarmRpcDispatcher dispatcher = new WorkerAlarmRpcDispatcher(registry);
-
-        AcknowledgeAlarmReply reply = await dispatcher.AcknowledgeAsync(
-            new AcknowledgeAlarmRequest
-            {
-                SessionId = "s1",
-                ClientCorrelationId = "c1",
-                AlarmFullReference = "Galaxy!Area.Tag", // not a GUID
-                Comment = "x",
-                OperatorUser = "u",
-            },
-            CancellationToken.None);
-
-        Assert.Equal(ProtocolStatusCode.InvalidRequest, reply.ProtocolStatus.Code);
-        Assert.Equal(0, worker.InvokeCount); // dispatcher short-circuits before the IPC.
-    }
-
    [Fact]
    public async Task AcknowledgeAsync_forwards_guid_and_returns_native_status()
    {
@@ -148,6 +121,107 @@ public sealed class WorkerAlarmRpcDispatcherTests
        Assert.Contains("-123", reply.DiagnosticMessage);
    }

+    [Theory]
+    [InlineData("Galaxy!TestArea.TestMachine_001.TestAlarm001", "Galaxy", "TestArea", "TestMachine_001.TestAlarm001")]
+    [InlineData("Galaxy!Area.Tag", "Galaxy", "Area", "Tag")]
+    [InlineData("Provider!Group.Tag.With.Dots", "Provider", "Group", "Tag.With.Dots")]
+    public void TryParseAlarmReference_decomposes_provider_group_tag(
+        string reference, string expectedProvider, string expectedGroup, string expectedName)
+    {
+        Assert.True(WorkerAlarmRpcDispatcher.TryParseAlarmReference(
+            reference, out string provider, out string group, out string name));
+        Assert.Equal(expectedProvider, provider);
+        Assert.Equal(expectedGroup, group);
+        Assert.Equal(expectedName, name);
+    }
+
+    [Theory]
+    [InlineData("")]
+    [InlineData("   ")]
+    [InlineData(null)]
+    [InlineData("no-bang-here")]
+    [InlineData("!Group.Tag")] // empty provider
+    [InlineData("Galaxy!")] // bang at end
+    [InlineData("Galaxy!Group")] // missing dot
+    [InlineData("Galaxy!.Tag")] // empty group
+    [InlineData("Galaxy!Group.")] // empty tag
+    public void TryParseAlarmReference_rejects_malformed_references(string? reference)
+    {
+        Assert.False(WorkerAlarmRpcDispatcher.TryParseAlarmReference(
+            reference, out _, out _, out _));
+    }
+
+    [Fact]
+    public async Task AcknowledgeAsync_routes_provider_group_tag_via_AckByName()
+    {
+        SessionRegistry registry = new SessionRegistry();
+        AcknowledgeAlarmByNameCommand? observed = null;
+        FakeAlarmWorkerClient worker = new FakeAlarmWorkerClient
+        {
+            ReplyFactory = command =>
+            {
+                Assert.Equal(MxCommandKind.AcknowledgeAlarmByName, command.Command.Kind);
+                observed = command.Command.AcknowledgeAlarmByNameCommand;
+                return new MxCommandReply
+                {
+                    Kind = MxCommandKind.AcknowledgeAlarmByName,
+                    ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok, Message = "OK" },
+                    Hresult = 0,
+                    AcknowledgeAlarm = new AcknowledgeAlarmReplyPayload { NativeStatus = 0 },
+                };
+            },
+        };
+        GatewaySession session = NewSession("s1");
+        session.AttachWorkerClient(worker);
+        session.MarkReady();
+        registry.TryAdd(session);
+
+        WorkerAlarmRpcDispatcher dispatcher = new WorkerAlarmRpcDispatcher(registry);
+
+        AcknowledgeAlarmReply reply = await dispatcher.AcknowledgeAsync(
+            new AcknowledgeAlarmRequest
+            {
+                SessionId = "s1",
+                ClientCorrelationId = "c1",
+                AlarmFullReference = "Galaxy!TestArea.TestMachine_001.TestAlarm001",
+                Comment = "ack-by-name",
+                OperatorUser = "bob",
+            },
+            CancellationToken.None);
+
+        Assert.Equal(ProtocolStatusCode.Ok, reply.ProtocolStatus.Code);
+        Assert.NotNull(observed);
+        Assert.Equal("TestMachine_001.TestAlarm001", observed!.AlarmName);
+        Assert.Equal("Galaxy", observed.ProviderName);
+        Assert.Equal("TestArea", observed.GroupName);
+        Assert.Equal("bob", observed.OperatorUser);
+        Assert.Equal("ack-by-name", observed.Comment);
+    }
+
+    [Fact]
+    public async Task AcknowledgeAsync_returns_invalid_request_for_unparseable_reference()
+    {
+        SessionRegistry registry = new SessionRegistry();
+        FakeAlarmWorkerClient worker = new FakeAlarmWorkerClient();
+        GatewaySession session = NewSession("s1");
+        session.AttachWorkerClient(worker);
+        session.MarkReady();
+        registry.TryAdd(session);
+
+        WorkerAlarmRpcDispatcher dispatcher = new WorkerAlarmRpcDispatcher(registry);
+
+        AcknowledgeAlarmReply reply = await dispatcher.AcknowledgeAsync(
+            new AcknowledgeAlarmRequest
+            {
+                SessionId = "s1",
+                AlarmFullReference = "no-bang-no-dot",
+            },
+            CancellationToken.None);
+
+        Assert.Equal(ProtocolStatusCode.InvalidRequest, reply.ProtocolStatus.Code);
+        Assert.Equal(0, worker.InvokeCount);
+    }
+
    [Fact]
    public async Task QueryActiveAlarmsAsync_yields_each_snapshot_from_payload()
    {