Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[wasm][debugger] Fix debugger behavior when the type has ToString method overridden #76780

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 11 commits into from
Oct 11, 2022
Merged

[wasm][debugger] Fix debugger behavior when the type has ToString method overridden #76780

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
62d86f2
The description of an object that has ToString implemented should be …
thaystg Oct 8, 2022
0c124b8
Fix if cannot find ToString method.
thaystg Oct 8, 2022
8dcd0d4
removing my name of the code
thaystg Oct 8, 2022
87fc1a3
Implementing support for inherited classes with ToString overriden.
thaystg Oct 9, 2022
eabbc6b
Fix test cases.
thaystg Oct 9, 2022
7d9698a
Apply suggestions from code review
thaystg Oct 10, 2022
451b4ec
Adding more tests and addressing @radical comments
thaystg Oct 10, 2022
eadebf0
Adding tests for record
thaystg Oct 10, 2022
99b2429
Moving implementation of InvokeToStringAsync to sdbhelper and reuse i…
thaystg Oct 10, 2022
d11ed8f
Apply suggestions from code review
thaystg Oct 10, 2022
794a460
Addressing @radical comments.
thaystg Oct 10, 2022
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
Prev Previous commit
Next Next commit
Moving implementation of InvokeToStringAsync to sdbhelper and reuse i… 
…t on objects and valuetypes.
  • Loading branch information
@thaystg
thaystg committed Oct 10, 2022
commit 99b24293ffea1955dd80053329c918e353f4a087
44 changes: 3 additions & 41 deletions src/mono/wasm/debugger/BrowserDebugProxy/JObjectValueCreator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,45 +266,7 @@ async Task<string> GetNullObjectClassName()
return className;
}
}
private async Task<string> InvokeToStringAsync(List<int> typeIds, int objectId, CancellationToken token)
{
string description = "";
try {
foreach (var typeId in typeIds)
{
var typeInfo = await _sdbAgent.GetTypeInfo(typeId, token);
if (typeInfo == null || typeInfo.Name == "object")
continue;
{
MethodInfo methodInfo = typeInfo.Info.Methods.FirstOrDefault(m => m.Name == "ToString");
if (methodInfo != null)
{
int[] methodIds = await _sdbAgent.GetMethodIdsByName(typeId, "ToString", BindingFlags.DeclaredOnly, token);
if (methodIds != null)
{
foreach (var methodId in methodIds)
{
var methodInfoFromRuntime = await _sdbAgent.GetMethodInfo(methodId, token);
if (methodInfoFromRuntime.Info.GetParametersInfo().Length > 0)
continue;
var toString = await _sdbAgent.InvokeMethod(objectId, methodId, isValueType: false, token);
if (toString["value"]?["value"] != null)
{
description = toString["value"]?["value"].Value<string>();
}
}
}
break;
}
}
}
}
catch (Exception e)
{
_logger.LogDebug($"Error while evaluating ToString method: {e}");
}
return description;
}

