Skip to content

Allow tag helper discovery to be cancellable #12258

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
DustinCampbell merged 6 commits into from
Sep 24, 2025
Merged

Allow tag helper discovery to be cancellable #12258

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
50c1a1d
Add CancellationToken parameter to tag helper APIs
DustinCampbell Sep 23, 2025
dcbd9c3
Call ThrowIfCancellationRequested in ITagHelperDescriptorProviders
DustinCampbell Sep 23, 2025
a618939
Change TagHelperDescriptorContext.TargetSymbol to TargetAssembly
DustinCampbell Sep 23, 2025
285dbbc
Remove SymbolVisitors from tag helper discovery
DustinCampbell Sep 23, 2025
e937d8b
Collect all bind tag helpers before adding component bind tag helpers
DustinCampbell Sep 23, 2025
9bde812
CR Feedback
DustinCampbell Sep 23, 2025
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
80 changes: 31 additions & 49 deletions ...n1_X/test/ViewComponentTypeVisitorTest.cs → ...ns.Version1_X/test/IsViewComponentTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable disable

using System;
using System.Collections.Generic;
using System.Reflection;
using Microsoft.AspNetCore.Razor;
using Microsoft.AspNetCore.Razor.Language;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Xunit;

namespace Microsoft.AspNetCore.Mvc.Razor.Extensions.Version1_X;

public class ViewComponentTypeVisitorTest
public class IsViewComponentTest
{
private static readonly Assembly _assembly = typeof(ViewComponentTypeVisitorTest).GetTypeInfo().Assembly;

private static Compilation Compilation { get; } = TestCompilation.Create(_assembly);
private CSharpCompilation Compilation { get; }

// In practice MVC will provide a marker attribute for ViewComponents. To prevent a circular reference between MVC and Razor
// we can use a test class as a marker.
private static INamedTypeSymbol TestViewComponentAttributeSymbol { get; } = Compilation.GetTypeByMetadataName(typeof(TestViewComponentAttribute).FullName);
private static INamedTypeSymbol TestNonViewComponentAttributeSymbol { get; } = Compilation.GetTypeByMetadataName(typeof(TestNonViewComponentAttribute).FullName);
private INamedTypeSymbol TestViewComponentAttributeSymbol { get; }
private INamedTypeSymbol TestNonViewComponentAttributeSymbol { get; }

public IsViewComponentTest()
{
var assembly = typeof(IsViewComponentTest).GetTypeInfo().Assembly;
Compilation = TestCompilation.Create(assembly);
TestViewComponentAttributeSymbol = Compilation.GetTypeByMetadataName(typeof(TestViewComponentAttribute).FullName).AssumeNotNull();
TestNonViewComponentAttributeSymbol = Compilation.GetTypeByMetadataName(typeof(TestNonViewComponentAttribute).FullName).AssumeNotNull();
}

[Fact]
public void IsViewComponent_PlainViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_PlainViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -43,14 +46,11 @@ public void IsViewComponent_PlainViewComponent_ReturnsTrue()
public void IsViewComponent_DecoratedViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_DecoratedVC).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -60,14 +60,11 @@ public void IsViewComponent_DecoratedViewComponent_ReturnsTrue()
public void IsViewComponent_InheritedViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_InheritedVC).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -77,14 +74,11 @@ public void IsViewComponent_InheritedViewComponent_ReturnsTrue()
public void IsViewComponent_AbstractViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_AbstractViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -94,14 +88,11 @@ public void IsViewComponent_AbstractViewComponent_ReturnsFalse()
public void IsViewComponent_GenericViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_GenericViewComponent<>).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -111,14 +102,11 @@ public void IsViewComponent_GenericViewComponent_ReturnsFalse()
public void IsViewComponent_InternalViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_InternalViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -128,14 +116,11 @@ public void IsViewComponent_InternalViewComponent_ReturnsFalse()
public void IsViewComponent_DecoratedNonViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_DecoratedViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -145,14 +130,11 @@ public void IsViewComponent_DecoratedNonViewComponent_ReturnsFalse()
public void IsViewComponent_InheritedNonViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_InheritedViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand Down
79 changes: 30 additions & 49 deletions ...n2_X/test/ViewComponentTypeVisitorTest.cs → ...ns.Version2_X/test/IsViewComponentTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,42 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable disable

