Merge pull request #1293 from tracyma-05/feature/optimization_multitenancy

optimization multi tenancy

Author: Oceania2018

src/Infrastructure/BotSharp.Abstraction/Infrastructures/SharpCacheAttribute.cs

@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Infrastructures;
+using BotSharp.Abstraction.MultiTenancy;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Rougamo;
@@ -76,7 +77,7 @@ public virtual Task<bool> IsOutOfDate(MethodContext context, object value)
     private string GetCacheKey(MethodContext context)
     {
         var prefixKey = GetPrefixKey(context.Method.Name);
-        var argsKey = string.Join("_", context.Arguments.Select(arg => GetCacheKeyByArg(arg)));        
+        var argsKey = string.Join("_", context.Arguments.Select(arg => GetCacheKeyByArg(arg)));
 
         if (_perInstanceCache && context.Target != null)
         {
@@ -85,22 +86,41 @@ private string GetCacheKey(MethodContext context)
         else
         {
             return $"{prefixKey}_{argsKey}";
-        }        
+        }
     }
 
     private string GetPrefixKey(string name)
     {
+        var tenantId = GetTenantId();
+        if (!string.IsNullOrWhiteSpace(tenantId))
+        {
+            return $"{_settings.Prefix}:{tenantId}:{name}";
+        }
+
         return _settings.Prefix + ":" + name;
     }
 
+    private string? GetTenantId()
+    {
+        try
+        {
+            var tenant = Services.GetService<ICurrentTenant>();
+            return tenant?.TenantId;
+        }
+        catch
+        {
+            return null;
+        }
+    }
+
     private string GetCacheKeyByArg(object? arg)
     {
         if (arg is null)
         {
             return NullMarker.GetHashCode().ToString();
         }
         else if (arg is ICacheKey withCacheKey)
-        { 
+        {
             return withCacheKey.GetCacheKey();
         }
         else
@@ -110,7 +130,10 @@ private string GetCacheKeyByArg(object? arg)
     }
 
     public async Task ClearCacheAsync()
-    { 
-        await _cache.ClearCacheAsync(_settings.Prefix);
+    {
+        var tenantId = GetTenantId();
+        var prefix = string.IsNullOrWhiteSpace(tenantId) ? _settings.Prefix : $"{_settings.Prefix}:{tenantId}";
+        await _cache.ClearCacheAsync(prefix);
     }
+
 }

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/ConnectionStringNameAttribute.cs

@@ -1,3 +1,5 @@
+using System.Reflection;
+
 namespace BotSharp.Abstraction.MultiTenancy;
 
 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
@@ -10,7 +12,11 @@ public ConnectionStringNameAttribute(string name)
         Name = name;
     }
 
-    public static string GetConnStringName(Type type) => type.FullName ?? string.Empty;
+    public static string GetConnStringName(Type type)
+    {
+        var customAttribute = type.GetTypeInfo().GetCustomAttribute<ConnectionStringNameAttribute>();
+        return customAttribute == null ? type.FullName : customAttribute.Name;
+    }
 
     public static string GetConnStringName<T>() => GetConnStringName(typeof(T));
 }

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/IConnectionStringResolver.cs

@@ -5,4 +5,4 @@ public interface IConnectionStringResolver
     string? GetConnectionString(string connectionStringName);
 
     string? GetConnectionString<TContext>();
-}
+}

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/IMultiTenant.cs

@@ -0,0 +1,8 @@
+namespace BotSharp.Abstraction.MultiTenancy;
+public interface IMultiTenant
+{
+    /// <summary>
+    /// Id of the related tenant.
+    /// </summary>
+    string? TenantId { get; }
+}

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/ITenantRepository.cs

@@ -0,0 +1,8 @@
+using BotSharp.Abstraction.MultiTenancy.Options;
+
+namespace BotSharp.Abstraction.MultiTenancy;
+
+public interface ITenantRepository
+{
+    List<TenantConfiguration> GetTenants();
+}

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/ITenantStore.cs

@@ -0,0 +1,8 @@
+using BotSharp.Abstraction.MultiTenancy.Options;
+
+namespace BotSharp.Abstraction.MultiTenancy;
+
+public interface ITenantStore
+{
+    List<TenantConfiguration> GetTenants();
+}

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/Options/TenantConfiguration.cs

@@ -19,27 +19,19 @@ public TenantConfiguration()
         IsActive = true;
     }
 
-    public TenantConfiguration(Guid id, [NotNull] string name)
-        : this()
+    public TenantConfiguration(Guid id, [NotNull] string name) : this()
     {
-        if (string.IsNullOrWhiteSpace(name))
-        {
-            throw new ArgumentException("Name cannot be null or whitespace.");
-        }
-
+        if (string.IsNullOrWhiteSpace(name)) throw new ArgumentException("Name cannot be null or whitespace.");
         Id = id;
         Name = name;
+
         ConnectionStrings = new ConnectionStrings();
     }
 
     public TenantConfiguration(Guid id, [NotNull] string name, [NotNull] string normalizedName)
         : this(id, name)
     {
-        if (string.IsNullOrWhiteSpace(normalizedName))
-        {
-            throw new ArgumentException("NormalizedName cannot be null or whitespace.");
-        }
-
+        if (string.IsNullOrWhiteSpace(normalizedName)) throw new ArgumentException("NormalizedName cannot be null or whitespace.");
         NormalizedName = normalizedName;
     }
 }

src/Infrastructure/BotSharp.Abstraction/MultiTenancy/TenantStoreExtensions.cs

