Skip to content

Commit

Permalink
Improve handling of < in symbol parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
@verdie-g
verdie-g committed May 25, 2024
1 parent 722c015 commit 932202f
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 34 deletions.
86 changes: 68 additions & 18 deletions EventPipe.Test/SymbolCleanerTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ private static IEnumerable<TestCaseData> TestCaseSource()
ExpectedResult = "Contoso.Cookies.CookieEntry.TryGet(T&, System.Exception&, int32, bool)",
};
yield return new TestCaseData(
"System.Threading.Tasks.Task+DelayPromiseWithCancellation+<>c",
"<.ctor>b__1_0",
"instance void (class System.Object,value class System.Threading.CancellationToken)")
"System.Collections.Immutable.ImmutableDictionary`2[Contoso.Banners.Configuration.Inventory.Sources.InventoryAvailabilityKey,Contoso.Banners.Configuration.Inventory.Sources.AvailableBanner]",
"Wrap",
"class System.Collections.Immutable.ImmutableDictionary`2<!0,!1> (class System.Collections.Immutable.SortedInt32KeyNode`1<value class HashBucket<!0,!1>>,class Comparers<!0,!1>,int32)")
{
ExpectedResult = "System.Threading.Tasks.Task+DelayPromiseWithCancellation+<>c.<.ctor>b__1_0(System.Object, System.Threading.CancellationToken)",
RunState = RunState.Ignored,
TestName = "Generic arguments using angle brackets and no tilde",
ExpectedResult = "System.Collections.Immutable.ImmutableDictionary<Contoso.Banners.Configuration.Inventory.Sources.InventoryAvailabilityKey, Contoso.Banners.Configuration.Inventory.Sources.AvailableBanner>.Wrap(System.Collections.Immutable.SortedInt32KeyNode<HashBucket<T, T>>, Comparers<T, T>, int32)",
};
yield return new TestCaseData(
"Sdk.Connection.GhostClientBase`2+<Process>d__42[System.__Canon,System.__Canon]",
Expand All @@ -104,15 +104,17 @@ private static IEnumerable<TestCaseData> TestCaseSource()
"instance void ()")
{
TestName = "Mix of T and specified type",
ExpectedResult = "Ghost.Core.ComponentMiddleware<T, T, T, T>.Invoke<T, T, T, Contoso.RTB.Common.SerializedData>()",
ExpectedResult =
"Ghost.Core.ComponentMiddleware<T, T, T, T>.Invoke<T, T, T, Contoso.RTB.Common.SerializedData>()",
};
yield return new TestCaseData(
"Ghost.Transports.Http.Common.Middlewares.HttpExceptionMiddleware",
"Invoke",
"instance class System.Threading.Tasks.Task`1<value class Ghost.Contract.InvocationResult> (class Ghost.Transports.Http.Contract.IHttpRequest,class Ghost.Transports.Http.Contract.IHttpResponse,value class System.Threading.CancellationToken)")
{
TestName = "Mix of class and struct arguments",
ExpectedResult = "Ghost.Transports.Http.Common.Middlewares.HttpExceptionMiddleware.Invoke(Ghost.Transports.Http.Contract.IHttpRequest, Ghost.Transports.Http.Contract.IHttpResponse, System.Threading.CancellationToken)",
ExpectedResult =
"Ghost.Transports.Http.Common.Middlewares.HttpExceptionMiddleware.Invoke(Ghost.Transports.Http.Contract.IHttpRequest, Ghost.Transports.Http.Contract.IHttpResponse, System.Threading.CancellationToken)",
};
yield return new TestCaseData(
"Program",
Expand All @@ -128,15 +130,17 @@ private static IEnumerable<TestCaseData> TestCaseSource()
"instance value class Contoso.API.Versatile.EnumerableVariant (class System.Collections.Generic.IEnumerable`1<value class Contoso.API.Versatile.EnumerableVariant>)")
{
TestName = "Generic argument",
ExpectedResult = "Contoso.API.Versatile.Functions.FlattenedFunction.Evaluate(System.Collections.Generic.IEnumerable<Contoso.API.Versatile.EnumerableVariant>)",
ExpectedResult =
"Contoso.API.Versatile.Functions.FlattenedFunction.Evaluate(System.Collections.Generic.IEnumerable<Contoso.API.Versatile.EnumerableVariant>)",
};
yield return new TestCaseData(
"Program",
"InstanceMethod",
"instance int32 (value class System.ValueTuple`5<int32,int16,float32,class System.String,value class System.Guid>)")
{
TestName = "Value tuple argument",
ExpectedResult = "Program.InstanceMethod(System.ValueTuple<int32, int16, float32, System.String, System.Guid>)",
ExpectedResult =
"Program.InstanceMethod(System.ValueTuple<int32, int16, float32, System.String, System.Guid>)",
};
yield return new TestCaseData(
"Program+<InstanceMethodAsync>d__3",
Expand All @@ -162,23 +166,62 @@ private static IEnumerable<TestCaseData> TestCaseSource()
TestName = "Local generic async method in generic async method",
ExpectedResult = "Program.GenericInstanceMethodAsync.LocalGenericMethodAsync<T, T>()",
};
yield return new TestCaseData(
"System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1+AsyncStateMachineBox`1[System.Threading.Tasks.VoidTaskResult,Contoso.ThirdPartyDemand.Bidding.Framework.DspSpecificCompositeStep+<>c__DisplayClass3_0+<<Process>g__OnDspState|0>d]",
"MoveNext",
"instance void (class System.Threading.Thread)")
{
TestName = "Lambda of local method",
ExpectedResult = "System.Runtime.CompilerServices.AsyncTaskMethodBuilder<T>+AsyncStateMachineBox<System.Threading.Tasks.VoidTaskResult, Contoso.ThirdPartyDemand.Bidding.Framework.DspSpecificCompositeStep.()=>{}.Process.OnDspState>(System.Threading.Thread)",
};
yield return new TestCaseData(
"System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1+AsyncStateMachineBox`1[System.Threading.Tasks.VoidTaskResult,JetBrains.TextControl.DocumentMarkup.GutterMarksBackendServices+<>c__DisplayClass3_0+<<-ctor>g__BeginCreateForTextControlIfAllowed|1>d]",
"MoveNext",
"instance void (class System.Threading.Thread)")
{
TestName = "Lambda of a local method in a constructor",
ExpectedResult = "System.Runtime.CompilerServices.AsyncTaskMethodBuilder<T>+AsyncStateMachineBox<System.Threading.Tasks.VoidTaskResult, JetBrains.TextControl.DocumentMarkup.GutterMarksBackendServices.()=>{}.-ctor.BeginCreateForTextControlIfAllowed>(System.Threading.Thread)",
};
yield return new TestCaseData(
"System.Threading.Tasks.Task+DelayPromiseWithCancellation+<>c",
"<.ctor>b__1_0",
"instance void (class System.Object,value class System.Threading.CancellationToken)")
{
TestName = "Lambda in constructor",
ExpectedResult =
"System.Threading.Tasks.Task+DelayPromiseWithCancellation.()=>{}.<.ctor>b__1_0(System.Object, System.Threading.CancellationToken)",
};
yield return new TestCaseData(
"System.Net.Http.HttpConnectionPool+<>c",
"<CheckForHttp11ConnectionInjection>b__77_0",
"instance void (value class System.ValueTuple`2<class System.Net.Http.HttpConnectionPool,value class QueueItem<class System.Net.Http.HttpConnection>>)")
{
TestName = "Short lambda notation",
ExpectedResult = "System.Net.Http.HttpConnectionPool.()=>{}.<CheckForHttp11ConnectionInjection>b__77_0(System.ValueTuple<System.Net.Http.HttpConnectionPool, QueueItem<System.Net.Http.HttpConnection>>)",
};
yield return new TestCaseData(
"System.Threading.Tasks.ValueTask`1+ValueTaskSourceAsTask+<>c[System.Int32]",
"<.cctor>b__4_0",
"instance void (class System.Object)")
{
TestName = "Generic lambda",
ExpectedResult = "System.Threading.Tasks.ValueTask<T>+ValueTaskSourceAsTask.()=>{}<System.Int32>.<.cctor>b__4_0(System.Object)",
};
yield return new TestCaseData(
"Program",
"<.ctor>g__LocalMethod|1_1",
"void ()")
{
TestName = "Local method in constructor",
ExpectedResult = "Program..ctor.LocalMethod",
RunState = RunState.Ignored,
ExpectedResult = "Program.<.ctor>g__LocalMethod|1_1()",
};
yield return new TestCaseData(
"Program",
"<InstanceMethod>g__LocalMethod|2_1",
"void ()")
{
TestName = "Local method",
ExpectedResult = "Program.InstanceMethod.LocalMethod",
RunState = RunState.Ignored,
ExpectedResult = "Program.<InstanceMethod>g__LocalMethod|2_1()",
};
yield return new TestCaseData(
"Program+<MyEnumerableMethod>d__4",
Expand All @@ -188,30 +231,37 @@ private static IEnumerable<TestCaseData> TestCaseSource()
TestName = "Enumerable Method",
ExpectedResult = "Program.MyEnumerableMethod()",
};
yield return new TestCaseData(
"Microsoft.EntityFrameworkCore.Query.Internal.SplitQueryingEnumerable`1+AsyncEnumerator+<>c[System.Int32]",
"<MoveNextAsync>b__19_0",
"instance class System.Threading.Tasks.Task`1<bool> (class Microsoft.EntityFrameworkCore.DbContext,class AsyncEnumerator<!0>,value class System.Threading.CancellationToken)")
{
TestName = "Async enumerable method",
ExpectedResult = "Microsoft.EntityFrameworkCore.Query.Internal.SplitQueryingEnumerable<T>+AsyncEnumerator.()=>{}<System.Int32>.<MoveNextAsync>b__19_0(Microsoft.EntityFrameworkCore.DbContext, AsyncEnumerator<T>, System.Threading.CancellationToken)",
};
yield return new TestCaseData(
"Program+<>c",
"<Main>b__7_0",
"Signature=instance void (int32,class System.Object)")
"instance void (int32,class System.Object)")
{
TestName = "Lambda",
ExpectedResult = "Program.Main.lambda(int, System.Object)",
RunState = RunState.Ignored,
ExpectedResult = "Program.()=>{}.<Main>b__7_0(int32, System.Object)",
};
yield return new TestCaseData(
"Contoso.CookiesUpdater.PublisherCookiesUpdater+<>c__DisplayClass10_0+<<OnBidRequest>b__0>d",
"MoveNext",
"instance void ()")
{
TestName = "Async lambda",
ExpectedResult = "Contoso.CookiesUpdater.PublisherCookiesUpdater.OnBidRequest()",
ExpectedResult = "Contoso.CookiesUpdater.PublisherCookiesUpdater.()=>{}.OnBidRequest()",
};
yield return new TestCaseData(
"Program+<>c__DisplayClass7_0",
"<Main>b__1",
"instance void (class System.String)")
{
TestName = "Closure",
ExpectedResult = "Program.Main.lambda(System.String)",
ExpectedResult = "Program.()=>{}.<Main>b__1(System.String)",
RunState = RunState.Ignored,
};
}
Expand Down
57 changes: 41 additions & 16 deletions EventPipe/SymbolCleaner.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public static string Clean(string ns, string name, string signature)
private static int AppendCleanedType(StringBuilder sb, ReadOnlySpan<char> str)
{
int typeNameStartIndex = -1;
bool subType = false;
int i;
for (i = 0; i < str.Length; i += 1)
{
Expand All @@ -57,22 +58,24 @@ private static int AppendCleanedType(StringBuilder sb, ReadOnlySpan<char> str)
continue;
}

if (str[i] == '<')
{
i += AppendCleanedGeneratedType(sb, str[i..]);
i -= 1;
continue;
}

if (str[i] is '`' or '[')
if (str[i] is '`' or '[' or '<')
{
if (typeNameStartIndex != -1)
{
AppendPrettifiedType(sb, str[typeNameStartIndex..i]);
typeNameStartIndex = -1;
}

i += AppendTypeArguments(sb, str[i..], hasTildeHeader: str[i] == '`');
// Some subclass names can contain '<', in that case it's not the start of type arguments.
if (str[i] == '<' && subType)
{
i += AppendCleanedGeneratedType(sb, str[i..]);
}
else
{
i += AppendTypeArguments(sb, str[i..], hasTildeHeader: str[i] == '`');
}

i -= 1;
continue;
}
Expand All @@ -86,6 +89,7 @@ private static int AppendCleanedType(StringBuilder sb, ReadOnlySpan<char> str)
}