using System;
using System.Collections.Generic;
using System.Reflection;
using Microsoft.AspNetCore.Razor;
using Microsoft.AspNetCore.Razor.Language;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Xunit;

namespace Microsoft.AspNetCore.Mvc.Razor.Extensions.Version2_X;

public class ViewComponentTypeVisitorTest
public class IsViewComponentTest
{
private static readonly Assembly _assembly = typeof(ViewComponentTypeVisitorTest).GetTypeInfo().Assembly;

private static CSharpCompilation Compilation { get; } = TestCompilation.Create(_assembly);
private CSharpCompilation Compilation { get; }

// In practice MVC will provide a marker attribute for ViewComponents. To prevent a circular reference between MVC and Razor
// we can use a test class as a marker.
private static INamedTypeSymbol TestViewComponentAttributeSymbol { get; } = Compilation.GetTypeByMetadataName(typeof(TestViewComponentAttribute).FullName);
private static INamedTypeSymbol TestNonViewComponentAttributeSymbol { get; } = Compilation.GetTypeByMetadataName(typeof(TestNonViewComponentAttribute).FullName);
private INamedTypeSymbol TestViewComponentAttributeSymbol { get; }
private INamedTypeSymbol TestNonViewComponentAttributeSymbol { get; }

public IsViewComponentTest()
{
var assembly = typeof(IsViewComponentTest).GetTypeInfo().Assembly;
Compilation = TestCompilation.Create(assembly);
TestViewComponentAttributeSymbol = Compilation.GetTypeByMetadataName(typeof(TestViewComponentAttribute).FullName).AssumeNotNull();
TestNonViewComponentAttributeSymbol = Compilation.GetTypeByMetadataName(typeof(TestNonViewComponentAttribute).FullName).AssumeNotNull();
}

[Fact]
public void IsViewComponent_PlainViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_PlainViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -44,14 +46,11 @@ public void IsViewComponent_PlainViewComponent_ReturnsTrue()
public void IsViewComponent_DecoratedViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_DecoratedVC).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -61,14 +60,11 @@ public void IsViewComponent_DecoratedViewComponent_ReturnsTrue()
public void IsViewComponent_InheritedViewComponent_ReturnsTrue()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Valid_InheritedVC).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.True(isViewComponent);
Expand All @@ -78,14 +74,11 @@ public void IsViewComponent_InheritedViewComponent_ReturnsTrue()
public void IsViewComponent_AbstractViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_AbstractViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -95,14 +88,11 @@ public void IsViewComponent_AbstractViewComponent_ReturnsFalse()
public void IsViewComponent_GenericViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_GenericViewComponent<>).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -112,14 +102,11 @@ public void IsViewComponent_GenericViewComponent_ReturnsFalse()
public void IsViewComponent_InternalViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_InternalViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -129,14 +116,11 @@ public void IsViewComponent_InternalViewComponent_ReturnsFalse()
public void IsViewComponent_DecoratedNonViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_DecoratedViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand All @@ -146,14 +130,11 @@ public void IsViewComponent_DecoratedNonViewComponent_ReturnsFalse()
public void IsViewComponent_InheritedNonViewComponent_ReturnsFalse()
{
// Arrange
var testVisitor = new ViewComponentTypeVisitor(
TestViewComponentAttributeSymbol,
TestNonViewComponentAttributeSymbol,
new List<INamedTypeSymbol>());
var tagHelperSymbol = Compilation.GetTypeByMetadataName(typeof(Invalid_InheritedViewComponent).FullName);
Assert.NotNull(tagHelperSymbol);

// Act
var isViewComponent = testVisitor.IsViewComponent(tagHelperSymbol);
var isViewComponent = tagHelperSymbol.IsViewComponent(TestViewComponentAttributeSymbol, TestNonViewComponentAttributeSymbol);

// Assert
Assert.False(isViewComponent);
Expand Down
Loading