Skip to content

[wasm][debugger] Retry after timeout on debugger tests on CI #84080

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

Merged
merged 17 commits into from
Apr 5, 2023
Merged

[wasm][debugger] Retry after timeout on debugger tests on CI #84080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
4f17dc7
Adding --disable-software-rasterizer as suggested by @lewing
thaystg Mar 29, 2023
c00bac2
Trying to add --no-sandbox also when CI is detected
thaystg Mar 29, 2023
a37daf6
TRying to automatically retry if a test timeout.
thaystg Mar 30, 2023
fac595a
fix compilation error
thaystg Mar 30, 2023
0559358
Try another fix
thaystg Mar 30, 2023
76670c1
Fix compilation
thaystg Mar 30, 2023
bdcd4d3
retrying if timeout OpenSessionAsync.
thaystg Mar 30, 2023
9562f31
Adding more log
thaystg Mar 30, 2023
c6a0cbf
Fix retry
thaystg Mar 30, 2023
306d87f
Fix compilation
thaystg Mar 30, 2023
f2e9abb
Create another id for the retry
thaystg Mar 31, 2023
fa0e32e
Fix compilation
thaystg Mar 31, 2023
f712318
Another fix.
thaystg Mar 31, 2023
ca98402
Fix compilation
thaystg Mar 31, 2023
52216a0
Adding more log
thaystg Mar 31, 2023
d691494
Remove unrelated change
thaystg Apr 3, 2023
4a623f4
Update src/mono/wasm/debugger/DebuggerTestSuite/DebuggerTestBase.cs
thaystg Apr 5, 2023
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
2 changes: 1 addition & 1 deletion src/mono/wasm/debugger/DebuggerTestSuite/BadHarnessInitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public async Task InvalidInitCommands()

await Ready();

var ae = await Assert.ThrowsAsync<ArgumentException>(async () => await insp.OpenSessionAsync(fn, TestTimeout));
var ae = await Assert.ThrowsAsync<ArgumentException>(async () => await insp.OpenSessionAsync(fn, "", TestTimeout));
Assert.Contains(bad_cmd_name, ae.Message);
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/mono/wasm/debugger/DebuggerTestSuite/ChromeProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public async Task StartBrowserAndProxyAsync(HttpContext context,
// for WIndows setting --lang arg is enough
if (!OperatingSystem.IsWindows())
Environment.SetEnvironmentVariable("LANGUAGE", locale);
ProcessStartInfo psi = GetProcessStartInfo(s_browserPath.Value, GetInitParms(remoteDebuggingPort, locale), targetUrl);
ProcessStartInfo psi = GetProcessStartInfo(s_browserPath.Value, GetInitParms(remoteDebuggingPort, locale), "about:blank");
line = await LaunchHostAsync(
psi,
context,
Expand Down
25 changes: 21 additions & 4 deletions src/mono/wasm/debugger/DebuggerTestSuite/DebuggerTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ public static WasmHost RunningOn
static string s_debuggerTestAppPath;
static int s_idCounter = -1;

public int Id { get; init; }

public int Id { get; set; }
public string driver;

public static string DebuggerTestAppPath
{
get
Expand Down Expand Up @@ -130,7 +131,7 @@ static DebuggerTestBase()
Directory.Delete(TempPath, recursive: true);
}

public DebuggerTestBase(ITestOutputHelper testOutput, string locale, string driver = "debugger-driver.html")
public DebuggerTestBase(ITestOutputHelper testOutput, string locale, string _driver = "debugger-driver.html")
{
_env = new TestEnvironment(testOutput);
_testOutput = testOutput;
Expand All @@ -141,12 +142,14 @@ public DebuggerTestBase(ITestOutputHelper testOutput, string locale, string driv

insp = new Inspector(Id, _testOutput);
cli = insp.Client;
driver = _driver;
scripts = SubscribeToScripts(insp);
startTask = TestHarnessProxy.Start(DebuggerTestAppPath, driver, UrlToRemoteDebugging(), testOutput, locale);
}

public virtual async Task InitializeAsync()
{
bool retry = true;
Func<InspectorClient, CancellationToken, List<(string, Task<Result>)>> fn = (client, token) =>
{
Func<string, JObject, (string, Task<Result>)> getInitCmdFn = (cmd, args) => (cmd, client.SendCommand(cmd, args, token));
Expand All @@ -164,7 +167,21 @@ public virtual async Task InitializeAsync()
};

await Ready();
await insp.OpenSessionAsync(fn, TestTimeout);
try {
await insp.OpenSessionAsync(fn, $"http://{TestHarnessProxy.Endpoint.Authority}/{driver}", TestTimeout);
}
catch (TaskCanceledException exc) //if timed out for some reason let's try again
{
if (!retry)
throw exc;
retry = false;
_testOutput.WriteLine($"Let's retry: {exc.ToString()}");
Id = Interlocked.Increment(ref s_idCounter);
insp = new Inspector(Id, _testOutput);
cli = insp.Client;
scripts = SubscribeToScripts(insp);
await insp.OpenSessionAsync(fn, $"http://{TestHarnessProxy.Endpoint.Authority}/{driver}", TestTimeout);
}
}

public virtual async Task DisposeAsync()
Expand Down
2 changes: 1 addition & 1 deletion src/mono/wasm/debugger/DebuggerTestSuite/DebuggerTestFirefox.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public override async Task InitializeAsync()
};

await Ready();
await insp.OpenSessionAsync(fn, TestTimeout);
await insp.OpenSessionAsync(fn, "", TestTimeout);
}

internal override Dictionary<string, string> SubscribeToScripts(Inspector insp)
Expand Down
12 changes: 9 additions & 3 deletions src/mono/wasm/debugger/DebuggerTestSuite/Inspector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Inspector
ConcurrentQueue<(string, JObject)> nextNotifications = new (); //in a multithreaded runtime we can receive more than one pause at same time
public const string PAUSE = "pause";
public const string APP_READY = "app-ready";
public CancellationToken Token { get; }
public CancellationToken Token { get; set; }
public InspectorClient Client { get; }
public DebuggerProxyBase? Proxy { get; }
public bool DetectAndFailOnAssertions { get; set; } = true;
Expand Down Expand Up @@ -351,13 +351,12 @@ public async Task LaunchBrowser(DateTime start, TimeSpan span)
});
}

