Skip to content

Revert setting endpoint name automatically #36518

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 1 commit into from
Sep 15, 2021
Merged

Revert setting endpoint name automatically #36518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 0 additions & 3 deletions src/Http/Routing/src/Builder/DelegateEndpointRouteBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,6 @@ private static DelegateEndpointConventionBuilder Map(
|| !TypeHelper.IsCompilerGeneratedMethod(handler.Method))
{
endpointName ??= handler.Method.Name;

builder.Metadata.Add(new EndpointNameMetadata(endpointName));
builder.Metadata.Add(new RouteNameMetadata(endpointName));
builder.DisplayName = $"{builder.DisplayName} => {endpointName}";
}

Expand Down
98 changes: 9 additions & 89 deletions src/Http/Routing/test/UnitTests/Builder/DelegateEndpointRouteBuilderExtensionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,54 +615,24 @@ public void MapFallbackWithoutPath_BuildsEndpointWithLowestRouteOrder()
}

[Fact]
// This test scenario simulates methods defined in a top-level program
// which are compiler generated. We currently do some manually parsing leveraging
// code in Roslyn to support this scenario. More info at https://github.com/dotnet/roslyn/issues/55651.
public void MapMethod_DoesNotEndpointNameForInnerMethod()
{
var name = "InnerGetString";
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
string InnerGetString() => "TestString";
_ = builder.MapDelete("/", InnerGetString);

var dataSource = GetBuilderEndpointDataSource(builder);
// Trigger Endpoint build by calling getter.
var endpoint = Assert.Single(dataSource.Endpoints);

var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
var routeName = endpoint.Metadata.GetMetadata<IRouteNameMetadata>();
var routeEndpointBuilder = GetRouteEndpointBuilder(builder);
Assert.Equal(name, endpointName?.EndpointName);
Assert.Equal(name, routeName?.RouteName);
Assert.Equal("HTTP: DELETE / => InnerGetString", routeEndpointBuilder.DisplayName);
}

[Fact]
public void MapMethod_DoesNotEndpointNameForInnerMethodWithTarget()
public void WithTags_CanSetTagsForEndpoint()
{
var name = "InnerGetString";
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
var testString = "TestString";
string InnerGetString() => testString;
_ = builder.MapDelete("/", InnerGetString);
string GetString() => "Foo";
_ = builder.MapDelete("/", GetString).WithTags("Some", "Test", "Tags");

var dataSource = GetBuilderEndpointDataSource(builder);
// Trigger Endpoint build by calling getter.
var endpoint = Assert.Single(dataSource.Endpoints);

var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
var routeName = endpoint.Metadata.GetMetadata<IRouteNameMetadata>();
var routeEndpointBuilder = GetRouteEndpointBuilder(builder);
Assert.Equal(name, endpointName?.EndpointName);
Assert.Equal(name, routeName?.RouteName);
Assert.Equal("HTTP: DELETE / => InnerGetString", routeEndpointBuilder.DisplayName);
var tagsMetadata = endpoint.Metadata.GetMetadata<ITagsMetadata>();
Assert.Equal(new[] { "Some", "Test", "Tags" }, tagsMetadata?.Tags);
}


[Fact]
public void MapMethod_SetsEndpointNameForMethodGroup()
public void MapMethod_DoesNotEndpointNameForMethodGroupByDefault()
{
var name = "GetString";
string GetString() => "Foo";
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
_ = builder.MapDelete("/", GetString);

Expand All @@ -673,59 +643,9 @@ public void MapMethod_SetsEndpointNameForMethodGroup()
var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
var routeName = endpoint.Metadata.GetMetadata<IRouteNameMetadata>();
var routeEndpointBuilder = GetRouteEndpointBuilder(builder);
Assert.Equal(name, endpointName?.EndpointName);
Assert.Equal(name, routeName?.RouteName);
Assert.Equal("HTTP: DELETE / => GetString", routeEndpointBuilder.DisplayName);
}

[Fact]
public void WithNameOverridesDefaultEndpointName()
{
var name = "SomeCustomName";
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
_ = builder.MapDelete("/", GetString).WithName(name);

var dataSource = GetBuilderEndpointDataSource(builder);
// Trigger Endpoint build by calling getter.
var endpoint = Assert.Single(dataSource.Endpoints);

var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
var routeName = endpoint.Metadata.GetMetadata<IRouteNameMetadata>();
var routeEndpointBuilder = GetRouteEndpointBuilder(builder);
Assert.Equal(name, endpointName?.EndpointName);
Assert.Equal(name, routeName?.RouteName);
// Will still use the original method name, not the custom endpoint name
Assert.Equal("HTTP: DELETE / => GetString", routeEndpointBuilder.DisplayName);
}

private string GetString() => "TestString";

[Fact]
public void MapMethod_DoesNotSetEndpointNameForLambda()
{
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
_ = builder.MapDelete("/", () => { });

var dataSource = GetBuilderEndpointDataSource(builder);
// Trigger Endpoint build by calling getter.
var endpoint = Assert.Single(dataSource.Endpoints);

var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
Assert.Null(endpointName);
}

[Fact]
public void WithTags_CanSetTagsForEndpoint()
{
var builder = new DefaultEndpointRouteBuilder(new ApplicationBuilder(new EmptyServiceProvider()));
_ = builder.MapDelete("/", GetString).WithTags("Some", "Test", "Tags");

var dataSource = GetBuilderEndpointDataSource(builder);
// Trigger Endpoint build by calling getter.
var endpoint = Assert.Single(dataSource.Endpoints);

var tagsMetadata = endpoint.Metadata.GetMetadata<ITagsMetadata>();
Assert.Equal(new[] { "Some", "Test", "Tags" }, tagsMetadata?.Tags);
Assert.Null(routeName);
Assert.Equal("HTTP: DELETE / => GetString", routeEndpointBuilder.DisplayName);
}

[Theory]
Expand Down