sb.Append('+');
subType = true;
continue;
}

Expand Down Expand Up @@ -180,10 +184,23 @@ private static int AppendCleanedGeneratedType(StringBuilder sb, ReadOnlySpan<cha
sb[^1] = '.';
}

for (int i = 0; i < str.Length; i += 1)
int i = 0;
for (; i < str.Length;)
{
if (str[i] is '[')
{
break;
}

if (str[i] == '+')
{
i += 1;
continue;
}

if (str[i] == '<')
{
i += 1;
continue;
}

Expand All @@ -198,18 +215,21 @@ private static int AppendCleanedGeneratedType(StringBuilder sb, ReadOnlySpan<cha

if (str[i + 1] == 'g')
{
i += 3; // Skips g__
i += 4; // Skips >g__
sb.Append('.');
continue;
}

if (str[i + 1] == 'c')
{
if (i + 2 >= str.Length)
sb.Append("()=>{}");
if (i + 2 == str.Length || str[i + 2] != '_')
{
return str.Length;
i += 2; // Skips >c
continue;
}

sb.Append('.');
i += 16; // Skips >c__DisplayClass
i += SkipDigits(str[i..]);
i += 1; // Skips _
Expand All @@ -225,16 +245,21 @@ private static int AppendCleanedGeneratedType(StringBuilder sb, ReadOnlySpan<cha
{
i += 1; // Skips |
i += SkipDigits(str[i..]);
i += 1; // Skips _
i += SkipDigits(str[i..]);
if (str[i] == '_')
{
i += 1; // Skips _
i += SkipDigits(str[i..]);
}

i += 2; // Skips >d
return i;
}

sb.Append(str[i]);
i += 1;
}

return str.Length;
return i;

static int SkipDigits(ReadOnlySpan<char> s)
{
Expand Down

0 comments on commit 932202f

Please sign in to comment.