private async Task<JObject> ReadAsObjectValue(MonoBinaryReader retDebuggerCmdReader, int typeIdFromAttribute, bool forDebuggerDisplayAttribute, CancellationToken token)
{
var objectId = retDebuggerCmdReader.ReadInt32();
Expand Down Expand Up @@ -334,8 +296,8 @@ private async Task<JObject> ReadAsObjectValue(MonoBinaryReader retDebuggerCmdRea
}
else
{
var toString = await InvokeToStringAsync(typeIds, objectId, token);
if (toString != "")
var toString = await _sdbAgent.InvokeToStringAsync(typeIds, false, false, objectId, BindingFlags.DeclaredOnly, token);
if (toString != null)
description = toString;
}
return Create<object>(value: null, type: "object", description: description, className: className, objectId: $"dotnet:object:{objectId}");
Expand Down
37 changes: 37 additions & 0 deletions src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1839,6 +1839,43 @@ public Task<JObject> InvokeMethod(DotnetObjectId dotnetObjectId, CancellationTok
: throw new ArgumentException($"Cannot invoke method with id {methodId} on {dotnetObjectId}", nameof(dotnetObjectId));
}

public async Task<string> InvokeToStringAsync(List<int> typeIds, bool isValueType, bool isEnum, int objectId, BindingFlags extraFlags, CancellationToken token)
Copy link
Member

Choose a reason for hiding this comment

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

nit: extraFlags could have BindingFlags.Default as the default value.

{
try
{
foreach (var typeId in typeIds)
{
var typeInfo = await GetTypeInfo(typeId, token);
if (typeInfo == null)
continue;
if (typeInfo.Name == "object")
continue;
Microsoft.WebAssembly.Diagnostics.MethodInfo methodInfo = typeInfo.Info.Methods.FirstOrDefault(m => m.Name == "ToString");
if (isEnum != true && methodInfo == null)
continue;
int[] methodIds = await GetMethodIdsByName(typeId, "ToString", extraFlags, token);
if (methodIds == null)
continue;
foreach (var methodId in methodIds)
{
var methodInfoFromRuntime = await GetMethodInfo(methodId, token);
if (methodInfoFromRuntime.Info.GetParametersInfo().Length > 0)
Copy link
Member

Choose a reason for hiding this comment

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

MethodInfoWithDebugInformation implements GetParametersInfo(), so we could shorten:

Suggested change
if (methodInfoFromRuntime.Info.GetParametersInfo().Length > 0)
if (methodInfoFromRuntime.GetParametersInfo().Length > 0)

continue;
var retMethod = await InvokeMethod(objectId, methodId, isValueType, token);
return retMethod["value"]?["value"].Value<string>();
}
}
return null;
}
catch (Exception e)
{
logger.LogDebug($"Error while evaluating ToString method: {e}");
}
return null;
}



public async Task<int> GetPropertyMethodIdByName(int typeId, string propertyName, CancellationToken token)
{
using var retDebuggerCmdReader = await GetTypePropertiesReader(typeId, token);
Expand Down
34 changes: 2 additions & 32 deletions src/mono/wasm/debugger/BrowserDebugProxy/ValueTypeClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,42 +112,12 @@ JObject GetFieldWithMetadata(FieldTypeClass field, JObject fieldValue, bool isSt
}
}

public async Task<string> InvokeToStringAsync(MonoSDBHelper sdbAgent, CancellationToken token)
{
var typeInfo = await sdbAgent.GetTypeInfo(TypeId, token);
if (typeInfo == null)
return null;
if (typeInfo.Name == "object")
return null;
Microsoft.WebAssembly.Diagnostics.MethodInfo methodInfo = typeInfo.Info.Methods.FirstOrDefault(m => m.Name == "ToString");
if (!IsEnum && methodInfo == null)
return null;
int[] methodIds = await sdbAgent.GetMethodIdsByName(TypeId, "ToString", IsEnum ? BindingFlags.Default : BindingFlags.DeclaredOnly, token);
if (methodIds == null)
return null;
try {
foreach (var methodId in methodIds)
{
var methodInfoFromRuntime = await sdbAgent.GetMethodInfo(methodId, token);
if (methodInfoFromRuntime.Info.GetParametersInfo().Length > 0)
continue;
var retMethod = await sdbAgent.InvokeMethod(Buffer, methodId, token, "methodRet");
return retMethod["value"]?["value"].Value<string>();
}
}
catch (Exception e)
{
sdbAgent.logger.LogDebug($"Error while evaluating ToString method: {e}");
}
return null;
}

public async Task<JObject> ToJObject(MonoSDBHelper sdbAgent, bool forDebuggerDisplayAttribute, CancellationToken token)
{
string description = className;
if (ShouldAutoInvokeToString(className) || IsEnum)
{
var toString = await InvokeToStringAsync(sdbAgent, token);
var toString = await sdbAgent.InvokeToStringAsync(new List<int>(){TypeId}, true, IsEnum, Id.Value, IsEnum ? BindingFlags.Default : BindingFlags.DeclaredOnly, token);
if (toString == null)
sdbAgent.logger.LogDebug($"Error while evaluating ToString method on typeId = {TypeId}");
else
Expand All @@ -162,7 +132,7 @@ public async Task<JObject> ToJObject(MonoSDBHelper sdbAgent, bool forDebuggerDis
description = displayString;
else
{
var toString = await InvokeToStringAsync(sdbAgent, token);
var toString = await sdbAgent.InvokeToStringAsync(new List<int>(){TypeId}, true, IsEnum, Id.Value, IsEnum ? BindingFlags.Default : BindingFlags.DeclaredOnly, token);
if (toString != null)
description = toString;
}
Expand Down