V4/feature/merge v360

.github/workflows/build.yml

@@ -7,13 +7,15 @@ on:
       - 'master'
       - 'dev'
       - 'release/*'
+      - 'hotfix/*'
     tags: 
       - 'v*'
   pull_request:
     branches:
       - 'master'
       - 'dev'
       - 'release/*'
+      - 'hotfix/*'
 
 jobs:
   build:
@@ -40,10 +42,9 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: | 
-          5.0.x
+        dotnet-version: |
           6.0.x
-          7.0.x
+          8.0.x
 
     - name: Install GitVersion
       uses: gittools/actions/gitversion/[email protected]
@@ -60,10 +61,10 @@ jobs:
       run: dotnet build ${{ env.Solution_File }} --configuration ${{ env.Configuration }} --no-restore
 
     - name: Test
-      run: dotnet test "${{ env.Test_Proj }}" --no-build --verbosity normal --results-directory ${{ github.workspace }}/_TestResults  --logger "trx;logfilename=tests.trx"
+      run: dotnet test "${{ env.Test_Proj }}" --no-build --verbosity normal --results-directory ${{ github.workspace }}/_TestResults  --logger "trx;logfilename=tests.trx" --filter "TestCategory!~Benchmarks"
 
     - name: Upload test results
-      uses: actions/upload-artifact@v2  # upload test results
+      uses: actions/upload-artifact@v4  # upload test results
       if: success() || failure()        # run this step even if previous step failed
       with:
         name: examine-test-results
@@ -85,7 +86,7 @@ jobs:
           --output=${{ github.workspace }}/_NugetOutput
 
     - name: Upload artifacts
-      uses: actions/upload-artifact@v2  # upload nuget
+      uses: actions/upload-artifact@v4  # upload nuget
       if: success()
       with:
         name: examine-nuget-${{ env.GitVersion_SemVer }}

.github/workflows/docfx-gh-pages.yml

@@ -4,6 +4,9 @@ on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["feature/docfx"]
+  pull_request:
+    branches:
+      - 'feature/docfx'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

.github/workflows/test-report.yml

@@ -8,7 +8,7 @@ jobs:
   report:
     runs-on: ubuntu-latest
     steps:
-    - uses: dorny/test-reporter@v1.4.2
+    - uses: dorny/test-reporter@v1
       with:
         artifact: examine-test-results    # artifact name
         name: Publish Tests               # Name of the check run which will be created

docs/articles/indexing.md

