Pass in JsonSerializerOptions to generic methods (#187)

* Pass in JsonSerializerOptions to generic methods

addresses #186

* move the '?' to the right place

* Add unit tests for JsonSerializerOptions

* add missing json path

---------

Co-authored-by: shacharPash <[email protected]>
Co-authored-by: shacharPash <[email protected]>

Author: MichaelDeutschCoding

src/NRedisStack/Json/IJsonCommands.cs

@@ -1,5 +1,6 @@
 using NRedisStack.Json.DataTypes;
 using StackExchange.Redis;
+using System.Text.Json;
 
 namespace NRedisStack;
 
@@ -103,7 +104,7 @@ public interface IJsonCommands
     /// <param name="newLine">sets the string that's printed at the end of each line</param>
     /// <param name="space">sets the string that's put between a key and a value</param>
     /// <param name="path">the path to get.</param>
-    /// <returns>The requested Items</returns>
+    /// <returns>The requested items</returns>
     /// <remarks><seealso href="https://redis.io/commands/json.get"/></remarks>
     RedisResult Get(RedisKey key, RedisValue? indent = null, RedisValue? newLine = null, RedisValue? space = null, RedisValue? path = null);
 
@@ -119,17 +120,18 @@ public interface IJsonCommands
     RedisResult Get(RedisKey key, string[] paths, RedisValue? indent = null, RedisValue? newLine = null, RedisValue? space = null);
 
     /// <summary>
-    /// Generically gets an Item stored in Redis.
+    /// Generically gets an item stored in Redis.
     /// </summary>
     /// <param name="key">The key to retrieve</param>
     /// <param name="path">The path to retrieve</param>
+    /// <param name="serializerOptions">Json serializer options to use for deserialization.</param>
     /// <typeparam name="T">The type retrieved</typeparam>
     /// <returns>The object requested</returns>
     /// <remarks><seealso href="https://redis.io/commands/json.get"/></remarks>
-    T? Get<T>(RedisKey key, string path = "$");
+    T? Get<T>(RedisKey key, string path = "$", JsonSerializerOptions? serializerOptions = default);
 
     /// <summary>
-    /// retrieves a group of items stored in redis, appropriate if the path will  resolve to multiple records.
+    /// Retrieves a group of items stored in Redis, appropriate if the path will resolve to multiple records.
     /// </summary>
     /// <param name="key">The key to pull from.</param>
     /// <param name="path">The path to pull.</param>

src/NRedisStack/Json/IJsonCommandsAsync.cs

@@ -1,5 +1,6 @@
 using NRedisStack.Json.DataTypes;
 using StackExchange.Redis;
+using System.Text.Json;
 
 namespace NRedisStack;
 
@@ -123,10 +124,11 @@ public interface IJsonCommandsAsync
     /// </summary>
     /// <param name="key">The key to retrieve</param>
     /// <param name="path">The path to retrieve</param>
+    /// <param name="serializerOptions">Json serializer options to use for deserialization.</param>
     /// <typeparam name="T">The type retrieved</typeparam>
     /// <returns>The object requested</returns>
     /// <remarks><seealso href="https://redis.io/commands/json.get"/></remarks>
-    Task<T?> GetAsync<T>(RedisKey key, string path = "$");
+    Task<T?> GetAsync<T>(RedisKey key, string path = "$", JsonSerializerOptions? serializerOptions = default);
 
     /// <summary>
     /// retrieves a group of items stored in redis, appropriate if the path will  resolve to multiple records.

src/NRedisStack/Json/JsonCommands.cs

@@ -222,15 +222,15 @@ public RedisResult Get(RedisKey key, string[] paths, RedisValue? indent = null,
     }
 
     /// <inheritdoc/>
-    public T? Get<T>(RedisKey key, string path = "$")
+    public T? Get<T>(RedisKey key, string path = "$", JsonSerializerOptions? serializerOptions = default)
     {
         var res = _db.Execute(JsonCommandBuilder.Get<T>(key, path));
         if (res.Type == ResultType.BulkString)
         {
             var arr = JsonSerializer.Deserialize<JsonArray>(res.ToString()!);
             if (arr?.Count > 0)
             {
-                return JsonSerializer.Deserialize<T>(JsonSerializer.Serialize(arr[0]));
+                return JsonSerializer.Deserialize<T>(JsonSerializer.Serialize(arr[0]), serializerOptions);
             }
         }
 

src/NRedisStack/Json/JsonCommandsAsync.cs

@@ -78,15 +78,15 @@ public async Task<RedisResult> GetAsync(RedisKey key, string[] paths, RedisValue
         return await _db.ExecuteAsync(JsonCommandBuilder.Get(key, paths, indent, newLine, space));
     }
 
-    public async Task<T?> GetAsync<T>(RedisKey key, string path = "$")
+    public async Task<T?> GetAsync<T>(RedisKey key, string path = "$", JsonSerializerOptions? serializerOptions = default)
     {
         var res = await _db.ExecuteAsync(JsonCommandBuilder.Get<T>(key, path));
         if (res.Type == ResultType.BulkString)
         {
             var arr = JsonSerializer.Deserialize<JsonArray>(res.ToString()!);
             if (arr?.Count > 0)
             {
-                return JsonSerializer.Deserialize<T>(JsonSerializer.Serialize(arr[0]));
+                return JsonSerializer.Deserialize<T>(JsonSerializer.Serialize(arr[0]), serializerOptions);
             }
         }
 

tests/NRedisStack.Tests/Json/JsonTests.cs

@@ -681,14 +681,21 @@ public async Task ForgetAsync()
     public void Get()
     {
         var commands = new JsonCommands(redisFixture.Redis.GetDatabase());
-        var keys = CreateKeyNames(2);
+        var keys = CreateKeyNames(3);
         var key = keys[0];
         var complexKey = keys[1];
+        var caseInsensitiveKey = keys[2];
         commands.Set(key, "$", new Person() { Age = 35, Name = "Alice" });
         commands.Set(complexKey, "$", new { a = new Person() { Age = 35, Name = "Alice" }, b = new { a = new Person() { Age = 35, Name = "Alice" } } });
+        commands.Set(caseInsensitiveKey, "$", new { name = "Alice", AGE = 35 });
         var result = commands.Get<Person>(key);
         Assert.Equal("Alice", result!.Name);
         Assert.Equal(35, result.Age);
+        var jsonOptions = new JsonSerializerOptions { PropertyNameCaseInsensitive = true };
+        result = commands.Get<Person>(caseInsensitiveKey, "$", jsonOptions);
+        Assert.NotNull(result);
+        Assert.Equal("Alice", result!.Name);
+        Assert.Equal(35, result.Age);
         var people = commands.GetEnumerable<Person>(complexKey, "$..a").ToArray();
         Assert.Equal(2, people.Length);
         Assert.Equal("Alice", people[0]!.Name);
@@ -701,14 +708,21 @@ public void Get()
     public async Task GetAsync()
     {
         var commands = new JsonCommandsAsync(redisFixture.Redis.GetDatabase());
-        var keys = CreateKeyNames(2);
+        var keys = CreateKeyNames(3);
         var key = keys[0];
         var complexKey = keys[1];
+        var caseInsensitiveKey = keys[2];
         await commands.SetAsync(key, "$", new Person() { Age = 35, Name = "Alice" });
         await commands.SetAsync(complexKey, "$", new { a = new Person() { Age = 35, Name = "Alice" }, b = new { a = new Person() { Age = 35, Name = "Alice" } } });
+        await commands.SetAsync(caseInsensitiveKey, "$", new { name = "Alice", AGE = 35 });
         var result = await commands.GetAsync<Person>(key);
         Assert.Equal("Alice", result!.Name);
         Assert.Equal(35, result.Age);
+        var jsonOptions = new JsonSerializerOptions { PropertyNameCaseInsensitive = true };
+        result = await commands.GetAsync<Person>(caseInsensitiveKey, "$", jsonOptions);
+        Assert.NotNull(result);
+        Assert.Equal("Alice", result!.Name);
+        Assert.Equal(35, result.Age);
         var people = (await commands.GetEnumerableAsync<Person>(complexKey, "$..a")).ToArray();
         Assert.Equal(2, people.Length);
         Assert.Equal("Alice", people[0]!.Name);
@@ -730,8 +744,8 @@ public void MSet()
             new KeyPathValue(key1, "$", new { a = "hello" }),
             new KeyPathValue(key2, "$", new { a = "world" })
         };
-        commands.MSet(values)
-;
+        commands.MSet(values);
+
         var result = commands.MGet(keys.Select(x => new RedisKey(x)).ToArray(), "$.a");
 
         Assert.Equal("[\"hello\"]", result[0].ToString());
@@ -753,8 +767,8 @@ public async Task MSetAsync()
             new KeyPathValue(key1, "$", new { a = "hello" }),
             new KeyPathValue(key2, "$", new { a = "world" })
         };
-        await commands.MSetAsync(values)
-;
+        await commands.MSetAsync(values);
+
         var result = await commands.MGetAsync(keys.Select(x => new RedisKey(x)).ToArray(), "$.a");
 
         Assert.Equal("[\"hello\"]", result[0].ToString());