-
Notifications
You must be signed in to change notification settings - Fork 103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set up options and track changes in management SDK. #1081
Changes from all commits
f1d6d2c
ef79564
04d9b10
1840a4d
8cb960c
fa833d2
f9b358e
c4f2030
32636be
c83f4c9
17b6585
52dc94b
5315a43
d3a3b68
1399157
d32b810
80874da
6786043
3d6a3ec
37947ab
e3edf86
9a5c796
a9a6153
f6b7d91
2532535
514355a
13ec165
35c083e
4b73ac4
903f1c2
383ad4b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using System; | ||
using System.Threading; | ||
using Microsoft.Extensions.Configuration; | ||
using Microsoft.Extensions.Options; | ||
using Microsoft.Extensions.Primitives; | ||
|
||
namespace Microsoft.Azure.SignalR.Management.Configuration | ||
{ | ||
/// <summary> | ||
/// Sets up TargetOptions from SourceOptions and tracks changes . | ||
/// </summary> | ||
internal abstract class CascadeOptionsSetup<TargetOptions, SourceOptions> : IConfigureOptions<TargetOptions>, IOptionsChangeTokenSource<TargetOptions>, IDisposable | ||
where SourceOptions : class | ||
where TargetOptions : class | ||
{ | ||
private readonly IDisposable _registration; | ||
private readonly IOptionsMonitor<SourceOptions> _sourceMonitor; | ||
private ConfigurationReloadToken _changeToken; | ||
|
||
public CascadeOptionsSetup(IOptionsMonitor<SourceOptions> sourceMonitor) | ||
{ | ||
_registration = sourceMonitor.OnChange(RaiseChange); | ||
_changeToken = new ConfigurationReloadToken(); | ||
_sourceMonitor = sourceMonitor; | ||
} | ||
|
||
public string Name => Options.DefaultName; | ||
|
||
public void Configure(TargetOptions target) => Convert(target, _sourceMonitor.CurrentValue); | ||
|
||
protected abstract void Convert(TargetOptions target, SourceOptions source); | ||
|
||
public IChangeToken GetChangeToken() => _changeToken; | ||
|
||
private void RaiseChange(SourceOptions sourceOptions) | ||
{ | ||
var previousToken = Interlocked.Exchange(ref _changeToken, new ConfigurationReloadToken()); | ||
previousToken.OnReload(); | ||
} | ||
|
||
public void Dispose() | ||
{ | ||
_registration.Dispose(); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using Microsoft.Azure.SignalR.Management.Configuration; | ||
using Microsoft.Extensions.Options; | ||
|
||
namespace Microsoft.Azure.SignalR.Management | ||
{ | ||
internal class ServiceManagerContextSetup : CascadeOptionsSetup<ServiceManagerContext, ServiceManagerOptions> | ||
{ | ||
public ServiceManagerContextSetup(IOptionsMonitor<ServiceManagerOptions> sourceMonitor) : base(sourceMonitor) | ||
{ | ||
} | ||
|
||
protected override void Convert(ServiceManagerContext target, ServiceManagerOptions source) | ||
{ | ||
target.ServiceEndpoints = source.ServiceEndpoints ?? (source.ServiceEndpoint != null | ||
? (new ServiceEndpoint[] { source.ServiceEndpoint }) | ||
: (new ServiceEndpoint[] { new ServiceEndpoint(source.ConnectionString) })); | ||
target.ApplicationName = source.ApplicationName; | ||
target.ConnectionCount = source.ConnectionCount; | ||
target.Proxy = source.Proxy; | ||
target.ServiceTransportType = source.ServiceTransportType; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using Microsoft.Extensions.Configuration; | ||
using Microsoft.Extensions.FileProviders; | ||
using Microsoft.Extensions.Options; | ||
using Microsoft.Extensions.Primitives; | ||
|
||
namespace Microsoft.Azure.SignalR.Management.Configuration | ||
{ | ||
internal class ServiceManagerOptionsSetup : IConfigureOptions<ServiceManagerOptions>, IOptionsChangeTokenSource<ServiceManagerOptions> | ||
{ | ||
private readonly IConfiguration _configuration; | ||
|
||
public ServiceManagerOptionsSetup(IConfiguration configuration = null) | ||
{ | ||
_configuration = configuration; | ||
} | ||
|
||
public string Name => Options.DefaultName; | ||
|
||
public void Configure(ServiceManagerOptions options) | ||
{ | ||
if (_configuration != null) | ||
{ | ||
_configuration.GetSection(Constants.Keys.AzureSignalRSectionKey).Bind(options); | ||
} | ||
} | ||
|
||
public IChangeToken GetChangeToken() | ||
{ | ||
return _configuration?.GetReloadToken() ?? NullChangeToken.Singleton; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using Microsoft.Azure.SignalR.Management.Configuration; | ||
using Microsoft.Extensions.Options; | ||
|
||
namespace Microsoft.Azure.SignalR.Management | ||
{ | ||
internal class ServiceOptionsSetup : CascadeOptionsSetup<ServiceOptions, ServiceManagerContext> | ||
{ | ||
public ServiceOptionsSetup(IOptionsMonitor<ServiceManagerContext> sourceMonitor) : base(sourceMonitor) | ||
{ | ||
} | ||
|
||
protected override void Convert(ServiceOptions target, ServiceManagerContext source) | ||
{ | ||
target.ApplicationName = source.ApplicationName; | ||
target.Endpoints = source.ServiceEndpoints; | ||
target.Proxy = source.Proxy; | ||
target.ConnectionCount = source.ConnectionCount; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
using System; | ||
using System.ComponentModel; | ||
using System.Reflection; | ||
using Microsoft.Azure.SignalR.Management.Configuration; | ||
using Microsoft.Extensions.DependencyInjection; | ||
using Microsoft.Extensions.Options; | ||
|
||
namespace Microsoft.Azure.SignalR.Management | ||
{ | ||
internal static class DependencyInjectionExtensions //TODO: not ready for public use | ||
{ | ||
/// <summary> | ||
/// Adds the essential SignalR Service Manager services to the specified services collection and configures <see cref="ServiceManagerOptions"/> with configuration instance registered in service collection. | ||
/// </summary> | ||
public static IServiceCollection AddSignalRServiceManager(this IServiceCollection services) | ||
{ | ||
services.AddSingleton<ServiceManagerOptionsSetup>() | ||
.AddSingleton<IConfigureOptions<ServiceManagerOptions>>(sp => sp.GetService<ServiceManagerOptionsSetup>()) | ||
.AddSingleton<IOptionsChangeTokenSource<ServiceManagerOptions>>(sp => sp.GetService<ServiceManagerOptionsSetup>()); | ||
services.PostConfigure<ServiceManagerOptions>(o => o.ValidateOptions()); | ||
services.AddSingleton<ServiceManagerContextSetup>() | ||
.AddSingleton<IConfigureOptions<ServiceManagerContext>>(sp => sp.GetService<ServiceManagerContextSetup>()) | ||
.AddSingleton<IOptionsChangeTokenSource<ServiceManagerContext>>(sp => sp.GetService<ServiceManagerContextSetup>()); | ||
services.AddSingleton<ServiceOptionsSetup>() | ||
.AddSingleton<IConfigureOptions<ServiceOptions>>(sp => sp.GetService<ServiceOptionsSetup>()) | ||
.AddSingleton<IOptionsChangeTokenSource<ServiceOptions>>(sp => sp.GetService<ServiceOptionsSetup>()); | ||
return services.TrySetProductInfo(); | ||
} | ||
|
||
/// <summary> | ||
/// Adds the essential SignalR Service Manager services to the specified services collection and registers an action used to configure <see cref="ServiceManagerOptions"/> | ||
/// </summary> | ||
public static IServiceCollection AddSignalRServiceManager(this IServiceCollection services, Action<ServiceManagerOptions> configure) | ||
{ | ||
services.Configure(configure); | ||
return services.AddSignalRServiceManager(); | ||
} | ||
|
||
/// <summary> | ||
/// Adds product info to <see cref="ServiceManagerContext"/> | ||
/// </summary> | ||
/// <returns></returns> | ||
[EditorBrowsable(EditorBrowsableState.Never)] | ||
public static IServiceCollection WithAssembly(this IServiceCollection services, Assembly assembly) | ||
{ | ||
var productInfo = ProductInfo.GetProductInfo(assembly); | ||
return services.Configure<ServiceManagerContext>(o => o.ProductInfo = productInfo); | ||
} | ||
|
||
private static IServiceCollection TrySetProductInfo(this IServiceCollection services) | ||
{ | ||
var assembly = Assembly.GetExecutingAssembly(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So this anyway executes even if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, but if |
||
var productInfo = ProductInfo.GetProductInfo(assembly); | ||
return services.Configure<ServiceManagerContext>(o => o.ProductInfo = o.ProductInfo ?? productInfo); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,8 +28,9 @@ internal class ServiceManager : IServiceManager | |
private readonly string _productInfo; | ||
private readonly ServiceManagerContext _context; | ||
private readonly RestClientFactory _restClientFactory; | ||
private readonly IServiceProvider _serviceProvider; | ||
|
||
internal ServiceManager(ServiceManagerContext context, RestClientFactory restClientFactory) | ||
internal ServiceManager(ServiceManagerContext context, RestClientFactory restClientFactory, IServiceProvider serviceProvider) | ||
{ | ||
_endpoint = context.ServiceEndpoints.Single();//temp solution | ||
|
||
|
@@ -46,6 +47,7 @@ internal ServiceManager(ServiceManagerContext context, RestClientFactory restCli | |
_productInfo = context.ProductInfo; | ||
_context = context; | ||
_restClientFactory = restClientFactory; | ||
_serviceProvider = serviceProvider; | ||
} | ||
|
||
public async Task<IServiceHubContext> CreateHubContextAsync(string hubName, ILoggerFactory loggerFactory = null, CancellationToken cancellationToken = default) | ||
|
@@ -141,6 +143,14 @@ public async Task<IServiceHubContext> CreateHubContextAsync(string hubName, ILog | |
} | ||
} | ||
|
||
public void Dispose() | ||
{ | ||
if (_context.DisposeServiceProvider) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is passing some |
||
{ | ||
(_serviceProvider as IDisposable).Dispose(); | ||
} | ||
} | ||
|
||
public string GenerateClientAccessToken(string hubName, string userId = null, IList<Claim> claims = null, TimeSpan? lifeTime = null) | ||
{ | ||
var claimsWithUserId = new List<Claim>(); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think adding
services.Configure<ServiceManagerOptions>(Configuration.GetSection(Constants.Keys.AzureSignalRSectionKey));
is enough, we don't need this setup class as we don't have additional setups? Emulator uses such configure and hotreload works, see https://github.com/Azure/azure-signalr/blob/dev/src/Microsoft.Azure.SignalR.Emulator/Startup.cs#L45There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In here, https://github.com/Azure/azure-signalr/blob/dev/src/Microsoft.Azure.SignalR.Emulator/Startup.cs#L45, the
Configuration
variable is actually anIConfiguration
type variable. However, in the extension methods ofServiceCollection
, we don't haveIConfiguration
. Do you think we should add it as a parameter?