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

Improve performance of DefaultRazorTagHelperContextDiscoveryPhase #10602

Merged
merged 9 commits into from
Jul 16, 2024
Merged

Improve performance of DefaultRazorTagHelperContextDiscoveryPhase #10602

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e957bb2
Nullable-enable `DefaultRazorTagHelperContextDiscoveryPhase`
DustinCampbell Jul 9, 2024
7d38fdf
Add pooling for DirectiveVisitors
DustinCampbell Jul 9, 2024
918e316
Don't compute list of non-component tag helpers until necessary
DustinCampbell Jul 9, 2024
27feb66
Prefer list pattern
DustinCampbell Jul 9, 2024
848286c
Track tag helpers by assembly in TagHelperDirectiveVisitor
DustinCampbell Jul 9, 2024
cec0f4e
Clean up ComponentDirectiveVisitor a bit
DustinCampbell Jul 9, 2024
9c1c4f4
convert enumerables and enumerators to ref structs
DustinCampbell Jul 15, 2024
2ebe03e
Pass variable rather than reading property again
DustinCampbell Jul 15, 2024
9ad4466
Merge branch 'main' into tag-helper-discovery-perf
DustinCampbell Jul 16, 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
108 changes: 59 additions & 49 deletions ...Compiler/Microsoft.AspNetCore.Razor.Language/test/DefaultRazorTagHelperBinderPhaseTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,8 +724,8 @@ public void DirectiveVisitor_ExtractsPrefixFromSyntaxTree(
var sourceDocument = TestRazorSourceDocument.Create(source, filePath: "TestFile");
var parser = new RazorParser();
var syntaxTree = parser.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor(tagHelpers: [], matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor();
visitor.Initialize(tagHelpers: []);

// Act
visitor.Visit(syntaxTree.Root);
Expand Down Expand Up @@ -883,26 +883,26 @@ public static TheoryData ProcessTagHelperMatchesData
[MemberData(nameof(ProcessTagHelperMatchesData))]
public void DirectiveVisitor_FiltersTagHelpersByDirectives(
string source,
object tagHelpers,
object expectedDescriptors)
TagHelperDescriptor[] tagHelpers,
TagHelperDescriptor[] expectedTagHelpers)
{
// Arrange
var expected = (TagHelperDescriptor[])expectedDescriptors;
var sourceDocument = TestRazorSourceDocument.Create(source, filePath: "TestFile");
var parser = new RazorParser();
var syntaxTree = parser.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor((TagHelperDescriptor[])tagHelpers, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor();
visitor.Initialize(tagHelpers);

// Act
visitor.Visit(syntaxTree.Root);
var results = visitor.GetResults();

// Assert
Assert.Equal(expected.Length, matches.Count);
Assert.Equal(expectedTagHelpers.Length, results.Length);

foreach (var expectedDescriptor in expected)
foreach (var expectedTagHelper in expectedTagHelpers)
{
Assert.Contains(expectedDescriptor, matches);
Assert.Contains(expectedTagHelper, results);
}
}

Expand Down Expand Up @@ -1030,20 +1030,21 @@ public static TheoryData ProcessTagHelperMatches_EmptyResultData
[MemberData(nameof(ProcessTagHelperMatches_EmptyResultData))]
public void ProcessDirectives_CanReturnEmptyDescriptorsBasedOnDirectiveDescriptors(
string source,
object tagHelpers)
TagHelperDescriptor[] tagHelpers)
{
// Arrange
var sourceDocument = TestRazorSourceDocument.Create(source, filePath: "TestFile");
var parser = new RazorParser();
var syntaxTree = parser.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor((TagHelperDescriptor[])tagHelpers, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor();
visitor.Initialize(tagHelpers);

// Act
visitor.Visit(syntaxTree.Root);
var results = visitor.GetResults();

// Assert
Assert.Empty(matches);
Assert.Empty(results);
}

[Fact]
Expand All @@ -1052,22 +1053,24 @@ public void TagHelperDirectiveVisitor_DoesNotMatch_Components()
// Arrange
var componentDescriptor = CreateComponentDescriptor("counter", "SomeProject.Counter", AssemblyA);
var legacyDescriptor = Valid_PlainTagHelperDescriptor;
var descriptors = new[]
var tagHelpers = new[]
{
legacyDescriptor,
componentDescriptor,
};
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor(descriptors, matches);

var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.TagHelperDirectiveVisitor();
visitor.Initialize(tagHelpers);
var sourceDocument = CreateTestSourceDocument();
var tree = RazorSyntaxTree.Parse(sourceDocument);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
var match = Assert.Single(matches);
Assert.Same(legacyDescriptor, match);
var result = Assert.Single(results);
Assert.Same(legacyDescriptor, result);
}

private static RazorSourceDocument CreateTestSourceDocument()
Expand Down Expand Up @@ -1110,16 +1113,16 @@ public void ComponentDirectiveVisitor_DoesNotMatch_LegacyTagHelpers()
};
var sourceDocument = CreateComponentTestSourceDocument(@"<Counter />", "C:\\SomeFolder\\SomeProject\\Counter.cshtml");
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);

