Set DIALECT 2 as default configurable dialect version (#355)

atakavci · web-flow · commit e152ef232bb9 · 2024-12-30T14:46:16.000+03:00
- provide dialect 2 as default configurable dialect version
diff --git a/src/NRedisStack/ModulePrefixes.cs b/src/NRedisStack/ModulePrefixes.cs
@@ -17,7 +17,7 @@ public static class ModulePrefixes
 
         public static TdigestCommands TDIGEST(this IDatabase db) => new TdigestCommands(db);
 
-        public static SearchCommands FT(this IDatabase db, int? searchDialect = null) => new SearchCommands(db, searchDialect);
+        public static SearchCommands FT(this IDatabase db, int? searchDialect = 2) => new SearchCommands(db, searchDialect);
 
         public static JsonCommands JSON(this IDatabase db) => new JsonCommands(db);
 
diff --git a/src/NRedisStack/Search/AggregationRequest.cs b/src/NRedisStack/Search/AggregationRequest.cs
@@ -2,7 +2,7 @@
 using NRedisStack.Search.Literals;
 
 namespace NRedisStack.Search;
-public class AggregationRequest
+public class AggregationRequest : IDialectAwareParam
 {
     private List<object> args = new List<object>(); // Check if Readonly
     private bool isWithCursor = false;
@@ -184,4 +184,10 @@ public bool IsWithCursor()
     {
         return isWithCursor;
     }
+
+    int? IDialectAwareParam.Dialect
+    {
+        get { return dialect; }
+        set { dialect = value; }
+    }
 }
diff --git a/src/NRedisStack/Search/FTSpellCheckParams.cs b/src/NRedisStack/Search/FTSpellCheckParams.cs
@@ -1,7 +1,7 @@
 using NRedisStack.Search.Literals;
 namespace NRedisStack.Search
 {
-    public class FTSpellCheckParams
+    public class FTSpellCheckParams : IDialectAwareParam
     {
         List<object> args = new List<object>();
         private List<KeyValuePair<string, string>> terms = new List<KeyValuePair<string, string>>();
@@ -59,38 +59,29 @@ public List<object> GetArgs()
         }
 
         public void SerializeRedisArgs()
-        {
-            Distance();
-            Terms();
-            Dialect();
-        }
-
-        private void Dialect()
         {
             if (dialect != null)
             {
                 args.Add(SearchArgs.DIALECT);
                 args.Add(dialect);
             }
-        }
-
-        private void Terms()
-        {
             foreach (var term in terms)
             {
                 args.Add(SearchArgs.TERMS);
                 args.Add(term.Value);
                 args.Add(term.Key);
             }
-        }
-
-        private void Distance()
-        {
             if (distance != null)
             {
                 args.Add(SearchArgs.DISTANCE);
                 args.Add(distance);
             }
         }
+
+        int? IDialectAwareParam.Dialect
+        {
+            get { return dialect; }
+            set { dialect = value; }
+        }
     }
 }
diff --git a/src/NRedisStack/Search/IDialectAwareParam.cs b/src/NRedisStack/Search/IDialectAwareParam.cs
@@ -0,0 +1,15 @@
+namespace NRedisStack.Search
+{
+    /// <summary>
+    /// Interface for dialect-aware parameters.
+    /// To provide a single interface to manage default dialect version under which to execute the query.
+    /// </summary>
+    internal interface IDialectAwareParam
+    {
+        /// <summary>
+        ///  Selects the dialect version under which to execute the query.
+        /// </summary>
+        internal int? Dialect { get; set; }
+    }
+
+}
diff --git a/src/NRedisStack/Search/Query.cs b/src/NRedisStack/Search/Query.cs
@@ -7,7 +7,7 @@ namespace NRedisStack.Search
     /// <summary>
     ///  Query represents query parameters and filters to load results from the engine
     /// </summary>
-    public sealed class Query
+    public sealed class Query : IDialectAwareParam
     {
         /// <summary>
         /// Filter represents a filtering rules in a query
@@ -691,5 +691,12 @@ public Query SetExpander(String field)
             _expander = field;
             return this;
         }
