Add XML docs required by CommentChecker fixes
All checks were successful
NuGet Package Publish / nuget (push) Successful in 1m13s

This commit is contained in:
Joseph Doherty
2026-02-23 04:39:25 -05:00
parent cce24fa8f3
commit 6c4714f666
15 changed files with 444 additions and 15 deletions

View File

@@ -10,18 +10,24 @@ namespace ZB.MOM.WW.CDBBC.E2E.Benchmark.Tests;
[SimpleJob(launchCount: 1, warmupCount: 0, iterationCount: 1)]
public class OfflineResyncThroughputBenchmarks
{
private const int BacklogOperationCount = 10_000;
private const int BacklogOperationCount = 100_000;
private BenchmarkPeerNode _onlineNode = null!;
private BenchmarkPeerNode _offlineNode = null!;
private int _runSequence;
private string _currentPrefix = string.Empty;
/// <summary>
/// Sets up benchmark resources for offline resync scenarios.
/// </summary>
[GlobalSetup]
public Task GlobalSetupAsync()
{
return Task.CompletedTask;
}
/// <summary>
/// Handles benchmark teardown for offline resync scenarios.
/// </summary>
[GlobalCleanup]
public Task GlobalCleanupAsync()
{
@@ -30,6 +36,9 @@ public class OfflineResyncThroughputBenchmarks
return Task.CompletedTask;
}
/// <summary>
/// Prepares write-only workload state for the 100K throughput benchmark.
/// </summary>
[IterationSetup(Target = nameof(OfflineBacklogWriteThroughput100k))]
public void SetupOfflineWriteThroughput()
{
@@ -37,12 +46,18 @@ public class OfflineResyncThroughputBenchmarks
InitializeIterationNodesAsync().GetAwaiter().GetResult();
}
[Benchmark(Description = "Offline backlog write throughput (10K ops)", OperationsPerInvoke = BacklogOperationCount)]
/// <summary>
/// Measures offline backlog write throughput for 100K operations.
/// </summary>
[Benchmark(Description = "Offline backlog write throughput (100K ops)", OperationsPerInvoke = BacklogOperationCount)]
public async Task OfflineBacklogWriteThroughput100k()
{
await WriteBatchAsync(_currentPrefix, BacklogOperationCount);
}
/// <summary>
/// Prepares nodes and backlog before the re-sync benchmark iteration.
/// </summary>
[IterationSetup(Target = nameof(OfflineNodeResyncDurationAfter100kBacklog))]
public void SetupOfflineResyncBenchmark()
{
@@ -51,7 +66,10 @@ public class OfflineResyncThroughputBenchmarks
WriteBatchAsync(_currentPrefix, BacklogOperationCount).GetAwaiter().GetResult();
}
[Benchmark(Description = "Offline node re-sync duration after 10K backlog")]
/// <summary>
/// Measures re-sync duration after processing a 100K-entry offline backlog.
/// </summary>
[Benchmark(Description = "Offline node re-sync duration after 100K backlog")]
public async Task OfflineNodeResyncDurationAfter100kBacklog()
{
await _offlineNode.StartAsync();