Fix Query input in Explain & ExplainCli

src/NRedisStack/Search/ISearchCommands.cs

@@ -146,19 +146,21 @@ public interface ISearchCommands
         /// Return the execution plan for a complex query
         /// </summary>
         /// <param name="indexName">The index name</param>
-        /// <param name="q">The query to explain</param>
+        /// <param name="query">The query to explain</param>
+        /// <param name="dialect">Dialect version under which to execute the query</param>
         /// <returns>String that representing the execution plan</returns>
         /// <remarks><seealso href="https://redis.io/commands/ft.explain/"/></remarks>
-        string Explain(string indexName, Query q);
+        string Explain(string indexName, string query, int? dialect = null);
 
         /// <summary>
         /// Return the execution plan for a complex query
         /// </summary>
         /// <param name="indexName">The index name</param>
-        /// <param name="q">The query to explain</param>
+        /// <param name="query">The query to explain</param>
+        /// <param name="dialect">Dialect version under which to execute the query</param>
         /// <returns>An array reply with a string representing the execution plan</returns>
         /// <remarks><seealso href="https://redis.io/commands/ft.explaincli/"/></remarks>
-        RedisResult[] ExplainCli(string indexName, Query q);
+        RedisResult[] ExplainCli(string indexName, string query, int? dialect = null);
 
         /// <summary>
         /// Return information and statistics on the index.

src/NRedisStack/Search/ISearchCommandsAsync.cs

@@ -145,19 +145,21 @@ public interface ISearchCommandsAsync
         /// Return the execution plan for a complex query
         /// </summary>
         /// <param name="indexName">The index name</param>
-        /// <param name="q">The query to explain</param>
+        /// <param name="query">The query to explain</param>
+        /// <param name="dialect">Dialect version under which to execute the query</param>
         /// <returns>String that representing the execution plan</returns>
         /// <remarks><seealso href="https://redis.io/commands/ft.explain/"/></remarks>
-        Task<string> ExplainAsync(string indexName, Query q);
+        Task<string> ExplainAsync(string indexName, string query, int? dialect = null);
 
         /// <summary>
         /// Return the execution plan for a complex query
         /// </summary>
         /// <param name="indexName">The index name</param>
-        /// <param name="q">The query to explain</param>
+        /// <param name="query">The query to explain</param>
+        /// <param name="dialect">Dialect version under which to execute the query</param>
         /// <returns>An array reply with a string representing the execution plan</returns>
         /// <remarks><seealso href="https://redis.io/commands/ft.explaincli/"/></remarks>
-        Task<RedisResult[]> ExplainCliAsync(string indexName, Query q);
+        Task<RedisResult[]> ExplainCliAsync(string indexName, string query, int? dialect = null);
 
         /// <summary>
         /// Return information and statistics on the index.

src/NRedisStack/Search/Query.cs

@@ -191,12 +191,12 @@ public HighlightTags(string open, string close)
         public string Scorer { get; set; }
         // public bool ExplainScore { get; set; } // TODO: Check if this is needed because Jedis doesn't have it
 
-        private Dictionary<String, Object> _params = new Dictionary<string, object>();
+        private Dictionary<string, object> _params = new Dictionary<string, object>();
         public int? dialect { get; private set;} = null;
         private int _slop = -1;
         private long _timeout = -1;
         private bool _inOrder = false;
-        private string _expander = null;
+        private string? _expander = null;
 
         public Query() : this("*") { }
 

src/NRedisStack/Search/SearchCommandBuilder.cs

@@ -126,17 +126,25 @@ public static SerializedCommand DropIndex(string indexName, bool dd = false)
                          : new SerializedCommand(FT.DROPINDEX, indexName));
         }
 
-        public static SerializedCommand Explain(string indexName, Query q)
+        public static SerializedCommand Explain(string indexName, string query, int? dialect)
         {
-            var args = new List<object> { indexName };
-            q.SerializeRedisArgs(args);
+            var args = new List<object> { indexName, query };
+            if (dialect != null)
+            {
+                args.Add("DIALECT");
+                args.Add(dialect);
+            }
             return new SerializedCommand(FT.EXPLAIN, args);
         }
 
-        public static SerializedCommand ExplainCli(string indexName, Query q)
+        public static SerializedCommand ExplainCli(string indexName, string query, int? dialect)
         {
-            var args = new List<object> { indexName };
-            q.SerializeRedisArgs(args);
+            var args = new List<object> { indexName, query };
+            if (dialect != null)
+            {
+                args.Add("DIALECT");
+                args.Add(dialect);
+            }
             return new SerializedCommand(FT.EXPLAINCLI, args);
         }
 

src/NRedisStack/Search/SearchCommands.cs

@@ -130,23 +130,23 @@ public bool DropIndex(string indexName, bool dd = false)
         }
 
         /// <inheritdoc/>
-        public string Explain(string indexName, Query q)
+        public string Explain(string indexName, string query, int? dialect = null)
         {
-            if (q.dialect == null && defaultDialect != null)
+            if (dialect == null && defaultDialect != null)
             {
-                q.Dialect((int)defaultDialect);
+                dialect = defaultDialect;
             }
-            return _db.Execute(SearchCommandBuilder.Explain(indexName, q)).ToString();
+            return _db.Execute(SearchCommandBuilder.Explain(indexName, query, dialect)).ToString();
         }
 
         /// <inheritdoc/>
