Merge pull request #622 from imperugo/feature/hash-expiry-azure-compression

Add hash field expiry, Azure Managed Identity support, and compression decorator

Author: imperugo

NuGetPack.bat

@@ -6,4 +6,9 @@ dotnet pack src\serializers\StackExchange.Redis.Extensions.Utf8Json\StackExchang
 dotnet pack src\serializers\StackExchange.Redis.Extensions.System.Text.Json\StackExchange.Redis.Extensions.System.Text.Json.csproj -o .\packages\ -c Release
 dotnet pack src\serializers\StackExchange.Redis.Extensions.MemoryPack\StackExchange.Redis.Extensions.MemoryPack.csproj -o .\packages\ -c Release
 dotnet pack src\serializers\StackExchange.Redis.Extensions.ServiceStack\StackExchange.Redis.Extensions.ServiceStack.csproj -o .\packages\ -c Release
+dotnet pack src\compressors\StackExchange.Redis.Extensions.Compression.GZip\StackExchange.Redis.Extensions.Compression.GZip.csproj -o .\packages\ -c Release
+dotnet pack src\compressors\StackExchange.Redis.Extensions.Compression.Brotli\StackExchange.Redis.Extensions.Compression.Brotli.csproj -o .\packages\ -c Release
+dotnet pack src\compressors\StackExchange.Redis.Extensions.Compression.LZ4\StackExchange.Redis.Extensions.Compression.LZ4.csproj -o .\packages\ -c Release
+dotnet pack src\compressors\StackExchange.Redis.Extensions.Compression.Snappier\StackExchange.Redis.Extensions.Compression.Snappier.csproj -o .\packages\ -c Release
+dotnet pack src\compressors\StackExchange.Redis.Extensions.Compression.ZstdSharp\StackExchange.Redis.Extensions.Compression.ZstdSharp.csproj -o .\packages\ -c Release
 dotnet pack src\aspnet\StackExchange.Redis.Extensions.AspNetCore\StackExchange.Redis.Extensions.AspNetCore.csproj -o .\packages\ -c Release

StackExchange.Redis.Extensions.sln

@@ -0,0 +1,82 @@
+// Copyright (c) Ugo Lattanzi.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System;
+
+using StackExchange.Redis.Extensions.Core;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Extension methods to add compression support to the Redis serialization pipeline.
+/// </summary>
+public static class IServiceCollectionCompressionExtensions
+{
+    /// <summary>
+    /// Adds compression to the Redis serialization pipeline using the specified <see cref="ICompressor"/> implementation.
+    /// Wraps the registered <see cref="ISerializer"/> with a <see cref="CompressedSerializer"/>.
+    /// Must be called after <c>AddStackExchangeRedisExtensions</c>.
+    /// </summary>
+    /// <typeparam name="TCompressor">The compressor implementation type.</typeparam>
+    /// <param name="services">The service collection.</param>
+    /// <returns>The service collection for chaining.</returns>
+    /// <example>
+    /// <code>
+    /// services.AddStackExchangeRedisExtensions&lt;SystemTextJsonSerializer&gt;(config);
+    /// services.AddRedisCompression&lt;GZipCompressor&gt;();
+    /// </code>
+    /// </example>
+    public static IServiceCollection AddRedisCompression<TCompressor>(this IServiceCollection services)
+        where TCompressor : class, ICompressor, new()
+    {
+        var compressor = new TCompressor();
+
+        return services.AddRedisCompression(compressor);
+    }
+
+    /// <summary>
+    /// Adds compression to the Redis serialization pipeline using the specified <see cref="ICompressor"/> instance.
+    /// Wraps the registered <see cref="ISerializer"/> with a <see cref="CompressedSerializer"/>.
+    /// Must be called after <c>AddStackExchangeRedisExtensions</c>.
+    /// </summary>
+    /// <param name="services">The service collection.</param>
+    /// <param name="compressor">The compressor instance to use.</param>
+    /// <returns>The service collection for chaining.</returns>
+    public static IServiceCollection AddRedisCompression(this IServiceCollection services, ICompressor compressor)
+    {
+        ArgumentNullException.ThrowIfNull(compressor);
+
+        services.AddSingleton(compressor);
+
+        // Find the existing ISerializer registration and wrap it
+        for (var i = services.Count - 1; i >= 0; i--)
+        {
+            var descriptor = services[i];
+
+            if (descriptor.ServiceType != typeof(ISerializer))
+                continue;
+
+            var previousFactory = descriptor.ImplementationFactory;
+            var previousInstance = descriptor.ImplementationInstance;
+            var previousType = descriptor.ImplementationType;
+
+            services[i] = ServiceDescriptor.Singleton<ISerializer>(sp =>
+            {
+                ISerializer inner;
+
+                if (previousInstance != null)
+                    inner = (ISerializer)previousInstance;
+                else if (previousFactory != null)
+                    inner = (ISerializer)previousFactory(sp);
+                else
+                    inner = (ISerializer)ActivatorUtilities.CreateInstance(sp, previousType!);
+
+                return new CompressedSerializer(inner, compressor);
+            });
+
+            return services;
+        }
+
+        throw new InvalidOperationException(
+            $"No registration for {nameof(ISerializer)} found. Call AddStackExchangeRedisExtensions before AddRedisCompression.");
+    }
+}

