API review changes for Microsoft.AspNetCore.SignalR (#2033)

benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks/BroadcastBenchmark.cs

@@ -49,7 +49,7 @@ public void GlobalSetup()
  var hubConnection = new HubConnectionContext(connection, Timeout.InfiniteTimeSpan, NullLoggerFactory.Instance);
  hubConnection.Protocol = protocol;
  _hubLifetimeManager.OnConnectedAsync(hubConnection).GetAwaiter().GetResult();
- _hubLifetimeManager.AddGroupAsync(connection.ConnectionId, TestGroupName).GetAwaiter().GetResult();
+ _hubLifetimeManager.AddToGroupAsync(connection.ConnectionId, TestGroupName).GetAwaiter().GetResult();
 
  _ = ConsumeAsync(connection.Application);
  }

benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks/DefaultHubActivatorBenchmark.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using BenchmarkDotNet.Attributes;
+using Microsoft.AspNetCore.SignalR.Internal;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.AspNetCore.SignalR.Microbenchmarks

benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks/DefaultHubLifetimeManagerBenchmark.cs

@@ -56,7 +56,7 @@ public void GlobalSetup()
  hubConnectionContext.Protocol = jsonHubProtocol;
 
  _hubLifetimeManager.OnConnectedAsync(hubConnectionContext).GetAwaiter().GetResult();
- _hubLifetimeManager.AddGroupAsync(connectionId, groupName);
+ _hubLifetimeManager.AddToGroupAsync(connectionId, groupName);
  }
  }
 

benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks/RedisHubLifetimeManagerBenchmark.cs

@@ -49,11 +49,11 @@ public void GlobalSetup()
  _manager1 = new RedisHubLifetimeManager<TestHub>(logger, options, resolver);
  _manager2 = new RedisHubLifetimeManager<TestHub>(logger, options, resolver);
 
- async Task ConnectClient(TestClient client, IHubProtocol protocol, string userId, string group)
+ async Task ConnectClient(TestClient client, IHubProtocol protocol, string userId, string groupName)
  {
  await _manager2.OnConnectedAsync(HubConnectionContextUtils.Create(client.Connection, protocol, userId));
- await _manager2.AddGroupAsync(client.Connection.ConnectionId, "Everyone");
- await _manager2.AddGroupAsync(client.Connection.ConnectionId, group);
+ await _manager2.AddToGroupAsync(client.Connection.ConnectionId, "Everyone");
+ await _manager2.AddToGroupAsync(client.Connection.ConnectionId, groupName);
  }
 
  // Connect clients

samples/ChatSample/PresenceHubLifetimeManager.cs

@@ -173,14 +173,14 @@ public override Task SendUserAsync(string userId, string methodName, object[] ar
  return _wrappedHubLifetimeManager.SendUserAsync(userId, methodName, args);
  }
 
- public override Task AddGroupAsync(string connectionId, string groupName)
+ public override Task AddToGroupAsync(string connectionId, string groupName)
  {
- return _wrappedHubLifetimeManager.AddGroupAsync(connectionId, groupName);
+ return _wrappedHubLifetimeManager.AddToGroupAsync(connectionId, groupName);
  }
 
- public override Task RemoveGroupAsync(string connectionId, string groupName)
+ public override Task RemoveFromGroupAsync(string connectionId, string groupName)
  {
- return _wrappedHubLifetimeManager.RemoveGroupAsync(connectionId, groupName);
+ return _wrappedHubLifetimeManager.RemoveFromGroupAsync(connectionId, groupName);
  }
 
  public override Task SendGroupExceptAsync(string groupName, string methodName, object[] args, IReadOnlyList<string> excludedIds)

samples/SignalRSamples/Hubs/Chat.cs

