Added NegotiateMetadata to negotiate endpoints (#8907)
- This makes it a bit cleaner to identify the negotiate when trying to apply policies (like replacing the endpoint) - Added tests that cover MapConnectionHandler for endpoint routing
This commit is contained in:
parent
284e968101
commit
61b3504dbe
|
|
@ -55,6 +55,10 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
public LongPollingOptions() { }
|
public LongPollingOptions() { }
|
||||||
public System.TimeSpan PollTimeout { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
|
public System.TimeSpan PollTimeout { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
|
||||||
}
|
}
|
||||||
|
public partial class NegotiateMetadata
|
||||||
|
{
|
||||||
|
public NegotiateMetadata() { }
|
||||||
|
}
|
||||||
public partial class WebSocketOptions
|
public partial class WebSocketOptions
|
||||||
{
|
{
|
||||||
public WebSocketOptions() { }
|
public WebSocketOptions() { }
|
||||||
|
|
|
||||||
|
|
@ -105,6 +105,8 @@ namespace Microsoft.AspNetCore.Builder
|
||||||
|
|
||||||
var negotiateBuilder = endpoints.Map(pattern + "/negotiate", negotiateHandler);
|
var negotiateBuilder = endpoints.Map(pattern + "/negotiate", negotiateHandler);
|
||||||
conventionBuilders.Add(negotiateBuilder);
|
conventionBuilders.Add(negotiateBuilder);
|
||||||
|
// Add the negotiate metadata so this endpoint can be identified
|
||||||
|
negotiateBuilder.WithMetadata(new NegotiateMetadata());
|
||||||
|
|
||||||
// build the execute handler part of the protocol
|
// build the execute handler part of the protocol
|
||||||
app = endpoints.CreateApplicationBuilder();
|
app = endpoints.CreateApplicationBuilder();
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
// Copyright (c) .NET Foundation. All rights reserved.
|
||||||
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
||||||
|
|
||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Text;
|
||||||
|
|
||||||
|
namespace Microsoft.AspNetCore.Http.Connections
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Metadata to identify the /negotiate endpoint for HTTP connections
|
||||||
|
/// </summary>
|
||||||
|
public class NegotiateMetadata
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -11,6 +11,7 @@ using Microsoft.AspNetCore.Builder;
|
||||||
using Microsoft.AspNetCore.Connections;
|
using Microsoft.AspNetCore.Connections;
|
||||||
using Microsoft.AspNetCore.Hosting;
|
using Microsoft.AspNetCore.Hosting;
|
||||||
using Microsoft.AspNetCore.Hosting.Server.Features;
|
using Microsoft.AspNetCore.Hosting.Server.Features;
|
||||||
|
using Microsoft.AspNetCore.Routing;
|
||||||
using Microsoft.AspNetCore.SignalR.Tests;
|
using Microsoft.AspNetCore.SignalR.Tests;
|
||||||
using Microsoft.AspNetCore.Testing.xunit;
|
using Microsoft.AspNetCore.Testing.xunit;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
|
|
@ -68,6 +69,69 @@ namespace Microsoft.AspNetCore.Http.Connections.Tests
|
||||||
Assert.Equal(2, authCount);
|
Assert.Equal(2, authCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void MapConnectionHandlerEndPointRoutingFindsAttributesOnHub()
|
||||||
|
{
|
||||||
|
var authCount = 0;
|
||||||
|
using (var host = BuildWebHostWithEndPointRouting(routes => routes.MapConnectionHandler<AuthConnectionHandler>("/path", options =>
|
||||||
|
{
|
||||||
|
authCount += options.AuthorizationData.Count;
|
||||||
|
})))
|
||||||
|
{
|
||||||
|
host.Start();
|
||||||
|
|
||||||
|
var dataSource = host.Services.GetRequiredService<EndpointDataSource>();
|
||||||
|
// We register 2 endpoints (/negotiate and /)
|
||||||
|
Assert.Equal(2, dataSource.Endpoints.Count);
|
||||||
|
Assert.NotNull(dataSource.Endpoints[0].Metadata.GetMetadata<IAuthorizeData>());
|
||||||
|
Assert.NotNull(dataSource.Endpoints[1].Metadata.GetMetadata<IAuthorizeData>());
|
||||||
|
}
|
||||||
|
|
||||||
|
Assert.Equal(1, authCount);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void MapConnectionHandlerEndPointRoutingAppliesAttributesBeforeConventions()
|
||||||
|
{
|
||||||
|
void ConfigureRoutes(IEndpointRouteBuilder endpoints)
|
||||||
|
{
|
||||||
|
// This "Foo" policy should override the default auth attribute
|
||||||
|
endpoints.MapConnectionHandler<AuthConnectionHandler>("/path")
|
||||||
|
.RequireAuthorization(new AuthorizeAttribute("Foo"));
|
||||||
|
}
|
||||||
|
|
||||||
|
using (var host = BuildWebHostWithEndPointRouting(ConfigureRoutes))
|
||||||
|
{
|
||||||
|
host.Start();
|
||||||
|
|
||||||
|
var dataSource = host.Services.GetRequiredService<EndpointDataSource>();
|
||||||
|
// We register 2 endpoints (/negotiate and /)
|
||||||
|
Assert.Equal(2, dataSource.Endpoints.Count);
|
||||||
|
Assert.Equal("Foo", dataSource.Endpoints[0].Metadata.GetMetadata<IAuthorizeData>()?.Policy);
|
||||||
|
Assert.Equal("Foo", dataSource.Endpoints[1].Metadata.GetMetadata<IAuthorizeData>()?.Policy);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void MapConnectionHandlerEndPointRoutingAppliesNegotiateMetadata()
|
||||||
|
{
|
||||||
|
void ConfigureRoutes(IEndpointRouteBuilder endpoints)
|
||||||
|
{
|
||||||
|
endpoints.MapConnectionHandler<AuthConnectionHandler>("/path");
|
||||||
|
}
|
||||||
|
|
||||||
|
using (var host = BuildWebHostWithEndPointRouting(ConfigureRoutes))
|
||||||
|
{
|
||||||
|
host.Start();
|
||||||
|
|
||||||
|
var dataSource = host.Services.GetRequiredService<EndpointDataSource>();
|
||||||
|
// We register 2 endpoints (/negotiate and /)
|
||||||
|
Assert.Equal(2, dataSource.Endpoints.Count);
|
||||||
|
Assert.NotNull(dataSource.Endpoints[0].Metadata.GetMetadata<NegotiateMetadata>());
|
||||||
|
Assert.Null(dataSource.Endpoints[1].Metadata.GetMetadata<NegotiateMetadata>());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
[ConditionalFact]
|
[ConditionalFact]
|
||||||
[WebSocketsSupportedCondition]
|
[WebSocketsSupportedCondition]
|
||||||
public async Task MapConnectionHandlerWithWebSocketSubProtocolSetsProtocol()
|
public async Task MapConnectionHandlerWithWebSocketSubProtocolSetsProtocol()
|
||||||
|
|
@ -135,6 +199,23 @@ namespace Microsoft.AspNetCore.Http.Connections.Tests
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private IWebHost BuildWebHostWithEndPointRouting(Action<IEndpointRouteBuilder> configure)
|
||||||
|
{
|
||||||
|
return new WebHostBuilder()
|
||||||
|
.UseKestrel()
|
||||||
|
.ConfigureServices(services =>
|
||||||
|
{
|
||||||
|
services.AddConnections();
|
||||||
|
})
|
||||||
|
.Configure(app =>
|
||||||
|
{
|
||||||
|
app.UseRouting();
|
||||||
|
app.UseEndpoints(endpoints => configure(endpoints));
|
||||||
|
})
|
||||||
|
.UseUrls("http://127.0.0.1:0")
|
||||||
|
.Build();
|
||||||
|
}
|
||||||
|
|
||||||
private IWebHost BuildWebHost<TConnectionHandler>(string path, Action<HttpConnectionDispatcherOptions> configureOptions) where TConnectionHandler : ConnectionHandler
|
private IWebHost BuildWebHost<TConnectionHandler>(string path, Action<HttpConnectionDispatcherOptions> configureOptions) where TConnectionHandler : ConnectionHandler
|
||||||
{
|
{
|
||||||
return new WebHostBuilder()
|
return new WebHostBuilder()
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@ using System.Threading.Tasks;
|
||||||
using Microsoft.AspNetCore.Authorization;
|
using Microsoft.AspNetCore.Authorization;
|
||||||
using Microsoft.AspNetCore.Builder;
|
using Microsoft.AspNetCore.Builder;
|
||||||
using Microsoft.AspNetCore.Hosting;
|
using Microsoft.AspNetCore.Hosting;
|
||||||
|
using Microsoft.AspNetCore.Http.Connections;
|
||||||
using Microsoft.AspNetCore.Routing;
|
using Microsoft.AspNetCore.Routing;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
using Xunit;
|
using Xunit;
|
||||||
|
|
@ -204,6 +205,8 @@ namespace Microsoft.AspNetCore.SignalR.Tests
|
||||||
Assert.Equal(2, dataSource.Endpoints.Count);
|
Assert.Equal(2, dataSource.Endpoints.Count);
|
||||||
Assert.Equal(typeof(AuthHub), dataSource.Endpoints[0].Metadata.GetMetadata<HubMetadata>()?.HubType);
|
Assert.Equal(typeof(AuthHub), dataSource.Endpoints[0].Metadata.GetMetadata<HubMetadata>()?.HubType);
|
||||||
Assert.Equal(typeof(AuthHub), dataSource.Endpoints[1].Metadata.GetMetadata<HubMetadata>()?.HubType);
|
Assert.Equal(typeof(AuthHub), dataSource.Endpoints[1].Metadata.GetMetadata<HubMetadata>()?.HubType);
|
||||||
|
Assert.NotNull(dataSource.Endpoints[0].Metadata.GetMetadata<NegotiateMetadata>());
|
||||||
|
Assert.Null(dataSource.Endpoints[1].Metadata.GetMetadata<NegotiateMetadata>());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue