feat(wire): attribute updates carry source_execution_id/trace; PullTraceEvents RPC + site read-by-execution-ids
Flow Debugger (design 2026-09-05 §5.3/§5.4): AttributeValueUpdate fields 7/8 stamped by StreamRelayActor and parsed by SiteStreamGrpcClient (older frames => null/false). New PullTraceEvents unary RPC on SiteStreamService (same PSK-gated prefix as PullAuditEvents): a point read of the site audit SQLite by ExecutionId OR ParentExecutionId (ISiteAuditQueue.ReadByExecutionIdsAsync, json_extract on the codec's camelCase keys, new IX_audit_event_occurred index, 64-id / 2000-row caps) that moves no cursor and flips no ForwardState. Central IPullTraceEventsClient/GrpcPullTraceEventsClient mirror the audit pull client (endpoint resolution, NodeB failover, fault => empty) and register beside it. Claude-Session: https://claude.ai/code/session_01GSLkkHKz9JrAtmJjmQK3cP
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,125 @@
|
||||
using Akka.TestKit.Xunit2;
|
||||
using Google.Protobuf.WellKnownTypes;
|
||||
using Grpc.Core;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using NSubstitute;
|
||||
using ZB.MOM.WW.Audit;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
||||
using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Flow Debugger (design 2026-09-05 §5.4): <see cref="SiteStreamGrpcServer.PullTraceEvents"/>
|
||||
/// — request validation, the queue point-read, DTO projection, and the guarantee that it is
|
||||
/// NOT a reconciliation path (no cursor flip). Also pins that the RPC sits under the
|
||||
/// PSK-gated <c>/sitestream.SiteStreamService/</c> prefix.
|
||||
/// </summary>
|
||||
public class SiteStreamPullTraceEventsTests : TestKit
|
||||
{
|
||||
private readonly ISiteStreamSubscriber _subscriber = Substitute.For<ISiteStreamSubscriber>();
|
||||
|
||||
private SiteStreamGrpcServer CreateServer() => new(_subscriber, NullLogger<SiteStreamGrpcServer>.Instance);
|
||||
|
||||
private static ServerCallContext NewContext()
|
||||
{
|
||||
var context = Substitute.For<ServerCallContext>();
|
||||
context.CancellationToken.Returns(CancellationToken.None);
|
||||
return context;
|
||||
}
|
||||
|
||||
private static AuditEvent Row(Guid executionId) => ScadaBridgeAuditEventFactory.Create(
|
||||
AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
|
||||
occurredAtUtc: new DateTime(2026, 9, 5, 12, 0, 0, DateTimeKind.Utc), executionId: executionId, sourceSiteId: "site-a");
|
||||
|
||||
[Fact]
|
||||
public void PullTraceEvents_IsUnderThePskGatedServicePrefix()
|
||||
{
|
||||
var method = SiteStreamService.Descriptor.FindMethodByName("PullTraceEvents");
|
||||
Assert.NotNull(method);
|
||||
Assert.Equal("sitestream.SiteStreamService", SiteStreamService.Descriptor.FullName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task NoQueueWired_ReturnsEmpty()
|
||||
{
|
||||
var response = await CreateServer().PullTraceEvents(new PullTraceEventsRequest
|
||||
{
|
||||
ExecutionIds = { Guid.NewGuid().ToString("D") }, MaxEvents = 10,
|
||||
}, NewContext());
|
||||
Assert.Empty(response.Events);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ReadsByIds_ProjectsDtos_AndNeverFlipsState()
|
||||
{
|
||||
var queue = Substitute.For<ISiteAuditQueue>();
|
||||
var id = Guid.NewGuid();
|
||||
var rows = new List<AuditEvent> { Row(id), Row(id) };
|
||||
IReadOnlyCollection<Guid>? seenIds = null;
|
||||
DateTime seenSince = default;
|
||||
int seenLimit = 0;
|
||||
queue.ReadByExecutionIdsAsync(
|
||||
Arg.Do<IReadOnlyCollection<Guid>>(x => seenIds = x), Arg.Do<DateTime>(x => seenSince = x),
|
||||
Arg.Do<int>(x => seenLimit = x), Arg.Any<CancellationToken>())
|
||||
.Returns((IReadOnlyList<AuditEvent>)rows);
|
||||
var server = CreateServer();
|
||||
server.SetSiteAuditQueue(queue);
|
||||
var since = new DateTime(2026, 9, 5, 11, 0, 0, DateTimeKind.Utc);
|
||||
|
||||
var response = await server.PullTraceEvents(new PullTraceEventsRequest
|
||||
{
|
||||
ExecutionIds = { id.ToString("D") }, SinceUtc = Timestamp.FromDateTime(since), MaxEvents = 500,
|
||||
}, NewContext());
|
||||
|
||||
Assert.Equal(2, response.Events.Count);
|
||||
Assert.Equal(rows[0].EventId.ToString(), response.Events[0].EventId);
|
||||
Assert.Equal(new[] { id }, seenIds);
|
||||
Assert.Equal(since, seenSince);
|
||||
Assert.Equal(500, seenLimit);
|
||||
await queue.DidNotReceiveWithAnyArgs().MarkReconciledUpToAsync(default, default, default);
|
||||
await queue.DidNotReceiveWithAnyArgs().MarkReconciledAsync(default!, default);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData(0, 1)]
|
||||
[InlineData(2001, 1)]
|
||||
[InlineData(10, 0)]
|
||||
[InlineData(10, 65)]
|
||||
public async Task InvalidArguments_AreRejected(int maxEvents, int idCount)
|
||||
{
|
||||
var server = CreateServer();
|
||||
server.SetSiteAuditQueue(Substitute.For<ISiteAuditQueue>());
|
||||
var request = new PullTraceEventsRequest { MaxEvents = maxEvents };
|
||||
for (var i = 0; i < idCount; i++) request.ExecutionIds.Add(Guid.NewGuid().ToString("D"));
|
||||
|
||||
var ex = await Assert.ThrowsAsync<RpcException>(() => server.PullTraceEvents(request, NewContext()));
|
||||
Assert.Equal(StatusCode.InvalidArgument, ex.StatusCode);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task NonGuidId_IsRejected()
|
||||
{
|
||||
var server = CreateServer();
|
||||
server.SetSiteAuditQueue(Substitute.For<ISiteAuditQueue>());
|
||||
var ex = await Assert.ThrowsAsync<RpcException>(() => server.PullTraceEvents(
|
||||
new PullTraceEventsRequest { ExecutionIds = { "nope" }, MaxEvents = 10 }, NewContext()));
|
||||
Assert.Equal(StatusCode.InvalidArgument, ex.StatusCode);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task QueueFault_CollapsesToEmpty()
|
||||
{
|
||||
var queue = Substitute.For<ISiteAuditQueue>();
|
||||
queue.ReadByExecutionIdsAsync(default!, default, default, default)
|
||||
.ReturnsForAnyArgs<IReadOnlyList<AuditEvent>>(_ => throw new InvalidOperationException("boom"));
|
||||
var server = CreateServer();
|
||||
server.SetSiteAuditQueue(queue);
|
||||
|
||||
var response = await server.PullTraceEvents(
|
||||
new PullTraceEventsRequest { ExecutionIds = { Guid.NewGuid().ToString("D") }, MaxEvents = 10 }, NewContext());
|
||||
Assert.Empty(response.Events);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
using System.Threading.Channels;
|
||||
using Akka.Actor;
|
||||
using Akka.TestKit.Xunit2;
|
||||
using Google.Protobuf.WellKnownTypes;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Streaming;
|
||||
using ZB.MOM.WW.ScadaBridge.Communication.Actors;
|
||||
using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Flow Debugger (design 2026-09-05 §5.3/§5.4): <c>AttributeValueUpdate</c> fields 7/8 —
|
||||
/// <see cref="StreamRelayActor"/> stamps <c>source_execution_id</c>/<c>trace</c> on the way
|
||||
/// out and <see cref="SiteStreamGrpcClient"/> parses them back; an unstamped change (and an
|
||||
/// older site's frame) round-trips to null/false.
|
||||
/// </summary>
|
||||
public class StreamRelayTraceStampTests : TestKit
|
||||
{
|
||||
private static SiteStreamEvent Relay(AttributeValueChanged change, ActorSystem sys)
|
||||
{
|
||||
var channel = Channel.CreateUnbounded<SiteStreamEvent>();
|
||||
var actor = sys.ActorOf(Props.Create(() => new StreamRelayActor("corr", channel.Writer)));
|
||||
actor.Tell(change);
|
||||
SiteStreamEvent? evt = null;
|
||||
for (var i = 0; i < 40 && !channel.Reader.TryRead(out evt); i++) Thread.Sleep(50);
|
||||
Assert.NotNull(evt);
|
||||
return evt!;
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void TracedChange_IsStampedOnTheWire_AndParsedBack()
|
||||
{
|
||||
var source = Guid.NewGuid();
|
||||
var now = new DateTimeOffset(2026, 9, 5, 12, 0, 0, TimeSpan.Zero);
|
||||
var change = new AttributeValueChanged("P1", "Status", "Status", "Running", "Good", now, SourceExecutionId: source, Trace: true);
|
||||
|
||||
var evt = Relay(change, Sys);
|
||||
Assert.Equal(source.ToString("D"), evt.AttributeChanged.SourceExecutionId);
|
||||
Assert.True(evt.AttributeChanged.Trace);
|
||||
|
||||
var back = Assert.IsType<AttributeValueChanged>(SiteStreamGrpcClient.ConvertToDomainEvent(evt));
|
||||
Assert.Equal(source, back.SourceExecutionId);
|
||||
Assert.True(back.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void UnstampedChange_RoundTripsToNullAndFalse()
|
||||
{
|
||||
var change = new AttributeValueChanged("P1", "Status", "Status", "Idle", "Good", DateTimeOffset.UtcNow);
|
||||
|
||||
var evt = Relay(change, Sys);
|
||||
Assert.Equal(string.Empty, evt.AttributeChanged.SourceExecutionId);
|
||||
Assert.False(evt.AttributeChanged.Trace);
|
||||
|
||||
var back = Assert.IsType<AttributeValueChanged>(SiteStreamGrpcClient.ConvertToDomainEvent(evt));
|
||||
Assert.Null(back.SourceExecutionId);
|
||||
Assert.False(back.Trace);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void OlderSiteFrame_WithoutTheFields_ParsesToNullAndFalse()
|
||||
{
|
||||
var evt = new SiteStreamEvent
|
||||
{
|
||||
CorrelationId = "c",
|
||||
AttributeChanged = new AttributeValueUpdate
|
||||
{
|
||||
InstanceUniqueName = "P1", AttributePath = "A", AttributeName = "A", Value = "1",
|
||||
Quality = Quality.Good, Timestamp = Timestamp.FromDateTimeOffset(DateTimeOffset.UtcNow),
|
||||
},
|
||||
};
|
||||
var back = Assert.IsType<AttributeValueChanged>(SiteStreamGrpcClient.ConvertToDomainEvent(evt));
|
||||
Assert.Null(back.SourceExecutionId);
|
||||
Assert.False(back.Trace);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user