RavenDB-22369: Introducing the SupportedFeatures.All option and makin…

…g SupportedFeatures mandatory to pass into IndexWriter.
ravendb · May 17, 2024 · dbfad58 · dbfad58
1 parent 558ba9e
commit dbfad58
Show file tree

Hide file tree

Showing 29 changed files with 97 additions and 102 deletions.
diff --git a/bench/Voron.Benchmark/Corax/AndOrBenchmark.cs b/bench/Voron.Benchmark/Corax/AndOrBenchmark.cs
@@ -114,7 +114,7 @@ private static void GenerateData(StorageEnvironment env)
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             IndexFieldsMapping fields = CreateFieldsMapping(bsc);
 
-            using (var writer = new IndexWriter(env, fields))
+            using (var writer = new IndexWriter(env, fields, SupportedFeatures.All))
             {
                 {
                     using var builder = writer.Index("Arava");

diff --git a/bench/Voron.Benchmark/Corax/InBenchmark.cs b/bench/Voron.Benchmark/Corax/InBenchmark.cs
@@ -115,7 +115,7 @@ private static void GenerateData(StorageEnvironment env)
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             IndexFieldsMapping fields = CreateFieldsMapping(bsc);
 
-            using (var writer = new IndexWriter(env, fields))
+            using (var writer = new IndexWriter(env, fields, SupportedFeatures.All))
             {
                 {
                     using var builder = writer.Index("Arava");

diff --git a/bench/Voron.Benchmark/Corax/OrderByBenchmark.cs b/bench/Voron.Benchmark/Corax/OrderByBenchmark.cs
@@ -121,7 +121,7 @@ private static void GenerateData(StorageEnvironment env)
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             IndexFieldsMapping fields = CreateFieldsMapping(bsc);
 
-            using (var writer = new IndexWriter(env, fields))
+            using (var writer = new IndexWriter(env, fields, SupportedFeatures.All))
             {
                 {
                     using var builder = writer.Index("items/1"u8);

diff --git a/bench/Voron.Benchmark/Corax/StartWithBenchmark.cs b/bench/Voron.Benchmark/Corax/StartWithBenchmark.cs
@@ -114,7 +114,7 @@ private static void GenerateData(StorageEnvironment env)
         {
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             IndexFieldsMapping fields = CreateFieldsMapping(bsc);
-            using (var writer = new IndexWriter(env, fields))
+            using (var writer = new IndexWriter(env, fields, SupportedFeatures.All))
             {
                 {
                     using var entryWriter = writer.Index("Arava");

diff --git a/src/Corax/Indexing/IndexWriter.cs b/src/Corax/Indexing/IndexWriter.cs
@@ -87,7 +87,7 @@ private IndexWriter(IndexFieldsMapping fieldsMapping, SupportedFeatures supporte
             _indexDebugDumper = new IndexOperationsDumper(fieldsMapping);
             _builder = new IndexEntryBuilder(this);
             _fieldsMapping = fieldsMapping;
-            _supportedFeatures = supportedFeatures ?? new(); // if not explicitly set - all features are available
+            _supportedFeatures = supportedFeatures; // if not explicitly set - all features are available
             _encodingBufferHandler = Analyzer.BufferPool.Rent(fieldsMapping.MaximumOutputSize);
             _tokensBufferHandler = Analyzer.TokensPool.Rent(fieldsMapping.MaximumTokenSize);
             _utf8ConverterBufferHandler = Analyzer.BufferPool.Rent(fieldsMapping.MaximumOutputSize * 10);
@@ -104,7 +104,7 @@ private IndexWriter(IndexFieldsMapping fieldsMapping, SupportedFeatures supporte
             _removalsForTerm = new List<long>();
         }
 
-        public IndexWriter([NotNull] StorageEnvironment environment, IndexFieldsMapping fieldsMapping, in SupportedFeatures supportedFeatures = default) : this(fieldsMapping, supportedFeatures)
+        public IndexWriter([NotNull] StorageEnvironment environment, IndexFieldsMapping fieldsMapping, SupportedFeatures supportedFeatures) : this(fieldsMapping, supportedFeatures)
         {
             TransactionPersistentContext transactionPersistentContext = new(true);
             _transaction = environment.WriteTransaction(transactionPersistentContext);
@@ -113,7 +113,7 @@ public IndexWriter([NotNull] StorageEnvironment environment, IndexFieldsMapping
             Init();
         }
 
-        public IndexWriter([NotNull] Transaction tx, IndexFieldsMapping fieldsMapping, in SupportedFeatures supportedFeatures = default) : this(fieldsMapping, supportedFeatures)
+        public IndexWriter([NotNull] Transaction tx, IndexFieldsMapping fieldsMapping, SupportedFeatures supportedFeatures) : this(fieldsMapping, supportedFeatures)
         {
             _transaction = tx;
 

diff --git a/src/Corax/SupportedFeatures.cs b/src/Corax/SupportedFeatures.cs
@@ -1,18 +1,9 @@
 namespace Corax;
 
-public class SupportedFeatures
+public class SupportedFeatures(bool isPhraseQuerySupported, bool isStoreOnlySupported)
 {
-    public readonly bool PhraseQuery = true;
-    public readonly bool StoreOnly = true;
-
-    public SupportedFeatures(bool isPhraseQuerySupported, bool isStoreOnlySupported)
-    {
-        PhraseQuery = isPhraseQuerySupported;
-        StoreOnly = isStoreOnlySupported;
-    }
+    public static readonly SupportedFeatures All = new (true, true);
 
-    public SupportedFeatures()
-    {
-        // all is supported
-    }
+    public readonly bool PhraseQuery = isPhraseQuerySupported;
+    public readonly bool StoreOnly = isStoreOnlySupported;
 }
diff --git a/test/FastTests/Corax/BoostingQuery.cs b/test/FastTests/Corax/BoostingQuery.cs
@@ -319,7 +319,7 @@ public unsafe void CanAddAndRemoveDocumentBoost()
 
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             using var knownFields = CreateKnownFields(bsc);
-            using (var indexWriter = new IndexWriter(Env, knownFields))
+            using (var indexWriter = new IndexWriter(Env, knownFields, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/1");
                 indexWriter.Commit();
@@ -387,7 +387,7 @@ private void IndexEntries()
             using var bsc = new ByteStringContext(SharedMultipleUseFlag.None);
             using var knownFields = CreateKnownFields(bsc);
 
-            using var indexWriter = new IndexWriter(Env, knownFields);
+            using var indexWriter = new IndexWriter(Env, knownFields, SupportedFeatures.All);
 
             foreach (var entry in longList)
             {

diff --git a/test/FastTests/Corax/Bugs/FacetIndexingRepro.cs b/test/FastTests/Corax/Bugs/FacetIndexingRepro.cs
@@ -36,7 +36,7 @@ public void CanHandleRecompressionOfEntryTerms()
         var fieldsTree = wtx.CreateTree(Constants.IndexWriter.FieldsSlice);
         CompactTree idTree = fieldsTree.CompactTreeFor(id);
 
-        using var iw = new IndexWriter(wtx, fields);
+        using var iw = new IndexWriter(wtx, fields, SupportedFeatures.All);
         string entryKey = "users/00000001";
         long entryId;
         using (var builder = iw.Index("entryKey"))
@@ -125,7 +125,7 @@ public unsafe void ShouldNotCorrupt()
         var wtx = Env.WriteTransaction();
         try
         {
-            var iw = new IndexWriter(wtx, fields);
+            var iw = new IndexWriter(wtx, fields, SupportedFeatures.All);
             while (true)
             {
                 string id;
@@ -178,7 +178,7 @@ void FlushIndexAndRenewWriteTransaction()
                 txns++;
                 items = 0;
                 wtx = Env.WriteTransaction();
-                iw = new IndexWriter(wtx, fields);
+                iw = new IndexWriter(wtx, fields, SupportedFeatures.All);
             }
         }
         finally
@@ -228,7 +228,7 @@ public unsafe void CanSuccessfullyIndexData()
         IndexFieldsMapping indexFieldsMapping = builder.Build();
         using (var wtx = Env.WriteTransaction())
         {
-            var iw = new IndexWriter(wtx, indexFieldsMapping);
+            var iw = new IndexWriter(wtx, indexFieldsMapping, SupportedFeatures.All);
             while (true)
             {
                 string id;
@@ -248,7 +248,7 @@ public unsafe void CanSuccessfullyIndexData()
                 {
                     iw.Commit();
                     iw.Dispose();
-                    iw = new IndexWriter(wtx, indexFieldsMapping);
+                    iw = new IndexWriter(wtx, indexFieldsMapping, SupportedFeatures.All);
                     continue;
                 }
 

diff --git a/test/FastTests/Corax/Bugs/IndexEntryReaderBigDoc.cs b/test/FastTests/Corax/Bugs/IndexEntryReaderBigDoc.cs
@@ -32,7 +32,7 @@ public unsafe void CanCreateAndReadBigDocument()
 
 
         long entryId;
-        using (var indexWriter = new IndexWriter(Env, knownFields))
+        using (var indexWriter = new IndexWriter(Env, knownFields, SupportedFeatures.All))
         {
             var options = new[] { "one", "two", "three" };
             using (var writer = indexWriter.Index("users/1"))

diff --git a/test/FastTests/Corax/Bugs/OptimizedUpdatesOnIndexes.cs b/test/FastTests/Corax/Bugs/OptimizedUpdatesOnIndexes.cs
@@ -22,7 +22,7 @@ public void CanUpdateAndNotDelete()
     {
         using var fields = CreateKnownFields(Allocator);
         long oldId; 
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var entry = indexWriter.Update("cars/1"u8))
             {
@@ -45,7 +45,7 @@ public void CanUpdateAndNotDelete()
         }
 
         long newId;
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var entry = indexWriter.Update("cars/1"u8))
             {

diff --git a/test/FastTests/Corax/Bugs/RavenDB-19283.cs b/test/FastTests/Corax/Bugs/RavenDB-19283.cs
@@ -36,7 +36,7 @@ public unsafe void CanReadAndWriteLargeEntries()
         using var knownFields = builder.Build();
 
         long entryId;
-        using (var indexWriter = new IndexWriter(Env, knownFields))
+        using (var indexWriter = new IndexWriter(Env, knownFields, SupportedFeatures.All))
         {
             var options = new[] { "one", "two", "three" };
             using (var writer = indexWriter.Index("users/1"))

diff --git a/test/FastTests/Corax/Bugs/RavenDB-22285.cs b/test/FastTests/Corax/Bugs/RavenDB-22285.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Corax;
 using Corax.Analyzers;
 using Corax.Indexing;
 using Corax.Mappings;
@@ -29,7 +30,7 @@ public void MultiTermMatchReturnsGoodResults()
         using var mapping = CreateKnownFields(allocator);
         var descendingSortedTerm = Enumerable.Range(0, 26).Select(i => new[] { (byte)('z' - i) }).ToList();
         var database = new List<Dto>();
-        using (var indexWriter = new IndexWriter(Env, mapping))
+        using (var indexWriter = new IndexWriter(Env, mapping, SupportedFeatures.All))
         {
             for (var idX = 0; idX < 2096; ++idX)
             {

diff --git a/test/FastTests/Corax/CoraxCrud.cs b/test/FastTests/Corax/CoraxCrud.cs
@@ -27,7 +27,7 @@ public void CanIndexUsingBuilder()
     {
         var fields = CreateKnownFields(Allocator);
         Span<long> ids = stackalloc long[1024];
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Index("users/1"u8))
             {
@@ -51,7 +51,7 @@ public void CanDetectWhenFieldHasMultipleTerms()
     {
         var fields = CreateKnownFields(Allocator);
         Span<long> ids = stackalloc long[1024];
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Index("users/1"u8))
             {
@@ -80,7 +80,7 @@ public void CanUpdateWithDifferentFrequency()
     {
         var fields = CreateKnownFields(Allocator);
         Span<long> ids = stackalloc long[1024];
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Index("users/1"u8))
             {
@@ -90,7 +90,7 @@ public void CanUpdateWithDifferentFrequency()
             indexWriter.Commit();
         }
 
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Update("users/1"u8))
             {
@@ -125,7 +125,7 @@ public void CanUpdateUsingBuilder()
     {
         var fields = CreateKnownFields(Allocator);
         Span<long> ids = stackalloc long[1024];
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Index("users/1"u8))
             {
@@ -135,7 +135,7 @@ public void CanUpdateUsingBuilder()
             indexWriter.Commit();
         }
 
-        using (var indexWriter = new IndexWriter(Env, fields))
+        using (var indexWriter = new IndexWriter(Env, fields, SupportedFeatures.All))
         {
             using (var builder = indexWriter.Update("users/1"u8))
             {

diff --git a/test/FastTests/Corax/CoraxQueries.cs b/test/FastTests/Corax/CoraxQueries.cs
@@ -3,6 +3,7 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Text;
+using Corax;
 using Corax.Mappings;
 using Corax.Querying.Matches;
 using Corax.Querying.Matches.Meta;
@@ -334,7 +335,7 @@ private void IndexEntries()
             _knownFields.TryGetByFieldId(TextualValueId, out binding);
             _textualItemFieldMetadata = binding.Metadata;
 
-            using var indexWriter = new IndexWriter(Env, _knownFields);
+            using var indexWriter = new IndexWriter(Env, _knownFields, SupportedFeatures.All);
 
             foreach (var entry in _entries)
             {

diff --git a/test/FastTests/Corax/DeleteTest.cs b/test/FastTests/Corax/DeleteTest.cs
@@ -42,7 +42,7 @@ public void CanDelete()
                 Assert.Equal(_longList.Count, match.Fill(ids));
             }
 
-            using (var indexWriter = new IndexWriter(Env, _analyzers))
+            using (var indexWriter = new IndexWriter(Env, _analyzers, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/0");
                 indexWriter.Commit();
@@ -81,7 +81,7 @@ public void CanDeleteNumericalData()
                 Assert.Equal(_longList.Count, match.Fill(ids));
             }
 
-            using (var indexWriter = new IndexWriter(Env, _analyzers))
+            using (var indexWriter = new IndexWriter(Env, _analyzers, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/0");
                 indexWriter.Commit();
@@ -116,7 +116,7 @@ public void CanDeleteSingleItemInList(int batchSize)
                 Assert.Equal(batchSize, indexSearcher.NumberOfEntries);
             }
 
-            using (var indexWriter = new IndexWriter(Env, _analyzers))
+            using (var indexWriter = new IndexWriter(Env, _analyzers, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/0");
                 indexWriter.Commit();
@@ -144,7 +144,7 @@ public void CanDeleteOneElement()
                 Assert.Equal(count, match.Fill(ids));
             }
 
-            using (var indexWriter = new IndexWriter(Env, _analyzers))
+            using (var indexWriter = new IndexWriter(Env, _analyzers, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/9");
                 indexWriter.Commit();
@@ -180,7 +180,7 @@ public void CanDeleteAndPushUnderSameId()
                 var match = indexSearcher.TermQuery("Content", "0");
                 Assert.Equal(1, match.Fill(ids));
             }
-            using (var indexWriter = new IndexWriter(Env, _analyzers))
+            using (var indexWriter = new IndexWriter(Env, _analyzers, SupportedFeatures.All))
             {
                 indexWriter.TryDeleteEntry("list/0");
                 indexWriter.Commit();
@@ -229,7 +229,7 @@ private enum DataType
 
         private void IndexEntries(IndexFieldsMapping knownFields)
         {
-            using var indexWriter = new IndexWriter(Env, knownFields);
+            using var indexWriter = new IndexWriter(Env, knownFields, SupportedFeatures.All);
 
             foreach (var entry in _longList)
             {