dohertj2/natsdotnet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add XML doc comments to server types and fix flaky test timings

Browse Source 
Add XML doc comments to public properties across EventTypes, Connz, Varz,
NatsOptions, StreamConfig, IStreamStore, FileStore, MqttListener,
MqttSessionStore, MessageTraceContext, and JetStreamApiResponse. Fix flaky
tests by increasing timing margins (ResponseTracker expiry 1ms→50ms,
sleep 50ms→200ms) and document known flaky test patterns in tests.md.
This commit is contained in:
Joseph Doherty
2026-03-13 18:47:48 -04:00
parent 1d4b87e5f9
commit 88a82ee860
24 changed files with 2874 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tests/NATS.E2E.Tests/AccountIsolationTests.cs
View File

@@ -42,7 +42,7 @@ public class AccountIsolationTests(AccountServerFixture fixture)
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
var readTask = subscription.Msgs.ReadAsync(cts.Token).AsTask();
var completed = await Task.WhenAny(readTask, Task.Delay(1000));
var completed = await Task.WhenAny(readTask, Task.Delay(3000));
completed.ShouldNotBe(readTask);
}
@@ -75,7 +75,7 @@ public class AccountIsolationTests(AccountServerFixture fixture)
using var ctsBNoMsg = new CancellationTokenSource(TimeSpan.FromSeconds(5));
var readBTask = subscriptionB.Msgs.ReadAsync(ctsBNoMsg.Token).AsTask();
var completedB = await Task.WhenAny(readBTask, Task.Delay(1000));
var completedB = await Task.WhenAny(readBTask, Task.Delay(3000));
completedB.ShouldNotBe(readBTask);
// Cancel the abandoned read so it doesn't consume the next message
await ctsBNoMsg.CancelAsync();
@@ -90,7 +90,7 @@ public class AccountIsolationTests(AccountServerFixture fixture)
using var ctsANoMsg = new CancellationTokenSource(TimeSpan.FromSeconds(5));
var readATask2 = subscriptionA.Msgs.ReadAsync(ctsANoMsg.Token).AsTask();
var completedA2 = await Task.WhenAny(readATask2, Task.Delay(1000));
var completedA2 = await Task.WhenAny(readATask2, Task.Delay(3000));
completedA2.ShouldNotBe(readATask2);
await ctsANoMsg.CancelAsync();
try { await readATask2; } catch (OperationCanceledException) { }

4
tests/NATS.E2E.Tests/CoreMessagingTests.cs
View File

@@ -62,7 +62,7 @@ public class CoreMessagingTests(NatsServerFixture fixture)
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
var readTask = subscription.Msgs.ReadAsync(cts.Token).AsTask();
var winner = await Task.WhenAny(readTask, Task.Delay(1000));
var winner = await Task.WhenAny(readTask, Task.Delay(3000));
winner.ShouldNotBe(readTask);
}
@@ -327,7 +327,7 @@ public class CoreMessagingTests(NatsServerFixture fixture)
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
var readTask = subscription.Msgs.ReadAsync(cts.Token).AsTask();
var winner = await Task.WhenAny(readTask, Task.Delay(1000));
var winner = await Task.WhenAny(readTask, Task.Delay(3000));
winner.ShouldNotBe(readTask);
}