Joseph Doherty
cc1a7ec687
- EnsureEventPumpStarted replaces a pump created for an older registry session (the reopen -> replay window still held the dead session's pump, so an advise there lost its initial value and the replay skipped it); RestartEventPumpForReplay keeps a pump already on the current session. - SubscribeAsync, read-via-subscribe and ReplayAsync also await the bounded StreamRequested wait before advising, not just the probes. - TryEnsureEventPumpStarted tolerates a teardown flipping _runtimeStopping mid-check; the probe hook honours an already-cancelled seed token. - StreamRequested is documented as narrowing, not closing, the attach race. - Tests: reopen-window probe test, EventPump.StreamRequested tests, and the FixRound1 fresh-pump assertion now waits on a positive control. Claude-Session: https://claude.ai/code/session_01GT67AD99zQQqpLCVm3p7xk
63 lines
3.1 KiB
C#
63 lines
3.1 KiB
C#
using System.Runtime.CompilerServices;
|
|
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
using ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Runtime;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests.Runtime;
|
|
|
|
/// <summary>
|
|
/// #865: <see cref="EventPump.StreamRequested"/> — what advise paths wait on so an initial value is
|
|
/// never pushed before the stream is requested. It must complete once the RPC is started (before any
|
|
/// event), and must never strand a waiter on a pump whose loop died before getting that far.
|
|
/// </summary>
|
|
public sealed class EventPumpStreamRequestedTests
|
|
{
|
|
private sealed class ScriptedSubscriber(Func<CancellationToken, IAsyncEnumerable<MxEvent>> stream) : IGalaxySubscriber
|
|
{
|
|
public Task<IReadOnlyList<SubscribeResult>> SubscribeBulkAsync(
|
|
IReadOnlyList<string> fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken)
|
|
=> Task.FromResult<IReadOnlyList<SubscribeResult>>([]);
|
|
|
|
public Task UnsubscribeBulkAsync(IReadOnlyList<int> itemHandles, CancellationToken cancellationToken) => Task.CompletedTask;
|
|
|
|
public IAsyncEnumerable<MxEvent> StreamEventsAsync(CancellationToken cancellationToken) => stream(cancellationToken);
|
|
}
|
|
|
|
/// <summary>A stream that is requested and then never yields: StreamRequested completes; the RPC started first.</summary>
|
|
[Fact]
|
|
public async Task Completes_once_the_stream_is_requested_before_any_event()
|
|
{
|
|
var rpcStarted = 0;
|
|
async IAsyncEnumerable<MxEvent> Never([EnumeratorCancellation] CancellationToken ct)
|
|
{
|
|
Interlocked.Exchange(ref rpcStarted, 1); // the synchronous first step — where a real call is created
|
|
await Task.Delay(Timeout.Infinite, ct).ConfigureAwait(false);
|
|
yield break;
|
|
}
|
|
|
|
await using var pump = new EventPump(new ScriptedSubscriber(Never), new SubscriptionRegistry());
|
|
pump.StreamRequested.IsCompleted.ShouldBeFalse("not before Start");
|
|
pump.Start();
|
|
|
|
await TestWait.ForAsync(pump.StreamRequested, "StreamRequested must complete once the stream call is started");
|
|
Volatile.Read(ref rpcStarted).ShouldBe(1, "StreamRequested must not precede the stream call");
|
|
}
|
|
|
|
/// <summary>A subscriber that throws before reaching the RPC still completes StreamRequested (no stranded waiter).</summary>
|
|
[Fact]
|
|
public async Task Completes_when_the_stream_fails_before_the_rpc()
|
|
{
|
|
var faulted = new TaskCompletionSource<Exception>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
await using var pump = new EventPump(
|
|
new ScriptedSubscriber(_ => throw new InvalidOperationException("not connected")),
|
|
new SubscriptionRegistry(),
|
|
onStreamFault: ex => faulted.TrySetResult(ex));
|
|
pump.Start();
|
|
|
|
await TestWait.ForAsync(pump.StreamRequested, "a dead pump must not strand a StreamRequested waiter");
|
|
(await TestWait.ForAsync(faulted.Task, "positive control: the failure is still reported as a stream fault"))
|
|
.ShouldBeOfType<InvalidOperationException>();
|
|
}
|
|
}
|