Skip to content
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

Jump to bottom

Use the roslyn tokenizer #10702

Merged
merged 17 commits into from
Aug 12, 2024
Merged

Use the roslyn tokenizer #10702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
894a9ba
Remove unused ITokenizer interface, make tokenizers disposable.
333fred Aug 1, 2024
a15d7cc
Remove unneeded common states
333fred Aug 1, 2024
3a8fd07
Allow setting the next tokenizer state after a razor comment body is …
333fred Aug 1, 2024
60ac8d1
Plumb the Roslyn tokenizer through more tests
333fred Aug 1, 2024
73aa717
Nullable enable the tokenizer
333fred Aug 1, 2024
dcef8ed
Add consolidated syntax kinds. Since there aren't consumers that care…
333fred Aug 1, 2024
5749a8e
Give better error messages when syntax tree verification fails.
333fred Aug 1, 2024
2823f64
The big change: use the roslyn tokenizer for tokenizing C#.
333fred Aug 1, 2024
c25ac20
Update SyntaxKinds to the new consolidated kinds in tests.
333fred Aug 1, 2024
34ab111
Increase test coverage of a few scenarios, and bulk up existing tests.
333fred Aug 1, 2024
abd6aba
Skip test for now, give a better exception.
333fred Aug 1, 2024
acf7a60
Name change
333fred Aug 1, 2024
640d377
Better support giving errors on raw string literals, increase test co…
333fred Aug 2, 2024
3155200
PR feedback.
333fred Aug 2, 2024
1a0d57d
Convert to the correct type
333fred Aug 2, 2024
aa24f69
Additional commenting and PR feedback. I've simplified the reset loop…
333fred Aug 6, 2024
5b7e927
More feedback
333fred Aug 9, 2024
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
1 change: 1 addition & 0 deletions ...spNetCore.Razor.Language/test/DefaultRazorIntermediateNodeLoweringPhaseIntegrationTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,7 @@ public DesignTimeOptionsFeature(bool designTime)
public void Configure(RazorParserOptionsBuilder options)
{
options.SetDesignTime(_designTime);
options.UseRoslynTokenizer = true;
Copy link
Member

Choose a reason for hiding this comment

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

Can we also run razor-toolset-ci pipeline (which tests bunch of existing razor projects) with the roslyn tokenizer enabled?

Copy link
Member Author

Choose a reason for hiding this comment

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

Will do this before we merge the feature branch and address any breaks that come up with dedicated tests at that point.

}