public async Task OpenSessionAsync(Func<InspectorClient, CancellationToken, List<(string, Task<Result>)>> getInitCmds, TimeSpan span)
public async Task OpenSessionAsync(Func<InspectorClient, CancellationToken, List<(string, Task<Result>)>> getInitCmds, string urlToInspect, TimeSpan span)
{
var start = DateTime.Now;
try
{
await LaunchBrowser(start, span);

var init_cmds = getInitCmds(Client, _cancellationTokenSource.Token);

Task<Result> readyTask = Task.Run(async () => Result.FromJson(await WaitFor(APP_READY)));
Expand All @@ -373,7 +372,10 @@ public async Task OpenSessionAsync(Func<InspectorClient, CancellationToken, List
string cmd_name = init_cmds[cmdIdx].Item1;

if (_isFailingWithException is not null)
{
_logger.LogError($"_isFailingWithException. {_isFailingWithException}.");
throw _isFailingWithException;
}

if (completedTask.IsCanceled)
{
Expand All @@ -388,11 +390,15 @@ public async Task OpenSessionAsync(Func<InspectorClient, CancellationToken, List
_logger.LogError($"Command {cmd_name} failed with {completedTask.Exception}. Remaining commands: {RemainingCommandsToString(cmd_name, init_cmds)}.");
throw completedTask.Exception!;
}

await Client.ProcessCommand(completedTask.Result, _cancellationTokenSource.Token);
Result res = completedTask.Result;

if (!res.IsOk)
throw new ArgumentException($"Command {cmd_name} failed with: {res.Error}. Remaining commands: {RemainingCommandsToString(cmd_name, init_cmds)}");

if (DebuggerTestBase.RunningOnChrome && cmd_name == "Debugger.enable")
Copy link
Member

@lewing lewing Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels a little odd to pass an empty string just to ignore it unless it is chrome and is there ever a case where we'd try to navigate to "" on chrome?

Copy link
Member Author

@thaystg thaystg Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if I understood the question.
Before this change we startup the chrome passing the url that it should navigate. And on my tests I saw that sometimes it was timing out the debugger.enable command. So I decided to first startup the chrome navigating to about:blank then send the Debugger.enabled and then when we receive the answer we send the Page.navigate to the wasm page.
On firefox we don't need to navigate to the page because we are still starting the browser passing the wasm page as parameter.

await Client.SendCommand("Page.navigate", JObject.FromObject(new { url = urlToInspect }), _cancellationTokenSource.Token);
init_cmds.RemoveAt(cmdIdx);
}

Expand Down