mirror of
https://github.com/bitwarden/server
synced 2026-01-02 08:33:48 +00:00
* Upgrade ExtendedCache with support for named caches * Addressed Claude PR suggestions - defensive mux creation, defend empty cache name, added tests * Addressed PR suggestions; Fixed issue where IDistributedCache was missing when using the shared route; Added more unit tests * Revert to TryAdd, document expectation that AddDistributedCache is called first
164 lines
6.5 KiB
C#
164 lines
6.5 KiB
C#
using Bit.Core.Settings;
|
|
using Bit.Core.Utilities;
|
|
using Microsoft.Extensions.Caching.Distributed;
|
|
using Microsoft.Extensions.Caching.StackExchangeRedis;
|
|
using Microsoft.Extensions.DependencyInjection.Extensions;
|
|
using Microsoft.Extensions.Logging;
|
|
using StackExchange.Redis;
|
|
using ZiggyCreatures.Caching.Fusion;
|
|
using ZiggyCreatures.Caching.Fusion.Backplane;
|
|
using ZiggyCreatures.Caching.Fusion.Backplane.StackExchangeRedis;
|
|
using ZiggyCreatures.Caching.Fusion.Serialization.SystemTextJson;
|
|
|
|
namespace Microsoft.Extensions.DependencyInjection;
|
|
|
|
public static class ExtendedCacheServiceCollectionExtensions
|
|
{
|
|
/// <summary>
|
|
/// Adds a new, named Fusion Cache <see href="https://github.com/ZiggyCreatures/FusionCache"/> to the service
|
|
/// collection. If an existing cache of the same name is found, it will do nothing.<br/>
|
|
/// <br/>
|
|
/// <b>Note</b>: When re-using the existing Redis cache, it is expected to call this method <b>after</b> calling
|
|
/// <code>services.AddDistributedCache(globalSettings)</code><br />This ensures that DI correctly finds,
|
|
/// configures, and re-uses all the shared Redis architecture.
|
|
/// </summary>
|
|
public static IServiceCollection AddExtendedCache(
|
|
this IServiceCollection services,
|
|
string cacheName,
|
|
GlobalSettings globalSettings,
|
|
GlobalSettings.ExtendedCacheSettings? settings = null)
|
|
{
|
|
settings ??= globalSettings.DistributedCache.DefaultExtendedCache;
|
|
if (settings is null || string.IsNullOrEmpty(cacheName))
|
|
{
|
|
return services;
|
|
}
|
|
|
|
// If a cache already exists with this key, do nothing
|
|
if (services.Any(s => s.ServiceType == typeof(IFusionCache) &&
|
|
s.ServiceKey?.Equals(cacheName) == true))
|
|
{
|
|
return services;
|
|
}
|
|
|
|
if (services.All(s => s.ServiceType != typeof(FusionCacheSystemTextJsonSerializer)))
|
|
{
|
|
services.AddFusionCacheSystemTextJsonSerializer();
|
|
}
|
|
var fusionCacheBuilder = services
|
|
.AddFusionCache(cacheName)
|
|
.WithCacheKeyPrefix($"{cacheName}:")
|
|
.AsKeyedServiceByCacheName()
|
|
.WithOptions(opt =>
|
|
{
|
|
opt.DistributedCacheCircuitBreakerDuration = settings.DistributedCacheCircuitBreakerDuration;
|
|
})
|
|
.WithDefaultEntryOptions(new FusionCacheEntryOptions
|
|
{
|
|
Duration = settings.Duration,
|
|
IsFailSafeEnabled = settings.IsFailSafeEnabled,
|
|
FailSafeMaxDuration = settings.FailSafeMaxDuration,
|
|
FailSafeThrottleDuration = settings.FailSafeThrottleDuration,
|
|
EagerRefreshThreshold = settings.EagerRefreshThreshold,
|
|
FactorySoftTimeout = settings.FactorySoftTimeout,
|
|
FactoryHardTimeout = settings.FactoryHardTimeout,
|
|
DistributedCacheSoftTimeout = settings.DistributedCacheSoftTimeout,
|
|
DistributedCacheHardTimeout = settings.DistributedCacheHardTimeout,
|
|
AllowBackgroundDistributedCacheOperations = settings.AllowBackgroundDistributedCacheOperations,
|
|
JitterMaxDuration = settings.JitterMaxDuration
|
|
})
|
|
.WithRegisteredSerializer();
|
|
|
|
if (!settings.EnableDistributedCache)
|
|
return services;
|
|
|
|
if (settings.UseSharedRedisCache)
|
|
{
|
|
// Using Shared Redis, TryAdd and reuse all pieces (multiplexer, distributed cache and backplane)
|
|
|
|
if (!CoreHelpers.SettingHasValue(globalSettings.DistributedCache.Redis.ConnectionString))
|
|
return services;
|
|
|
|
services.TryAddSingleton<IConnectionMultiplexer>(sp =>
|
|
CreateConnectionMultiplexer(sp, cacheName, globalSettings.DistributedCache.Redis.ConnectionString));
|
|
|
|
services.TryAddSingleton<IDistributedCache>(sp =>
|
|
{
|
|
var mux = sp.GetRequiredService<IConnectionMultiplexer>();
|
|
return new RedisCache(new RedisCacheOptions
|
|
{
|
|
ConnectionMultiplexerFactory = () => Task.FromResult(mux)
|
|
});
|
|
});
|
|
|
|
services.TryAddSingleton<IFusionCacheBackplane>(sp =>
|
|
{
|
|
var mux = sp.GetRequiredService<IConnectionMultiplexer>();
|
|
return new RedisBackplane(new RedisBackplaneOptions
|
|
{
|
|
ConnectionMultiplexerFactory = () => Task.FromResult(mux)
|
|
});
|
|
});
|
|
|
|
fusionCacheBuilder
|
|
.WithRegisteredDistributedCache()
|
|
.WithRegisteredBackplane();
|
|
|
|
return services;
|
|
}
|
|
|
|
// Using keyed Redis / Distributed Cache. Create all pieces as keyed services.
|
|
|
|
if (!CoreHelpers.SettingHasValue(settings.Redis.ConnectionString))
|
|
return services;
|
|
|
|
services.TryAddKeyedSingleton<IConnectionMultiplexer>(
|
|
cacheName,
|
|
(sp, _) => CreateConnectionMultiplexer(sp, cacheName, settings.Redis.ConnectionString)
|
|
);
|
|
services.TryAddKeyedSingleton<IDistributedCache>(
|
|
cacheName,
|
|
(sp, _) =>
|
|
{
|
|
var mux = sp.GetRequiredKeyedService<IConnectionMultiplexer>(cacheName);
|
|
return new RedisCache(new RedisCacheOptions
|
|
{
|
|
ConnectionMultiplexerFactory = () => Task.FromResult(mux)
|
|
});
|
|
}
|
|
);
|
|
services.TryAddKeyedSingleton<IFusionCacheBackplane>(
|
|
cacheName,
|
|
(sp, _) =>
|
|
{
|
|
var mux = sp.GetRequiredKeyedService<IConnectionMultiplexer>(cacheName);
|
|
return new RedisBackplane(new RedisBackplaneOptions
|
|
{
|
|
ConnectionMultiplexerFactory = () => Task.FromResult(mux)
|
|
});
|
|
}
|
|
);
|
|
|
|
fusionCacheBuilder
|
|
.WithRegisteredKeyedDistributedCacheByCacheName()
|
|
.WithRegisteredKeyedBackplaneByCacheName();
|
|
|
|
return services;
|
|
}
|
|
|
|
private static ConnectionMultiplexer CreateConnectionMultiplexer(IServiceProvider sp, string cacheName,
|
|
string connectionString)
|
|
{
|
|
try
|
|
{
|
|
return ConnectionMultiplexer.Connect(connectionString);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
var logger = sp.GetService<ILogger>();
|
|
logger?.LogError(ex, "Failed to connect to Redis for cache {CacheName}", cacheName);
|
|
throw;
|
|
}
|
|
}
|
|
}
|