public void Configure(RazorCodeGenerationOptionsBuilder options)
Expand Down
48 changes: 39 additions & 9 deletions ...Microsoft.AspNetCore.Razor.Language/test/DefaultRazorIntermediateNodeLoweringPhaseTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ public void Execute_AutomaticallyImportsSingleLineSinglyOccurringDirective()
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
b.AddDirective(directive);
});
var options = RazorParserOptions.Create(builder => builder.Directives.Add(directive));
var options = RazorParserOptions.Create(builder =>
{
builder.Directives.Add(directive);
builder.UseRoslynTokenizer = true;
});
var importSource = TestRazorSourceDocument.Create("@custom \"hello\"", filePath: "import.cshtml");
var codeDocument = TestRazorCodeDocument.Create("<p>NonDirective</p>");
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, options));
Expand Down Expand Up @@ -65,7 +69,11 @@ public void Execute_AutomaticallyOverridesImportedSingleLineSinglyOccurringDirec
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
b.AddDirective(directive);
});
var options = RazorParserOptions.Create(builder => builder.Directives.Add(directive));
var options = RazorParserOptions.Create(builder =>
{
builder.Directives.Add(directive);
builder.UseRoslynTokenizer = true;
});
var importSource = TestRazorSourceDocument.Create("@custom \"hello\"", filePath: "import.cshtml");
var codeDocument = TestRazorCodeDocument.Create("@custom \"world\"");
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, options));
Expand Down Expand Up @@ -100,7 +108,11 @@ public void Execute_AutomaticallyOverridesImportedSingleLineSinglyOccurringDirec
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
b.AddDirective(directive);
});
var options = RazorParserOptions.Create(builder => builder.Directives.Add(directive));
var options = RazorParserOptions.Create(builder =>
{
builder.Directives.Add(directive);
builder.UseRoslynTokenizer = true;
});
var importSource1 = TestRazorSourceDocument.Create("@custom \"hello\"", filePath: "import1.cshtml");
var importSource2 = TestRazorSourceDocument.Create("@custom \"world\"", filePath: "import2.cshtml");
var codeDocument = TestRazorCodeDocument.Create("<p>NonDirective</p>");
Expand Down Expand Up @@ -136,6 +148,7 @@ public void Execute_DoesNotImportNonFileScopedSinglyOccurringDirectives_Block()
{
builder.Directives.Add(codeBlockDirective);
builder.Directives.Add(razorBlockDirective);
builder.UseRoslynTokenizer = true;
});
var importSource = TestRazorSourceDocument.Create(
@"@code ""code block"" { }
Expand Down Expand Up @@ -166,7 +179,11 @@ public void Execute_ErrorsForCodeBlockFileScopedSinglyOccurringDirectives()
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
b.AddDirective(directive);
});
var options = RazorParserOptions.Create(builder => builder.Directives.Add(directive));
var options = RazorParserOptions.Create(builder =>
{
builder.Directives.Add(directive);
builder.UseRoslynTokenizer = true;
});
var importSource = TestRazorSourceDocument.Create("@custom { }", filePath: "import.cshtml");
var codeDocument = TestRazorCodeDocument.Create("<p>NonDirective</p>");
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, options));
Expand Down Expand Up @@ -196,7 +213,11 @@ public void Execute_ErrorsForRazorBlockFileScopedSinglyOccurringDirectives()
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
b.AddDirective(directive);
});
var options = RazorParserOptions.Create(builder => builder.Directives.Add(directive));
var options = RazorParserOptions.Create(builder =>
{
builder.Directives.Add(directive);
builder.UseRoslynTokenizer = true;
});
var importSource = TestRazorSourceDocument.Create("@custom { }", filePath: "import.cshtml");
var codeDocument = TestRazorCodeDocument.Create("<p>NonDirective</p>");
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, options));
Expand Down Expand Up @@ -247,8 +268,13 @@ public void Execute_CollatesSyntaxDiagnosticsFromSourceDocument()
b.Phases.Add(phase);
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
});

var options = RazorParserOptions.Create(builder =>
{
builder.UseRoslynTokenizer = true;
});
var codeDocument = TestRazorCodeDocument.Create("<p class=@(");
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source));
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, options));

// Act
phase.Execute(codeDocument);
Expand All @@ -271,12 +297,16 @@ public void Execute_CollatesSyntaxDiagnosticsFromImportDocuments()
b.Features.Add(new DefaultRazorCodeGenerationOptionsFeature(designTime: false));
});

var parseOptions = RazorParserOptions.Create(builder =>
{
builder.UseRoslynTokenizer = true;
});
var codeDocument = TestRazorCodeDocument.CreateEmpty();
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source));
codeDocument.SetSyntaxTree(RazorSyntaxTree.Parse(codeDocument.Source, parseOptions));
codeDocument.SetImportSyntaxTrees(new[]
{
RazorSyntaxTree.Parse(TestRazorSourceDocument.Create("@ ")),
RazorSyntaxTree.Parse(TestRazorSourceDocument.Create("<p @(")),
RazorSyntaxTree.Parse(TestRazorSourceDocument.Create("@ "), parseOptions),
RazorSyntaxTree.Parse(TestRazorSourceDocument.Create("<p @("), parseOptions),
}.ToImmutableArray());
var options = RazorCodeGenerationOptions.CreateDefault();

Expand Down
180 changes: 173 additions & 7 deletions src/Compiler/Microsoft.AspNetCore.Razor.Language/test/Legacy/CSharpTokenizerCommentTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,42 +55,208 @@ public void Next_Returns_Comment_Token_For_Entire_Single_Line_Comment()
[Fact]
public void Single_Line_Comment_Is_Terminated_By_Newline()
{
TestTokenizer("// Foo Bar Baz\na", SyntaxFactory.Token(SyntaxKind.CSharpComment, "// Foo Bar Baz"), IgnoreRemaining);
TestTokenizer("""
// Foo Bar Baz
a
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, "// Foo Bar Baz"), IgnoreRemaining);
}

[Fact]
public void Multi_Line_Comment_In_Single_Line_Comment_Has_No_Effect()
{
TestTokenizer("// Foo/*Bar*/ Baz\na", SyntaxFactory.Token(SyntaxKind.CSharpComment, "// Foo/*Bar*/ Baz"), IgnoreRemaining);
TestTokenizer("""
// Foo/*Bar*/ Baz
a
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, "// Foo/*Bar*/ Baz"), IgnoreRemaining);
}

