Skip to content

[wasm][debugger] Hide members from classes that don't have debug information#73982

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
thaystg merged 6 commits into from
Aug 16, 2022
Merged

[wasm][debugger] Hide members from classes that don't have debug information #73982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
88a6e18
adding fields that are from non-user-code as private
thaystg Aug 15, 2022
80501d5
Merge remote-tracking branch 'origin/main' into thays_fix_43184
thaystg Aug 15, 2022
7969c92
Do not show members from types that doesn't have debug information if…
thaystg Aug 16, 2022
6a2dd67
Addressing @radical comments.
thaystg Aug 16, 2022
3580e80
Apply suggestions from code review
thaystg Aug 16, 2022
048d2d3
Adding more tests.
thaystg Aug 16, 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
13 changes: 11 additions & 2 deletions src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
internal int Token { get; }
internal string Namespace { get; }
internal bool IsCompilerGenerated { get; }
private bool NonUserCode { get; }
public string FullName { get; }
internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
public List<MethodInfo> Methods { get; } = new();
public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
continue;
var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
if (attributeName == nameof(CompilerGeneratedAttribute))
IsCompilerGenerated = true;
switch (attributeName)
{
case nameof(CompilerGeneratedAttribute):
IsCompilerGenerated = true;
break;
case nameof(DebuggerNonUserCodeAttribute):
NonUserCode = true;
break;
}
}

void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down
8 changes: 8 additions & 0 deletions src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
FieldAttributes.Public => "result",
_ => "internal"
};