@@ -115,9 +115,10 @@ myIndex.IndexItem(new ValueSet(
 Be default all indexing is done asynchronously. If you need to run indexing synchronously you should create a synchronous scope. This is for instance a necessary step for unit tests.
 
 ```cs
-using (myIndex.ProcessNonAsync())
+using (var luceneIndex = (LuceneIndex)myIndex)
+using (var syncIndexContext = luceneIndex.WithThreadingMode(IndexThreadingMode.Synchronous))
 {
-    myIndex.IndexItem(new ValueSet(
+    luceneIndex.IndexItem(new ValueSet(
         "SKU987",
         "Product",             
         new Dictionary<string, object>()
@@ -251,4 +252,4 @@ private void IndexCommited(object sender, EventArgs e)
 {
     // Triggered when the index is commited
 }
-```
+```

docs/articles/searching.md

@@ -132,7 +132,7 @@ query.Field("nodeTypeAlias", "CWS_Home".Boost(20));
 var results = query.Execute();
 ```
 
-This will boost the term `CWS_Home` and make enteries with `nodeTypeAlias:CWS_Home` score higher in the results.
+This will boost the term `CWS_Home` and make entries with `nodeTypeAlias:CWS_Home` score higher in the results.
 
 ## Proximity
 

docs/docs-v1-v2/searching.md

@@ -124,7 +124,7 @@ query.Field("nodeTypeAlias", "CWS_Home".Boost(20));
 var results = query.Execute();
 ```
 
-This will boost the term `CWS_Home` and make enteries with `nodeTypeAlias:CWS_Home` score higher in the results.
+This will boost the term `CWS_Home` and make entries with `nodeTypeAlias:CWS_Home` score higher in the results.
 
 ## Proximity
 
@@ -248,4 +248,4 @@ var query = searcher.CreateQuery();
 var query = (LuceneSearchQuery)query.NativeQuery("hello:world").And(); // Make query ready for extending
 query.LuceneQuery(NumericRangeQuery.NewInt64Range("numTest", 4, 5, true, true)); // Add the raw lucene query
 var results = query.Execute();
-```
+```

src/Directory.Build.props

@@ -8,9 +8,12 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
   </ItemGroup>
   <PropertyGroup>
+
+    <SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
+
     <PackageProjectUrl>https://github.com/Shazwazza/Examine</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Shazwazza/Examine</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
@@ -22,7 +25,8 @@
     <VersionPrefix>2.0.0</VersionPrefix>
   </PropertyGroup>
   <PropertyGroup Condition="'$(MSBuildProjectName)' != 'Examine.Web.Demo' AND '$(MSBuildProjectName)' != 'Examine.Test'">
-    <TargetFrameworks>net6.0;netstandard2.1;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net8.0;</TargetFrameworks>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
   <!-- Disable the nullable warnings when compiling for .NET Standard 2.0 -->

src/Examine.Benchmarks/ConcurrentAcquireBenchmarks.cs

@@ -0,0 +1,147 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+using Lucene.Net.Analysis;
+using Lucene.Net.Analysis.Standard;
+using Lucene.Net.Index;
+using Lucene.Net.Search;
+using Lucene.Net.Store;
+using Lucene.Net.Util;
+using Microsoft.Extensions.Logging;
+
+namespace Examine.Benchmarks
+{
+    [MediumRunJob(RuntimeMoniker.Net80)]
+    [ThreadingDiagnoser]
+    [MemoryDiagnoser]
+    public class ConcurrentAcquireBenchmarks : ExamineBaseTest
+    {
+        private readonly StandardAnalyzer _analyzer = new StandardAnalyzer(LuceneInfo.CurrentVersion);
+        private string? _tempBasePath;
+        private FSDirectory? _indexDir;
+        private IndexWriter? _writer;
+        private SearcherManager? _searcherManager;
+
+        [GlobalSetup]
+        public override void Setup()
+        {
+            base.Setup();
+
+            _tempBasePath = Path.Combine(Path.GetTempPath(), "ExamineTests");
+
+            // indexer for lucene
+            var tempIndexer = InitializeAndIndexItems(_tempBasePath, _analyzer, out var indexDir);
+            tempIndexer.Dispose();
+            _indexDir = FSDirectory.Open(indexDir);
+            var writerConfig = new IndexWriterConfig(LuceneVersion.LUCENE_48, _analyzer);
+            //writerConfig.SetMaxBufferedDocs(1000);
+            //writerConfig.SetReaderTermsIndexDivisor(4);
+            //writerConfig.SetOpenMode(OpenMode.APPEND);
+            //writerConfig.SetReaderPooling(true);
+            //writerConfig.SetCodec(new Lucene46Codec());
+            _writer = new IndexWriter(_indexDir, writerConfig);
+            var trackingWriter = new TrackingIndexWriter(_writer);
+            _searcherManager = new SearcherManager(trackingWriter.IndexWriter, applyAllDeletes: true, new SearcherFactory());
+        }
+
+        [GlobalCleanup]
+        public override void TearDown()
+        {
+            _searcherManager.Dispose();
+            _writer.Dispose();
+            _indexDir.Dispose();
+
+            base.TearDown();
+
+            System.IO.Directory.Delete(_tempBasePath, true);
+        }
+
+        [Params(1, 15, 30, 100)]
+        public int ThreadCount { get; set; }
+
+        [Benchmark(Baseline = true)]
+        public async Task SimpleMultiThreadLoop()
+        {
+            var tasks = new List<Task>();
+
+            for (var i = 0; i < ThreadCount; i++)
+            {
+                tasks.Add(new Task(() =>
+                {
+                    var i = 0;
+                }));
+            }
+
+            foreach (var task in tasks)
+            {
+                task.Start();
+            }
+
+            await Task.WhenAll(tasks);
+        }
+
+        [Benchmark]
+        public async Task TestAcquireThreadContention()
+        {
+            var tasks = new List<Task>();
+
+            for (var i = 0; i < ThreadCount; i++)
+            {
+                tasks.Add(new Task(() =>
+                {
+                    var searcher = _searcherManager.Acquire();
+                    try
+                    {
+                        if (searcher.IndexReader.RefCount > (ThreadCount + 1))
+                        {
+                            Console.WriteLine(searcher.IndexReader.RefCount);
+                        }
+                    }
+                    finally
+                    {
+                        _searcherManager.Release(searcher);
+                    }
+                }));
+            }
+
+            foreach (var task in tasks)
+            {
+                task.Start();
+            }
+
+            await Task.WhenAll(tasks);
+        }
+
+#if RELEASE
+        protected override ILoggerFactory CreateLoggerFactory()
+            => Microsoft.Extensions.Logging.LoggerFactory.Create(builder => builder.AddConsole().SetMinimumLevel(LogLevel.Information));
+#endif
+        private TestIndex InitializeAndIndexItems(
+            string tempBasePath,
+            Analyzer analyzer,
+            out DirectoryInfo indexDir)
+        {
+            var tempPath = Path.Combine(tempBasePath, Guid.NewGuid().ToString());
+            System.IO.Directory.CreateDirectory(tempPath);
+            indexDir = new DirectoryInfo(tempPath);
+            var luceneDirectory = FSDirectory.Open(indexDir);
+            var indexer = GetTestIndex(luceneDirectory, analyzer);
+
+            var random = new Random();
+            var valueSets = new List<ValueSet>();
+
+            for (var i = 0; i < 1000; i++)
+            {
+                valueSets.Add(ValueSet.FromObject(Guid.NewGuid().ToString(), "content",
+                    new
+                    {
+                        nodeName = "location " + i,
+                        bodyText = Enumerable.Range(0, random.Next(10, 100)).Select(x => Guid.NewGuid().ToString())
+                    }));
+            }
+
+            indexer.IndexItems(valueSets);
+
+            return indexer;
+        }
+    }
+}