Make HubConnection methods virtual (#35132)

Author: BrennanConroy

src/SignalR/clients/csharp/Client.Core/src/HubConnection.cs

@@ -233,7 +233,7 @@ public HubConnection(IConnectionFactory connectionFactory,
         /// </summary>
         /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None" />.</param>
         /// <returns>A <see cref="Task"/> that represents the asynchronous start.</returns>
-        public async Task StartAsync(CancellationToken cancellationToken = default)
+        public virtual async Task StartAsync(CancellationToken cancellationToken = default)
         {
             CheckDisposed();
             using (_logger.BeginScope(_logScope))
@@ -286,7 +286,7 @@ private async Task StartAsyncInner(CancellationToken cancellationToken = default
         /// </summary>
         /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None" />.</param>
         /// <returns>A <see cref="Task"/> that represents the asynchronous stop.</returns>
-        public async Task StopAsync(CancellationToken cancellationToken = default)
+        public virtual async Task StopAsync(CancellationToken cancellationToken = default)
         {
             CheckDisposed();
             using (_logger.BeginScope(_logScope))
@@ -301,7 +301,7 @@ public async Task StopAsync(CancellationToken cancellationToken = default)
         /// Disposes the <see cref="HubConnection"/>.
         /// </summary>
         /// <returns>A <see cref="ValueTask"/> that represents the asynchronous dispose.</returns>
-        public async ValueTask DisposeAsync()
+        public virtual async ValueTask DisposeAsync()
         {
             if (!_disposed)
             {
@@ -324,7 +324,7 @@ public async ValueTask DisposeAsync()
         /// <remarks>
         /// This is a low level method for registering a handler. Using an <see cref="HubConnectionExtensions"/> <c>On</c> extension method is recommended.
         /// </remarks>
-        public IDisposable On(string methodName, Type[] parameterTypes, Func<object?[], object, Task> handler, object state)
+        public virtual IDisposable On(string methodName, Type[] parameterTypes, Func<object?[], object, Task> handler, object state)
         {
             Log.RegisteringHandler(_logger, methodName);
 
@@ -349,7 +349,7 @@ public IDisposable On(string methodName, Type[] parameterTypes, Func<object?[],
         /// Removes all handlers associated with the method with the specified method name.
         /// </summary>
         /// <param name="methodName">The name of the hub method from which handlers are being removed</param>
-        public void Remove(string methodName)
+        public virtual void Remove(string methodName)
         {
             CheckDisposed();
             Log.RemovingHandlers(_logger, methodName);
@@ -370,7 +370,7 @@ public void Remove(string methodName)
         /// <remarks>
         /// This is a low level method for invoking a streaming hub method on the server. Using an <see cref="HubConnectionExtensions"/> <c>StreamAsChannelAsync</c> extension method is recommended.
         /// </remarks>
-        public async Task<ChannelReader<object?>> StreamAsChannelCoreAsync(string methodName, Type returnType, object?[] args, CancellationToken cancellationToken = default)
+        public virtual async Task<ChannelReader<object?>> StreamAsChannelCoreAsync(string methodName, Type returnType, object?[] args, CancellationToken cancellationToken = default)
         {
             using (_logger.BeginScope(_logScope))
             {
@@ -392,7 +392,7 @@ public void Remove(string methodName)
         /// <remarks>
         /// This is a low level method for invoking a hub method on the server. Using an <see cref="HubConnectionExtensions"/> <c>InvokeAsync</c> extension method is recommended.
         /// </remarks>
-        public async Task<object?> InvokeCoreAsync(string methodName, Type returnType, object?[] args, CancellationToken cancellationToken = default)
+        public virtual async Task<object?> InvokeCoreAsync(string methodName, Type returnType, object?[] args, CancellationToken cancellationToken = default)
         {
             using (_logger.BeginScope(_logScope))
             {
@@ -411,7 +411,7 @@ public void Remove(string methodName)
         /// <remarks>
         /// This is a low level method for invoking a hub method on the server. Using an <see cref="HubConnectionExtensions"/> <c>SendAsync</c> extension method is recommended.
         /// </remarks>
-        public async Task SendCoreAsync(string methodName, object?[] args, CancellationToken cancellationToken = default)
+        public virtual async Task SendCoreAsync(string methodName, object?[] args, CancellationToken cancellationToken = default)
         {
             using (_logger.BeginScope(_logScope))
             {
@@ -551,7 +551,7 @@ private async Task StopAsyncCore(bool disposing)
         /// <returns>
         /// A <see cref="IAsyncEnumerable{TResult}"/> that represents the stream.
         /// </returns>
-        public IAsyncEnumerable<TResult> StreamAsyncCore<TResult>(string methodName, object?[] args, CancellationToken cancellationToken = default)
+        public virtual IAsyncEnumerable<TResult> StreamAsyncCore<TResult>(string methodName, object?[] args, CancellationToken cancellationToken = default)
         {
             var cts = cancellationToken.CanBeCanceled ? CancellationTokenSource.CreateLinkedTokenSource(cancellationToken) : new CancellationTokenSource();
             var stream = CastIAsyncEnumerable<TResult>(methodName, args, cts);

src/SignalR/clients/csharp/Client.Core/src/PublicAPI.Unshipped.txt

@@ -9,9 +9,10 @@
 *REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.StopAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task
 *REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.On(string methodName, System.Type[] parameterTypes, System.Func<object[], object, System.Threading.Tasks.Task> handler, object state) -> System.IDisposable
 *REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.Remove(string methodName) -> void
+*REMOVED*Microsoft.AspNetCore.SignalR.Client.HubConnection.DisposeAsync() -> System.Threading.Tasks.ValueTask
 *REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsChannelCoreAsync(string methodName, System.Type returnType, object[] args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<System.Threading.Channels.ChannelReader<object>>
-*REMOVED*Microsoft.AspNetCore.SignalR.Client.HubConnection.InvokeCoreAsync(string! methodName, System.Type! returnType, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<object?>!
-*REMOVED*Microsoft.AspNetCore.SignalR.Client.HubConnection.SendCoreAsync(string! methodName, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
+*REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.InvokeCoreAsync(string methodName, System.Type returnType, object[] args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<object>
+*REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.SendCoreAsync(string methodName, object[] args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task
 *REMOVED*~Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsyncCore<TResult>(string methodName, object[] args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>
 *REMOVED*~static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.On(this Microsoft.AspNetCore.SignalR.Client.HubConnection hubConnection, string methodName, System.Action handler) -> System.IDisposable
 *REMOVED*~static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.On(this Microsoft.AspNetCore.SignalR.Client.HubConnection hubConnection, string methodName, System.Func<System.Threading.Tasks.Task> handler) -> System.IDisposable
@@ -109,14 +110,6 @@ Microsoft.AspNetCore.SignalR.Client.HubConnection.Reconnected -> System.Func<str
 Microsoft.AspNetCore.SignalR.Client.HubConnection.ConnectionId.get -> string?
 Microsoft.AspNetCore.SignalR.Client.HubConnection.HubConnection(Microsoft.AspNetCore.Connections.IConnectionFactory! connectionFactory, Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol! protocol, System.Net.EndPoint! endPoint, System.IServiceProvider! serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory) -> void
 Microsoft.AspNetCore.SignalR.Client.HubConnection.HubConnection(Microsoft.AspNetCore.Connections.IConnectionFactory! connectionFactory, Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol! protocol, System.Net.EndPoint! endPoint, System.IServiceProvider! serviceProvider, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory, Microsoft.AspNetCore.SignalR.Client.IRetryPolicy! reconnectPolicy) -> void
-Microsoft.AspNetCore.SignalR.Client.HubConnection.StartAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.StopAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.On(string! methodName, System.Type![]! parameterTypes, System.Func<object?[]!, object!, System.Threading.Tasks.Task!>! handler, object! state) -> System.IDisposable!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.Remove(string! methodName) -> void
-Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsChannelCoreAsync(string! methodName, System.Type! returnType, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<System.Threading.Channels.ChannelReader<object?>!>!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.InvokeCoreAsync(string! methodName, System.Type! returnType, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<object?>!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.SendCoreAsync(string! methodName, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
-Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsyncCore<TResult>(string! methodName, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>!
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.On(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, System.Action! handler) -> System.IDisposable!
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.On(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, System.Func<System.Threading.Tasks.Task!>! handler) -> System.IDisposable!
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.On(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, System.Type![]! parameterTypes, System.Func<object?[]!, System.Threading.Tasks.Task!>! handler) -> System.IDisposable!
@@ -207,3 +200,12 @@ static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.StreamAsync<T
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.StreamAsync<TResult>(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, object? arg1, object? arg2, object? arg3, object? arg4, object? arg5, object? arg6, object? arg7, object? arg8, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>!
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.StreamAsync<TResult>(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, object? arg1, object? arg2, object? arg3, object? arg4, object? arg5, object? arg6, object? arg7, object? arg8, object? arg9, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>!
 static Microsoft.AspNetCore.SignalR.Client.HubConnectionExtensions.StreamAsync<TResult>(this Microsoft.AspNetCore.SignalR.Client.HubConnection! hubConnection, string! methodName, object? arg1, object? arg2, object? arg3, object? arg4, object? arg5, object? arg6, object? arg7, object? arg8, object? arg9, object? arg10, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.DisposeAsync() -> System.Threading.Tasks.ValueTask
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.InvokeCoreAsync(string! methodName, System.Type! returnType, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<object?>!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.On(string! methodName, System.Type![]! parameterTypes, System.Func<object?[]!, object!, System.Threading.Tasks.Task!>! handler, object! state) -> System.IDisposable!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.Remove(string! methodName) -> void
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.SendCoreAsync(string! methodName, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.StartAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.StopAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsChannelCoreAsync(string! methodName, System.Type! returnType, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<System.Threading.Channels.ChannelReader<object?>!>!
+virtual Microsoft.AspNetCore.SignalR.Client.HubConnection.StreamAsyncCore<TResult>(string! methodName, object?[]! args, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Collections.Generic.IAsyncEnumerable<TResult>!

src/SignalR/clients/csharp/Client/test/UnitTests/HubConnectionTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Buffers;
 using System.IO;
+using System.Net;
 using System.Net.WebSockets;
 using System.Threading;
 using System.Threading.Channels;
@@ -713,6 +714,47 @@ public async Task VerifyUserOptionsAreNotChanged()
             }
         }
 
+        [Fact]
+        public async Task HubConnectionIsMockable()
+        {
+            var mockConnection = new Mock<HubConnection>(new Mock<IConnectionFactory>().Object, new Mock<IHubProtocol>().Object, new Mock<EndPoint>().Object,
+                new Mock<IServiceProvider>().Object, new Mock<ILoggerFactory>().Object, new Mock<IRetryPolicy>().Object);
+
+            mockConnection.Setup(c => c.StartAsync(default)).Returns(() => Task.CompletedTask);
+            mockConnection.Setup(c => c.StopAsync(default)).Returns(() => Task.CompletedTask);
+            mockConnection.Setup(c => c.DisposeAsync()).Returns(() => ValueTask.CompletedTask);
+            mockConnection.Setup(c => c.On(It.IsAny<string>(), It.IsAny<Type[]>(), It.IsAny<Func<object[], object, Task>>(), It.IsAny<object>()));
+            mockConnection.Setup(c => c.Remove(It.IsAny<string>()));
+            mockConnection.Setup(c => c.StreamAsChannelCoreAsync(It.IsAny<string>(), It.IsAny<Type>(), It.IsAny<object[]>(), It.IsAny<CancellationToken>()))
+                .Returns(() => Task.FromResult(It.IsAny<ChannelReader<object>>()));
+            mockConnection.Setup(c => c.InvokeCoreAsync(It.IsAny<string>(), It.IsAny<Type>(), It.IsAny<object[]>(), It.IsAny<CancellationToken>())).Returns(() => Task.FromResult(It.IsAny<object>()));
+            mockConnection.Setup(c => c.SendCoreAsync(It.IsAny<string>(), It.IsAny<object[]>(), It.IsAny<CancellationToken>())).Returns(() => Task.CompletedTask);
+            mockConnection.Setup(c => c.StreamAsyncCore<object>(It.IsAny<string>(), It.IsAny<object[]>(), It.IsAny<CancellationToken>())).Returns(() => It.IsAny<IAsyncEnumerable<object>>());
+
+            var hubConnection = mockConnection.Object;
+            // .On extension method
+            _ = hubConnection.On("someMethod", () => { });
+            // .On non-extension method
+            _ = hubConnection.On("someMethod2", new Type[] { typeof(int) }, (args, obj) => Task.CompletedTask, 2);
+            hubConnection.Remove("someMethod");
+            await hubConnection.StartAsync();
+            _ = await hubConnection.StreamAsChannelCoreAsync("stream", typeof(int), Array.Empty<object>(), default);
+            _ = await hubConnection.InvokeCoreAsync("test", typeof(int), Array.Empty<object>(), default);
+            await hubConnection.SendCoreAsync("test2", Array.Empty<object>(), default);
+            _ = hubConnection.StreamAsyncCore<int>("stream2", Array.Empty<object>(), default);
+            await hubConnection.StopAsync();
+
+            mockConnection.Verify(c => c.On("someMethod", It.IsAny<Type[]>(), It.IsAny<Func<object[], object, Task>>(), It.IsAny<object>()), Times.Once);
+            mockConnection.Verify(c => c.On("someMethod2", It.IsAny<Type[]>(), It.IsAny<Func<object[], object, Task>>(), 2), Times.Once);
+            mockConnection.Verify(c => c.Remove("someMethod"), Times.Once);
+            mockConnection.Verify(c => c.StreamAsChannelCoreAsync("stream", It.IsAny<Type>(), It.IsAny<object[]>(), It.IsAny<CancellationToken>()), Times.Once);
+            mockConnection.Verify(c => c.InvokeCoreAsync("test", typeof(int), Array.Empty<object>(), It.IsAny<CancellationToken>()), Times.Once);
+            mockConnection.Verify(c => c.SendCoreAsync("test2", Array.Empty<object>(), It.IsAny<CancellationToken>()), Times.Once);
+            mockConnection.Verify(c => c.StreamAsyncCore<int>("stream2", Array.Empty<object>(), It.IsAny<CancellationToken>()), Times.Once);
+            mockConnection.Verify(c => c.StartAsync(It.IsAny<CancellationToken>()), Times.Once);
+            mockConnection.Verify(c => c.StopAsync(It.IsAny<CancellationToken>()), Times.Once);
+        }
+
         private class SampleObject
         {
             public SampleObject(string foo, int bar)