Merge branch 'master' into DOC-4261-geo-tces

Author: andy-stark-redis

src/NRedisStack/Gears/GearsCommandBuilder.cs

@@ -3,8 +3,10 @@
 namespace NRedisStack
 {
 
+    [Obsolete]
     public static class GearsCommandBuilder
     {
+        [Obsolete]
         public static SerializedCommand TFunctionLoad(string libraryCode, bool replace = false, string? config = null)
         {
             var args = new List<object>() { GearsArgs.LOAD };
@@ -23,11 +25,13 @@ public static SerializedCommand TFunctionLoad(string libraryCode, bool replace =
             return new SerializedCommand(RG.TFUNCTION, args);
         }
 
+        [Obsolete]
         public static SerializedCommand TFunctionDelete(string libraryName)
         {
             return new SerializedCommand(RG.TFUNCTION, GearsArgs.DELETE, libraryName);
         }
 
+        [Obsolete]
         public static SerializedCommand TFunctionList(bool withCode = false, int verbose = 0, string? libraryName = null)
         {
             var args = new List<object>() { GearsArgs.LIST };
@@ -55,6 +59,7 @@ public static SerializedCommand TFunctionList(bool withCode = false, int verbose
             return new SerializedCommand(RG.TFUNCTION, args);
         }
 
+        [Obsolete]
         public static SerializedCommand TFCall(string libraryName, string functionName, string[]? keys = null, string[]? args = null, bool async = false)
         {
             string command = async ? RG.TFCALLASYNC : RG.TFCALL;

src/NRedisStack/Gears/GearsCommands.cs

@@ -1,7 +1,7 @@
 using StackExchange.Redis;
 namespace NRedisStack
 {
-
+    [Obsolete]
     public static class GearsCommands //: GearsCommandsAsync, IGearsCommands
     {
 
@@ -17,6 +17,7 @@ public static class GearsCommands //: GearsCommandsAsync, IGearsCommands
         /// <param name="replace">an optional argument, instructs RedisGears to replace the function if its already exists.</param>
         /// <returns><see langword="true"/> if everything was done correctly, Error otherwise.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfunction-load/"/></remarks> //TODO: check this link when it's available
+        [Obsolete]
         public static bool TFunctionLoad(this IDatabase db, string libraryCode, bool replace = false, string? config = null)
         {
             return db.Execute(GearsCommandBuilder.TFunctionLoad(libraryCode, replace, config)).OKtoBoolean();
@@ -28,6 +29,7 @@ public static bool TFunctionLoad(this IDatabase db, string libraryCode, bool rep
         /// <param name="libraryName">the name of the library to delete.</param>
         /// <returns><see langword="true"/> if the library was deleted successfully, Error otherwise.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfunction-delete/"/></remarks> //TODO: check this link when it's available
+        [Obsolete]
         public static bool TFunctionDelete(this IDatabase db, string libraryName)
         {
             return db.Execute(GearsCommandBuilder.TFunctionDelete(libraryName)).OKtoBoolean();
@@ -42,6 +44,7 @@ public static bool TFunctionDelete(this IDatabase db, string libraryName)
         /// multiple times to show multiple libraries in a single command)</param>
         /// <returns>Information about the requested libraries.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfunction-list/"/></remarks> //TODO: check this link when it's available
+        [Obsolete]
         public static Dictionary<string, RedisResult>[] TFunctionList(this IDatabase db, bool withCode = false, int verbose = 0, string? libraryName = null)
         {
             return db.Execute(GearsCommandBuilder.TFunctionList(withCode, verbose, libraryName)).ToDictionarys();
@@ -56,6 +59,7 @@ public static Dictionary<string, RedisResult>[] TFunctionList(this IDatabase db,
         /// <param name="args">Additional argument to pass to the function.</param>
         /// <returns>The return value from the sync &amp; async function on error in case of failure.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfcall"/></remarks>
+        [Obsolete]
         public static RedisResult TFCall_(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null)
         {
             return db.Execute(GearsCommandBuilder.TFCall(libraryName, functionName, keys, args, async: false));
@@ -70,6 +74,7 @@ public static RedisResult TFCall_(this IDatabase db, string libraryName, string
         /// <param name="args">Additional argument to pass to the function.</param>
         /// <returns>The return value from the sync &amp; async function on error in case of failure.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfcallasync"/></remarks>
+        [Obsolete]
         public static RedisResult TFCallAsync_(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null)
         {
             return db.Execute(GearsCommandBuilder.TFCall(libraryName, functionName, keys, args, async: true));

src/NRedisStack/Gears/GearsCommandsAsync.cs

@@ -16,6 +16,7 @@ public static class GearsCommandsAsync //: IGearsCommandsAsync
         /// <param name="replace">an optional argument, instructs RedisGears to replace the function if its already exists.</param>
         /// <returns><see langword="true"/> if everything was done correctly, Error otherwise.</returns>
         /// <remarks><seealso href="https://redis.io/commands/"/></remarks> //TODO: add link to the command when it's available
+        [Obsolete]
         public static async Task<bool> TFunctionLoadAsync(this IDatabase db, string libraryCode, string? config = null, bool replace = false)
         {
             return (await db.ExecuteAsync(GearsCommandBuilder.TFunctionLoad(libraryCode, replace, config))).OKtoBoolean();
@@ -27,6 +28,7 @@ public static async Task<bool> TFunctionLoadAsync(this IDatabase db, string libr
         /// <param name="libraryName">the name of the library to delete.</param>
         /// <returns><see langword="true"/> if the library was deleted successfully, Error otherwise.</returns>
         /// <remarks><seealso href="https://redis.io/commands/"/></remarks> //TODO: add link to the command when it's available
+        [Obsolete]
         public static async Task<bool> TFunctionDeleteAsync(this IDatabase db, string libraryName)
         {
             return (await db.ExecuteAsync(GearsCommandBuilder.TFunctionDelete(libraryName))).OKtoBoolean();
@@ -41,6 +43,7 @@ public static async Task<bool> TFunctionDeleteAsync(this IDatabase db, string li
         /// multiple times to show multiple libraries in a single command)</param>
         /// <returns>Information about the requested libraries.</returns>
         /// <remarks><seealso href="https://redis.io/commands/"/></remarks> //TODO: add link to the command when it's available
+        [Obsolete]
         public static async Task<Dictionary<string, RedisResult>[]> TFunctionListAsync(this IDatabase db, bool withCode = false, int verbose = 0, string? libraryName = null)
         {
             return (await db.ExecuteAsync(GearsCommandBuilder.TFunctionList(withCode, verbose, libraryName))).ToDictionarys();
@@ -55,6 +58,7 @@ public static async Task<Dictionary<string, RedisResult>[]> TFunctionListAsync(t
         /// <param name="args">Additional argument to pass to the function.</param>
         /// <returns>The return value from the sync &amp; async function on error in case of failure.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfcall"/></remarks>
+        [Obsolete]
         public async static Task<RedisResult> TFCall_Async(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null)
         {
             return await db.ExecuteAsync(GearsCommandBuilder.TFCall(libraryName, functionName, keys, args, async: false));
@@ -69,6 +73,7 @@ public async static Task<RedisResult> TFCall_Async(this IDatabase db, string lib
         /// <param name="args">Additional argument to pass to the function.</param>
         /// <returns>The return value from the sync &amp; async function on error in case of failure.</returns>
         /// <remarks><seealso href="https://redis.io/commands/tfcallasync"/></remarks>
+        [Obsolete]
         public async static Task<RedisResult> TFCallAsync_Async(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null)
         {
             return await db.ExecuteAsync(GearsCommandBuilder.TFCall(libraryName, functionName, keys, args, async: true));

src/NRedisStack/Search/AggregationResult.cs

@@ -6,7 +6,9 @@ namespace NRedisStack.Search;
 public sealed class AggregationResult
 {
     public long TotalResults { get; }
-    private readonly Dictionary<string, RedisValue>[] _results;
+    private readonly Dictionary<string, object>[] _results;
+    private Dictionary<string, RedisValue>[] _resultsAsRedisValues;
+
     public long CursorId { get; }
 
 
@@ -18,18 +20,23 @@ internal AggregationResult(RedisResult result, long cursorId = -1)
         // // the first element is always the number of results
         // TotalResults = (long)arr[0];
 
-        _results = new Dictionary<string, RedisValue>[arr.Length - 1];
+        _results = new Dictionary<string, object>[arr.Length - 1];
         for (int i = 1; i < arr.Length; i++)
         {
             var raw = (RedisResult[])arr[i]!;
-            var cur = new Dictionary<string, RedisValue>();
+            var cur = new Dictionary<string, object>();
             for (int j = 0; j < raw.Length;)
             {
                 var key = (string)raw[j++]!;
                 var val = raw[j++];
                 if (val.Type == ResultType.MultiBulk)
-                    continue; // TODO: handle multi-bulk (maybe change to object?)
-                cur.Add(key, (RedisValue)val);
+                {
+                    cur.Add(key, ConvertMultiBulkToObject((RedisResult[])val!));
+                }
+                else
+                {
+                    cur.Add(key, (RedisValue)val);
+                }
             }
 
             _results[i - 1] = cur;
@@ -52,17 +59,47 @@ private object ConvertMultiBulkToObject(IEnumerable<RedisResult> multiBulkArray)
     {
         return multiBulkArray.Select(item => item.Type == ResultType.MultiBulk
                 ? ConvertMultiBulkToObject((RedisResult[])item!)
-                : item)
+                : (RedisValue)item)
             .ToList();
     }
 
-    public IReadOnlyList<Dictionary<string, RedisValue>> GetResults() => _results;
+    /// <summary>
+    /// Gets the results as a read-only list of dictionaries with string keys and RedisValue values.
+    /// </summary>
+    /// <remarks>
+    /// This method is deprecated and will be removed in future versions. 
+    /// Please use <see cref="GetRow"/> instead.
+    /// </remarks>
+    [Obsolete("This method is deprecated and will be removed in future versions. Please use 'GetRow' instead.")]
+    public IReadOnlyList<Dictionary<string, RedisValue>> GetResults()
+    {
+        return getResultsAsRedisValues();
+    }
 
+    /// <summary>
+    /// Gets the aggregation result at the specified index.
+    /// </summary>
+    /// <param name="index">The zero-based index of the aggregation result to retrieve.</param>
+    /// <returns>
+    /// A dictionary containing the aggregation result as Redis values if the index is within bounds;
+    /// otherwise, <c>null</c>.
+    /// </returns>
+    [Obsolete("This method is deprecated and will be removed in future versions. Please use 'GetRow' instead.")]
     public Dictionary<string, RedisValue>? this[int index]
-        => index >= _results.Length ? null : _results[index];
+   => index >= getResultsAsRedisValues().Length ? null : getResultsAsRedisValues()[index];
 
     public Row GetRow(int index)
     {
         return index >= _results.Length ? default : new Row(_results[index]);
     }
+
+    private Dictionary<string, RedisValue>[] getResultsAsRedisValues()
+    {
+        if (_resultsAsRedisValues == null)
+            _resultsAsRedisValues = _results.Select(dict => dict.ToDictionary(
+               kvp => kvp.Key,
+               kvp => kvp.Value is RedisValue value ? value : RedisValue.Null
+           )).ToArray();
+        return _resultsAsRedisValues;
+    }
 }

src/NRedisStack/Search/Row.cs

@@ -4,18 +4,19 @@ namespace NRedisStack.Search.Aggregation
 {
     public readonly struct Row
     {
-        private readonly Dictionary<string, RedisValue> _fields;
+        private readonly Dictionary<string, object> _fields;
 
-        internal Row(Dictionary<string, RedisValue> fields)
+        internal Row(Dictionary<string, object> fields)
         {
             _fields = fields;
         }
 
         public bool ContainsKey(string key) => _fields.ContainsKey(key);
-        public RedisValue this[string key] => _fields.TryGetValue(key, out var result) ? result : RedisValue.Null;
+        public RedisValue this[string key] => _fields.TryGetValue(key, out var result) ? (result is RedisValue ? (RedisValue)result : RedisValue.Null) : RedisValue.Null;
+        public object Get(string key) => _fields.TryGetValue(key, out var result) ? result : RedisValue.Null;
 
         public string? GetString(string key) => _fields.TryGetValue(key, out var result) ? result.ToString() : default;
-        public long GetLong(string key) => _fields.TryGetValue(key, out var result) ? (long)result : default;
-        public double GetDouble(string key) => _fields.TryGetValue(key, out var result) ? (double)result : default;
+        public long GetLong(string key) => _fields.TryGetValue(key, out var result) ? (long)(RedisValue)result : default;
+        public double GetDouble(string key) => _fields.TryGetValue(key, out var result) ? (double)(RedisValue)result : default;
     }
 }