if (field.IsBackingField)
{
fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
for (int i = 0; i < typeIdsCnt; i++)
{
int typeId = typeIdsIncludingParents[i];
var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
continue;

int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
string typeName = await sdbHelper.GetTypeName(typeId, token);
// 0th id is for the object itself, and then its ancestors
bool isOwn = i == 0;

IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
if (!includeStatic)
thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

if (thisTypeFields.Count > 0)
{
var allFields = await ExpandFieldValues(
Expand Down
2 changes: 2 additions & 0 deletions src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
}
if (JustMyCode)
getObjectOptions |= GetObjectCommandOptions.JustMyCode;
try
{
switch (objectId.Scheme)
Expand Down
3 changes: 2 additions & 1 deletion src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
OwnProperties = 4,
ForDebuggerProxyAttribute = 8,
ForDebuggerDisplayAttribute = 16,
WithProperties = 32
WithProperties = 32,
JustMyCode = 64
}

internal enum CommandSet {
Expand Down
47 changes: 47 additions & 0 deletions src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
}
);
}

[Theory]
[InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
[InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
[InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
[InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
[InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
[InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
{
await SetJustMyCode(jmc);
var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

await EvaluateAndCheck(
"window.setTimeout(function() {" + expression + "; }, 1);",
"dotnet://debugger-test.dll/debugger-test.cs", line, 8,
$"{class_name}.CallMethod",
locals_fn: async (locals) =>
{
var this_props = await GetObjectOnLocals(locals, "this");
if (jmc)
{
await CheckProps(this_props, new
{
myField = TNumber(0),
myField2 = TNumber(0),
}, "this_props", num_fields: 2);
}
else
{
await CheckProps(this_props, new
{
propA = TNumber(10),
propB = TNumber(20),
propC = TNumber(30),
d = TNumber(40),
e = TNumber(50),
f = TNumber(60),
G = TGetter("G"),
H = TGetter("H"),
myField = TNumber(0),
myField2 = TNumber(0),
}, "this_props", num_fields: 10);
}
}
);
}
}
}
4 changes: 4 additions & 0 deletions ...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
</PropertyGroup>
</Project>
41 changes: 41 additions & 0 deletions src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
public class NormalClass
{
public int myField2;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
{
private int propA {get;}
public int propB {get;}
protected int propC {get;}
private int d;
public int e;
protected int f;
public int G
{
get {return f + 1;}
}
public int H => f;

public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
{
propA = 10;
propB = 20;
propC = 30;
d = 40;
e = 50;
f = 60;
Console.WriteLine(propA);
Console.WriteLine(propB);
Console.WriteLine(propC);
Console.WriteLine(d);
Console.WriteLine(e);
Console.WriteLine(f);
}
}
}
6 changes: 6 additions & 0 deletions ...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<DebugType>none</DebugType>
<DebugSymbols>false</DebugSymbols>
</PropertyGroup>
</Project>
35 changes: 35 additions & 0 deletions src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
public class ClassWithoutDebugSymbolsToInherit
{
private int propA {get;}
public int propB {get;}
protected int propC {get;}
private int d;
public int e;
protected int f;
public int G
{
get {return f + 1;}
}
public int H => f;

public ClassWithoutDebugSymbolsToInherit()
{
propA = 10;
propB = 20;
propC = 30;
d = 40;
e = 50;
f = 60;
Console.WriteLine(propA);
Console.WriteLine(propB);
Console.WriteLine(propC);
Console.WriteLine(d);
Console.WriteLine(e);
Console.WriteLine(f);
}
}
}
80 changes: 80 additions & 0 deletions src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
public static void Run()
{
var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
myVar.CallMethod();
}

public void CallMethod()
{
System.Diagnostics.Debugger.Break();
}
public int myField2;
public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
private int propA {get;}
public int propB {get;}
protected int propC {get;}
private int d;
public int e;
protected int f;
public int G
{
get {return f + 1;}
}
public int H => f;

public ClassNonUserCodeToInherit()
{
propA = 10;
propB = 20;
propC = 30;
d = 40;
e = 50;
f = 60;
Console.WriteLine(propA);
Console.WriteLine(propB);
Console.WriteLine(propC);
Console.WriteLine(d);
Console.WriteLine(e);
Console.WriteLine(f);
}
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
public static void Run()
{
var myVar = new ClassInheritsFromNonUserCodeClass();
myVar.CallMethod();
}

public void CallMethod()
{
System.Diagnostics.Debugger.Break();
}

public int myField2;
public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
public static void Run()
{
var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
myVar.CallMethod();
}

public void CallMethod()
{
System.Diagnostics.Debugger.Break();
}

public int myField;

@radicalradicalAug 16, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.

}
6 changes: 5 additions & 1 deletion src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
<ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
<ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
<ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
<ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
<ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
<!-- loaded by *tests*, and not the test app -->
<ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
<WasmMainJSPath>debugger-main.js</WasmMainJSPath>
<!-- -1 enabled debugging and disables debug logging. -->
<WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

<WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
</PropertyGroup>

<ItemGroup>
<WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
<WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
<WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
<WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
<WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
<WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

<!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

<WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
<WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
<WasmAssemblySearchPaths Include="$(OutDir)"/>

@radicalradicalAug 16, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why was this needed?

</ItemGroup>
</Target>
<Target Name="PreserveEnCAssembliesFromLinking"
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[wasm][debugger] Hide members from classes that don't have debug information by thaystg · Pull Request #73982 · dotnet/runtime · GitHub
Skip to content
[wasm][debugger] Hide members from classes that don't have debug information#73982

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

thaystg
merged 6 commits into

from

Aug 16, 2022
 Merged


[wasm][debugger] Hide members from classes that don't have debug information
#73982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
88a6e18

adding fields that are from non-user-code as private


thaystg Aug 15, 2022
80501d5

Merge remote-tracking branch 'origin/main' into thays_fix_43184


thaystg Aug 15, 2022
7969c92

Do not show members from types that doesn't have debug information if…


thaystg Aug 16, 2022
6a2dd67

Addressing @radical comments.


thaystg Aug 16, 2022
3580e80

Apply suggestions from code review


thaystg Aug 16, 2022
048d2d3

Adding more tests.


thaystg Aug 16, 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


13 changes: 11 additions & 2 deletions
src/mono/wasm/debugger/BrowserDebugProxy/DebugStore.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -701,7 +701,9 @@ internal sealed class TypeInfo
 internal int Token { get; }
 internal string Namespace { get; }
 internal bool IsCompilerGenerated { get; }
 private bool NonUserCode { get; }
 public string FullName { get; }
 internal bool IsNonUserCode => assembly.pdbMetadataReader == null || NonUserCode;
 public List<MethodInfo> Methods { get; } = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableFields = new();
 public Dictionary<string, DebuggerBrowsableState?> DebuggerBrowsableProperties = new();
Expand DownExpand Up@@ -769,8 +771,15 @@ internal TypeInfo(AssemblyInfo assembly, TypeDefinitionHandle typeHandle, TypeDe
 continue;
 var container = metadataReader.GetMemberReference((MemberReferenceHandle)ctorHandle).Parent;
 var attributeName = assembly.EnCGetString(metadataReader.GetTypeReference((TypeReferenceHandle)container).Name);
 if (attributeName == nameof(CompilerGeneratedAttribute))
 IsCompilerGenerated = true;
 switch (attributeName)
 {
 case nameof(CompilerGeneratedAttribute):
 IsCompilerGenerated = true;
 break;
 case nameof(DebuggerNonUserCodeAttribute):
 NonUserCode = true;
 break;
 }
 }

 void AppendToBrowsable(Dictionary<string, DebuggerBrowsableState?> dict, CustomAttributeHandleCollection customAttrs, string fieldName)
Expand Down

8 changes: 8 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MemberObjectsExplorer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ private static async Task<JObject> ReadFieldValue(
 FieldAttributes.Public => "result",
 _ => "internal"
 };

 if (field.IsBackingField)
 {
 fieldValue["__isBackingField"] = true;
Expand DownExpand Up@@ -567,13 +568,20 @@ public static async Task<GetMembersResult> GetObjectMemberValues(
 for (int i = 0; i < typeIdsCnt; i++)
 {
 int typeId = typeIdsIncludingParents[i];
 var typeInfo = await sdbHelper.GetTypeInfo(typeId, token);

 if (typeInfo.Info.IsNonUserCode && getCommandType.HasFlag(GetObjectCommandOptions.JustMyCode))
 continue;

 int parentTypeId = i + 1 < typeIdsCnt ? typeIdsIncludingParents[i + 1] : -1;
 string typeName = await sdbHelper.GetTypeName(typeId, token);
 // 0th id is for the object itself, and then its ancestors
 bool isOwn = i == 0;

 IReadOnlyList<FieldTypeClass> thisTypeFields = await sdbHelper.GetTypeFields(typeId, token);
 if (!includeStatic)
 thisTypeFields = thisTypeFields.Where(f => !f.Attributes.HasFlag(FieldAttributes.Static)).ToList();

 if (thisTypeFields.Count > 0)
 {
 var allFields = await ExpandFieldValues(
Expand Down

2 changes: 2 additions & 0 deletions
src/mono/wasm/debugger/BrowserDebugProxy/MonoProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -745,6 +745,8 @@ internal async Task<ValueOrError<GetMembersResult>> RuntimeGetObjectMembers(Sess
 if (args["forDebuggerDisplayAttribute"]?.Value<bool>() == true)
 getObjectOptions |= GetObjectCommandOptions.ForDebuggerDisplayAttribute;
 }
 if (JustMyCode)
 getObjectOptions |= GetObjectCommandOptions.JustMyCode;
 try
 {
 switch (objectId.Scheme)
Expand Down

3 changes: 2 additions & 1 deletion
src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,8 @@ internal enum GetObjectCommandOptions
 OwnProperties = 4,
 ForDebuggerProxyAttribute = 8,
 ForDebuggerDisplayAttribute = 16,
 WithProperties = 32
 WithProperties = 32,
 JustMyCode = 64
 }

 internal enum CommandSet {
Expand Down

47 changes: 47 additions & 0 deletions
src/mono/wasm/debugger/DebuggerTestSuite/MiscTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1039,5 +1039,52 @@ await EvaluateAndCheck(
 }
 );
 }

 [Theory]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, true)]
 [InlineData("ClassInheritsFromClassWithoutDebugSymbols", 1287, false)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, true)]
 [InlineData("ClassInheritsFromNonUserCodeClass", 1335, false)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, true)]
 [InlineData("ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass", 1352, false)]
 public async Task InspectThisThatInheritsFromClassNonUserCode(string class_name, int line, bool jmc)
 {
 await SetJustMyCode(jmc);
 var expression = "{{ invoke_static_method('[debugger-test] " + class_name + ":Run'); }}";

 await EvaluateAndCheck(
 "window.setTimeout(function() {" + expression + "; }, 1);",
 "dotnet://debugger-test.dll/debugger-test.cs", line, 8,
 $"{class_name}.CallMethod",
 locals_fn: async (locals) =>
 {
 var this_props = await GetObjectOnLocals(locals, "this");
 if (jmc)
 {
 await CheckProps(this_props, new
 {
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 2);
 }
 else
 {
 await CheckProps(this_props, new
 {
 propA = TNumber(10),
 propB = TNumber(20),
 propC = TNumber(30),
 d = TNumber(40),
 e = TNumber(50),
 f = TNumber(60),
 G = TGetter("G"),
 H = TGetter("H"),
 myField = TNumber(0),
 myField2 = TNumber(0),
 }, "this_props", num_fields: 10);
 }
 }
 );
 }
 }
}

4 changes: 4 additions & 0 deletions
...ests/debugger-test-with-non-user-code-class/debugger-test-with-non-user-code-class.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 </PropertyGroup>
</Project>

41 changes: 41 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-with-non-user-code-class/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
using System;

namespace DebuggerTests
{
 public class NormalClass
 {
 public int myField2;
 }

 [System.Diagnostics.DebuggerNonUserCode]
 public class ClassNonUserCodeToInheritThatInheritsFromNormalClass : NormalClass
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInheritThatInheritsFromNormalClass()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

6 changes: 6 additions & 0 deletions
...ger-test-without-debug-symbols-to-load/debugger-test-without-debug-symbols-to-load.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <DebugType>none</DebugType>
 <DebugSymbols>false</DebugSymbols> 
 </PropertyGroup>
</Project>

35 changes: 35 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test-without-debug-symbols-to-load/test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
using System;

namespace DebuggerTests
{
 public class ClassWithoutDebugSymbolsToInherit
 {
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassWithoutDebugSymbolsToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
 }
}

80 changes: 80 additions & 0 deletions
src/mono/wasm/debugger/tests/debugger-test/debugger-test.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1275,3 +1275,83 @@ public static void MethodWithHiddenLinesAtTheEnd3()
#line default
}

public class ClassInheritsFromClassWithoutDebugSymbols : DebuggerTests.ClassWithoutDebugSymbolsToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromClassWithoutDebugSymbols();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }
 public int myField2;
 public int myField;
}