@@ -46,7 +46,7 @@ public Task SendToOthersInGroup(string groupName, string message)
 
  public async Task JoinGroup(string groupName)
  {
- await Groups.AddAsync(Context.ConnectionId, groupName);
+ await Groups.AddToGroupAsync(Context.ConnectionId, groupName);
 
  await Clients.Group(groupName).SendAsync("Send", $"{Context.ConnectionId} joined {groupName}");
  }
@@ -55,7 +55,7 @@ public async Task LeaveGroup(string groupName)
  {
  await Clients.Group(groupName).SendAsync("Send", $"{Context.ConnectionId} left {groupName}");
 
- await Groups.RemoveAsync(Context.ConnectionId, groupName);
+ await Groups.RemoveFromGroupAsync(Context.ConnectionId, groupName);
  }
 
  public Task Echo(string message)

samples/SignalRSamples/Hubs/DynamicChat.cs

@@ -41,7 +41,7 @@ public Task SendToOthersInGroup(string groupName, string message)
 
  public async Task JoinGroup(string groupName)
  {
- await Groups.AddAsync(Context.ConnectionId, groupName);
+ await Groups.AddToGroupAsync(Context.ConnectionId, groupName);
 
  await Clients.Group(groupName).Send($"{Context.ConnectionId} joined {groupName}");
  }
@@ -50,7 +50,7 @@ public async Task LeaveGroup(string groupName)
  {
  await Clients.Group(groupName).Send($"{Context.ConnectionId} left {groupName}");
 
- await Groups.RemoveAsync(Context.ConnectionId, groupName);
+ await Groups.RemoveFromGroupAsync(Context.ConnectionId, groupName);
  }
 
  public Task Echo(string message)

samples/SignalRSamples/Hubs/HubTChat.cs

@@ -41,7 +41,7 @@ public Task SendToOthersInGroup(string groupName, string message)
 
  public async Task JoinGroup(string groupName)
  {
- await Groups.AddAsync(Context.ConnectionId, groupName);
+ await Groups.AddToGroupAsync(Context.ConnectionId, groupName);
 
  await Clients.Group(groupName).Send($"{Context.ConnectionId} joined {groupName}");
  }
@@ -50,7 +50,7 @@ public async Task LeaveGroup(string groupName)
  {
  await Clients.Group(groupName).Send($"{Context.ConnectionId} left {groupName}");
 
- await Groups.RemoveAsync(Context.ConnectionId, groupName);
+ await Groups.RemoveFromGroupAsync(Context.ConnectionId, groupName);
  }
 
  public Task Echo(string message)

src/Microsoft.AspNetCore.SignalR.Core/IClientProxyExtensions.cs → src/Microsoft.AspNetCore.SignalR.Core/ClientProxyExtensions.cs

