Skip to content

Fix missing comma classification in json classification #68535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 12, 2023
+22 −3
Merged

Fix missing comma classification in json classification #68535

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53889cd
Fix missing comma classification in json classification
CyrusNajmabadi Jun 10, 2023
d6c1dd2
Expand comment
CyrusNajmabadi Jun 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/EditorFeatures/CSharpTest/Classification/SemanticClassifierTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4023,6 +4023,7 @@ void Goo()
}

[Theory, CombinatorialData]
[WorkItem("https://github.com/dotnet/roslyn/issues/68534")]
public async Task TestJson1(TestHost testHost)
{
await TestAsync(
Expand All @@ -4043,10 +4044,12 @@ void Goo()
Json.PropertyName("'goo'"),
Json.Punctuation(":"),
Json.Number("0"),
Json.Punctuation(","),
Json.PropertyName("bar"),
Json.Punctuation(":"),
Json.Operator("-"),
Json.Keyword("Infinity"),
Json.Punctuation(","),
Json.PropertyName(@"""""baz"""""),
Json.Punctuation(":"),
Json.Keyword("true"),
Expand Down Expand Up @@ -4090,6 +4093,7 @@ void Goo()
}

[Theory, CombinatorialData]
[WorkItem("https://github.com/dotnet/roslyn/issues/68534")]
public async Task TestMultiLineJson1(TestHost testHost)
{
await TestAsync(
Expand Down Expand Up @@ -4120,13 +4124,16 @@ void Goo()
Json.PropertyName("'goo'"),
Json.Punctuation(":"),
Json.Number("0"),
Json.Punctuation(","),
Json.PropertyName("bar"),
Json.Punctuation(":"),
Json.Operator("-"),
Json.Keyword("Infinity"),
Json.Punctuation(","),
Json.PropertyName(@"""""baz"""""),
Json.Punctuation(":"),
Json.Keyword("true"),
Json.Punctuation(","),
Json.PropertyName("0"),
Json.Punctuation(":"),
Json.Keyword("null"),
Expand Down
16 changes: 13 additions & 3 deletions src/Features/Core/Portable/EmbeddedLanguages/Json/LanguageServices/JsonClassifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,26 @@ private static void AddClassifications(JsonNode node, Visitor visitor, EmbeddedL
}
else
{
AddTriviaClassifications(child.Token, context);
AddTokenClassifications(child.Token, context);
}
}
}

private static void AddTriviaClassifications(JsonToken token, EmbeddedLanguageClassificationContext context)
private static void AddTokenClassifications(JsonToken token, EmbeddedLanguageClassificationContext context)
{
foreach (var trivia in token.LeadingTrivia)
AddTriviaClassifications(trivia, context);

if (!token.IsMissing)
{
switch (token.Kind)
{
case JsonKind.CommaToken:
context.AddClassification(ClassificationTypeNames.JsonPunctuation, token.GetSpan());
break;
}
}

foreach (var trivia in token.TrailingTrivia)
AddTriviaClassifications(trivia, context);
}
Expand Down Expand Up @@ -187,7 +197,7 @@ public void Visit(JsonTextNode node)

public void Visit(JsonCommaValueNode node)
{
AddClassification(node.CommaToken, ClassificationTypeNames.JsonPunctuation);
// already handled when we recurse in AddTokenClassifications
Copy link
Member

@333fred 333fred Jun 10, 2023

Choose a reason for hiding this comment

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

I don't think I understand how the logic in here works. Why are commas special versus other types of tokens handled by the other visit methods?

Copy link
Member Author

@CyrusNajmabadi CyrusNajmabadi Jun 11, 2023

Choose a reason for hiding this comment

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

Commas are handled slightly specially in json (for error recovery purposes). They can both be a node (with a token in them), or just a token in separated list. We were only handling the first case.

Now we handle both cases by just checking the token case only.

Copy link
Member

@333fred 333fred Jun 11, 2023

Choose a reason for hiding this comment

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

Probably worth documenting that :)

Copy link
Member Author

@CyrusNajmabadi CyrusNajmabadi Jun 11, 2023

Choose a reason for hiding this comment

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

That's what I thought that comment was :'(

Copy link
Member

@333fred 333fred Jun 11, 2023

Choose a reason for hiding this comment

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

This comment explains a bit of the why, but not the "commas are special for error recovery" part. That's what I needed to know to understand the code 🙂.

}
}
}
Expand Down