Enable MessagePackCompression.Lz4BlockArray for EFCoreSecondLevelCacheInterceptor.StackExchange.Redis, Close #296

Author: VahidN

src/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis/EFMessagePackSerializer.cs

@@ -1,5 +1,6 @@
 using MessagePack;
 using MessagePack.Resolvers;
+using Microsoft.Extensions.Options;
 
 namespace EFCoreSecondLevelCacheInterceptor;
 
@@ -16,14 +17,31 @@ public class EFMessagePackSerializer : IEFDataSerializer
             DynamicGenericResolver.Instance
         ]);
 
+    private readonly bool _enableCompression;
+    private MessagePackSerializerOptions? _messagePackSerializerOptions;
+
+    /// <summary>
+    ///     High-Level API of MessagePack for C#.
+    /// </summary>
+    public EFMessagePackSerializer(IOptions<EFCoreSecondLevelCacheSettings> cacheSettings)
+    {
+        var options = cacheSettings.Value.AdditionalData as EFRedisCacheConfigurationOptions ??
+                      throw new InvalidOperationException(
+                          message: "Please call the UseStackExchangeRedisCacheProvider() method.");
+
+        _enableCompression = options.EnableCompression;
+    }
+
+    private MessagePackSerializerOptions MessagePackSerializerOptions
+        => _messagePackSerializerOptions ??= GetSerializerOptions();
+
     /// <summary>
     ///     Serializes a given value with the specified buffer writer.
     /// </summary>
     /// <param name="obj"></param>
     /// <typeparam name="T"></typeparam>
     /// <returns></returns>
-    public byte[] Serialize<T>(T? obj)
-        => MessagePackSerializer.Serialize(obj, MessagePackSerializerOptions.Standard.WithResolver(CustomResolvers));
+    public byte[] Serialize<T>(T? obj) => MessagePackSerializer.Serialize(obj, MessagePackSerializerOptions);
 
     /// <summary>
     ///     Deserializes a value of a given type from a sequence of bytes.
@@ -32,8 +50,11 @@ public byte[] Serialize<T>(T? obj)
     /// <typeparam name="T"></typeparam>
     /// <returns></returns>
     public T? Deserialize<T>(byte[]? data)
-        => data is null
-            ? default
-            : MessagePackSerializer.Deserialize<T>(data,
-                MessagePackSerializerOptions.Standard.WithResolver(CustomResolvers));
+        => data is null ? default : MessagePackSerializer.Deserialize<T>(data, MessagePackSerializerOptions);
+
+    private MessagePackSerializerOptions GetSerializerOptions()
+        => _enableCompression
+            ? MessagePackSerializerOptions.Standard.WithCompression(MessagePackCompression.Lz4BlockArray)
+                .WithResolver(CustomResolvers)
+            : MessagePackSerializerOptions.Standard.WithResolver(CustomResolvers);
 }

src/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis/EFRedisCacheConfigurationOptions.cs

@@ -16,4 +16,9 @@ public class EFRedisCacheConfigurationOptions
     ///     Redis ConnectionString
     /// </summary>
     public string? RedisConnectionString { set; get; }
+
+    /// <summary>
+    ///     Enables MessagePackCompression.Lz4BlockArray
+    /// </summary>
+    public bool EnableCompression { set; get; }
 }

src/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis/EFStackExchangeRedisCacheProviderOptions.cs

@@ -1,4 +1,3 @@
-using System;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using StackExchange.Redis;
 
@@ -16,7 +15,8 @@ public static class EFStackExchangeRedisCacheProviderOptions
     public static EFCoreSecondLevelCacheOptions UseStackExchangeRedisCacheProvider(
         this EFCoreSecondLevelCacheOptions options,
         ConfigurationOptions configurationOptions,
-        TimeSpan timeout)
+        TimeSpan timeout,
+        bool enableCompression = false)
     {
         if (options == null)
         {
@@ -25,7 +25,8 @@ public static EFCoreSecondLevelCacheOptions UseStackExchangeRedisCacheProvider(
 
         SetOptions(options, timeout, new EFRedisCacheConfigurationOptions
         {
-            ConfigurationOptions = configurationOptions
+            ConfigurationOptions = configurationOptions,
+            EnableCompression = enableCompression
         });
 
         return options;
@@ -38,7 +39,8 @@ public static EFCoreSecondLevelCacheOptions UseStackExchangeRedisCacheProvider(
     public static EFCoreSecondLevelCacheOptions UseStackExchangeRedisCacheProvider(
         this EFCoreSecondLevelCacheOptions options,
         string redisConnectionString,
-        TimeSpan timeout)
+        TimeSpan timeout,
+        bool enableCompression = false)
     {
         if (options == null)
         {
@@ -47,7 +49,8 @@ public static EFCoreSecondLevelCacheOptions UseStackExchangeRedisCacheProvider(
 
         SetOptions(options, timeout, new EFRedisCacheConfigurationOptions
         {
-            RedisConnectionString = redisConnectionString
+            RedisConnectionString = redisConnectionString,
+            EnableCompression = enableCompression
         });
 
         return options;