Skip to content

Set route name metadata in WithName #35388

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
Aug 16, 2021
Merged

Set route name metadata in WithName #35388

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
2 changes: 1 addition & 1 deletion src/Http/Routing/src/Builder/RoutingEndpointConventionBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public static TBuilder WithMetadata<TBuilder>(this TBuilder builder, params obje
/// <returns>The <see cref="IEndpointConventionBuilder"/>.</returns>
public static TBuilder WithName<TBuilder>(this TBuilder builder, string endpointName) where TBuilder : IEndpointConventionBuilder
{
builder.WithMetadata(new EndpointNameAttribute(endpointName));
builder.WithMetadata(new EndpointNameAttribute(endpointName), new RouteNameMetadata(endpointName));
Copy link
Member

@halter73 halter73 Aug 16, 2021

Choose a reason for hiding this comment

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

I see that both IEndpointNameMetadata and IRouteNameMetadata have been around in the same namespace and assembly since at least 3.0. The doc comments for both indicate that they're used for link-generation.

@pranavkm @JamesNK Do either of you know why we have a route name and an enpoint name and how they're used differently?

Copy link
Member

@JamesNK JamesNK Aug 16, 2021

Choose a reason for hiding this comment

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

Sorry, I don't know. I didn't touch link generation much. When I worked on routing I focused on endpoint generation and route matching.

return builder;
}

Expand Down
8 changes: 6 additions & 2 deletions src/Http/Routing/test/UnitTests/Builder/RoutingEndpointConventionBuilderExtensionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,16 +119,20 @@ public void WithMetadata_ChainedCall_ReturnedBuilderIsDerivedType()
public void WithName_SetsEndpointName()
{
// Arrange
var name = "SomeEndpointName";
var builder = CreateBuilder();

// Act
builder.WithName("SomeEndpointName");
builder.WithName(name);

// Assert
var endpoint = builder.Build();

var endpointName = endpoint.Metadata.GetMetadata<IEndpointNameMetadata>();
Assert.Equal("SomeEndpointName", endpointName.EndpointName);
Assert.Equal(name, endpointName.EndpointName);

var routeName = endpoint.Metadata.GetMetadata<IRouteNameMetadata>();
Assert.Equal(name, routeName.RouteName);
}

[Fact]
Expand Down