@@ -0,0 +1,16 @@
+using BotSharp.Abstraction.MultiTenancy.Options;
+using Microsoft.Extensions.Options;
+
+namespace BotSharp.Abstraction.MultiTenancy;
+
+public static class TenantStoreExtensions
+{
+    public static bool IsEnabled(this IOptionsMonitor<TenantStoreOptions> options)
+        => options.CurrentValue.Enabled;
+
+    public static bool HasConfiguredTenants(this IOptionsMonitor<TenantStoreOptions> options)
+        => options.CurrentValue.Tenants is { Length: > 0 };
+
+    public static IReadOnlyList<TenantConfiguration> ConfiguredTenants(this IOptionsMonitor<TenantStoreOptions> options)
+        => options.CurrentValue.Tenants;
+}

src/Plugins/BotSharp.Plugin.MultiTenancy/Controllers/TenantsController.cs

@@ -1,28 +1,40 @@
 using BotSharp.Abstraction.MultiTenancy;
+using BotSharp.Abstraction.MultiTenancy.Options;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
 using System.Linq;
-using System.Threading.Tasks;
 
 namespace BotSharp.Plugin.MultiTenancy.Controllers;
 
 [ApiController]
 public class TenantsController : ControllerBase
 {
-    private readonly ITenantOptionProvider _tenantOptionProvider;
+    private readonly ITenantStore _tenantStore;
+    private readonly IOptionsMonitor<TenantStoreOptions> _options;
 
-    public TenantsController(ITenantOptionProvider tenantOptionProvider)
+    public TenantsController(ITenantStore tenantStore, IOptionsMonitor<TenantStoreOptions> options)
     {
-        _tenantOptionProvider = tenantOptionProvider;
+        _tenantStore = tenantStore;
+        _options = options;
     }
 
     [AllowAnonymous]
     [HttpGet]
     [Route("/tenants/options")]
-    public async Task<IActionResult> Options()
+    public IActionResult Options()
     {
-        var tenants = await _tenantOptionProvider.GetOptionsAsync();
-        var payload = tenants.Select(t => new { tenantId = t.TenantId, name = t.Name }).ToArray();
+        if (!_options.CurrentValue.Enabled)
+        {
+            return Ok(System.Array.Empty<object>());
+        }
+
+        var tenants = _tenantStore.GetTenants();
+        var payload = tenants
+            .Select(t => new { tenantId = t.Id, name = t.Name })
+            .Distinct()
+            .ToArray();
+
         return Ok(payload);
     }
 }

src/Plugins/BotSharp.Plugin.MultiTenancy/Extensions/MultiTenancyServiceCollectionExtensions.cs

@@ -1,38 +1,58 @@
 using BotSharp.Abstraction.MultiTenancy;
 using BotSharp.Abstraction.MultiTenancy.Options;
-using BotSharp.Plugin.MultiTenancy.Interfaces;
 using BotSharp.Plugin.MultiTenancy.Models;
 using BotSharp.Plugin.MultiTenancy.MultiTenancy;
-using BotSharp.Plugin.MultiTenancy.MultiTenancy.Providers;
 using BotSharp.Plugin.MultiTenancy.MultiTenancy.Resolvers;
-using BotSharp.Plugin.MultiTenancy.MultiTenancy.Tenant;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+using System.Collections.Generic;
 
 namespace BotSharp.Plugin.MultiTenancy.Extensions;
 
 public static class MultiTenancyServiceCollectionExtensions
 {
     public static IServiceCollection AddMultiTenancy(this IServiceCollection services, IConfiguration configuration, string sectionName = "TenantStore")
     {
+        var section = configuration.GetSection(sectionName);
+        if (section.Exists())
+        {
+            services.Configure<TenantStoreOptions>(section);
+        }
+        else
+        {
+            services.Configure<TenantStoreOptions>(_ => { });
+        }
+
         services.Configure<TenantResolveOptions>(options =>
         {
             options.TenantResolvers.Add(new ClaimsTenantResolveContributor());
             options.TenantResolvers.Add(new HeaderTenantResolveContributor());
             options.TenantResolvers.Add(new QueryStringTenantResolveContributor());
         });
 
-        services.Configure<TenantStoreOptions>(configuration.GetSection(sectionName));
-        services.AddScoped<ICurrentTenant, CurrentTenant>();
-        services.AddSingleton<ICurrentTenantAccessor>(AsyncLocalCurrentTenantAccessor.Instance);
         services.AddScoped<ITenantResolver, TenantResolver>();
-        services.AddScoped<IConnectionStringResolver, DefaultConnectionStringResolver>();
-        services.AddScoped<ITenantConnectionProvider, TenantConnectionProvider>();
-        services.AddSingleton<ITenantFeature, TenantFeature>();
         services.AddScoped<MultiTenancyMiddleware>();
+        services.AddScoped<ICurrentTenant, CurrentTenant>();
+        services.AddSingleton<ICurrentTenantAccessor>(AsyncLocalCurrentTenantAccessor.Instance);
+
+        // tenant store infrastructure
+        services.AddMemoryCache();
+        services.TryAddScoped<ITenantRepository, NullTenantRepository>();
+        services.TryAddScoped<ConfigTenantStore>();
+        services.TryAddScoped<DbTenantStore>();
+        services.TryAddScoped<ITenantStore>(sp => new CompositeTenantStore(
+            sp.GetRequiredService<IOptionsMonitor<TenantStoreOptions>>(),
+            new List<ITenantStore>
+            {
+                sp.GetRequiredService<ConfigTenantStore>(),
+                sp.GetRequiredService<DbTenantStore>()
+            }));
 
-        services.TryAddScoped<ITenantOptionProvider, ConfigTenantOptionProvider>();
+        services.TryAddScoped<IConnectionStringResolver, DefaultConnectionStringResolver>();
+        services.TryAddScoped<ITenantFeature, TenantFeature>();
+        services.TryAddScoped<ITenantConnectionProvider, TenantConnectionProvider>();
 
         return services;
     }