src/aspnet/StackExchange.Redis.Extensions.AspNetCore/Extensions/IServiceCollectionCompressionExtensions.cs

@@ -0,0 +1,47 @@
+// Copyright (c) Ugo Lattanzi.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System.IO;
+using System.IO.Compression;
+
+namespace StackExchange.Redis.Extensions.Core;
+
+/// <summary>
+/// An <see cref="ICompressor"/> implementation using Brotli compression.
+/// Higher compression ratio than GZip, especially for text-like data. No external dependencies.
+/// </summary>
+public class BrotliCompressor : ICompressor
+{
+    private readonly CompressionLevel compressionLevel;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BrotliCompressor"/> class.
+    /// </summary>
+    /// <param name="compressionLevel">The compression level to use. Defaults to <see cref="CompressionLevel.Fastest"/>.</param>
+    public BrotliCompressor(CompressionLevel compressionLevel = CompressionLevel.Fastest)
+    {
+        this.compressionLevel = compressionLevel;
+    }
+
+    /// <inheritdoc/>
+    public byte[] Compress(byte[] data)
+    {
+        using var output = new MemoryStream();
+
+        using (var brotli = new BrotliStream(output, compressionLevel))
+            brotli.Write(data, 0, data.Length);
+
+        return output.ToArray();
+    }
+
+    /// <inheritdoc/>
+    public byte[] Decompress(byte[] compressedData)
+    {
+        using var input = new MemoryStream(compressedData);
+        using var brotli = new BrotliStream(input, CompressionMode.Decompress);
+        using var output = new MemoryStream();
+
+        brotli.CopyTo(output);
+
+        return output.ToArray();
+    }
+}

src/compressors/StackExchange.Redis.Extensions.Compression.Brotli/BrotliCompressor.cs

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
+    <Title>Brotli compression for StackExchange.Redis.Extensions.</Title>
+    <Summary>Brotli compression for StackExchange.Redis.Extensions. No additional dependencies required.</Summary>
+    <Description>Provides a Brotli ICompressor implementation for use with StackExchange.Redis.Extensions.Core's CompressedSerializer. Uses System.IO.Compression from the BCL — no external dependencies. Requires .NET 8+.</Description>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.201" PrivateAssets="All" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\core\StackExchange.Redis.Extensions.Core\StackExchange.Redis.Extensions.Core.csproj" />
+  </ItemGroup>
+</Project>

src/compressors/StackExchange.Redis.Extensions.Compression.Brotli/StackExchange.Redis.Extensions.Compression.Brotli.csproj

@@ -0,0 +1,47 @@
+// Copyright (c) Ugo Lattanzi.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System.IO;
+using System.IO.Compression;
+
+namespace StackExchange.Redis.Extensions.Core;
+
+/// <summary>
+/// An <see cref="ICompressor"/> implementation using GZip compression.
+/// Good compression ratio, widely supported. No external dependencies.
+/// </summary>
+public class GZipCompressor : ICompressor
+{
+    private readonly CompressionLevel compressionLevel;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GZipCompressor"/> class.
+    /// </summary>
+    /// <param name="compressionLevel">The compression level to use. Defaults to <see cref="CompressionLevel.Fastest"/>.</param>
+    public GZipCompressor(CompressionLevel compressionLevel = CompressionLevel.Fastest)
+    {
+        this.compressionLevel = compressionLevel;
+    }
+
+    /// <inheritdoc/>
+    public byte[] Compress(byte[] data)
+    {
+        using var output = new MemoryStream();
+
+        using (var gzip = new GZipStream(output, compressionLevel))
+            gzip.Write(data, 0, data.Length);
+
+        return output.ToArray();
+    }
+
+    /// <inheritdoc/>
+    public byte[] Decompress(byte[] compressedData)
+    {
+        using var input = new MemoryStream(compressedData);
+        using var gzip = new GZipStream(input, CompressionMode.Decompress);
+        using var output = new MemoryStream();
+
+        gzip.CopyTo(output);
+
+        return output.ToArray();
+    }
+}

