Skip to content

Commit

Permalink
Merge branch 'dev' into tefa/fix-access-key-interface
Browse files Browse the repository at this point in the history
  • Loading branch information
@terencefan
terencefan authored Nov 28, 2024
2 parents 0631e8f + a789992 commit 9005135
Show file tree
Hide file tree
Showing 17 changed files with 1,015 additions and 847 deletions.
313 changes: 156 additions & 157 deletions src/Microsoft.Azure.SignalR.AspNet/DispatcherHelper.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,176 +16,175 @@
using Microsoft.Owin.Infrastructure;
using Owin;

namespace Microsoft.Azure.SignalR.AspNet
namespace Microsoft.Azure.SignalR.AspNet;

internal class DispatcherHelper
{
internal class DispatcherHelper
internal static ILoggerFactory GetLoggerFactory(HubConfiguration configuration)
{
internal static ILoggerFactory GetLoggerFactory(HubConfiguration configuration)
{
var resolver = configuration.Resolver ?? throw new ArgumentException("A dependency resolver must be specified.", nameof(configuration.Resolver));

// 1. check if loggerFactory is already defined
var loggerFactory = resolver.Resolve<ILoggerFactory>();
if (loggerFactory != null)
{
return loggerFactory;
}

// 2. check if loggingBuilder is already defined
var loggingBuilder = configuration?.Resolver.Resolve<ILoggingBuilder>() ?? new DefaultLoggingBuilder();
var providers = loggingBuilder.Services?.BuildServiceProvider().GetServices<ILoggerProvider>();
if (providers != null)
{
loggerFactory = new LoggerFactory(providers);
}
var resolver = configuration.Resolver ?? throw new ArgumentException("A dependency resolver must be specified.", nameof(configuration.Resolver));

// 1. check if loggerFactory is already defined
var loggerFactory = resolver.Resolve<ILoggerFactory>();
if (loggerFactory != null)
{
return loggerFactory;
}

internal static ServiceHubDispatcher PrepareAndGetDispatcher(IAppBuilder builder, HubConfiguration configuration, ServiceOptions options, string applicationName, ILoggerFactory loggerFactory)
// 2. check if loggingBuilder is already defined
var loggingBuilder = configuration?.Resolver.Resolve<ILoggingBuilder>() ?? new DefaultLoggingBuilder();
var providers = loggingBuilder.Services?.BuildServiceProvider().GetServices<ILoggerProvider>();
if (providers != null)
{
loggerFactory = new LoggerFactory(providers);
}

return loggerFactory;
}

internal static ServiceHubDispatcher PrepareAndGetDispatcher(IAppBuilder builder, HubConfiguration configuration, ServiceOptions options, string applicationName, ILoggerFactory loggerFactory)
{
// Ensure we have the conversions for MS.Owin so that
// the app builder respects the OwinMiddleware base class
SignatureConversions.AddConversions(builder);

// ServiceEndpointManager needs the logger
var hubs = GetAvailableHubNames(configuration);

// Get the one from DI or new a default one
var router = configuration.Resolver.Resolve<IEndpointRouter>() ?? new DefaultEndpointRouter();

var serverNameProvider = configuration.Resolver.Resolve<IServerNameProvider>();
if (serverNameProvider == null)
{
serverNameProvider = new DefaultServerNameProvider();
configuration.Resolver.Register(typeof(IServerNameProvider), () => serverNameProvider);
}

var synchronizer = configuration.Resolver.Resolve<IAccessKeySynchronizer>();
if (synchronizer == null)
{
synchronizer = new AccessKeySynchronizer(loggerFactory);
configuration.Resolver.Register(typeof(IAccessKeySynchronizer), () => synchronizer);
}

var endpoint = new ServiceEndpointManager(synchronizer, options, loggerFactory);
configuration.Resolver.Register(typeof(IServiceEndpointManager), () => endpoint);

var requestIdProvider = configuration.Resolver.Resolve<IConnectionRequestIdProvider>();
if (requestIdProvider == null)
{
requestIdProvider = new DefaultConnectionRequestIdProvider();
configuration.Resolver.Register(typeof(IConnectionRequestIdProvider), () => requestIdProvider);
}

builder.Use<NegotiateMiddleware>(configuration, applicationName, endpoint, router, options, serverNameProvider, requestIdProvider, loggerFactory);

builder.RunSignalR(configuration);

// Fetch the trace manager from DI and add logger provider
var traceManager = configuration.Resolver.Resolve<ITraceManager>();
if (traceManager != null)
{
loggerFactory.AddProvider(new TraceManagerLoggerProvider(traceManager));
}

configuration.Resolver.Register(typeof(ILoggerFactory), () => loggerFactory);

// TODO: Using IOptions looks wierd, thinking of a way removing it
// share the same object all through
var serviceOptions = Options.Create(options);

// For safety, ALWAYS register abstract classes or interfaces
// Some third-party DI frameworks such as Ninject, implicit self-binding concrete types:
// https://github.com/ninject/ninject/wiki/dependency-injection-with-ninject#skipping-the-type-binding-bit--implicit-self-binding-of-concrete-types
configuration.Resolver.Register(typeof(IOptions<ServiceOptions>), () => serviceOptions);

var serviceProtocol = new ServiceProtocol();
configuration.Resolver.Register(typeof(IServiceProtocol), () => serviceProtocol);

// allow override from tests
var scm = configuration.Resolver.Resolve<IServiceConnectionManager>();
if (scm == null)
{
scm = new ServiceConnectionManager(applicationName, hubs);
configuration.Resolver.Register(typeof(IServiceConnectionManager), () => scm);
}

var ccm = configuration.Resolver.Resolve<IClientConnectionManagerAspNet>();
if (ccm == null)
{
// Ensure we have the conversions for MS.Owin so that
// the app builder respects the OwinMiddleware base class
SignatureConversions.AddConversions(builder);

// ServiceEndpointManager needs the logger
var hubs = GetAvailableHubNames(configuration);

// Get the one from DI or new a default one
var router = configuration.Resolver.Resolve<IEndpointRouter>() ?? new DefaultEndpointRouter();

var serverNameProvider = configuration.Resolver.Resolve<IServerNameProvider>();
if (serverNameProvider == null)
{
serverNameProvider = new DefaultServerNameProvider();
configuration.Resolver.Register(typeof(IServerNameProvider), () => serverNameProvider);
}

var synchronizer = configuration.Resolver.Resolve<IAccessKeySynchronizer>();
if (synchronizer == null)
{
synchronizer = new AccessKeySynchronizer(loggerFactory);
configuration.Resolver.Register(typeof(IAccessKeySynchronizer), () => synchronizer);
}

var endpoint = new ServiceEndpointManager(synchronizer, options, loggerFactory);
configuration.Resolver.Register(typeof(IServiceEndpointManager), () => endpoint);

var requestIdProvider = configuration.Resolver.Resolve<IConnectionRequestIdProvider>();
if (requestIdProvider == null)
{
requestIdProvider = new DefaultConnectionRequestIdProvider();
configuration.Resolver.Register(typeof(IConnectionRequestIdProvider), () => requestIdProvider);
}

builder.Use<NegotiateMiddleware>(configuration, applicationName, endpoint, router, options, serverNameProvider, requestIdProvider, loggerFactory);

builder.RunSignalR(configuration);

// Fetch the trace manager from DI and add logger provider
var traceManager = configuration.Resolver.Resolve<ITraceManager>();
if (traceManager != null)
{
loggerFactory.AddProvider(new TraceManagerLoggerProvider(traceManager));
}

configuration.Resolver.Register(typeof(ILoggerFactory), () => loggerFactory);

// TODO: Using IOptions looks wierd, thinking of a way removing it
// share the same object all through
var serviceOptions = Options.Create(options);

// For safety, ALWAYS register abstract classes or interfaces
// Some third-party DI frameworks such as Ninject, implicit self-binding concrete types:
// https://github.com/ninject/ninject/wiki/dependency-injection-with-ninject#skipping-the-type-binding-bit--implicit-self-binding-of-concrete-types
configuration.Resolver.Register(typeof(IOptions<ServiceOptions>), () => serviceOptions);

var serviceProtocol = new ServiceProtocol();
configuration.Resolver.Register(typeof(IServiceProtocol), () => serviceProtocol);

// allow override from tests
var scm = configuration.Resolver.Resolve<IServiceConnectionManager>();
if (scm == null)
{
scm = new ServiceConnectionManager(applicationName, hubs);
configuration.Resolver.Register(typeof(IServiceConnectionManager), () => scm);
}

var ccm = configuration.Resolver.Resolve<IClientConnectionManagerAspNet>();
if (ccm == null)
{
ccm = new ClientConnectionManager(configuration, loggerFactory);
configuration.Resolver.Register(typeof(IClientConnectionManagerAspNet), () => ccm);
}

var atm = new AzureTransportManager(configuration.Resolver);
configuration.Resolver.Register(typeof(ITransportManager), () => atm);

var parser = new SignalRMessageParser(hubs, configuration.Resolver, loggerFactory.CreateLogger<SignalRMessageParser>());
configuration.Resolver.Register(typeof(IMessageParser), () => parser);

var smb = new ServiceMessageBus(configuration.Resolver, loggerFactory.CreateLogger<ServiceMessageBus>());
configuration.Resolver.Register(typeof(IMessageBus), () => smb);

var serviceEventHandler = configuration.Resolver.Resolve<IServiceEventHandler>();
if (serviceEventHandler == null)
{
serviceEventHandler = new DefaultServiceEventHandler(loggerFactory);
configuration.Resolver.Register(typeof(IServiceEventHandler), () => serviceEventHandler);
}

var cf = configuration.Resolver.Resolve<IConnectionFactory>();
if (cf == null)
{
var connectionFactory = new ConnectionFactory(serverNameProvider, loggerFactory);
configuration.Resolver.Register(typeof(IConnectionFactory), () => cf);
}

var scf = configuration.Resolver.Resolve<IServiceConnectionFactory>();
if (scf == null)
{
scf = new ServiceConnectionFactory(serviceProtocol, ccm, cf, loggerFactory, serverNameProvider, serviceEventHandler);
configuration.Resolver.Register(typeof(IServiceConnectionFactory), () => scf);
}

var sccf = new ServiceConnectionContainerFactory(scf, endpoint, router, options, loggerFactory);

if (hubs?.Count > 0)
{
return new ServiceHubDispatcher(hubs, scm, sccf, serviceOptions, loggerFactory);
}
else
{
loggerFactory.CreateLogger<DispatcherHelper>().Log(LogLevel.Warning, "No hubs found.");
return null;
}
ccm = new ClientConnectionManager(configuration, loggerFactory);
configuration.Resolver.Register(typeof(IClientConnectionManagerAspNet), () => ccm);
}

private static IReadOnlyList<string> GetAvailableHubNames(HubConfiguration configuration)
var atm = new AzureTransportManager(configuration.Resolver);
configuration.Resolver.Register(typeof(ITransportManager), () => atm);

var parser = new SignalRMessageParser(hubs, configuration.Resolver, loggerFactory.CreateLogger<SignalRMessageParser>());
configuration.Resolver.Register(typeof(IMessageParser), () => parser);

var smb = new ServiceMessageBus(configuration.Resolver, loggerFactory.CreateLogger<ServiceMessageBus>());
configuration.Resolver.Register(typeof(IMessageBus), () => smb);

var serviceEventHandler = configuration.Resolver.Resolve<IServiceEventHandler>();
if (serviceEventHandler == null)
{
serviceEventHandler = new DefaultServiceEventHandler(loggerFactory);
configuration.Resolver.Register(typeof(IServiceEventHandler), () => serviceEventHandler);
}

var cf = configuration.Resolver.Resolve<IConnectionFactory>();
if (cf == null)
{
var connectionFactory = new ConnectionFactory(serverNameProvider, loggerFactory);
configuration.Resolver.Register(typeof(IConnectionFactory), () => cf);
}

var scf = configuration.Resolver.Resolve<IServiceConnectionFactory>();
if (scf == null)
{
scf = new ServiceConnectionFactory(serviceProtocol, ccm, cf, loggerFactory, serverNameProvider, serviceEventHandler);
configuration.Resolver.Register(typeof(IServiceConnectionFactory), () => scf);
}

var sccf = new ServiceConnectionContainerFactory(scf, endpoint, router, options, loggerFactory);

if (hubs?.Count > 0)
{
return new ServiceHubDispatcher(hubs, scm, sccf, serviceOptions, loggerFactory);
}
else
{
loggerFactory.CreateLogger<DispatcherHelper>().Log(LogLevel.Warning, "No hubs found.");
return null;
}
}

private static IReadOnlyList<string> GetAvailableHubNames(HubConfiguration configuration)
{
var hubManager = configuration.Resolver.Resolve<IHubManager>();
return hubManager?.GetHubs().Select(s => s.Name).ToList();
}

/// <summary>
/// For compatibility issue that
/// public static ILoggerFactory AddEventSourceLogger(this ILoggerFactory factory)
/// is removed since Microsoft.Extensions.Logging.EventSource 3.0.0
/// </summary>
private sealed class DefaultLoggingBuilder : ILoggingBuilder
{
public IServiceCollection Services { get; }

public DefaultLoggingBuilder()
{
var hubManager = configuration.Resolver.Resolve<IHubManager>();
return hubManager?.GetHubs().Select(s => s.Name).ToList();
Services = new ServiceCollection();
this.AddEventSourceLogger();
}

/// <summary>
/// For compatibility issue that
/// public static ILoggerFactory AddEventSourceLogger(this ILoggerFactory factory)
/// is removed since Microsoft.Extensions.Logging.EventSource 3.0.0
/// </summary>
private sealed class DefaultLoggingBuilder : ILoggingBuilder
public IServiceProvider Build()
{
public IServiceCollection Services { get; }

public DefaultLoggingBuilder()
{
Services = new ServiceCollection();
this.AddEventSourceLogger();
}

public IServiceProvider Build()
{
return Services.BuildServiceProvider();
}
return Services.BuildServiceProvider();
}
}
}
Loading

0 comments on commit 9005135

Please sign in to comment.