// 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.Threading.Channels; using System.Threading.Tasks; using Microsoft.AspNetCore.SignalR.Internal; using Microsoft.AspNetCore.SignalR.Protocol; using Microsoft.AspNetCore.SignalR.Tests; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Extensions.Options; using Moq; using Newtonsoft.Json.Linq; using Newtonsoft.Json.Serialization; using Xunit; namespace Microsoft.AspNetCore.SignalR.Redis.Tests { public class RedisHubLifetimeManagerTests { [Fact] public async Task InvokeAllAsyncWritesToAllConnectionsOutput() { var server = new TestRedisServer(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var manager = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager.OnConnectedAsync(connection1).OrTimeout(); await manager.OnConnectedAsync(connection2).OrTimeout(); await manager.SendAllAsync("Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client1); await AssertMessageAsync(client2); } } [Fact] public async Task InvokeAllExceptAsyncExcludesSpecifiedConnections() { var server = new TestRedisServer(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) using (var client3 = new TestClient()) { var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); var manager3 = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); var connection3 = HubConnectionContextUtils.Create(client3.Connection); await manager1.OnConnectedAsync(connection1).OrTimeout(); await manager2.OnConnectedAsync(connection2).OrTimeout(); await manager3.OnConnectedAsync(connection3).OrTimeout(); await manager1.SendAllExceptAsync("Hello", new object[] { "World" }, new [] { client3.Connection.ConnectionId }).OrTimeout(); await AssertMessageAsync(client1); await AssertMessageAsync(client2); Assert.Null(client3.TryRead()); } } [Fact] public async Task InvokeAllAsyncDoesNotWriteToDisconnectedConnectionsOutput() { var server = new TestRedisServer(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var manager = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager.OnConnectedAsync(connection1).OrTimeout(); await manager.OnConnectedAsync(connection2).OrTimeout(); await manager.OnDisconnectedAsync(connection2).OrTimeout(); await manager.SendAllAsync("Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client1); Assert.Null(client2.TryRead()); } } [Fact] public async Task InvokeGroupAsyncWritesToAllConnectionsInGroupOutput() { var server = new TestRedisServer(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var manager = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager.OnConnectedAsync(connection1).OrTimeout(); await manager.OnConnectedAsync(connection2).OrTimeout(); await manager.AddToGroupAsync(connection1.ConnectionId, "gunit").OrTimeout(); await manager.SendGroupAsync("gunit", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client1); Assert.Null(client2.TryRead()); } } [Fact] public async Task InvokeGroupExceptAsyncWritesToAllValidConnectionsInGroupOutput() { var server = new TestRedisServer(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var manager = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager.OnConnectedAsync(connection1).OrTimeout(); await manager.OnConnectedAsync(connection2).OrTimeout(); await manager.AddToGroupAsync(connection1.ConnectionId, "gunit").OrTimeout(); await manager.AddToGroupAsync(connection2.ConnectionId, "gunit").OrTimeout(); var excludedConnectionIds = new List { client2.Connection.ConnectionId }; await manager.SendGroupExceptAsync("gunit", "Hello", new object[] { "World" }, excludedConnectionIds).OrTimeout(); await AssertMessageAsync(client1); Assert.Null(client2.TryRead()); } } [Fact] public async Task InvokeConnectionAsyncWritesToConnectionOutput() { var server = new TestRedisServer(); using (var client = new TestClient()) { var manager = CreateLifetimeManager(server); var connection = HubConnectionContextUtils.Create(client.Connection); await manager.OnConnectedAsync(connection).OrTimeout(); await manager.SendConnectionAsync(connection.ConnectionId, "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); } } [Fact] public async Task InvokeConnectionAsyncOnNonExistentConnectionDoesNotThrow() { var server = new TestRedisServer(); var manager = CreateLifetimeManager(server); await manager.SendConnectionAsync("NotARealConnectionId", "Hello", new object[] { "World" }).OrTimeout(); } [Fact] public async Task InvokeAllAsyncWithMultipleServersWritesToAllConnectionsOutput() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager1.OnConnectedAsync(connection1).OrTimeout(); await manager2.OnConnectedAsync(connection2).OrTimeout(); await manager1.SendAllAsync("Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client1); await AssertMessageAsync(client2); } } [Fact] public async Task InvokeAllAsyncWithMultipleServersDoesNotWriteToDisconnectedConnectionsOutput() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager1.OnConnectedAsync(connection1).OrTimeout(); await manager2.OnConnectedAsync(connection2).OrTimeout(); await manager2.OnDisconnectedAsync(connection2).OrTimeout(); await manager2.SendAllAsync("Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client1); Assert.Null(client2.TryRead()); } } [Fact] public async Task InvokeConnectionAsyncOnServerWithoutConnectionWritesOutputToConnection() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager2.SendConnectionAsync(connection.ConnectionId, "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); } } [Fact] public async Task InvokeGroupAsyncOnServerWithoutConnectionWritesOutputToGroupConnection() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager1.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); } } [Fact] public async Task DisconnectConnectionRemovesConnectionFromGroup() { var server = new TestRedisServer(); var manager = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager.OnConnectedAsync(connection).OrTimeout(); await manager.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager.OnDisconnectedAsync(connection).OrTimeout(); await manager.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); Assert.Null(client.TryRead()); } } [Fact] public async Task RemoveGroupFromLocalConnectionNotInGroupDoesNothing() { var server = new TestRedisServer(); var manager = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager.OnConnectedAsync(connection).OrTimeout(); await manager.RemoveFromGroupAsync(connection.ConnectionId, "name").OrTimeout(); } } [Fact] public async Task RemoveGroupFromConnectionOnDifferentServerNotInGroupDoesNothing() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager2.RemoveFromGroupAsync(connection.ConnectionId, "name").OrTimeout(); } } [Fact] public async Task AddGroupAsyncForConnectionOnDifferentServerWorks() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager2.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); } } [Fact] public async Task AddGroupAsyncForLocalConnectionAlreadyInGroupDoesNothing() { var server = new TestRedisServer(); var manager = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager.OnConnectedAsync(connection).OrTimeout(); await manager.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); Assert.Null(client.TryRead()); } } [Fact] public async Task AddGroupAsyncForConnectionOnDifferentServerAlreadyInGroupDoesNothing() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager1.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); Assert.Null(client.TryRead()); } } [Fact] public async Task RemoveGroupAsyncForConnectionOnDifferentServerWorks() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); await manager1.OnConnectedAsync(connection).OrTimeout(); await manager1.AddToGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); await manager2.RemoveFromGroupAsync(connection.ConnectionId, "name").OrTimeout(); await manager2.SendGroupAsync("name", "Hello", new object[] { "World" }).OrTimeout(); Assert.Null(client.TryRead()); } } [Fact] public async Task InvokeConnectionAsyncForLocalConnectionDoesNotPublishToRedis() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { var connection = HubConnectionContextUtils.Create(client.Connection); // Add connection to both "servers" to see if connection receives message twice await manager1.OnConnectedAsync(connection).OrTimeout(); await manager2.OnConnectedAsync(connection).OrTimeout(); await manager1.SendConnectionAsync(connection.ConnectionId, "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client); Assert.Null(client.TryRead()); } } [Fact] public async Task WritingToRemoteConnectionThatFailsDoesNotThrow() { var server = new TestRedisServer(); var manager1 = CreateLifetimeManager(server); var manager2 = CreateLifetimeManager(server); using (var client = new TestClient()) { // Force an exception when writing to connection var connectionMock = HubConnectionContextUtils.CreateMock(client.Connection); connectionMock.Setup(m => m.WriteAsync(It.IsAny())).Throws(new Exception()); var connection = connectionMock.Object; await manager2.OnConnectedAsync(connection).OrTimeout(); // This doesn't throw because there is no connection.ConnectionId on this server so it has to publish to redis. // And once that happens there is no way to know if the invocation was successful or not. await manager1.SendConnectionAsync(connection.ConnectionId, "Hello", new object[] { "World" }).OrTimeout(); } } [Fact] public async Task WritingToGroupWithOneConnectionFailingSecondConnectionStillReceivesMessage() { var server = new TestRedisServer(); var manager = CreateLifetimeManager(server); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { // Force an exception when writing to connection var connectionMock = HubConnectionContextUtils.CreateMock(client1.Connection); connectionMock.Setup(m => m.WriteAsync(It.IsAny())).Throws(new Exception()); var connection1 = connectionMock.Object; var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager.OnConnectedAsync(connection1).OrTimeout(); await manager.AddToGroupAsync(connection1.ConnectionId, "group"); await manager.OnConnectedAsync(connection2).OrTimeout(); await manager.AddToGroupAsync(connection2.ConnectionId, "group"); await manager.SendGroupAsync("group", "Hello", new object[] { "World" }).OrTimeout(); // connection1 will throw when receiving a group message, we are making sure other connections // are not affected by another connection throwing await AssertMessageAsync(client2); // Repeat to check that group can still be sent to await manager.SendGroupAsync("group", "Hello", new object[] { "World" }).OrTimeout(); await AssertMessageAsync(client2); } } [Fact] public async Task CamelCasedJsonIsPreservedAcrossRedisBoundary() { var server = new TestRedisServer(); var messagePackOptions = new MessagePackHubProtocolOptions(); var jsonOptions = new JsonHubProtocolOptions(); jsonOptions.PayloadSerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver(); using (var client1 = new TestClient()) using (var client2 = new TestClient()) { // The sending manager has serializer settings var manager1 = CreateLifetimeManager(server, messagePackOptions, jsonOptions); // The receiving one doesn't matter because of how we serialize! var manager2 = CreateLifetimeManager(server); var connection1 = HubConnectionContextUtils.Create(client1.Connection); var connection2 = HubConnectionContextUtils.Create(client2.Connection); await manager1.OnConnectedAsync(connection1).OrTimeout(); await manager2.OnConnectedAsync(connection2).OrTimeout(); await manager1.SendAllAsync("Hello", new object[] { new TestObject { TestProperty = "Foo" } }); var message = Assert.IsType(await client2.ReadAsync().OrTimeout()); Assert.Equal("Hello", message.Target); Assert.Collection( message.Arguments, arg0 => { var dict = Assert.IsType(arg0); Assert.Collection(dict.Properties(), prop => { Assert.Equal("testProperty", prop.Name); Assert.Equal("Foo", prop.Value.Value()); }); }); } } public class TestObject { public string TestProperty { get; set; } } private RedisHubLifetimeManager CreateLifetimeManager(TestRedisServer server, MessagePackHubProtocolOptions messagePackOptions = null, JsonHubProtocolOptions jsonOptions = null) { var options = new RedisOptions() { ConnectionFactory = async (t) => await Task.FromResult(new TestConnectionMultiplexer(server)) }; messagePackOptions = messagePackOptions ?? new MessagePackHubProtocolOptions(); jsonOptions = jsonOptions ?? new JsonHubProtocolOptions(); return new RedisHubLifetimeManager( NullLogger>.Instance, Options.Create(options), new DefaultHubProtocolResolver(new IHubProtocol[] { new JsonHubProtocol(Options.Create(jsonOptions)), new MessagePackHubProtocol(Options.Create(messagePackOptions)), }, NullLogger.Instance)); } private async Task AssertMessageAsync(TestClient client) { var message = Assert.IsType(await client.ReadAsync().OrTimeout()); Assert.Equal("Hello", message.Target); Assert.Single(message.Arguments); Assert.Equal("World", (string)message.Arguments[0]); } private class MyHub : Hub { } private class MockChannel : Channel { public MockChannel(ChannelWriter writer = null) { Writer = writer; } } } }