Expose an option for the netframework to configure the underlying websocket options (#2180)

Author: vicancy

src/Microsoft.Azure.SignalR.AspNet/DispatcherHelper.cs

@@ -132,7 +132,10 @@ internal static ServiceHubDispatcher PrepareAndGetDispatcher(IAppBuilder builder
         var cf = configuration.Resolver.Resolve<IConnectionFactory>();
         if (cf == null)
         {
-            cf = new ConnectionFactory(serverNameProvider, loggerFactory);
+            cf = new ConnectionFactory(serverNameProvider, loggerFactory)
+            {
+                ConfigureServiceConnectionWebSocketOptions = options.ConfigureServiceConnectionWebSocketOptions
+            };
             configuration.Resolver.Register(typeof(IConnectionFactory), () => cf);
         }
 

src/Microsoft.Azure.SignalR.AspNet/ServiceOptions.cs

@@ -11,6 +11,7 @@
 using Microsoft.Owin;
 
 namespace Microsoft.Azure.SignalR.AspNet;
+#nullable enable
 
 /// <summary>
 /// Configurable options when using Azure SignalR Service.
@@ -20,7 +21,7 @@ public class ServiceOptions : IServiceEndpointOptions
     public ServiceOptions()
     {
         var count = ConfigurationManager.ConnectionStrings.Count;
-        string connectionString = null;
+        string? connectionString = null;
         var endpoints = new List<ServiceEndpoint>();
         var connectionStringKeyPrefix = $"{Constants.Keys.ConnectionStringDefaultKey}:";
         for (var i = 0; i < count; i++)
@@ -82,7 +83,7 @@ public ServiceOptions()
     /// <summary>
     /// Gets or sets the proxy used when ServiceEndpoint will attempt to connect to Azure SignalR.
     /// </summary>
-    public IWebProxy Proxy { get; set; }
+    public IWebProxy? Proxy { get; set; }
 
     /// <summary>
     /// Specifies the mode for server sticky, when client is always routed to the server which it first /negotiate with, we call it "server sticky mode".
@@ -96,7 +97,14 @@ public ServiceOptions()
     /// Gets or sets the func to generate claims from <see cref="IOwinContext" />.
     /// The claims will be included in the auto-generated token for clients.
     /// </summary>
-    public Func<IOwinContext, IEnumerable<Claim>> ClaimsProvider { get; set; } = null;
+    public Func<IOwinContext, IEnumerable<Claim>>? ClaimsProvider { get; set; }
+
+    /// <summary>
+    /// Provide the ability to configure the underlying ClientWebSocketOptions for the WebSocketClient used to establish the server connection to the service
+    /// For example, you could specify the inner buffer used for each WebSocketClient by setting:
+    /// <code>options.ConfigureServiceConnectionWebSocketOptions = o => o.SetBuffer(0x1000, 0x1000);</code>
+    /// </summary>
+    public Action<System.Net.WebSockets.ClientWebSocketOptions>? ConfigureServiceConnectionWebSocketOptions { get; set; }
 
     /// <summary>
     /// Gets or sets the initial number of connections per hub from SDK to Azure SignalR Service. Default value is 5.
@@ -114,12 +122,12 @@ public int ConnectionCount
     /// <summary>
     /// Gets or sets the connection string of Azure SignalR Service instance.
     /// </summary>
-    public string ConnectionString { get; set; }
+    public string? ConnectionString { get; set; }
     /// <summary>
     /// Gets or sets the func to set diagnostic client filter from <see cref="IOwinContext" />.
     /// The clients will be regarded as diagnostic client only if the function returns true.
     /// </summary>
-    public Func<IOwinContext, bool> DiagnosticClientFilter { get; set; } = null;
+    public Func<IOwinContext, bool>? DiagnosticClientFilter { get; set; } = null;
 
     /// <summary>
     /// Customize the multiple endpoints used
@@ -145,5 +153,5 @@ public int ConnectionCount
     /// <summary>
     /// Gets applicationName, which will be used as a prefix to apply to each hub name
     /// </summary>
-    internal string ApplicationName { get; set; }
+    internal string ApplicationName { get; set; } = string.Empty;
 }

src/Microsoft.Azure.SignalR.Common/ServiceConnections/ConnectionFactoryBase.cs

@@ -21,6 +21,8 @@ internal abstract class ConnectionFactoryBase : IConnectionFactory
 
     private readonly string _serverId;
 
+    public Action<System.Net.WebSockets.ClientWebSocketOptions>? ConfigureServiceConnectionWebSocketOptions { get; init; }
+
     public ConnectionFactoryBase(IServerNameProvider nameProvider,
                                  ILoggerFactory loggerFactory)
     {
@@ -44,6 +46,7 @@ public async Task<ConnectionContext> ConnectAsync(HubServiceEndpoint hubServiceE
         {
             Headers = GetRequestHeaders(),
             Proxy = provider.Proxy,
+            WebSocketConfiguration = ConfigureServiceConnectionWebSocketOptions,
         };
         var connection = new WebSocketConnectionContext(connectionOptions, _loggerFactory, accessTokenProvider);
 

test/Microsoft.Azure.SignalR.AspNet.Tests/RunAzureSignalRTests.cs

@@ -844,12 +844,23 @@ public async Task TestRunAzureSignalStartsServerConnection()
         using (var logCollector = StartVerifiableLog(out var loggerFactory, LogLevel.Debug))
         using (new AppSettingsConfigScope(ConnectionString))
         {
+            var logger = loggerFactory.CreateLogger(nameof(TestRunAzureSignalStartsServerConnection));
             var hubConfig = Utility.GetTestHubConfig(loggerFactory);
             var hubName = "hub";
             var testHub = new TestHubManager(hubName);
             hubConfig.Resolver.Register(typeof(IHubManager), () => testHub);
+            var bufferSize = 0x100;
+            var bufferLog = $"Buffer set to {bufferSize}";
             using (WebApp.Start(ServiceUrl, app => app.RunAzureSignalR(AppName, hubConfig,
-                o => o.InitialHubServerConnectionCount = 1
+                o =>
+                {
+                    o.InitialHubServerConnectionCount = 1;
+                    o.ConfigureServiceConnectionWebSocketOptions = i =>
+                    {
+                        i.SetBuffer(bufferSize, bufferSize);
+                        logger.LogInformation(bufferLog);
+                    };
+                }
             )))
             {
                 var options = hubConfig.Resolver.Resolve<IServiceConnectionManager>();
@@ -863,6 +874,7 @@ public async Task TestRunAzureSignalStartsServerConnection()
             logCollector.Expects("StartTransport");
             logCollector.Expects("TransportStopping");
             logCollector.Expects("FailedToConnect");
+            logCollector.Expects(i => i.Write.Message == bufferLog);
         }
     }