feat(site-runtime): InstanceActor trace arm stamps the device echo of a traced write; Trace rides on published changes
Flow Debugger (design 2026-09-05 §5.3): a traced SetStaticAttributeCommand on a data-sourced attribute records (attribute → writer, expiry) for TraceArmWindowSeconds (new option, default 30, validated > 0); the next DCL echo for that attribute is published with the writer's SourceExecutionId + Trace whatever its value, and the arm is consumed once. Static writes publish Trace directly. Untraced writes never arm (pinned). Claude-Session: https://claude.ai/code/session_01GSLkkHKz9JrAtmJjmQK3cP
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,178 @@
|
||||
using Akka.Actor;
|
||||
using Akka.TestKit;
|
||||
using Akka.TestKit.Xunit2;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Protocol;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.DataConnection;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Instance;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Streaming;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
|
||||
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Actors;
|
||||
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Persistence;
|
||||
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
|
||||
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Streaming;
|
||||
using ZB.MOM.WW.ScadaBridge.TestSupport;
|
||||
using System.Text.Json;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
|
||||
|
||||
/// <summary>
|
||||
/// Flow Debugger design 2026-09-05 §5.3 — the Instance Actor trace arm: a TRACED write to a
|
||||
/// data-sourced attribute stamps the next DCL echo for that attribute with the writer's
|
||||
/// <c>SourceExecutionId</c> and <c>Trace</c>; the arm is consumed once and expires unconsumed.
|
||||
/// Untraced writes never arm (the production-unchanged pin). A traced static write publishes
|
||||
/// the flag directly.
|
||||
/// </summary>
|
||||
public class InstanceActorTraceArmTests : TestKit, IDisposable
|
||||
{
|
||||
private const string Tag = "ns=3;s=Recipe.Processed";
|
||||
private readonly SiteStorageService _storage;
|
||||
private readonly ScriptCompilationService _compilationService;
|
||||
private readonly SharedScriptLibrary _sharedScriptLibrary;
|
||||
private readonly TestLocalDb _localDb;
|
||||
|
||||
public InstanceActorTraceArmTests()
|
||||
{
|
||||
_localDb = TestLocalDb.CreateTemp("instance-tracearm-test");
|
||||
_storage = new SiteStorageService(_localDb.Db, NullLogger<SiteStorageService>.Instance);
|
||||
_storage.InitializeAsync().GetAwaiter().GetResult();
|
||||
_compilationService = new ScriptCompilationService(NullLogger<ScriptCompilationService>.Instance);
|
||||
_sharedScriptLibrary = new SharedScriptLibrary(_compilationService, NullLogger<SharedScriptLibrary>.Instance);
|
||||
}
|
||||
|
||||
void IDisposable.Dispose()
|
||||
{
|
||||
Shutdown();
|
||||
var path = _localDb.Path;
|
||||
_localDb.Dispose();
|
||||
TestLocalDb.DeleteFiles(path);
|
||||
}
|
||||
|
||||
private static FlattenedConfiguration Config(string instance) => new()
|
||||
{
|
||||
InstanceUniqueName = instance,
|
||||
Attributes =
|
||||
[
|
||||
new ResolvedAttribute
|
||||
{
|
||||
CanonicalName = "Processed", Value = "false", DataType = "Boolean",
|
||||
DataSourceReference = Tag, BoundDataConnectionName = "PLC"
|
||||
},
|
||||
new ResolvedAttribute { CanonicalName = "Status", Value = "Idle", DataType = "String" },
|
||||
]
|
||||
};
|
||||
|
||||
private (IActorRef Actor, TestProbe Dcl, TestProbe Subscriber) Create(string instance, int armWindowSeconds = 30)
|
||||
{
|
||||
var options = new SiteRuntimeOptions { StreamBufferSize = 100, TraceArmWindowSeconds = armWindowSeconds };
|
||||
var streamManager = new SiteStreamManager(options, NullLogger<SiteStreamManager>.Instance);
|
||||
streamManager.Initialize(Sys);
|
||||
var dcl = CreateTestProbe();
|
||||
var actor = ActorOf(Props.Create(() => new InstanceActor(
|
||||
instance, JsonSerializer.Serialize(Config(instance)), _storage, _compilationService,
|
||||
_sharedScriptLibrary, streamManager, options, NullLogger<InstanceActor>.Instance, dcl.Ref)));
|
||||
var subscriber = CreateTestProbe();
|
||||
streamManager.Subscribe(instance, subscriber.Ref);
|
||||
return (actor, dcl, subscriber);
|
||||
}
|
||||
|
||||
private static WriteTagRequest ExpectWrite(TestProbe dcl)
|
||||
=> dcl.FishForMessage<WriteTagRequest>(_ => true, TimeSpan.FromSeconds(5));
|
||||
|
||||
private void Write(IActorRef actor, TestProbe dcl, string instance, Guid? source, bool trace)
|
||||
{
|
||||
actor.Tell(new SetStaticAttributeCommand("c", instance, "Processed", "true", DateTimeOffset.UtcNow,
|
||||
SourceExecutionId: source, Trace: trace));
|
||||
var write = ExpectWrite(dcl);
|
||||
Assert.Equal(Tag, write.TagPath);
|
||||
dcl.Reply(new WriteTagResponse(write.CorrelationId, true, null, DateTimeOffset.UtcNow));
|
||||
Assert.True(ExpectMsg<SetStaticAttributeResponse>(TimeSpan.FromSeconds(5)).Success);
|
||||
}
|
||||
|
||||
private static AttributeValueChanged Echo(IActorRef actor, TestProbe subscriber, object? value)
|
||||
{
|
||||
actor.Tell(new TagValueUpdate("PLC", Tag, value, QualityCode.Good, DateTimeOffset.UtcNow));
|
||||
return subscriber.FishForMessage<AttributeValueChanged>(
|
||||
m => m.AttributeName == "Processed" && Equals(m.Value, value), TimeSpan.FromSeconds(10));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void TracedDataWrite_ThenEcho_PublishesChangeStampedWithSourceAndTrace()
|
||||
{
|
||||
var (actor, dcl, sub) = Create("P1");
|
||||
var writer = Guid.NewGuid();
|
||||
|
||||
Write(actor, dcl, "P1", writer, trace: true);
|
||||
// The device clamps/echoes whatever it wants — the stamp does not depend on the value.
|
||||
var published = Echo(actor, sub, "clamped");
|
||||
|
||||
Assert.Equal(writer, published.SourceExecutionId);
|
||||
Assert.True(published.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void UntracedDataWrite_ThenEcho_PublishesUnstampedChange()
|
||||
{
|
||||
var (actor, dcl, sub) = Create("P2");
|
||||
|
||||
// Stamped writer but NOT traced — the ordinary script-write path.
|
||||
Write(actor, dcl, "P2", Guid.NewGuid(), trace: false);
|
||||
var published = Echo(actor, sub, true);
|
||||
|
||||
Assert.Null(published.SourceExecutionId);
|
||||
Assert.False(published.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Arm_IsConsumedOnce()
|
||||
{
|
||||
var (actor, dcl, sub) = Create("P3");
|
||||
var writer = Guid.NewGuid();
|
||||
|
||||
Write(actor, dcl, "P3", writer, trace: true);
|
||||
var first = Echo(actor, sub, "one");
|
||||
var second = Echo(actor, sub, "two");
|
||||
|
||||
Assert.Equal(writer, first.SourceExecutionId);
|
||||
Assert.True(first.Trace);
|
||||
Assert.Null(second.SourceExecutionId);
|
||||
Assert.False(second.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
[Trait("Category", "Slow")]
|
||||
public void Arm_Expired_IsIgnored()
|
||||
{
|
||||
var (actor, dcl, sub) = Create("P4", armWindowSeconds: 1);
|
||||
|
||||
Write(actor, dcl, "P4", Guid.NewGuid(), trace: true);
|
||||
Thread.Sleep(1100);
|
||||
var published = Echo(actor, sub, true);
|
||||
|
||||
Assert.Null(published.SourceExecutionId);
|
||||
Assert.False(published.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void StaticWrite_Traced_PublishesTraceFlag()
|
||||
{
|
||||
var (actor, _, sub) = Create("P5");
|
||||
var writer = Guid.NewGuid();
|
||||
|
||||
actor.Tell(new SetStaticAttributeCommand("c", "P5", "Status", "Running", DateTimeOffset.UtcNow,
|
||||
SourceExecutionId: writer, Trace: true));
|
||||
Assert.True(ExpectMsg<SetStaticAttributeResponse>(TimeSpan.FromSeconds(5)).Success);
|
||||
|
||||
var published = sub.FishForMessage<AttributeValueChanged>(
|
||||
m => m.AttributeName == "Status" && Equals(m.Value, "Running"), TimeSpan.FromSeconds(10));
|
||||
Assert.Equal(writer, published.SourceExecutionId);
|
||||
Assert.True(published.Trace);
|
||||
|
||||
// And an untraced static write publishes Trace=false (pin).
|
||||
actor.Tell(new SetStaticAttributeCommand("c2", "P5", "Status", "Idle2", DateTimeOffset.UtcNow, SourceExecutionId: writer));
|
||||
ExpectMsg<SetStaticAttributeResponse>(TimeSpan.FromSeconds(5));
|
||||
var plain = sub.FishForMessage<AttributeValueChanged>(
|
||||
m => m.AttributeName == "Status" && Equals(m.Value, "Idle2"), TimeSpan.FromSeconds(10));
|
||||
Assert.False(plain.Trace);
|
||||
}
|
||||
}
|
||||
@@ -136,6 +136,17 @@ public class SiteRuntimeOptionsValidatorTests
|
||||
}
|
||||
|
||||
/// <summary>A zero cap would shed every trigger, silently disabling all scripts.</summary>
|
||||
[Fact]
|
||||
public void ZeroTraceArmWindowSeconds_IsRejected()
|
||||
{
|
||||
// Flow Debugger design 2026-09-05 §5.3: the arm window must be positive.
|
||||
var result = Validate(new SiteRuntimeOptions { TraceArmWindowSeconds = 0 });
|
||||
|
||||
Assert.True(result.Failed);
|
||||
Assert.Contains("TraceArmWindowSeconds", result.FailureMessage);
|
||||
Assert.Equal(30, new SiteRuntimeOptions().TraceArmWindowSeconds);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ZeroMaxConcurrentRunsPerScript_IsRejected()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user