feat(adminui): native-alarm HistorizeToAveva opt-out

2026-06-16 16:27:31 -04:00
parent 72d414ada7
commit 6a8020e7e7
8 changed files with 393 additions and 15 deletions
@@ -146,10 +146,78 @@ public sealed class DriverHostActorNativeAlarmTests : RuntimeActorTestBase
        evt.Severity.ShouldBe(700);                    // AlarmSeverity.High → projector 700
        evt.Message.ShouldBe("temperature high");
        evt.User.ShouldBe(string.Empty);              // no operator comment ⇒ device-origin (empty user)
-        evt.HistorizeToAveva.ShouldBe(true);
+        // This tag's TagConfig.alarm carries no historizeToAveva key ⇒ null ⇒ the HistorianAdapterActor
+        // gate (historizeToAveva is not false) still historizes (default-on). Only an explicit false
+        // suppresses the durable AVEVA row — see Native_alarm_historizeToAveva_false_threads_through.
+        evt.HistorizeToAveva.ShouldBeNull();
        alerts.ExpectNoMsg(TimeSpan.FromMilliseconds(300)); // exactly one
    }

+    /// <summary>Native-alarm HistorizeToAveva opt-out (Task 3): a tag whose <c>TagConfig.alarm</c> carries
+    /// <c>historizeToAveva: false</c> publishes its <see cref="AlarmTransitionEvent"/> with
+    /// <c>HistorizeToAveva == false</c>, so the runtime's <c>HistorianAdapterActor</c> gate
+    /// (<c>historizeToAveva is not false</c>) suppresses the durable AVEVA write — the same opt-out the
+    /// scripted-alarm plan flag drives. The live <c>/alerts</c> fan-out is unaffected (the transition still
+    /// publishes; only the durable row is gated downstream).</summary>
+    [Fact]
+    public void Native_alarm_historizeToAveva_false_threads_through()
+    {
+        var db = NewInMemoryDbFactory();
+        var deploymentId = SeedDeploymentWithAlarmTag(db, RevA,
+            Equip: "eq-1", Driver: "drv-1", FullName: "Temp.HiHi", Folder: null, Name: "temp_hi",
+            historizeToAveva: false);
+
+        var alerts = CreateTestProbe();
+        SubscribeToAlerts(alerts);
+
+        var (actor, publish) = SpawnHostAndApply(db, deploymentId);
+
+        actor.Tell(new DriverInstanceActor.AttributeAlarmPublished("drv-1", new AlarmEventArgs(
+            new StubAlarmHandle(),
+            SourceNodeId: "Temp",
+            ConditionId: "Temp.HiHi",
+            AlarmType: "OffNormalAlarm",
+            Message: "temperature high",
+            Severity: AlarmSeverity.High,
+            SourceTimestampUtc: Ts,
+            Kind: AlarmTransitionKind.Raise)));
+
+        var evt = alerts.ExpectMsg<AlarmTransitionEvent>(TimeSpan.FromSeconds(5));
+        evt.AlarmId.ShouldBe("eq-1/temp_hi");
+        // The explicit opt-out rides onto the transition ⇒ the historian gate suppresses the durable row.
+        evt.HistorizeToAveva.ShouldBe(false);
+    }
+
+    /// <summary>Native-alarm HistorizeToAveva opt-IN (Task 3): an explicit <c>historizeToAveva: true</c>
+    /// rides through as <c>true</c> (distinct from the absent ⇒ null default-on case) so an operator who
+    /// deliberately opts in is recorded as such on the transition.</summary>
+    [Fact]
+    public void Native_alarm_historizeToAveva_true_threads_through()
+    {
+        var db = NewInMemoryDbFactory();
+        var deploymentId = SeedDeploymentWithAlarmTag(db, RevA,
+            Equip: "eq-1", Driver: "drv-1", FullName: "Temp.HiHi", Folder: null, Name: "temp_hi",
+            historizeToAveva: true);
+
+        var alerts = CreateTestProbe();
+        SubscribeToAlerts(alerts);
+
+        var (actor, publish) = SpawnHostAndApply(db, deploymentId);
+
+        actor.Tell(new DriverInstanceActor.AttributeAlarmPublished("drv-1", new AlarmEventArgs(
+            new StubAlarmHandle(),
+            SourceNodeId: "Temp",
+            ConditionId: "Temp.HiHi",
+            AlarmType: "OffNormalAlarm",
+            Message: "temperature high",
+            Severity: AlarmSeverity.High,
+            SourceTimestampUtc: Ts,
+            Kind: AlarmTransitionKind.Raise)));
+
+        var evt = alerts.ExpectMsg<AlarmTransitionEvent>(TimeSpan.FromSeconds(5));
+        evt.HistorizeToAveva.ShouldBe(true);
+    }
+
    /// <summary>Secondary suppression (Phase B WS-5): when the cached local role is Secondary the host
    /// MUST still write the local OPC UA condition node (ungated — keeps the standby's address space warm
    /// for failover) but MUST NOT publish the cluster-wide <c>alerts</c> transition (the Primary publishes
@@ -292,8 +360,14 @@ public sealed class DriverHostActorNativeAlarmTests : RuntimeActorTestBase
    /// </summary>
    private static DeploymentId SeedDeploymentWithAlarmTag(
        IDbContextFactory<OtOpcUaConfigDbContext> db, RevisionHash rev,
-        string Equip, string Driver, string FullName, string? Folder, string Name)
+        string Equip, string Driver, string FullName, string? Folder, string Name,
+        bool? historizeToAveva = null)
    {
+        // historizeToAveva absent (null) ⇒ omit the key entirely so the absent ⇒ historize default path is
+        // exercised; a concrete true/false writes the bool into the alarm object so the native path threads it.
+        object alarm = historizeToAveva is { } h
+            ? new { alarmType = "OffNormalAlarm", severity = 700, historizeToAveva = h }
+            : new { alarmType = "OffNormalAlarm", severity = 700 };
        var artifact = JsonSerializer.SerializeToUtf8Bytes(new
        {
            Namespaces = new[]
@@ -317,7 +391,7 @@ public sealed class DriverHostActorNativeAlarmTests : RuntimeActorTestBase
                    TagConfig = JsonSerializer.Serialize(new
                    {
                        FullName,
-                        alarm = new { alarmType = "OffNormalAlarm", severity = 700 },
+                        alarm,
                    }),
                },
            },