[System.Diagnostics.DebuggerNonUserCode]
public class ClassNonUserCodeToInherit
{
 private int propA {get;}
 public int propB {get;}
 protected int propC {get;}
 private int d;
 public int e;
 protected int f;
 public int G
 {
 get {return f + 1;}
 }
 public int H => f;

 public ClassNonUserCodeToInherit()
 {
 propA = 10;
 propB = 20;
 propC = 30;
 d = 40;
 e = 50;
 f = 60;
 Console.WriteLine(propA);
 Console.WriteLine(propB);
 Console.WriteLine(propC);
 Console.WriteLine(d);
 Console.WriteLine(e);
 Console.WriteLine(f);
 }
}

public class ClassInheritsFromNonUserCodeClass : ClassNonUserCodeToInherit
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField2;
 public int myField;
}

public class ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass : DebuggerTests.ClassNonUserCodeToInheritThatInheritsFromNormalClass
{
 public static void Run()
 {
 var myVar = new ClassInheritsFromNonUserCodeClassThatInheritsFromNormalClass();
 myVar.CallMethod();
 }

 public void CallMethod()
 {
 System.Diagnostics.Debugger.Break();
 }

 public int myField;
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Add custom, and autogenerated properties too.
}

6 changes: 5 additions & 1 deletion
src/mono/wasm/debugger/tests/debugger-test/debugger-test.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 <ProjectReference Include="..\ApplyUpdateReferencedAssembly\ApplyUpdateReferencedAssembly.csproj" />
 <ProjectReference Include="..\debugger-test-special-char-in-path-#@\debugger-test-special-char-in-path.csproj" ReferenceOutputAssembly="false" />
 <ProjectReference Include="..\debugger-test-with-source-link\debugger-test-with-source-link.csproj" ReferenceOutputAssembly="false" Private="true" />
 <ProjectReference Include="..\debugger-test-without-debug-symbols-to-load\debugger-test-without-debug-symbols-to-load.csproj" Private="true" />
 <ProjectReference Include="..\debugger-test-with-non-user-code-class\debugger-test-with-non-user-code-class.csproj" Private="true" />
 <!-- loaded by *tests*, and not the test app -->
 <ProjectReference Include="..\lazy-debugger-test-embedded\lazy-debugger-test-embedded.csproj" ReferenceOutputAssembly="false" Private="true" />