// Assert
Assert.Null(visitor.TagHelperPrefix);
var match = Assert.Single(matches);
Assert.Same(componentDescriptor, match);
var result = Assert.Single(visitor.GetResults());
Assert.Same(componentDescriptor, result);
}

[Fact]
Expand All @@ -1142,16 +1145,17 @@ public void ComponentDirectiveVisitor_AddsErrorOnLegacyTagHelperDirectives()
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
Assert.Null(visitor.TagHelperPrefix);
var match = Assert.Single(matches);
Assert.Same(componentDescriptor, match);
var result = Assert.Single(results);
Assert.Same(componentDescriptor, result);
var directiveChunkGenerator = (TagHelperPrefixDirectiveChunkGenerator)tree.Root.DescendantNodes().First(n => n is CSharpStatementLiteralSyntax).GetChunkGenerator();
var diagnostic = Assert.Single(directiveChunkGenerator.Diagnostics);
Assert.Equal("RZ9978", diagnostic.Id);
Expand All @@ -1176,15 +1180,16 @@ public void ComponentDirectiveVisitor_MatchesFullyQualifiedComponents()
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
var match = Assert.Single(matches);
Assert.Same(componentDescriptor, match);
var result = Assert.Single(results);
Assert.Same(componentDescriptor, result);
}

[Fact]
Expand Down Expand Up @@ -1213,14 +1218,15 @@ public void ComponentDirectiveVisitor_ComponentInScope_MatchesChildContent()
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
Assert.Equal(2, matches.Count);
Assert.Equal(2, results.Length);
}

[Fact]
Expand All @@ -1247,15 +1253,16 @@ public void ComponentDirectiveVisitor_NullCurrentNamespace_MatchesOnlyFullyQuali
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
var match = Assert.Single(matches);
Assert.Same(fullyQualifiedComponent, match);
var result = Assert.Single(results);
Assert.Same(fullyQualifiedComponent, result);
}

[Fact]
Expand All @@ -1282,14 +1289,15 @@ @using SomeProject.SomeOtherFolder
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
Assert.Equal(2, matches.Count);
Assert.Equal(2, results.Length);
}

[Fact]
Expand All @@ -1311,15 +1319,16 @@ public void ComponentDirectiveVisitor_MatchesIfNamespaceInUsing_GlobalPrefix()
""";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
var match = Assert.Single(matches);
Assert.Same(componentDescriptor, match);
var result = Assert.Single(results);
Assert.Same(componentDescriptor, result);
}

[Fact]
Expand Down Expand Up @@ -1347,15 +1356,16 @@ @using static SomeProject.SomeOtherFolder.Foo
";
var sourceDocument = CreateComponentTestSourceDocument(content, filePath);
var tree = RazorSyntaxTree.Parse(sourceDocument);
var matches = new HashSet<TagHelperDescriptor>();
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor(sourceDocument.FilePath, descriptors, currentNamespace, matches);
var visitor = new DefaultRazorTagHelperContextDiscoveryPhase.ComponentDirectiveVisitor();
visitor.Initialize(sourceDocument.FilePath, descriptors, currentNamespace);

// Act
visitor.Visit(tree);
var results = visitor.GetResults();

// Assert
var match = Assert.Single(matches);
Assert.Same(componentDescriptor, match);
var result = Assert.Single(results);
Assert.Same(componentDescriptor, result);
}

[Theory]
Expand Down
Loading