-        public RedisResult[] ExplainCli(string indexName, Query q)
+        public RedisResult[] ExplainCli(string indexName, string query, int? dialect = null)
         {
-            if (q.dialect == null && defaultDialect != null)
+            if (dialect == null && defaultDialect != null)
             {
-                q.Dialect((int)defaultDialect);
+                dialect = defaultDialect;
             }
-            return _db.Execute(SearchCommandBuilder.ExplainCli(indexName, q)).ToArray();
+            return _db.Execute(SearchCommandBuilder.ExplainCli(indexName, query, dialect)).ToArray();
         }
 
         /// <inheritdoc/>

src/NRedisStack/Search/SearchCommandsAsync.cs

@@ -121,25 +121,25 @@ public async Task<bool> DropIndexAsync(string indexName, bool dd = false)
         }
 
         /// <inheritdoc/>
-        public async Task<string> ExplainAsync(string indexName, Query q)
+        public async Task<string> ExplainAsync(string indexName, string query, int? dialect = null)
         {
-            if (q.dialect == null && defaultDialect != null)
+            if (dialect == null && defaultDialect != null)
             {
-                q.Dialect((int)defaultDialect);
+                dialect = defaultDialect;
             }
 
-            return (await _db.ExecuteAsync(SearchCommandBuilder.Explain(indexName, q))).ToString();
+            return (await _db.ExecuteAsync(SearchCommandBuilder.Explain(indexName, query, dialect))).ToString();
         }
 
         /// <inheritdoc/>
-        public async Task<RedisResult[]> ExplainCliAsync(string indexName, Query q)
+        public async Task<RedisResult[]> ExplainCliAsync(string indexName, string query, int? dialect = null)
         {
-            if (q.dialect == null && defaultDialect != null)
+            if (dialect == null && defaultDialect != null)
             {
-                q.Dialect((int)defaultDialect);
+                dialect = defaultDialect;
             }
 
-            return (await _db.ExecuteAsync(SearchCommandBuilder.ExplainCli(indexName, q))).ToArray();
+            return (await _db.ExecuteAsync(SearchCommandBuilder.ExplainCli(indexName, query, dialect))).ToArray();
         }
 
         /// <inheritdoc/>

tests/NRedisStack.Tests/Search/SearchTests.cs

@@ -1317,6 +1317,7 @@ public async Task TestDictionaryAsync()
         Assert.Equal((await ft.DictDumpAsync("dict")).Length, 0);
     }
 
+    string explainQuery = "@f3:f3_val @f2:f2_val @f1:f1_val";
     [Fact]
     public void TestExplain()
     {
@@ -1329,9 +1330,16 @@ public void TestExplain()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        string res = ft.Explain(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+        string res = ft.Explain(index, explainQuery);
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
+
+        // Test with dialect:
+        res = ft.Explain(index, explainQuery, 2);
+        Assert.NotNull(res);
+        Assert.False(res.Length == 0);
+
+
     }
 
     [Fact]
@@ -1346,7 +1354,13 @@ public async Task TestExplainAsync()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        string res = await ft.ExplainAsync(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+
+        string res = await ft.ExplainAsync(index, explainQuery);
+        Assert.NotNull(res);
+        Assert.False(res.Length == 0);
+
+        // Test with dialect:
+        res = await ft.ExplainAsync(index, explainQuery, 2);
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
     }
@@ -1363,7 +1377,13 @@ public void TestExplainCli()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        var res = ft.ExplainCli(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+
+        var res = ft.ExplainCli(index, explainQuery);
+        Assert.NotNull(res);
+        Assert.False(res.Length == 0);
+
+        // Test with dialect (ovveride the dialect 2):
+        res = ft.ExplainCli(index, explainQuery, 1);
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
     }
@@ -1380,7 +1400,13 @@ public async Task TestExplainCliAsync()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        var res = await ft.ExplainCliAsync(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+
+        var res = await ft.ExplainCliAsync(index, explainQuery);
+        Assert.NotNull(res);
+        Assert.False(res.Length == 0);
+
+        // Test with dialect (ovveride the dialect 2):
+        res = await ft.ExplainCliAsync(index, explainQuery, 1);
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
     }
@@ -1397,7 +1423,7 @@ public void TestExplainWithDefaultDialect()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        String res = ft.Explain(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+        String res = ft.Explain(index, "@f3:f3_val @f2:f2_val @f1:f1_val");
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
     }
@@ -1414,7 +1440,7 @@ public async Task TestExplainWithDefaultDialectAsync()
             .AddTextField("f3", 1.0);
         ft.Create(index, FTCreateParams.CreateParams(), sc);
 
-        String res = await ft.ExplainAsync(index, new Query("@f3:f3_val @f2:f2_val @f1:f1_val"));
+        String res = await ft.ExplainAsync(index, "@f3:f3_val @f2:f2_val @f1:f1_val");
         Assert.NotNull(res);
         Assert.False(res.Length == 0);
     }
@@ -2275,4 +2301,4 @@ public void TestModulePrefixs1()
             conn.Dispose();
         }
     }
-}
+}