@@ -5,7 +5,7 @@
 
 namespace Microsoft.AspNetCore.SignalR
 {
- public static class IClientProxyExtensions
+ public static class ClientProxyExtensions
  {
  /// <summary>
  /// Invokes a method on the connection(s) represented by the <see cref="IClientProxy"/> instance.

src/Microsoft.AspNetCore.SignalR.Core/DefaultHubLifetimeManager.cs

@@ -23,7 +23,7 @@ public DefaultHubLifetimeManager(ILogger<DefaultHubLifetimeManager<THub>> logger
  _logger = logger;
  }
 
- public override Task AddGroupAsync(string connectionId, string groupName)
+ public override Task AddToGroupAsync(string connectionId, string groupName)
  {
  if (connectionId == null)
  {
@@ -46,7 +46,7 @@ public override Task AddGroupAsync(string connectionId, string groupName)
  return Task.CompletedTask;
  }
 
- public override Task RemoveGroupAsync(string connectionId, string groupName)
+ public override Task RemoveFromGroupAsync(string connectionId, string groupName)
  {
  if (connectionId == null)
  {

src/Microsoft.AspNetCore.SignalR.Core/HubConnectionContext.cs

@@ -52,7 +52,8 @@ public HubConnectionContext(ConnectionContext connectionContext, TimeSpan keepAl
 
  public virtual IDictionary<object, object> Items => _connectionContext.Items;
 
- public virtual PipeReader Input => _connectionContext.Transport.Input;
+ // Used by HubConnectionHandler
+ internal PipeReader Input => _connectionContext.Transport.Input;
 
  public string UserIdentifier { get; set; }
 

src/Microsoft.AspNetCore.SignalR.Core/HubLifetimeManager.cs

@@ -30,9 +30,9 @@ public abstract class HubLifetimeManager<THub> where THub : Hub
 
  public abstract Task SendUsersAsync(IReadOnlyList<string> userIds, string methodName, object[] args);
 
- public abstract Task AddGroupAsync(string connectionId, string groupName);
+ public abstract Task AddToGroupAsync(string connectionId, string groupName);
 
- public abstract Task RemoveGroupAsync(string connectionId, string groupName);
+ public abstract Task RemoveFromGroupAsync(string connectionId, string groupName);
  }
 
 }

src/Microsoft.AspNetCore.SignalR.Core/IGroupManager.cs

@@ -7,7 +7,7 @@ namespace Microsoft.AspNetCore.SignalR
 {
  public interface IGroupManager
  {
- Task AddAsync(string connectionId, string groupName);
- Task RemoveAsync(string connectionId, string groupName);
+ Task AddToGroupAsync(string connectionId, string groupName);
+ Task RemoveFromGroupAsync(string connectionId, string groupName);
  }
 }

src/Microsoft.AspNetCore.SignalR.Core/IHubClients`T.cs

@@ -9,7 +9,7 @@ public interface IHubClients<T>
  {
  T All { get; }
 
- T AllExcept(IReadOnlyList<string> excludedIds);
+ T AllExcept(IReadOnlyList<string> excludedConnectionIds);
 
  T Client(string connectionId);
 
@@ -19,7 +19,7 @@ public interface IHubClients<T>
 
  T Groups(IReadOnlyList<string> groupNames);
 
- T GroupExcept(string groupName, IReadOnlyList<string> excludeIds);
+ T GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds);
 
  T User(string userId);
 

src/Microsoft.AspNetCore.SignalR.Core/DefaultHubActivator.cs → src/Microsoft.AspNetCore.SignalR.Core/Internal/DefaultHubActivator.cs

@@ -5,7 +5,7 @@
 using System.Diagnostics;
 using Microsoft.Extensions.DependencyInjection;
 
-namespace Microsoft.AspNetCore.SignalR
+namespace Microsoft.AspNetCore.SignalR.Internal
 {
  public class DefaultHubActivator<THub> : IHubActivator<THub> where THub: Hub
  {
@@ -19,7 +19,7 @@ public DefaultHubActivator(IServiceProvider serviceProvider)
  _serviceProvider = serviceProvider;
  }
 
- public THub Create()
+ public virtual THub Create()
  {
  Debug.Assert(!_created.HasValue, "hub activators must not be reused.");
 
@@ -34,7 +34,7 @@ public THub Create()
  return hub;
  }
 
- public void Release(THub hub)
+ public virtual void Release(THub hub)
  {
  if (hub == null)
  {

src/Microsoft.AspNetCore.SignalR.Core/DefaultHubCallerContext.cs → src/Microsoft.AspNetCore.SignalR.Core/Internal/DefaultHubCallerContext.cs

@@ -8,7 +8,7 @@
 using System.Threading;
 using Microsoft.AspNetCore.Http.Features;
 
-namespace Microsoft.AspNetCore.SignalR
+namespace Microsoft.AspNetCore.SignalR.Internal
 {
  public class DefaultHubCallerContext : HubCallerContext
  {

src/Microsoft.AspNetCore.SignalR.Core/Internal/HubCallerClients.cs

@@ -24,9 +24,9 @@ public HubCallerClients(IHubClients hubClients, string connectionId)
 
  public IClientProxy All => _hubClients.All;
 
- public IClientProxy AllExcept(IReadOnlyList<string> excludedIds)
+ public IClientProxy AllExcept(IReadOnlyList<string> excludedConnectionIds)
  {
- return _hubClients.AllExcept(excludedIds);
+ return _hubClients.AllExcept(excludedConnectionIds);
  }
 
  public IClientProxy Client(string connectionId)
@@ -49,9 +49,9 @@ public IClientProxy OthersInGroup(string groupName)
  return _hubClients.GroupExcept(groupName, _currentConnectionId);
  }
 
- public IClientProxy GroupExcept(string groupName, IReadOnlyList<string> excludeIds)
+ public IClientProxy GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds)
  {
- return _hubClients.GroupExcept(groupName, excludeIds);
+ return _hubClients.GroupExcept(groupName, excludedConnectionIds);
  }
 
  public IClientProxy User(string userId)

src/Microsoft.AspNetCore.SignalR.Core/Internal/HubClients.cs

@@ -17,9 +17,9 @@ public HubClients(HubLifetimeManager<THub> lifetimeManager)
 
  public IClientProxy All { get; }
 
- public IClientProxy AllExcept(IReadOnlyList<string> excludedIds)
+ public IClientProxy AllExcept(IReadOnlyList<string> excludedConnectionIds)
  {
- return new AllClientsExceptProxy<THub>(_lifetimeManager, excludedIds);
+ return new AllClientsExceptProxy<THub>(_lifetimeManager, excludedConnectionIds);
  }
 
  public IClientProxy Client(string connectionId)
@@ -32,9 +32,9 @@ public IClientProxy Group(string groupName)
  return new GroupProxy<THub>(_lifetimeManager, groupName);
  }
 
- public IClientProxy GroupExcept(string groupName, IReadOnlyList<string> excludeIds)
+ public IClientProxy GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds)
  {
- return new GroupExceptProxy<THub>(_lifetimeManager, groupName, excludeIds);
+ return new GroupExceptProxy<THub>(_lifetimeManager, groupName, excludedConnectionIds);
  }
 
  public IClientProxy Clients(IReadOnlyList<string> connectionIds)

src/Microsoft.AspNetCore.SignalR.Core/Internal/HubClients`T.cs

@@ -17,9 +17,9 @@ public HubClients(HubLifetimeManager<THub> lifetimeManager)
 
  public T All { get; }
 
- public T AllExcept(IReadOnlyList<string> excludedIds)
+ public T AllExcept(IReadOnlyList<string> excludedConnectionIds)
  {
- return TypedClientBuilder<T>.Build(new AllClientsExceptProxy<THub>(_lifetimeManager, excludedIds));
+ return TypedClientBuilder<T>.Build(new AllClientsExceptProxy<THub>(_lifetimeManager, excludedConnectionIds));
  }
 
  public virtual T Client(string connectionId)
@@ -37,9 +37,9 @@ public virtual T Group(string groupName)
  return TypedClientBuilder<T>.Build(new GroupProxy<THub>(_lifetimeManager, groupName));
  }
 
- public T GroupExcept(string groupName, IReadOnlyList<string> excludeIds)
+ public T GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds)
  {
- return TypedClientBuilder<T>.Build(new GroupExceptProxy<THub>(_lifetimeManager, groupName, excludeIds));
+ return TypedClientBuilder<T>.Build(new GroupExceptProxy<THub>(_lifetimeManager, groupName, excludedConnectionIds));
  }
 
  public T Groups(IReadOnlyList<string> groupNames)

src/Microsoft.AspNetCore.SignalR.Core/HubConnectionStore.cs → src/Microsoft.AspNetCore.SignalR.Core/Internal/HubConnectionStore.cs

@@ -6,7 +6,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 
-namespace Microsoft.AspNetCore.SignalR
+namespace Microsoft.AspNetCore.SignalR.Internal
 {
  public class HubConnectionStore
  {

src/Microsoft.AspNetCore.SignalR.Core/Internal/Proxies.cs

@@ -168,14 +168,14 @@ public GroupManager(HubLifetimeManager<THub> lifetimeManager)
  _lifetimeManager = lifetimeManager;
  }
 
- public Task AddAsync(string connectionId, string groupName)
+ public Task AddToGroupAsync(string connectionId, string groupName)
  {
- return _lifetimeManager.AddGroupAsync(connectionId, groupName);
+ return _lifetimeManager.AddToGroupAsync(connectionId, groupName);
  }
 
- public Task RemoveAsync(string connectionId, string groupName)
+ public Task RemoveFromGroupAsync(string connectionId, string groupName)
  {
- return _lifetimeManager.RemoveGroupAsync(connectionId, groupName);
+ return _lifetimeManager.RemoveFromGroupAsync(connectionId, groupName);
  }
  }
 }

src/Microsoft.AspNetCore.SignalR.Core/TypedHubClients.cs

@@ -20,7 +20,7 @@ public TypedHubClients(IHubCallerClients dynamicContext)
 
  public T Others => TypedClientBuilder<T>.Build(_hubClients.Others);
 
- public T AllExcept(IReadOnlyList<string> excludedIds) => TypedClientBuilder<T>.Build(_hubClients.AllExcept(excludedIds));
+ public T AllExcept(IReadOnlyList<string> excludedConnectionIds) => TypedClientBuilder<T>.Build(_hubClients.AllExcept(excludedConnectionIds));
 
  public T Client(string connectionId)
  {
@@ -32,9 +32,9 @@ public T Group(string groupName)
  return TypedClientBuilder<T>.Build(_hubClients.Group(groupName));
  }
 
- public T GroupExcept(string groupName, IReadOnlyList<string> excludeIds)
+ public T GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds)
  {
- return TypedClientBuilder<T>.Build(_hubClients.GroupExcept(groupName, excludeIds));
+ return TypedClientBuilder<T>.Build(_hubClients.GroupExcept(groupName, excludedConnectionIds));
  }
 
  public T Clients(IReadOnlyList<string> connectionIds)

