Skip to content

Commit 819bc3a

Browse files
github-actions[bot]radicalthaystg
authored
[release/6.0] [wasm][debugger] Fix pause on exception behavior (#58895)
Co-authored-by: Ankit Jain <radical@gmail.com> Co-authored-by: Thays <thaystg@gmail.com>
1 parent 56c8a9c commit 819bc3a

5 files changed

Lines changed: 100 additions & 43 deletions

File tree

‎src/mono/wasm/debugger/BrowserDebugProxy/DevToolsHelper.cs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,14 @@ internal enum StepKind
267267
Out
268268
}
269269

270+
internal enum PauseOnExceptionsKind
271+
{
272+
Unset,
273+
None,
274+
Uncaught,
275+
All
276+
}
277+
270278
internal class ExecutionContext
271279
{
272280
public string DebugId { get; set; }
@@ -279,8 +287,7 @@ internal class ExecutionContext
279287
public int Id { get; set; }
280288
public object AuxData { get; set; }
281289

282-
public bool PauseOnUncaught { get; set; }
283-
public bool PauseOnCaught { get; set; }
290+
public PauseOnExceptionsKind PauseOnExceptions { get; set; }
284291

285292
public List<Frame> CallStack { get; set; }
286293

‎src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,7 @@ protected override async Task<bool> AcceptEvent(SessionId sessionId, string meth
134134
{
135135
string exceptionError = args?["exceptionDetails"]?["exception"]?["value"]?.Value<string>();
136136
if (exceptionError == sPauseOnUncaught || exceptionError == sPauseOnCaught)
137-
{
138137
return true;
139-
}
140138
}
141139
break;
142140
}
@@ -156,17 +154,19 @@ protected override async Task<bool> AcceptEvent(SessionId sessionId, string meth
156154
if (exceptionError == sPauseOnUncaught)
157155
{
158156
await SendCommand(sessionId, "Debugger.resume", new JObject(), token);
159-
context.PauseOnUncaught = true;
157+
if (context.PauseOnExceptions == PauseOnExceptionsKind.Unset)
158+
context.PauseOnExceptions = PauseOnExceptionsKind.Uncaught;
160159
return true;
161160
}
162161
if (exceptionError == sPauseOnCaught)
163162
{
164163
await SendCommand(sessionId, "Debugger.resume", new JObject(), token);
165-
context.PauseOnCaught = true;
164+
context.PauseOnExceptions = PauseOnExceptionsKind.All;
166165
return true;
167166
}
168167
}
169168
}
169+
170170
//TODO figure out how to stich out more frames and, in particular what happens when real wasm is on the stack
171171
string top_func = args?["callFrames"]?[0]?["functionName"]?.Value<string>();
172172
switch (top_func) {
@@ -442,23 +442,16 @@ protected override async Task<bool> AcceptCommand(MessageId id, string method, J
442442
case "Debugger.setPauseOnExceptions":
443443
{
444444
string state = args["state"].Value<string>();
445-
if (!context.IsRuntimeReady)
445+
context.PauseOnExceptions = state switch
446446
{
447-
context.PauseOnCaught = false;
448-
context.PauseOnUncaught = false;
449-
switch (state)
450-
{
451-
case "all":
452-
context.PauseOnCaught = true;
453-
context.PauseOnUncaught = true;
454-
break;
455-
case "uncaught":
456-
context.PauseOnUncaught = true;
457-
break;
458-
}
459-
}
460-
else
461-
await SdbHelper.EnableExceptions(id, state, token);
447+
"all" => PauseOnExceptionsKind.All,
448+
"uncaught" => PauseOnExceptionsKind.Uncaught,
449+
"none" => PauseOnExceptionsKind.None,
450+
_ => PauseOnExceptionsKind.Unset
451+
};
452+
453+
if (context.IsRuntimeReady)
454+
await SdbHelper.EnableExceptions(id, context.PauseOnExceptions, token);
462455
// Pass this on to JS too
463456
return false;
464457
}
@@ -875,7 +868,7 @@ private async Task<bool> OnReceiveDebuggerAgentEvent(SessionId sessionId, JObjec
875868
int object_id = retDebuggerCmdReader.ReadInt32();
876869
var caught = retDebuggerCmdReader.ReadByte();
877870
var exceptionObject = await SdbHelper.GetObjectValues(sessionId, object_id, GetObjectCommandOptions.WithProperties | GetObjectCommandOptions.OwnProperties, token);
878-
var exceptionObjectMessage = exceptionObject.FirstOrDefault(attr => attr["name"].Value<string>().Equals("message"));
871+
var exceptionObjectMessage = exceptionObject.FirstOrDefault(attr => attr["name"].Value<string>().Equals("_message"));
879872
var data = JObject.FromObject(new
880873
{
881874
type = "object",
@@ -965,6 +958,7 @@ private async Task OnDefaultContext(SessionId sessionId, ExecutionContext contex
965958
{
966959
context.BreakpointRequests[kvp.Key] = kvp.Value.Clone();
967960
}
961+
context.PauseOnExceptions = previousContext.PauseOnExceptions;
968962
}
969963

970964
if (await IsRuntimeAlreadyReadyAlready(sessionId, token))
@@ -1228,10 +1222,8 @@ private async Task<DebugStore> RuntimeReady(SessionId sessionId, CancellationTok
12281222
Log("verbose", $"Failed to clear breakpoints");
12291223
}
12301224

1231-
if (context.PauseOnCaught && context.PauseOnUncaught)
1232-
await SdbHelper.EnableExceptions(sessionId, "all", token);
1233-
else if (context.PauseOnUncaught)
1234-
await SdbHelper.EnableExceptions(sessionId, "uncaught", token);
1225+
if (context.PauseOnExceptions != PauseOnExceptionsKind.None && context.PauseOnExceptions != PauseOnExceptionsKind.Unset)
1226+
await SdbHelper.EnableExceptions(sessionId, context.PauseOnExceptions, token);
12351227

12361228
await SdbHelper.SetProtocolVersion(sessionId, token);
12371229
await SdbHelper.EnableReceiveRequests(sessionId, EventKind.UserBreak, token);
@@ -1393,8 +1385,19 @@ private async Task AttachToTarget(SessionId sessionId, CancellationToken token)
13931385
// see https://github.com/mono/mono/issues/19549 for background
13941386
if (sessions.Add(sessionId))
13951387
{
1396-
string checkUncaughtExceptions = $"throw \"{sPauseOnUncaught}\";";
1397-
string checkCaughtExceptions = $"try {{throw \"{sPauseOnCaught}\";}} catch {{}}";
1388+
string checkUncaughtExceptions = string.Empty;
1389+
string checkCaughtExceptions = string.Empty;
1390+
1391+
//we only need this check if it's a non-vs debugging
1392+
if (sessionId == SessionId.Null)
1393+
{
1394+
if (!contexts.TryGetValue(sessionId, out ExecutionContext context) || context.PauseOnExceptions == PauseOnExceptionsKind.Unset)
1395+
{
1396+
checkUncaughtExceptions = $"throw \"{sPauseOnUncaught}\";";
1397+
checkCaughtExceptions = $"try {{throw \"{sPauseOnCaught}\";}} catch {{}}";
1398+
}
1399+
}
1400+
13981401
await SendMonoCommand(sessionId, new MonoCommands("globalThis.dotnetDebugger = true"), token);
13991402
Result res = await SendCommand(sessionId,
14001403
"Page.addScriptToEvaluateOnNewDocument",

‎src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2210,23 +2210,31 @@ public async Task<JArray> GetArrayValues(SessionId sessionId, int arrayId, Cance
22102210
}
22112211
return array;
22122212
}
2213-
public async Task<bool> EnableExceptions(SessionId sessionId, string state, CancellationToken token)
2213+
public async Task<bool> EnableExceptions(SessionId sessionId, PauseOnExceptionsKind state, CancellationToken token)
22142214
{
2215+
if (state == PauseOnExceptionsKind.Unset)
2216+
{
2217+
logger.LogDebug($"Trying to setPauseOnExceptions using status Unset");
2218+
return false;
2219+
}
2220+
22152221
var commandParams = new MemoryStream();
22162222
var commandParamsWriter = new MonoBinaryWriter(commandParams);
22172223
commandParamsWriter.Write((byte)EventKind.Exception);
22182224
commandParamsWriter.Write((byte)SuspendPolicy.None);
22192225
commandParamsWriter.Write((byte)1);
22202226
commandParamsWriter.Write((byte)ModifierKind.ExceptionOnly);
22212227
commandParamsWriter.Write(0); //exc_class
2222-
if (state == "all")
2228+
if (state == PauseOnExceptionsKind.All)
22232229
commandParamsWriter.Write((byte)1); //caught
22242230
else
22252231
commandParamsWriter.Write((byte)0); //caught
2226-
if (state == "uncaught" || state == "all")
2232+
2233+
if (state == PauseOnExceptionsKind.Uncaught || state == PauseOnExceptionsKind.All)
22272234
commandParamsWriter.Write((byte)1); //uncaught
22282235
else
22292236
commandParamsWriter.Write((byte)0); //uncaught
2237+
22302238
commandParamsWriter.Write((byte)1);//subclasses
22312239
commandParamsWriter.Write((byte)0);//not_filtered_feature
22322240
commandParamsWriter.Write((byte)0);//everything_else

‎src/mono/wasm/debugger/DebuggerTestSuite/ExceptionTests.cs‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -232,10 +232,11 @@ await CheckValue(pause_location["data"], JObject.FromObject(new
232232
CheckString(exception_members, "message", "not implemented uncaught");
233233
}
234234

235-
[Fact]
236-
public async Task ExceptionTestAllWithReload()
235+
[Theory]
236+
[InlineData("[debugger-test] DebuggerTests.ExceptionTestsClassDefault:TestExceptions", "System.Exception", 76)]
237+
[InlineData("[debugger-test] DebuggerTests.ExceptionTestsClass:TestExceptions", "DebuggerTests.CustomException", 28)]
238+
public async Task ExceptionTestAllWithReload(string entry_method_name, string class_name, int line_number)
237239
{
238-
string entry_method_name = "[debugger-test] DebuggerTests.ExceptionTestsClass:TestExceptions";
239240
var debugger_test_loc = "dotnet://debugger-test.dll/debugger-exception-test.cs";
240241

241242
await SetPauseOnException("all");
@@ -255,7 +256,7 @@ public async Task ExceptionTestAllWithReload()
255256
i++;
256257
}
257258

258-
259+
259260
var eval_expr = "window.setTimeout(function() { invoke_static_method (" +
260261
$"'{entry_method_name}'" +
261262
"); }, 1);";
@@ -270,29 +271,31 @@ await CheckValue(pause_location["data"], JObject.FromObject(new
270271
{
271272
type = "object",
272273
subtype = "error",
273-
className = "DebuggerTests.CustomException",
274-
uncaught = false
274+
className = class_name,
275+
uncaught = false,
276+
description = "not implemented caught"
275277
}), "exception0.data");
276278

277279
var exception_members = await GetProperties(pause_location["data"]["objectId"]?.Value<string>());
278-
CheckString(exception_members, "message", "not implemented caught");
280+
CheckString(exception_members, "_message", "not implemented caught");
279281

280282
pause_location = await WaitForManagedException(null);
281283
AssertEqual("run", pause_location["callFrames"]?[0]?["functionName"]?.Value<string>(), "pause1");
282284

283285
//stop in the uncaught exception
284-
CheckLocation(debugger_test_loc, 28, 16, scripts, pause_location["callFrames"][0]["location"]);
286+
CheckLocation(debugger_test_loc, line_number, 16, scripts, pause_location["callFrames"][0]["location"]);
285287

286288
await CheckValue(pause_location["data"], JObject.FromObject(new
287289
{
288290
type = "object",
289291
subtype = "error",
290-
className = "DebuggerTests.CustomException",
291-
uncaught = true
292+
className = class_name,
293+
uncaught = true,
294+
description = "not implemented uncaught"
292295
}), "exception1.data");
293296

294297
exception_members = await GetProperties(pause_location["data"]["objectId"]?.Value<string>());
295-
CheckString(exception_members, "message", "not implemented uncaught");
298+
CheckString(exception_members, "_message", "not implemented uncaught");
296299
}
297300

298301

‎src/mono/wasm/debugger/tests/debugger-test/debugger-exception-test.cs‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,40 @@ public CustomException(string message)
5252
this.message = message;
5353
}
5454
}
55+
56+
public class ExceptionTestsClassDefault
57+
{
58+
public class TestCaughtException
59+
{
60+
public void run()
61+
{
62+
try
63+
{
64+
throw new Exception("not implemented caught");
65+
}
66+
catch
67+
{
68+
Console.WriteLine("caught exception");
69+
}
70+
}
71+
}
72+
73+
public class TestUncaughtException
74+
{
75+
public void run()
76+
{
77+
throw new Exception("not implemented uncaught");
78+
}
79+
}
80+
81+
public static void TestExceptions()
82+
{
83+
TestCaughtException f = new TestCaughtException();
84+
f.run();
85+
86+
TestUncaughtException g = new TestUncaughtException();
87+
g.run();
88+
}
89+
90+
}
5591
}

0 commit comments

Comments
 (0)