Expand All@@ -44,14 +46,15 @@
 <WasmMainJSPath>debugger-main.js</WasmMainJSPath>
 <!-- -1 enabled debugging and disables debug logging. -->
 <WasmDebugLevel Condition="'$(WasmDebugLevel)'==''">-1</WasmDebugLevel>

 <WasmResolveAssembliesBeforeBuild>true</WasmResolveAssembliesBeforeBuild>
 </PropertyGroup>

 <ItemGroup>
 <WasmAssembliesToBundle Include="$(OutDir)\$(TargetFileName)" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-special-char-in-path.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-source-link.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-without-debug-symbols-to-load.dll" />
 <WasmAssembliesToBundle Include="$(OutDir)\debugger-test-with-non-user-code-class.dll" />
 <WasmAssembliesToBundle Include="$(MicrosoftNetCoreAppRuntimePackRidDir)\lib\$(NetCoreappCurrent)\System.Runtime.InteropServices.JavaScript.dll" />

 <!-- Assemblies only dynamically loaded -->
Expand All@@ -63,6 +66,7 @@

 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)native"/>
 <WasmAssemblySearchPaths Include="$(MicrosoftNetCoreAppRuntimePackRidDir)lib\$(NetCoreAppCurrent)"/>
 <WasmAssemblySearchPaths Include="$(OutDir)"/>
@radicalradicalAug 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Why was this needed?
 </ItemGroup>
 </Target>
 <Target Name="PreserveEnCAssembliesFromLinking"
Expand Down