[Fact]
public void Next_Returns_Comment_Token_For_Entire_Multi_Line_Comment()
{
TestTokenizer("/* Foo\nBar\nBaz */", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/* Foo\nBar\nBaz */"));
TestTokenizer("""
/* Foo
Bar
Baz */
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/* Foo
Bar
Baz */
"""));
}

[Fact]
public void Multi_Line_Comment_Is_Terminated_By_End_Sequence()
{
TestTokenizer("/* Foo\nBar\nBaz */a", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/* Foo\nBar\nBaz */"), IgnoreRemaining);
TestTokenizer("""
/* Foo
Bar
Baz */a
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/* Foo
Bar
Baz */
"""), IgnoreRemaining);
}

[Fact]
public void Unterminated_Multi_Line_Comment_Captures_To_EOF()
{
TestTokenizer("/* Foo\nBar\nBaz", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/* Foo\nBar\nBaz"), IgnoreRemaining);
TestTokenizer("""
/* Foo
Bar
Baz
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/* Foo
Bar
Baz
"""), IgnoreRemaining);
}

[Fact]
public void Nested_Multi_Line_Comments_Terminated_At_First_End_Sequence()
{
TestTokenizer("/* Foo/*\nBar\nBaz*/ */", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/* Foo/*\nBar\nBaz*/"), IgnoreRemaining);
TestTokenizer("""
/* Foo/*
Bar
Baz*/ */
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/* Foo/*
Bar
Baz*/
"""), IgnoreRemaining);
}

[Fact]
public void Nested_Multi_Line_Comments_Terminated_At_Full_End_Sequence()
{
TestTokenizer("/* Foo\nBar\nBaz* */", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/* Foo\nBar\nBaz* */"), IgnoreRemaining);
TestTokenizer("""
/* Foo
Bar
Baz* */
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/* Foo
Bar
Baz* */
"""), IgnoreRemaining);
}

[Fact]
public void Next_Returns_CSharpComment_Token_For_Single_Line_Documentation_Comment()
{
TestTokenizer("/// This is a single line documentation comment", SyntaxFactory.Token(SyntaxKind.CSharpComment, "/// This is a single line documentation comment"));
}

[Fact]
public void Single_Line_Documentation_Comment_Is_Terminated_By_And_Owns_Newline()
{
TestTokenizer("""
/// This is a single line documentation comment
a
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/// This is a single line documentation comment

"""), IgnoreRemaining);
}

[Fact]
public void Single_Line_Documentation_Comment_With_Multiple_Lines()
{
TestTokenizer("""
/// This is a single line documentation comment
/// with multiple lines
/// in the comment

""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/// This is a single line documentation comment
/// with multiple lines
/// in the comment

"""), IgnoreRemaining);
}

[Fact]
public void Next_Returns_CSharpComment_Token_For_Multi_Line_Documentation_Comment()
{
TestTokenizer("""
/**
* This is a
* multi-line
* documentation comment
*/
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/**
* This is a
* multi-line
* documentation comment
*/
"""));
}

[Fact]
public void Multi_Line_Documentation_Comment_Is_Terminated_By_End_Sequence()
{
TestTokenizer("""
/**
* This is a
* multi-line
* documentation comment
*/a
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/**
* This is a
* multi-line
* documentation comment
*/
"""), IgnoreRemaining);
}

[Fact]
public void Unterminated_Multi_Line_Documentation_Comment_Captures_To_EOF()
{
TestTokenizer("""
/**
* This is a
* multi-line
* documentation comment
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/**
* This is a
* multi-line
* documentation comment
"""), IgnoreRemaining);
}

[Fact]
public void Nested_Multi_Line_Documentation_Comments_Terminated_At_First_End_Sequence()
{
TestTokenizer("""
/**
* This is a
* /*nested*/
* documentation comment
*/
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/**
* This is a
* /*nested*/
"""), IgnoreRemaining);
}

[Fact]
public void Nested_Multi_Line_Documentation_Comments_Terminated_At_Full_End_Sequence()
{
TestTokenizer("""
/**
* This is a
* multi-line
* documentation comment*
*/
""", SyntaxFactory.Token(SyntaxKind.CSharpComment, """
/**
* This is a
* multi-line
* documentation comment*
*/
"""), IgnoreRemaining);
}
}
Loading