// 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.IO; using System.Text; using System.Threading.Tasks; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http.Internal; using Microsoft.AspNetCore.SignalR.Tests.Common; using Microsoft.AspNetCore.Sockets.Internal; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Primitives; using Xunit; namespace Microsoft.AspNetCore.Sockets.Tests { public class HttpConnectionDispatcherTests { // Redefined from MessageFormatter because we want constants to go in the Attributes private const string TextContentType = "application/vnd.microsoft.aspnetcore.endpoint-messages.v1+text"; private const string BinaryContentType = "application/vnd.microsoft.aspnetcore.endpoint-messages.v1+binary"; [Fact] public async Task NegotiateReservesConnectionIdAndReturnsIt() { var manager = CreateConnectionManager(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = new DefaultHttpContext(); var services = new ServiceCollection(); services.AddEndPoint(); context.RequestServices = services.BuildServiceProvider(); var ms = new MemoryStream(); context.Request.Path = "/negotiate"; context.Response.Body = ms; await dispatcher.ExecuteAsync("", context); var id = Encoding.UTF8.GetString(ms.ToArray()); ConnectionState state; Assert.True(manager.TryGetConnection(id, out state)); Assert.Equal(id, state.Connection.ConnectionId); } [Theory] [InlineData("/send")] [InlineData("/sse")] [InlineData("/poll")] [InlineData("/ws")] public async Task EndpointsThatAcceptConnectionId404WhenUnknownConnectionIdProvided(string path) { var manager = CreateConnectionManager(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); using (var strm = new MemoryStream()) { var context = new DefaultHttpContext(); context.Response.Body = strm; var services = new ServiceCollection(); services.AddEndPoint(); context.RequestServices = services.BuildServiceProvider(); context.Request.Path = path; var values = new Dictionary(); values["id"] = "unknown"; var qs = new QueryCollection(values); context.Request.Query = qs; await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status404NotFound, context.Response.StatusCode); await strm.FlushAsync(); Assert.Equal("No Connection with that ID", Encoding.UTF8.GetString(strm.ToArray())); } } [Theory] [InlineData("/send")] [InlineData("/sse")] [InlineData("/poll")] public async Task EndpointsThatRequireConnectionId400WhenNoConnectionIdProvided(string path) { var manager = CreateConnectionManager(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); using (var strm = new MemoryStream()) { var context = new DefaultHttpContext(); context.Response.Body = strm; var services = new ServiceCollection(); services.AddEndPoint(); context.RequestServices = services.BuildServiceProvider(); context.Request.Path = path; await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status400BadRequest, context.Response.StatusCode); await strm.FlushAsync(); Assert.Equal("Connection ID required", Encoding.UTF8.GetString(strm.ToArray())); } } [Fact] public async Task CompletedEndPointEndsConnection() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/sse", state); await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Fact] public async Task SynchronusExceptionEndsConnection() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/sse", state); await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Fact] public async Task SynchronusExceptionEndsLongPollingConnection() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/poll", state); await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status204NoContent, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Fact] public async Task CompletedEndPointEndsLongPollingConnection() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/poll", state); await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status204NoContent, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Fact] public async Task RequestToActiveConnectionId409ForStreamingTransports() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context1 = MakeRequest("/sse", state); var context2 = MakeRequest("/sse", state); var request1 = dispatcher.ExecuteAsync("", context1); await dispatcher.ExecuteAsync("", context2); Assert.Equal(StatusCodes.Status409Conflict, context2.Response.StatusCode); manager.CloseConnections(); await request1; } [Fact] public async Task RequestToActiveConnectionIdKillsPreviousConnectionLongPolling() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context1 = MakeRequest("/poll", state); var context2 = MakeRequest("/poll", state); var request1 = dispatcher.ExecuteAsync("", context1); var request2 = dispatcher.ExecuteAsync("", context2); await request1; Assert.Equal(StatusCodes.Status204NoContent, context1.Response.StatusCode); Assert.Equal(ConnectionState.ConnectionStatus.Active, state.Status); Assert.False(request2.IsCompleted); manager.CloseConnections(); await request2; } [Theory] [InlineData("/sse")] [InlineData("/poll")] public async Task RequestToDisposedConnectionIdReturns404(string path) { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); state.Status = ConnectionState.ConnectionStatus.Disposed; var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest(path, state); await dispatcher.ExecuteAsync("", context); Assert.Equal(StatusCodes.Status404NotFound, context.Response.StatusCode); } [Fact] public async Task ConnectionStateSetToInactiveAfterPoll() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/poll", state); var task = dispatcher.ExecuteAsync("", context); var buffer = Encoding.UTF8.GetBytes("Hello World"); // Write to the transport so the poll yields await state.Connection.Transport.Output.WriteAsync(new Message(buffer, MessageType.Text, endOfMessage: true)); await task; Assert.Equal(ConnectionState.ConnectionStatus.Inactive, state.Status); Assert.Null(state.RequestId); Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode); } [Fact] public async Task BlockingConnectionWorksWithStreamingConnections() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/sse", state); var task = dispatcher.ExecuteAsync("", context); var buffer = Encoding.UTF8.GetBytes("Hello World"); // Write to the application await state.Application.Output.WriteAsync(new Message(buffer, MessageType.Text, endOfMessage: true)); await task; Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Fact] public async Task BlockingConnectionWorksWithLongPollingConnection() { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/poll", state); var task = dispatcher.ExecuteAsync("", context); var buffer = Encoding.UTF8.GetBytes("Hello World"); // Write to the application await state.Application.Output.WriteAsync(new Message(buffer, MessageType.Text, endOfMessage: true)); await task; Assert.Equal(StatusCodes.Status204NoContent, context.Response.StatusCode); ConnectionState removed; bool exists = manager.TryGetConnection(state.Connection.ConnectionId, out removed); Assert.False(exists); } [Theory] [InlineData("", "text", "Hello, World", "Hello, World", MessageType.Text)] // Legacy format [InlineData("", "binary", "Hello, World", "Hello, World", MessageType.Binary)] // Legacy format [InlineData(TextContentType, null, "T12:T:Hello, World;", "Hello, World", MessageType.Text)] [InlineData(TextContentType, null, "T16:B:SGVsbG8sIFdvcmxk;", "Hello, World", MessageType.Binary)] [InlineData(TextContentType, null, "T12:E:Hello, World;", "Hello, World", MessageType.Error)] [InlineData(TextContentType, null, "T12:C:Hello, World;", "Hello, World", MessageType.Close)] [InlineData(BinaryContentType, null, "QgAAAAAAAAAMAEhlbGxvLCBXb3JsZA==", "Hello, World", MessageType.Text)] [InlineData(BinaryContentType, null, "QgAAAAAAAAAMAUhlbGxvLCBXb3JsZA==", "Hello, World", MessageType.Binary)] [InlineData(BinaryContentType, null, "QgAAAAAAAAAMAkhlbGxvLCBXb3JsZA==", "Hello, World", MessageType.Error)] [InlineData(BinaryContentType, null, "QgAAAAAAAAAMA0hlbGxvLCBXb3JsZA==", "Hello, World", MessageType.Close)] public async Task SendPutsPayloadsInTheChannel(string contentType, string format, string encoded, string payload, MessageType type) { var messages = await RunSendTest(contentType, encoded, format); Assert.Equal(1, messages.Count); Assert.Equal(payload, Encoding.UTF8.GetString(messages[0].Payload)); Assert.Equal(type, messages[0].Type); } [Theory] [InlineData(TextContentType, "T12:T:Hello, World;16:B:SGVsbG8sIFdvcmxk;5:E:Error;6:C:Closed;")] [InlineData(BinaryContentType, "QgAAAAAAAAAMAEhlbGxvLCBXb3JsZAAAAAAAAAAMAUhlbGxvLCBXb3JsZAAAAAAAAAAFAkVycm9yAAAAAAAAAAYDQ2xvc2Vk")] public async Task SendAllowsMultipleMessages(string contentType, string encoded) { var messages = await RunSendTest(contentType, encoded, format: null); Assert.Equal(4, messages.Count); Assert.Equal("Hello, World", Encoding.UTF8.GetString(messages[0].Payload)); Assert.Equal(MessageType.Text, messages[0].Type); Assert.Equal("Hello, World", Encoding.UTF8.GetString(messages[1].Payload)); Assert.Equal(MessageType.Binary, messages[1].Type); Assert.Equal("Error", Encoding.UTF8.GetString(messages[2].Payload)); Assert.Equal(MessageType.Error, messages[2].Type); Assert.Equal("Closed", Encoding.UTF8.GetString(messages[3].Payload)); Assert.Equal(MessageType.Close, messages[3].Type); } private static async Task> RunSendTest(string contentType, string encoded, string format) { var manager = CreateConnectionManager(); var state = manager.CreateConnection(); var dispatcher = new HttpConnectionDispatcher(manager, new LoggerFactory()); var context = MakeRequest("/send", state, format); context.Request.ContentType = contentType; var endPoint = context.RequestServices.GetRequiredService(); var buffer = contentType == BinaryContentType ? Convert.FromBase64String(encoded) : Encoding.UTF8.GetBytes(encoded); var messages = new List(); using (context.Request.Body = new MemoryStream(buffer, writable: false)) { await dispatcher.ExecuteAsync("", context).OrTimeout(); } while (state.Connection.Transport.Input.TryRead(out var message)) { messages.Add(message); } return messages; } private static DefaultHttpContext MakeRequest(string path, ConnectionState state, string format = null) where TEndPoint : EndPoint { var context = new DefaultHttpContext(); var services = new ServiceCollection(); services.AddEndPoint(); context.RequestServices = services.BuildServiceProvider(); context.Request.Path = path; var values = new Dictionary(); values["id"] = state.Connection.ConnectionId; if (format != null) { values["format"] = format; } var qs = new QueryCollection(values); context.Request.Query = qs; return context; } private static ConnectionManager CreateConnectionManager() { return new ConnectionManager(new Logger(new LoggerFactory())); } } public class BlockingEndPoint : EndPoint { public override Task OnConnectedAsync(Connection connection) { connection.Transport.Input.WaitToReadAsync().Wait(); return Task.CompletedTask; } } public class SynchronusExceptionEndPoint : EndPoint { public override Task OnConnectedAsync(Connection connection) { throw new InvalidOperationException(); } } public class ImmediatelyCompleteEndPoint : EndPoint { public override Task OnConnectedAsync(Connection connection) { return Task.CompletedTask; } } public class TestEndPoint : EndPoint { public override async Task OnConnectedAsync(Connection connection) { while (await connection.Transport.Input.WaitToReadAsync()) { } } } }