+
+        int? IDialectAwareParam.Dialect
+        {
+            get { return dialect; }
+            set { dialect = value; }
+        }
+
     }
 }
diff --git a/src/NRedisStack/Search/SearchCommands.cs b/src/NRedisStack/Search/SearchCommands.cs
@@ -6,21 +6,10 @@ namespace NRedisStack
 {
     public class SearchCommands : SearchCommandsAsync, ISearchCommands
     {
-        IDatabase _db;
-        public SearchCommands(IDatabase db, int? defaultDialect) : base(db)
+        private IDatabase _db;
+        public SearchCommands(IDatabase db, int? defaultDialect = 2) : base(db, defaultDialect)
         {
             _db = db;
-            SetDefaultDialect(defaultDialect);
-            this.defaultDialect = defaultDialect;
-        }
-
-        public void SetDefaultDialect(int? defaultDialect)
-        {
-            if (defaultDialect == 0)
-            {
-                throw new System.ArgumentOutOfRangeException("DIALECT=0 cannot be set.");
-            }
-            this.defaultDialect = defaultDialect;
         }
 
         /// <inheritdoc/>
@@ -32,11 +21,7 @@ public RedisResult[] _List()
         /// <inheritdoc/>
         public AggregationResult Aggregate(string index, AggregationRequest query)
         {
-            if (query.dialect == null && defaultDialect != null)
-            {
-                query.Dialect((int)defaultDialect);
-            }
-
+            setDefaultDialectIfUnset(query);
             var result = _db.Execute(SearchCommandBuilder.Aggregate(index, query));
             return result.ToAggregationResult(query);
         }
@@ -130,20 +115,14 @@ public bool DropIndex(string indexName, bool dd = false)
         /// <inheritdoc/>
         public string Explain(string indexName, string query, int? dialect = null)
         {
-            if (dialect == null && defaultDialect != null)
-            {
-                dialect = defaultDialect;
-            }
+            dialect = checkAndGetDefaultDialect(dialect);
             return _db.Execute(SearchCommandBuilder.Explain(indexName, query, dialect)).ToString()!;
         }
 
         /// <inheritdoc/>
         public RedisResult[] ExplainCli(string indexName, string query, int? dialect = null)
         {
-            if (dialect == null && defaultDialect != null)
-            {
-                dialect = defaultDialect;
-            }
+            dialect = checkAndGetDefaultDialect(dialect);
             return _db.Execute(SearchCommandBuilder.ExplainCli(indexName, query, dialect)).ToArray();
         }
 
@@ -160,22 +139,21 @@ public Tuple<SearchResult, Dictionary<string, RedisResult>> ProfileSearch(string
         /// <inheritdoc/>
         public Tuple<AggregationResult, Dictionary<string, RedisResult>> ProfileAggregate(string indexName, AggregationRequest query, bool limited = false)
         {
+            setDefaultDialectIfUnset(query);
             return _db.Execute(SearchCommandBuilder.ProfileAggregate(indexName, query, limited))
                             .ToProfileAggregateResult(query);
         }
         /// <inheritdoc/>
         public SearchResult Search(string indexName, Query q)
         {
-            if (q.dialect == null && defaultDialect != null)
-            {
-                q.Dialect((int)defaultDialect);
-            }
+            setDefaultDialectIfUnset(q);
             return _db.Execute(SearchCommandBuilder.Search(indexName, q)).ToSearchResult(q);
         }
 
         /// <inheritdoc/>
         public Dictionary<string, Dictionary<string, double>> SpellCheck(string indexName, string query, FTSpellCheckParams? spellCheckParams = null)
         {
+            setDefaultDialectIfUnset(spellCheckParams);
             return _db.Execute(SearchCommandBuilder.SpellCheck(indexName, query, spellCheckParams)).ToFtSpellCheckResult();
         }
 
diff --git a/src/NRedisStack/Search/SearchCommandsAsync.cs b/src/NRedisStack/Search/SearchCommandsAsync.cs
@@ -6,12 +6,33 @@ namespace NRedisStack
 {
     public class SearchCommandsAsync : ISearchCommandsAsync
     {
-        IDatabaseAsync _db;
+        private IDatabaseAsync _db;
         protected int? defaultDialect;
 
-        public SearchCommandsAsync(IDatabaseAsync db)
+        public SearchCommandsAsync(IDatabaseAsync db, int? defaultDialect = 2)
         {
             _db = db;
+            SetDefaultDialect(defaultDialect);
+        }
+
+        internal void setDefaultDialectIfUnset(IDialectAwareParam param)
+        {
+            if (param != null && param.Dialect == null && defaultDialect != null)
+            {
+                param.Dialect = defaultDialect;
+            }
+        }
+
+        internal int? checkAndGetDefaultDialect(int? dialect) =>
+             (dialect == null && defaultDialect != null) ? defaultDialect : dialect;
+
+        public void SetDefaultDialect(int? defaultDialect)
+        {
+            if (defaultDialect == 0)
+            {
+                throw new System.ArgumentOutOfRangeException("DIALECT=0 cannot be set.");
+            }
+            this.defaultDialect = defaultDialect;
         }
 
         /// <inheritdoc/>
@@ -23,11 +44,7 @@ public async Task<RedisResult[]> _ListAsync()
         /// <inheritdoc/>
         public async Task<AggregationResult> AggregateAsync(string index, AggregationRequest query)
         {
-            if (query.dialect == null && defaultDialect != null)
-            {
-                query.Dialect((int)defaultDialect);
-            }
-
+            setDefaultDialectIfUnset(query);
             var result = await _db.ExecuteAsync(SearchCommandBuilder.Aggregate(index, query));
             if (query.IsWithCursor())
             {
@@ -129,22 +146,14 @@ public async Task<bool> DropIndexAsync(string indexName, bool dd = false)
         /// <inheritdoc/>
         public async Task<string> ExplainAsync(string indexName, string query, int? dialect = null)
         {
-            if (dialect == null && defaultDialect != null)
-            {
-                dialect = defaultDialect;
-            }
-
+            dialect = checkAndGetDefaultDialect(dialect);
             return (await _db.ExecuteAsync(SearchCommandBuilder.Explain(indexName, query, dialect))).ToString()!;
         }
 
         /// <inheritdoc/>
         public async Task<RedisResult[]> ExplainCliAsync(string indexName, string query, int? dialect = null)
         {
-            if (dialect == null && defaultDialect != null)
-            {
-                dialect = defaultDialect;
-            }
-
+            dialect = checkAndGetDefaultDialect(dialect);
             return (await _db.ExecuteAsync(SearchCommandBuilder.ExplainCli(indexName, query, dialect))).ToArray();
         }
 
@@ -168,17 +177,14 @@ public async Task<Tuple<AggregationResult, Dictionary<string, RedisResult>>> Pro
         /// <inheritdoc/>
         public async Task<SearchResult> SearchAsync(string indexName, Query q)
         {
-            if (q.dialect == null && defaultDialect != null)
-            {
-                q.Dialect((int)defaultDialect);
-            }
-
+            setDefaultDialectIfUnset(q);
             return (await _db.ExecuteAsync(SearchCommandBuilder.Search(indexName, q))).ToSearchResult(q);
         }
 
         /// <inheritdoc/>
         public async Task<Dictionary<string, Dictionary<string, double>>> SpellCheckAsync(string indexName, string query, FTSpellCheckParams? spellCheckParams = null)
         {
+            setDefaultDialectIfUnset(spellCheckParams);
             return (await _db.ExecuteAsync(SearchCommandBuilder.SpellCheck(indexName, query, spellCheckParams))).ToFtSpellCheckResult();
         }
 

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`using NRedisStack.Search.Literals;`
`3`	`3`
`4`	`4`	`namespace NRedisStack.Search;`
`5`		`-public class AggregationRequest`
	`5`	`+public class AggregationRequest : IDialectAwareParam`
`6`	`6`	`{`
`7`	`7`	`private List<object> args = new List<object>(); // Check if Readonly`
`8`	`8`	`private bool isWithCursor = false;`
`@@ -184,4 +184,10 @@ public bool IsWithCursor()`
`184`	`184`	`{`
`185`	`185`	`return isWithCursor;`
`186`	`186`	`}`
	`187`	`+`
	`188`	`+ int? IDialectAwareParam.Dialect`
	`189`	`+ {`
	`190`	`+ get { return dialect; }`
	`191`	`+ set { dialect = value; }`
	`192`	`+ }`
`187`	`193`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using NRedisStack.Search.Literals;`
`2`	`2`	`namespace NRedisStack.Search`
`3`	`3`	`{`
`4`		`- public class FTSpellCheckParams`
	`4`	`+ public class FTSpellCheckParams : IDialectAwareParam`
`5`	`5`	`{`
`6`	`6`	`List<object> args = new List<object>();`
`7`	`7`	`private List<KeyValuePair<string, string>> terms = new List<KeyValuePair<string, string>>();`
`@@ -59,38 +59,29 @@ public List<object> GetArgs()`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`public void SerializeRedisArgs()`
`62`		`- {`
`63`		`- Distance();`
`64`		`- Terms();`
`65`		`- Dialect();`
`66`		`- }`
`67`		`-`
`68`		`- private void Dialect()`
`69`	`62`	`{`
`70`	`63`	`if (dialect != null)`
`71`	`64`	`{`
`72`	`65`	`args.Add(SearchArgs.DIALECT);`
`73`	`66`	`args.Add(dialect);`
`74`	`67`	`}`
`75`		`- }`
`76`		`-`
`77`		`- private void Terms()`
`78`		`- {`
`79`	`68`	`foreach (var term in terms)`
`80`	`69`	`{`
`81`	`70`	`args.Add(SearchArgs.TERMS);`
`82`	`71`	`args.Add(term.Value);`
`83`	`72`	`args.Add(term.Key);`
`84`	`73`	`}`
`85`		`- }`
`86`		`-`
`87`		`- private void Distance()`
`88`		`- {`
`89`	`74`	`if (distance != null)`
`90`	`75`	`{`
`91`	`76`	`args.Add(SearchArgs.DISTANCE);`
`92`	`77`	`args.Add(distance);`
`93`	`78`	`}`
`94`	`79`	`}`
	`80`	`+`
	`81`	`+ int? IDialectAwareParam.Dialect`
	`82`	`+ {`
	`83`	`+ get { return dialect; }`
	`84`	`+ set { dialect = value; }`
	`85`	`+ }`
`95`	`86`	`}`
`96`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace NRedisStack.Search`
`7`	`7`	`/// <summary>`
`8`	`8`	`/// Query represents query parameters and filters to load results from the engine`
`9`	`9`	`/// </summary>`
`10`		`- public sealed class Query`
	`10`	`+ public sealed class Query : IDialectAwareParam`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`	`13`	`/// Filter represents a filtering rules in a query`
`@@ -691,5 +691,12 @@ public Query SetExpander(String field)`
`691`	`691`	`_expander = field;`
`692`	`692`	`return this;`
`693`	`693`	`}`
	`694`	`+`
	`695`	`+ int? IDialectAwareParam.Dialect`
	`696`	`+ {`
	`697`	`+ get { return dialect; }`
	`698`	`+ set { dialect = value; }`
	`699`	`+ }`
	`700`	`+`
`694`	`701`	`}`
`695`	`702`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,21 +6,10 @@ namespace NRedisStack`
`6`	`6`	`{`
`7`	`7`	`public class SearchCommands : SearchCommandsAsync, ISearchCommands`
`8`	`8`	`{`
`9`		`- IDatabase _db;`
`10`		`- public SearchCommands(IDatabase db, int? defaultDialect) : base(db)`
	`9`	`+ private IDatabase _db;`
	`10`	`+ public SearchCommands(IDatabase db, int? defaultDialect = 2) : base(db, defaultDialect)`
`11`	`11`	`{`
`12`	`12`	`_db = db;`
`13`		`- SetDefaultDialect(defaultDialect);`
`14`		`- this.defaultDialect = defaultDialect;`
`15`		`- }`
`16`		`-`
`17`		`- public void SetDefaultDialect(int? defaultDialect)`
`18`		`- {`
`19`		`- if (defaultDialect == 0)`
`20`		`- {`
`21`		`- throw new System.ArgumentOutOfRangeException("DIALECT=0 cannot be set.");`
`22`		`- }`
`23`		`- this.defaultDialect = defaultDialect;`
`24`	`13`	`}`
`25`	`14`
`26`	`15`	`/// <inheritdoc/>`
`@@ -32,11 +21,7 @@ public RedisResult[] _List()`
`32`	`21`	`/// <inheritdoc/>`
`33`	`22`	`public AggregationResult Aggregate(string index, AggregationRequest query)`
`34`	`23`	`{`
`35`		`- if (query.dialect == null && defaultDialect != null)`
`36`		`- {`
`37`		`- query.Dialect((int)defaultDialect);`
`38`		`- }`
`39`		`-`
	`24`	`+ setDefaultDialectIfUnset(query);`
`40`	`25`	`var result = _db.Execute(SearchCommandBuilder.Aggregate(index, query));`
`41`	`26`	`return result.ToAggregationResult(query);`
`42`	`27`	`}`
`@@ -130,20 +115,14 @@ public bool DropIndex(string indexName, bool dd = false)`
`130`	`115`	`/// <inheritdoc/>`
`131`	`116`	`public string Explain(string indexName, string query, int? dialect = null)`
`132`	`117`	`{`
`133`		`- if (dialect == null && defaultDialect != null)`
`134`		`- {`
`135`		`- dialect = defaultDialect;`
`136`		`- }`
	`118`	`+ dialect = checkAndGetDefaultDialect(dialect);`
`137`	`119`	`return _db.Execute(SearchCommandBuilder.Explain(indexName, query, dialect)).ToString()!;`
`138`	`120`	`}`
`139`	`121`
`140`	`122`	`/// <inheritdoc/>`
`141`	`123`	`public RedisResult[] ExplainCli(string indexName, string query, int? dialect = null)`
`142`	`124`	`{`
`143`		`- if (dialect == null && defaultDialect != null)`
`144`		`- {`
`145`		`- dialect = defaultDialect;`
`146`		`- }`
	`125`	`+ dialect = checkAndGetDefaultDialect(dialect);`
`147`	`126`	`return _db.Execute(SearchCommandBuilder.ExplainCli(indexName, query, dialect)).ToArray();`
`148`	`127`	`}`
`149`	`128`
`@@ -160,22 +139,21 @@ public Tuple<SearchResult, Dictionary<string, RedisResult>> ProfileSearch(string`
`160`	`139`	`/// <inheritdoc/>`
`161`	`140`	`public Tuple<AggregationResult, Dictionary<string, RedisResult>> ProfileAggregate(string indexName, AggregationRequest query, bool limited = false)`
`162`	`141`	`{`
	`142`	`+ setDefaultDialectIfUnset(query);`
`163`	`143`	`return _db.Execute(SearchCommandBuilder.ProfileAggregate(indexName, query, limited))`
`164`	`144`	`.ToProfileAggregateResult(query);`
`165`	`145`	`}`
`166`	`146`	`/// <inheritdoc/>`
`167`	`147`	`public SearchResult Search(string indexName, Query q)`
`168`	`148`	`{`
`169`		`- if (q.dialect == null && defaultDialect != null)`
`170`		`- {`
`171`		`- q.Dialect((int)defaultDialect);`
`172`		`- }`
	`149`	`+ setDefaultDialectIfUnset(q);`
`173`	`150`	`return _db.Execute(SearchCommandBuilder.Search(indexName, q)).ToSearchResult(q);`
`174`	`151`	`}`
`175`	`152`
`176`	`153`	`/// <inheritdoc/>`
`177`	`154`	`public Dictionary<string, Dictionary<string, double>> SpellCheck(string indexName, string query, FTSpellCheckParams? spellCheckParams = null)`
`178`	`155`	`{`
	`156`	`+ setDefaultDialectIfUnset(spellCheckParams);`
`179`	`157`	`return _db.Execute(SearchCommandBuilder.SpellCheck(indexName, query, spellCheckParams)).ToFtSpellCheckResult();`
`180`	`158`	`}`
`181`	`159`