src/compressors/StackExchange.Redis.Extensions.Compression.GZip/GZipCompressor.cs

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <Title>GZip compression for StackExchange.Redis.Extensions.</Title>
+    <Summary>GZip compression for StackExchange.Redis.Extensions. No additional dependencies required.</Summary>
+    <Description>Provides a GZip ICompressor implementation for use with StackExchange.Redis.Extensions.Core's CompressedSerializer. Uses System.IO.Compression from the BCL — no external dependencies.</Description>
+    <TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.201" PrivateAssets="All" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\core\StackExchange.Redis.Extensions.Core\StackExchange.Redis.Extensions.Core.csproj" />
+  </ItemGroup>
+</Project>

src/compressors/StackExchange.Redis.Extensions.Compression.GZip/StackExchange.Redis.Extensions.Compression.GZip.csproj

@@ -0,0 +1,32 @@
+// Copyright (c) Ugo Lattanzi.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using K4os.Compression.LZ4;
+
+namespace StackExchange.Redis.Extensions.Core;
+
+/// <summary>
+/// An <see cref="ICompressor"/> implementation using LZ4 compression.
+/// Extremely fast compression and decompression — ideal for caching scenarios
+/// where latency matters more than compression ratio.
+/// </summary>
+public class LZ4Compressor : ICompressor
+{
+    private readonly LZ4Level level;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LZ4Compressor"/> class.
+    /// </summary>
+    /// <param name="level">The LZ4 compression level. Defaults to <see cref="LZ4Level.L00_FAST"/>.</param>
+    public LZ4Compressor(LZ4Level level = LZ4Level.L00_FAST)
+    {
+        this.level = level;
+    }
+
+    /// <inheritdoc/>
+    public byte[] Compress(byte[] data) =>
+        LZ4Pickler.Pickle(data, level);
+
+    /// <inheritdoc/>
+    public byte[] Decompress(byte[] compressedData) =>
+        LZ4Pickler.Unpickle(compressedData);
+}

src/compressors/StackExchange.Redis.Extensions.Compression.LZ4/LZ4Compressor.cs

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <Title>LZ4 compression for StackExchange.Redis.Extensions.</Title>
+    <Summary>LZ4 compression for StackExchange.Redis.Extensions. Extremely fast compression/decompression.</Summary>
+    <Description>Provides an LZ4 ICompressor implementation for use with StackExchange.Redis.Extensions.Core's CompressedSerializer. LZ4 offers the best compression/decompression speed, ideal for caching scenarios where latency matters more than compression ratio.</Description>
+    <TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="K4os.Compression.LZ4" Version="[1.3.*,2.0)" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.201" PrivateAssets="All" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\core\StackExchange.Redis.Extensions.Core\StackExchange.Redis.Extensions.Core.csproj" />
+  </ItemGroup>
+</Project>

src/compressors/StackExchange.Redis.Extensions.Compression.LZ4/StackExchange.Redis.Extensions.Compression.LZ4.csproj

@@ -0,0 +1,34 @@
+// Copyright (c) Ugo Lattanzi.  All Rights Reserved.  Licensed under the MIT license.  See License.txt in the project root for license information.
+
+using System;
+
+using Snappier;
+
+namespace StackExchange.Redis.Extensions.Core;
+
+/// <summary>
+/// An <see cref="ICompressor"/> implementation using Snappy compression via Snappier.
+/// Snappy prioritizes speed over compression ratio, similar to LZ4.
+/// </summary>
+public class SnappierCompressor : ICompressor
+{
+    /// <inheritdoc/>
+    public byte[] Compress(byte[] data)
+    {
+        var maxLength = Snappy.GetMaxCompressedLength(data.Length);
+        var buffer = new byte[maxLength];
+        var compressedLength = Snappy.Compress(data, buffer);
+
+        return buffer.AsSpan(0, compressedLength).ToArray();
+    }
+
+    /// <inheritdoc/>
+    public byte[] Decompress(byte[] compressedData)
+    {
+        var decompressedLength = Snappy.GetUncompressedLength(compressedData);
+        var buffer = new byte[decompressedLength];
+        var actualLength = Snappy.Decompress(compressedData, buffer);
+
+        return buffer.AsSpan(0, actualLength).ToArray();
+    }
+}