Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
80 lines
3.5 KiB
C#
80 lines
3.5 KiB
C#
using Bunit;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Shared;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Shared;
|
|
|
|
/// <summary>
|
|
/// Regression tests for disposing <c>DiffDialog</c> while it is open. <c>DiffDialog.OpenAsync</c> returns the
|
|
/// <c>TaskCompletionSource</c>'s task, completed only by <c>Close()</c>. If the
|
|
/// user navigated away while the dialog was open, <c>DisposeAsync</c> ran but
|
|
/// never completed the TCS — the awaiting caller was suspended forever and any
|
|
/// cleanup after the await was skipped. The fix completes the TCS in
|
|
/// <c>DisposeAsync</c>.
|
|
/// </summary>
|
|
public class DiffDialogTests : BunitContext
|
|
{
|
|
/// <summary>
|
|
/// DiffDialog applies/removes a body scroll-lock class and focuses the modal
|
|
/// via JS interop on open/close. Loose mode auto-completes those void calls
|
|
/// so a path that <c>await</c>s them (e.g. <c>DisposeAsync</c> →
|
|
/// <c>TryUnlockBodyAsync</c>) resumes instead of hanging on a never-completed
|
|
/// planned invocation, and no strict-mode unplanned-invocation exception
|
|
/// surfaces through the narrowed catch blocks.
|
|
/// </summary>
|
|
private void SetupBodyLockInterop()
|
|
{
|
|
JSInterop.Mode = JSRuntimeMode.Loose;
|
|
}
|
|
|
|
/// <summary>Verifies that disposing the dialog while it is open completes the pending task.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task DisposeAsync_WhileOpen_CompletesPendingTask()
|
|
{
|
|
SetupBodyLockInterop();
|
|
var cut = Render<DiffDialog>();
|
|
|
|
// Open the dialog; the returned task represents the caller's await.
|
|
// Block-bodied lambda so InvokeAsync sees a void delegate — it must NOT
|
|
// await the dialog's own (deliberately long-lived) task.
|
|
Task<bool> pending = null!;
|
|
await cut.InvokeAsync(
|
|
() => { pending = cut.Instance.ShowAsync("Compare", "before", "after"); });
|
|
|
|
Assert.False(pending.IsCompleted, "Dialog task should be pending while open.");
|
|
|
|
// Simulate navigating away while the dialog is still open.
|
|
await cut.InvokeAsync(async () => await cut.Instance.DisposeAsync());
|
|
|
|
// The awaiter must complete deterministically rather than hang forever.
|
|
var completed = await Task.WhenAny(pending, Task.Delay(TimeSpan.FromSeconds(2)));
|
|
Assert.Same(pending, completed);
|
|
Assert.True(pending.IsCompletedSuccessfully);
|
|
var result = await pending;
|
|
Assert.False(result, "Dismiss-on-dispose should resolve to false (not confirmed).");
|
|
}
|
|
|
|
/// <summary>Verifies that closing the dialog completes the pending task with true.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task Close_CompletesPendingTaskWithTrue()
|
|
{
|
|
SetupBodyLockInterop();
|
|
var cut = Render<DiffDialog>();
|
|
|
|
// Block-bodied lambda so InvokeAsync sees a void delegate — it must NOT
|
|
// await the dialog's own (deliberately long-lived) task.
|
|
Task<bool> pending = null!;
|
|
await cut.InvokeAsync(
|
|
() => { pending = cut.Instance.ShowAsync("Compare", "before", "after"); });
|
|
|
|
// Closing via the Close button completes the task with true.
|
|
await cut.InvokeAsync(() => cut.Find("button.btn-secondary").Click());
|
|
|
|
var completed = await Task.WhenAny(pending, Task.Delay(TimeSpan.FromSeconds(2)));
|
|
Assert.Same(pending, completed);
|
|
var result = await pending;
|
|
Assert.True(result);
|
|
}
|
|
}
|