src/Microsoft.AspNetCore.SignalR.Redis/RedisHubLifetimeManager.cs

@@ -94,7 +94,7 @@ public override Task OnDisconnectedAsync(HubConnectionContext connection)
  if (groupNames != null)
  {
  // Copy the groups to an array here because they get removed from this collection
- // in RemoveGroupAsync
+ // in RemoveFromGroupAsync
  foreach (var group in groupNames.ToArray())
  {
  // Use RemoveGroupAsyncCore because the connection is local and we don't want to
@@ -165,7 +165,7 @@ public override Task SendUserAsync(string userId, string methodName, object[] ar
  return PublishAsync(_channels.User(userId), message);
  }
 
- public override async Task AddGroupAsync(string connectionId, string groupName)
+ public override async Task AddToGroupAsync(string connectionId, string groupName)
  {
  if (connectionId == null)
  {
@@ -188,7 +188,7 @@ public override async Task AddGroupAsync(string connectionId, string groupName)
  await SendGroupActionAndWaitForAck(connectionId, groupName, GroupAction.Add);
  }
 
- public override async Task RemoveGroupAsync(string connectionId, string groupName)
+ public override async Task RemoveFromGroupAsync(string connectionId, string groupName)
  {
  if (connectionId == null)
  {

src/Microsoft.AspNetCore.SignalR/HubRouteBuilder.cs

@@ -18,11 +18,6 @@ public HubRouteBuilder(ConnectionsRouteBuilder routes)
  _routes = routes;
  }
 
- public void MapHub<THub>(string path) where THub : Hub
- {
- MapHub<THub>(new PathString(path), configureOptions: null);
- }
-
  public void MapHub<THub>(PathString path) where THub : Hub
  {
  MapHub<THub>(path, configureOptions: null);