// 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.IO; using System.IO.Pipelines; using System.Security.Claims; using System.Threading; using System.Threading.Tasks; using System.Threading.Tasks.Channels; using Microsoft.AspNetCore.Sockets; using Microsoft.AspNetCore.Sockets.Internal; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Internal; using Moq; using Newtonsoft.Json; using Xunit; namespace Microsoft.AspNetCore.SignalR.Tests { public class HubEndpointTests { [Fact] public async Task HubsAreDisposed() { var trackDispose = new TrackDispose(); var serviceProvider = CreateServiceProvider(s => s.AddSingleton(trackDispose)); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); // kill the connection connectionWrapper.Dispose(); await endPointTask; Assert.Equal(2, trackDispose.DisposeCount); } } [Fact] public async Task LifetimeManagerOnDisconnectedAsyncCalledIfLifetimeManagerOnConnectedAsyncThrows() { var mockLifetimeManager = new Mock>(); mockLifetimeManager .Setup(m => m.OnConnectedAsync(It.IsAny())) .Throws(new InvalidOperationException("Lifetime manager OnConnectedAsync failed.")); var mockHubActivator = new Mock>(); var serviceProvider = CreateServiceProvider(services => { services.AddSingleton(mockLifetimeManager.Object); services.AddSingleton(mockHubActivator.Object); }); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var exception = await Assert.ThrowsAsync( async () => await endPoint.OnConnectedAsync(connectionWrapper.Connection)); Assert.Equal("Lifetime manager OnConnectedAsync failed.", exception.Message); connectionWrapper.Dispose(); mockLifetimeManager.Verify(m => m.OnConnectedAsync(It.IsAny()), Times.Once); mockLifetimeManager.Verify(m => m.OnDisconnectedAsync(It.IsAny()), Times.Once); // No hubs should be created since the connection is terminated mockHubActivator.Verify(m => m.Create(), Times.Never); mockHubActivator.Verify(m => m.Release(It.IsAny()), Times.Never); } } [Fact] public async Task HubOnDisconnectedAsyncCalledIfHubOnConnectedAsyncThrows() { var mockLifetimeManager = new Mock>(); var serviceProvider = CreateServiceProvider(services => { services.AddSingleton(mockLifetimeManager.Object); }); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); connectionWrapper.Dispose(); var exception = await Assert.ThrowsAsync(async () => await endPointTask); Assert.Equal("Hub OnConnected failed.", exception.Message); mockLifetimeManager.Verify(m => m.OnConnectedAsync(It.IsAny()), Times.Once); mockLifetimeManager.Verify(m => m.OnDisconnectedAsync(It.IsAny()), Times.Once); } } [Fact] public async Task LifetimeManagerOnDisconnectedAsyncCalledIfHubOnDisconnectedAsyncThrows() { var mockLifetimeManager = new Mock>(); var serviceProvider = CreateServiceProvider(services => { services.AddSingleton(mockLifetimeManager.Object); }); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); connectionWrapper.Dispose(); var exception = await Assert.ThrowsAsync(async () => await endPointTask); Assert.Equal("Hub OnDisconnected failed.", exception.Message); mockLifetimeManager.Verify(m => m.OnConnectedAsync(It.IsAny()), Times.Once); mockLifetimeManager.Verify(m => m.OnDisconnectedAsync(It.IsAny()), Times.Once); } } [Fact] public async Task HubMethodCanReturnValueFromTask() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, nameof(MethodHub.TaskValueMethod)); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); // json serializer makes this a long Assert.Equal(42L, result.Result); // kill the connection connectionWrapper.Connection.Dispose(); await endPointTask.OrTimeout(); } } [Fact] public async Task HubMethodCanReturnValue() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, "ValueMethod"); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); // json serializer makes this a long Assert.Equal(43L, result.Result); // kill the connection connectionWrapper.Connection.Dispose(); await endPointTask.OrTimeout(); } } [Fact] public async Task HubMethodCanBeStatic() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, "StaticMethod"); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); Assert.Equal("fromStatic", result.Result); // kill the connection connectionWrapper.Connection.Dispose(); await endPointTask.OrTimeout(); } } [Fact] public async Task HubMethodCanBeVoid() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, "VoidMethod"); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); Assert.Null(result.Result); // kill the connection connectionWrapper.Connection.Dispose(); await endPointTask.OrTimeout(); } } [Fact] public async Task HubMethodWithMultiParam() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, "ConcatString", (byte)32, 42, 'm', "string"); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); Assert.Equal("32, 42, m, string", result.Result); // kill the connection connectionWrapper.Connection.Dispose(); await endPointTask; } } [Fact] public async Task CannotCallOverriddenBaseHubMethod() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connectionWrapper = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connectionWrapper.Connection); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(connectionWrapper, adapter, "OnDisconnectedAsync"); var result = await ReadConnectionOutputAsync(connectionWrapper).OrTimeout(); Assert.Equal("Unknown hub method 'OnDisconnectedAsync'", result.Error); } } [Fact] public async Task BroadcastHubMethod_SendsToAllClients() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var firstConnection = new ConnectionWrapper()) using (var secondConnection = new ConnectionWrapper()) { var firstEndPointTask = endPoint.OnConnectedAsync(firstConnection.Connection); var secondEndPointTask = endPoint.OnConnectedAsync(secondConnection.Connection); await Task.WhenAll(firstConnection.Connected, secondConnection.Connected).OrTimeout(); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest(firstConnection, adapter, "BroadcastMethod", "test"); foreach (var result in await Task.WhenAll( ReadConnectionOutputAsync(firstConnection), ReadConnectionOutputAsync(secondConnection)).OrTimeout()) { Assert.Equal("Broadcast", result.Method); Assert.Equal(1, result.Arguments.Length); Assert.Equal("test", result.Arguments[0]); } // kill the connections firstConnection.Connection.Dispose(); secondConnection.Connection.Dispose(); await Task.WhenAll(firstEndPointTask, secondEndPointTask).OrTimeout(); } } [Fact] public async Task HubsCanAddAndSendToGroup() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var firstConnection = new ConnectionWrapper()) using (var secondConnection = new ConnectionWrapper()) { var firstEndPointTask = endPoint.OnConnectedAsync(firstConnection.Connection); var secondEndPointTask = endPoint.OnConnectedAsync(secondConnection.Connection); await Task.WhenAll(firstConnection.Connected, secondConnection.Connected).OrTimeout(); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest_IgnoreReceive(firstConnection, adapter, "GroupSendMethod", "testGroup", "test"); // check that 'secondConnection' hasn't received the group send Message message; Assert.False(secondConnection.Application.Input.TryRead(out message)); await SendRequest_IgnoreReceive(secondConnection, adapter, "GroupAddMethod", "testGroup"); await SendRequest(firstConnection, adapter, "GroupSendMethod", "testGroup", "test"); // check that 'firstConnection' hasn't received the group send Assert.False(firstConnection.Application.Input.TryRead(out message)); // check that 'secondConnection' has received the group send var res = await ReadConnectionOutputAsync(secondConnection).OrTimeout(); Assert.Equal("Send", res.Method); Assert.Equal(1, res.Arguments.Length); Assert.Equal("test", res.Arguments[0]); // kill the connections firstConnection.Connection.Dispose(); secondConnection.Connection.Dispose(); await Task.WhenAll(firstEndPointTask, secondEndPointTask).OrTimeout(); } } [Fact] public async Task RemoveFromGroupWhenNotInGroupDoesNotFail() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var connection = new ConnectionWrapper()) { var endPointTask = endPoint.OnConnectedAsync(connection.Connection); var invocationAdapter = serviceProvider.GetService(); var writer = invocationAdapter.GetInvocationAdapter("json"); await SendRequest_IgnoreReceive(connection, writer, "GroupRemoveMethod", "testGroup"); // kill the connection connection.Connection.Dispose(); await endPointTask.OrTimeout(); } } [Fact] public async Task HubsCanSendToUser() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var firstConnection = new ConnectionWrapper()) using (var secondConnection = new ConnectionWrapper()) { var firstEndPointTask = endPoint.OnConnectedAsync(firstConnection.Connection); var secondEndPointTask = endPoint.OnConnectedAsync(secondConnection.Connection); await Task.WhenAll(firstConnection.Connected, secondConnection.Connected).OrTimeout(); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest_IgnoreReceive(firstConnection, adapter, "ClientSendMethod", secondConnection.Connection.User.Identity.Name, "test"); // check that 'secondConnection' has received the group send var res = await ReadConnectionOutputAsync(secondConnection).OrTimeout(); Assert.Equal("Send", res.Method); Assert.Equal(1, res.Arguments.Length); Assert.Equal("test", res.Arguments[0]); // kill the connections firstConnection.Connection.Dispose(); secondConnection.Connection.Dispose(); await Task.WhenAll(firstEndPointTask, secondEndPointTask).OrTimeout(); } } [Fact] public async Task HubsCanSendToConnection() { var serviceProvider = CreateServiceProvider(); var endPoint = serviceProvider.GetService>(); using (var firstConnection = new ConnectionWrapper()) using (var secondConnection = new ConnectionWrapper()) { var firstEndPointTask = endPoint.OnConnectedAsync(firstConnection.Connection); var secondEndPointTask = endPoint.OnConnectedAsync(secondConnection.Connection); await Task.WhenAll(firstConnection.Connected, secondConnection.Connected).OrTimeout(); var invocationAdapter = serviceProvider.GetService(); var adapter = invocationAdapter.GetInvocationAdapter("json"); await SendRequest_IgnoreReceive(firstConnection, adapter, "ConnectionSendMethod", secondConnection.Connection.ConnectionId, "test"); // check that 'secondConnection' has received the group send var result = await ReadConnectionOutputAsync(secondConnection).OrTimeout(); Assert.Equal("Send", result.Method); Assert.Equal(1, result.Arguments.Length); Assert.Equal("test", result.Arguments[0]); // kill the connections firstConnection.Connection.Dispose(); secondConnection.Connection.Dispose(); await Task.WhenAll(firstEndPointTask, secondEndPointTask).OrTimeout(); } } private static Type GetEndPointType(Type hubType) { var endPointType = typeof(HubEndPoint<>); return endPointType.MakeGenericType(hubType); } private static Type GetGenericType(Type genericType, Type hubType) { return genericType.MakeGenericType(hubType); } public async Task SendRequest(ConnectionWrapper connection, IInvocationAdapter writer, string method, params object[] args) { if (connection == null) { throw new ArgumentNullException(); } var stream = new MemoryStream(); await writer.WriteMessageAsync(new InvocationDescriptor { Arguments = args, Method = method }, stream); var buffer = ReadableBuffer.Create(stream.ToArray()).Preserve(); await connection.Application.Output.WriteAsync(new Message(buffer, Format.Binary, endOfMessage: true)); } public async Task SendRequest_IgnoreReceive(ConnectionWrapper connection, IInvocationAdapter writer, string method, params object[] args) { await SendRequest(connection, writer, method, args); // Consume the result await connection.Application.Input.ReadAsync(); } private async Task ReadConnectionOutputAsync(ConnectionWrapper connection) { // TODO: other formats? var message = await connection.Application.Input.ReadAsync(); var serializer = new JsonSerializer(); return serializer.Deserialize(new JsonTextReader(new StreamReader(new MemoryStream(message.Payload.Buffer.ToArray())))); } private IServiceProvider CreateServiceProvider(Action addServices = null) { var services = new ServiceCollection(); services.AddOptions() .AddLogging() .AddSignalR(); addServices?.Invoke(services); return services.BuildServiceProvider(); } public class OnConnectedThrowsHub : Hub { public override Task OnConnectedAsync() { var tcs = new TaskCompletionSource(); tcs.SetException(new InvalidOperationException("Hub OnConnected failed.")); return tcs.Task; } } public class OnDisconnectedThrowsHub : Hub { public override Task OnDisconnectedAsync(Exception exception) { var tcs = new TaskCompletionSource(); tcs.SetException(new InvalidOperationException("Hub OnDisconnected failed.")); return tcs.Task; } } private class MethodHub : Hub { public override Task OnConnectedAsync() { Context.Connection.Metadata.Get>("ConnectedTask").SetResult(true); return base.OnConnectedAsync(); } public Task GroupRemoveMethod(string groupName) { return Groups.RemoveAsync(groupName); } public Task ClientSendMethod(string userId, string message) { return Clients.User(userId).InvokeAsync("Send", message); } public Task ConnectionSendMethod(string connectionId, string message) { return Clients.Client(connectionId).InvokeAsync("Send", message); } public Task GroupAddMethod(string groupName) { return Groups.AddAsync(groupName); } public Task GroupSendMethod(string groupName, string message) { return Clients.Group(groupName).InvokeAsync("Send", message); } public Task BroadcastMethod(string message) { return Clients.All.InvokeAsync("Broadcast", message); } public Task TaskValueMethod() { return Task.FromResult(42); } public int ValueMethod() { return 43; } static public string StaticMethod() { return "fromStatic"; } public void VoidMethod() { } public string ConcatString(byte b, int i, char c, string s) { return $"{b}, {i}, {c}, {s}"; } public override Task OnDisconnectedAsync(Exception e) { return TaskCache.CompletedTask; } } private class TestHub : Hub { private TrackDispose _trackDispose; public TestHub(TrackDispose trackDispose) { _trackDispose = trackDispose; } protected override void Dispose(bool dispose) { if (dispose) { _trackDispose.DisposeCount++; } } } private class TrackDispose { public int DisposeCount = 0; } public class ConnectionWrapper : IDisposable { private static int _id; public Connection Connection { get; } public IChannelConnection Application { get; } public Task Connected => Connection.Metadata.Get>("ConnectedTask").Task; public ConnectionWrapper(string format = "json") { var transportToApplication = Channel.CreateUnbounded(); var applicationToTransport = Channel.CreateUnbounded(); Application = ChannelConnection.Create(input: applicationToTransport, output: transportToApplication); var transport = ChannelConnection.Create(input: transportToApplication, output: applicationToTransport); Connection = new Connection(Guid.NewGuid().ToString(), transport); Connection.Metadata["formatType"] = format; Connection.User = new ClaimsPrincipal(new ClaimsIdentity(new[] { new Claim(ClaimTypes.Name, Interlocked.Increment(ref _id).ToString()) })); Connection.Metadata["ConnectedTask"] = new TaskCompletionSource(); } public void Dispose() { Connection.Dispose(); } } } }