Joseph Doherty
01bcca992c
MES alarm-status API §6.4 (docs/plans/2026-06-30-mes-alarm-status-api.md,
Phase 1 task 1). MES needs a real AckDT for a triggered alarm, and the mirror
carried acked-vs-unacked but never WHEN. AckTime now rides the whole path:
DCL transition -> AlarmStateChanged -> gRPC AlarmStateUpdate -> site SQLite.
Stamping rule, identical on both protocols: non-null ONLY while the condition
is active AND acknowledged. That single predicate yields all three required
behaviours -- null while unacked, cleared on re-raise (a re-raise arrives
unacknowledged), and no phantom ack on a return-to-normal. The last one is
load-bearing for MxGateway, which maps INACTIVE to Acknowledged = true; without
the active check every clear would claim an ack the system never observed.
Provenance is honest, never fabricated:
- OPC UA A&C supplies a TRUE ack instant, so we now select it:
AcknowledgeableConditionType/AckedState/TransitionTime at SelectClause
index 18, APPENDED so the positional reads at 0-17 keep their meaning.
Servers that omit the field fall back to the event's own Time.
- MxAccess Gateway supplies none, so the ack transition's own timestamp is
used -- accurate to when the system SAW the ack. An ACTIVE_ACKED
re-subscribe snapshot restores one from LastTransitionTimestamp rather
than dropping it.
The decision lives in pure mappers (Opc/Mx AlarmMapper.DeriveAckTime), so it is
unit-tested with no live server or gateway.
Additive-only throughout: init-only property on AlarmStateChanged, trailing
optional positional on NativeAlarmTransition (all 14-arg call sites untouched),
proto field 24 (never reusing a number) regenerated via docker/regen-proto.sh
sitestream with the csproj diff verified empty.
Persistence rides native_alarm_state's existing metadata_json blob rather than
a new column -- deliberately. That table is RegisterReplicated in
SiteLocalDbSetup and LocalDb builds its CDC triggers from the column list at
registration time, so an additive JSON property changes no schema, no triggers
and no replication contract; metadata_json is exactly the extension point UA4
introduced for this. Rows written before the field deserialize it as null.
Tests: 4 OPC UA + 6 MxGateway mapper cases, 3 NativeAlarmActor (emit,
failover rehydrate, pre-AckTime row), 1 proto round-trip incl. the null case,
4 Commons additive/back-compat. The OPC UA SelectClause count lock-in moves
18 -> 19 with an index-18 assertion -- intended, the clause is appended, which
is precisely what that guard exists to make visible.
59 lines
2.3 KiB
C#
59 lines
2.3 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Streaming;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Alarms;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
|
|
|
|
public class AlarmStateChangedEnrichmentTests
|
|
{
|
|
[Fact]
|
|
public void Defaults_AreComputedKind_WithAutoAck()
|
|
{
|
|
var m = new AlarmStateChanged("inst", "HiAlarm", AlarmState.Active, 700, DateTimeOffset.UnixEpoch);
|
|
Assert.Equal(AlarmKind.Computed, m.Kind);
|
|
Assert.True(m.Condition.Acknowledged); // computed = auto-acked
|
|
Assert.Equal(700, m.Condition.Severity); // severity defaults to Priority
|
|
Assert.True(m.Condition.Active); // derived from State
|
|
Assert.Equal("", m.SourceReference);
|
|
}
|
|
|
|
[Fact]
|
|
public void Factory_ForComputed_MapsPriorityAndState()
|
|
{
|
|
var c = AlarmConditionStateFactory.ForComputed(AlarmState.Normal, priority: 250);
|
|
Assert.False(c.Active);
|
|
Assert.True(c.Acknowledged);
|
|
Assert.Equal(250, c.Severity);
|
|
}
|
|
|
|
// ── MES alarm-status API §6.4: additive AckTime ──
|
|
|
|
[Fact]
|
|
public void AckTime_DefaultsToNull_OnThePositionalConstructor()
|
|
{
|
|
// Additive-only evolution: every existing positional construction stays valid and
|
|
// reports no ack time. A computed alarm is auto-acked but has no operator ack
|
|
// event, so null (not the timestamp) is the honest value.
|
|
var m = new AlarmStateChanged("inst", "HiAlarm", AlarmState.Active, 700, DateTimeOffset.UnixEpoch);
|
|
|
|
Assert.True(m.Condition.Acknowledged); // computed = auto-acked…
|
|
Assert.Null(m.AckTime); // …yet still no ack instant
|
|
}
|
|
|
|
[Fact]
|
|
public void AckTime_RoundTripsThroughTheInitProperty()
|
|
{
|
|
var ackedAt = new DateTimeOffset(2026, 8, 1, 12, 0, 0, TimeSpan.Zero);
|
|
|
|
var m = new AlarmStateChanged("inst", "Tank01.Level.HiHi", AlarmState.Active, 900, DateTimeOffset.UnixEpoch)
|
|
{
|
|
Kind = AlarmKind.NativeOpcUa,
|
|
AckTime = ackedAt
|
|
};
|
|
|
|
Assert.Equal(ackedAt, m.AckTime);
|
|
// `with` (used by the mirror to synthesise a return-to-normal) preserves it.
|
|
Assert.Equal(ackedAt, (m with { State = AlarmState.Normal }).AckTime);
|
|
}
|
|
}
|