feat(commons): additive Trace flag + ChildExecutionId/TraceEvents on route/call/write/change records

Flow Debugger (design 2026-09-05 §5.2/§5.4): Trace rides beside ParentExecutionId on RouteToCallRequest/RouteToSetAttributesRequest/ScriptCallRequest/SetStaticAttributeCommand/ AttributeValueChanged; RouteToCallResponse and ScriptCallResult carry the site run's ExecutionId and its ScriptTrace AuditEvents inline. All trailing optional — zero call-site edits. Claude-Session: https://claude.ai/code/session_01GSLkkHKz9JrAtmJjmQK3cP
2026-09-05 23:41:50 -04:00
parent 352e0bfa37
commit 24e595d6d9
6 changed files with 82 additions and 7 deletions
@@ -0,0 +1,53 @@
+using ZB.MOM.WW.Audit;
+using ZB.MOM.WW.ScadaBridge.Commons.Messages.InboundApi;
+using ZB.MOM.WW.ScadaBridge.Commons.Messages.Instance;
+using ZB.MOM.WW.ScadaBridge.Commons.Messages.ScriptExecution;
+using ZB.MOM.WW.ScadaBridge.Commons.Messages.Streaming;
+
+namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
+
+/// <summary>
+/// Flow Debugger (design 2026-09-05 §5.2/§5.4): the trace flag and trace payload are additive
+/// trailing optional members — every pre-existing positional construction stays untraced.
+/// </summary>
+public class TraceFlagDefaultsTests
+{
+    [Fact]
+    public void ExistingPositionalConstructions_DefaultToUntraced()
+    {
+        var now = DateTimeOffset.UtcNow;
+        Assert.False(new RouteToCallRequest("c", "i", "s", null, now).Trace);
+        Assert.False(new RouteToSetAttributesRequest("c", "i", new Dictionary<string, string>(), now).Trace);
+        Assert.False(new ScriptCallRequest("s", null, 0, "c").Trace);
+        Assert.False(new SetStaticAttributeCommand("c", "i", "a", "v", now).Trace);
+        Assert.False(new AttributeValueChanged("i", "p", "a", 1, "Good", now).Trace);
+
+        var reply = new RouteToCallResponse("c", true, null, null, now);
+        Assert.Null(reply.ChildExecutionId);
+        Assert.Null(reply.TraceEvents);
+
+        var result = new ScriptCallResult("c", true, null, null);
+        Assert.Null(result.ExecutionId);
+        Assert.Null(result.TraceEvents);
+    }
+
+    [Fact]
+    public void TraceEvents_AreAuditEvents()
+    {
+        var evt = new AuditEvent
+        {
+            EventId = Guid.NewGuid(),
+            OccurredAtUtc = DateTimeOffset.UtcNow,
+            Actor = "a",
+            Action = "ScriptTrace.ScriptRun",
+            Outcome = AuditOutcome.Success
+        };
+        var result = new ScriptCallResult("c", true, null, null, Guid.NewGuid(), [evt]);
+        Assert.Single(result.TraceEvents!);
+        Assert.NotNull(result.ExecutionId);
+
+        var reply = new RouteToCallResponse("c", true, null, null, DateTimeOffset.UtcNow, result.ExecutionId, result.TraceEvents);
+        Assert.Equal(result.ExecutionId, reply.ChildExecutionId);
+        Assert.Same(evt, reply.TraceEvents![0]);
+    }
+}