Skip to content

Fix flaky CanRunOnIdleTask by polling instead of sleeping #2314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andyleejordan wants to merge 3 commits into
base: main
Choose a base branch
from
+33 −16
Open

Fix flaky CanRunOnIdleTask by polling instead of sleeping #2314

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1393db
Make `OnIdle` tests deterministic by polling instead of sleeping
andyleejordan Jun 16, 2026
a3ba818
Move `OnIdle` assertion into helper and drop list return
andyleejordan Jun 17, 2026
fc97a40
Assert `OnIdle` poll result with `Assert.True`
andyleejordan Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 33 additions & 16 deletions test/PowerShellEditorServices.Test/Session/PsesInternalHostTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,37 @@ namespace PowerShellEditorServices.Test.Session
using System.Management.Automation;
using System.Management.Automation.Runspaces;

// Shared helpers for the OnIdle engine-event tests, whose handler actions are
// dispatched asynchronously by PowerShell's event manager.
internal static class OnIdleTestHelpers
{
// The OnIdle engine event's -Action scriptblock is not run inline when
// OnPowerShellIdle generates the event; PowerShell enqueues it as a pending
// action and dispatches it asynchronously around subsequent pipeline executions.
// So instead of sleeping a fixed amount, poll the handler variable until it
// reports true (each read is itself a pipeline, giving the engine another chance
// to drain the pending action), then assert it was set within the timeout.
internal static async Task AssertHandledAsync(PsesInternalHost psesHost, string variableName)
{
using CancellationTokenSource cancellationSource = new(millisecondsDelay: 15000);
bool handled = false;
while (!handled && !cancellationSource.IsCancellationRequested)
{
IReadOnlyList<bool> result = await psesHost.ExecutePSCommandAsync<bool>(
new PSCommand().AddScript(variableName),
CancellationToken.None);

handled = result.Count > 0 && result[0];
if (!handled)
{
await Task.Delay(200);
}
}

Assert.True(handled, $"Timed out waiting for the OnIdle handler to set '{variableName}'.");
}
}

[Trait("Category", "PsesInternalHost")]
public class PsesInternalHostTests : IAsyncLifetime
{
Expand Down Expand Up @@ -203,14 +234,7 @@ await psesHost.ExecuteDelegateAsync(
(_, _) => psesHost.OnPowerShellIdle(CancellationToken.None),
CancellationToken.None);

// TODO: Why is this racy?
Thread.Sleep(2000);

handled = await psesHost.ExecutePSCommandAsync<bool>(
new PSCommand().AddScript("$handled"),
CancellationToken.None);

Assert.Collection(handled, Assert.True);
await OnIdleTestHelpers.AssertHandledAsync(psesHost, "$handled");
}

[Fact]
Expand Down Expand Up @@ -303,14 +327,7 @@ await psesHost.ExecuteDelegateAsync(
(_, _) => psesHost.OnPowerShellIdle(CancellationToken.None),
CancellationToken.None);

// TODO: Why is this racy?
Thread.Sleep(2000);

IReadOnlyList<bool> handled = await psesHost.ExecutePSCommandAsync<bool>(
new PSCommand().AddScript("$handledInProfile"),
CancellationToken.None);

Assert.Collection(handled, Assert.True);
await OnIdleTestHelpers.AssertHandledAsync(psesHost, "$handledInProfile");
}
}
}
Loading