Lucene index rebuild and reset steps (Lombiq Technologies: OCORE-101)

src/OrchardCore.Modules/OrchardCore.Lucene/Deployment/LuceneIndexRebuildDeploymentStep.cs

@@ -3,7 +3,7 @@
 namespace OrchardCore.Lucene.Deployment
 {
     /// <summary>
-    /// Adds rebuild lucene index task to a <see cref="DeploymentPlanResult"/>.
+    /// Adds rebuild Lucene index task to a <see cref="DeploymentPlanResult"/>.
     /// </summary>
     public class LuceneIndexRebuildDeploymentStep : DeploymentStep
     {

src/OrchardCore.Modules/OrchardCore.Lucene/Deployment/LuceneIndexResetDeploymentStep.cs

@@ -3,7 +3,7 @@
 namespace OrchardCore.Lucene.Deployment
 {
     /// <summary>
-    /// Adds reset lucene index task to a <see cref="DeploymentPlanResult"/>.
+    /// Adds reset Lucene index task to a <see cref="DeploymentPlanResult"/>.
     /// </summary>
     public class LuceneIndexResetDeploymentStep : DeploymentStep
     {

src/OrchardCore.Modules/OrchardCore.Lucene/Recipes/LuceneIndexRebuildStep.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
 using OrchardCore.BackgroundJobs;
 using OrchardCore.Recipes.Models;
 using OrchardCore.Recipes.Services;
@@ -11,29 +12,6 @@ namespace OrchardCore.Lucene.Recipes
     /// </summary>
     public class LuceneIndexRebuildStep : IRecipeStepHandler
     {
-        private readonly LuceneIndexSettingsService _luceneIndexSettingsService;
-        private readonly LuceneIndexingService _luceneIndexingService;
-
-        public LuceneIndexRebuildStep(
-            LuceneIndexSettingsService luceneIndexSettingsService,
-            LuceneIndexingService luceneIndexingService
-            )
-        {
-            _luceneIndexSettingsService = luceneIndexSettingsService;
-            _luceneIndexingService = luceneIndexingService;
-        }
-
-        private async Task RebuildIndexAsync(string indexName)
-        {
-            var luceneIndexSettings = await _luceneIndexSettingsService.GetSettingsAsync(indexName);
-
-            if (luceneIndexSettings != null)
-            {
-                await _luceneIndexingService.RebuildIndexAsync(indexName);
-                await _luceneIndexingService.ProcessContentItemsAsync(indexName);
-            }
-        }
-
         public async Task ExecuteAsync(RecipeExecutionContext context)
         {
             if (!String.Equals(context.Name, "lucene-index-rebuild", StringComparison.OrdinalIgnoreCase))
@@ -44,10 +22,18 @@ public async Task ExecuteAsync(RecipeExecutionContext context)
             var indices = context.Step["Indices"];
             if (indices != null)
             {
-                await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("lucene-index-rebuild", async (shellScope) => {
-                    foreach (var indexName in indices)
+                await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("lucene-index-rebuild", async (scope) => {
+                    var luceneIndexSettingsService = scope.ServiceProvider.GetRequiredService<LuceneIndexSettingsService>();
+                    var luceneIndexingService = scope.ServiceProvider.GetRequiredService<LuceneIndexingService>();
+                    foreach (var indexToken in indices)
                     {
-                        await RebuildIndexAsync(indexName.ToObject<string>());
+                        var indexName = indexToken.ToObject<string>();
+                        var luceneIndexSettings = await luceneIndexSettingsService.GetSettingsAsync(indexName);
+                        if (luceneIndexSettings != null)
+                        {
+                            await luceneIndexingService.RebuildIndexAsync(indexName);
+                            await luceneIndexingService.ProcessContentItemsAsync(indexName);
+                        }
                     }
                 });
             }

src/OrchardCore.Modules/OrchardCore.Lucene/Recipes/LuceneIndexResetStep.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
 using OrchardCore.BackgroundJobs;
 using OrchardCore.Recipes.Models;
 using OrchardCore.Recipes.Services;
@@ -11,41 +12,6 @@ namespace OrchardCore.Lucene.Recipes
     /// </summary>
     public class LuceneIndexResetStep : IRecipeStepHandler
     {
-        private readonly LuceneIndexSettingsService _luceneIndexSettingsService;
-        private readonly LuceneIndexingService _luceneIndexingService;
-        private readonly LuceneIndexManager _luceneIndexManager;
-
-        public LuceneIndexResetStep(
-            LuceneIndexSettingsService luceneIndexSettingsService,
-            LuceneIndexingService luceneIndexingService,
-            LuceneIndexManager luceneIndexManager
-            )
-        {
-            _luceneIndexSettingsService = luceneIndexSettingsService;
-            _luceneIndexManager = luceneIndexManager;
-            _luceneIndexingService = luceneIndexingService;
-        }
-
-        private async Task ResetIndexAsync(string indexName)
-        {
-            var luceneIndexSettings = await _luceneIndexSettingsService.GetSettingsAsync(indexName);
-
-            if (luceneIndexSettings != null)
-            {
-                if (!_luceneIndexManager.Exists(indexName))
-                {
-                    await _luceneIndexingService.CreateIndexAsync(luceneIndexSettings);
-                    await _luceneIndexingService.ProcessContentItemsAsync(indexName);
-                }
-                else
-                {
-                    _luceneIndexingService.ResetIndex(indexName);
-                    await _luceneIndexingService.ProcessContentItemsAsync(indexName);
-                }
-            }
-            await Task.CompletedTask;
-        }
-
         public async Task ExecuteAsync(RecipeExecutionContext context)
         {
             if (!String.Equals(context.Name, "lucene-index-reset", StringComparison.OrdinalIgnoreCase))
@@ -56,10 +22,26 @@ public async Task ExecuteAsync(RecipeExecutionContext context)
             var indices = context.Step["Indices"];
             if (indices != null)
             {
-                await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("lucene-index-reset", async (shellScope) => {
-                    foreach (var indexName in indices)
+                await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("lucene-index-reset", async (scope) => {
+                    var luceneIndexSettingsService = scope.ServiceProvider.GetRequiredService<LuceneIndexSettingsService>();
+                    var luceneIndexingService = scope.ServiceProvider.GetRequiredService<LuceneIndexingService>();
+                    var luceneIndexManager = scope.ServiceProvider.GetRequiredService<LuceneIndexManager>();
+                    foreach (var indexToken in indices)
                     {
-                        await ResetIndexAsync(indexName.ToObject<string>());
+                        var indexName = indexToken.ToObject<string>();
+                        var luceneIndexSettings = await luceneIndexSettingsService.GetSettingsAsync(indexName);
+                        if (luceneIndexSettings != null)
+                        {
+                            if (!luceneIndexManager.Exists(indexName))
+                            {
+                                await luceneIndexingService.CreateIndexAsync(luceneIndexSettings);
+                            }
+                            else
+                            {
+                                luceneIndexingService.ResetIndex(indexName);
+                            }
+                            await luceneIndexingService.ProcessContentItemsAsync(indexName);
+                        }
                     }
                 });
             }

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexRebuildDeploymentStep.Fields.Edit.cshtml

@@ -1,14 +1,14 @@
 @model LuceneIndexRebuildDeploymentStepViewModel
 
-<h5>@T["Rebuild Search Indexes"]</h5>
+<h5>@T["Rebuild Lucene Search Indices"]</h5>
 
 <div class="mb-3 mt-4 mb-5">
     <div class="row">
         <div class="col">
             <div class="form-check">
                 <label class="form-check-label">
                     <input class="form-check-input" asp-for="IncludeAll" data-element-id-to-collapse="indexes-list"/>
-                    @T["Include all Search Indexes."]
+                    @T["Include all Lucene search indices."]
                 </label>
             </div>
         </div>
@@ -18,7 +18,7 @@
 <div id="indexes-list" class="mt-4 mb-5 collapse @(Model.IncludeAll ? "" : "show")">
     <div class="row">
         <div class="col-small">
-            <span class="hint">@T["The Search Indexes to rebuild as part of the plan."]</span>
+            <span class="hint">@T["The Lucene search indices to rebuild as part of the plan."]</span>
         </div>
     </div>
     <div class="row">

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexRebuildDeploymentStep.Fields.Summary.cshtml

@@ -8,7 +8,7 @@
     var indexNames = Model.Value.IndexNames;
 }
 
-<h5>@T["Rebuild Search Indexes"]</h5>
+<h5>@T["Rebuild Lucene Search Indices"]</h5>
 
 @if (includeAll)
 {

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexRebuildDeploymentStep.Fields.Thumbnail.cshtml

@@ -1,4 +1,4 @@
 @model dynamic
 
-<h4 class="card-title">@T["Rebuild Search Indexes"]</h4>
-<p>@T["Rebuild all or specified search indexes."]</p>
+<h4 class="card-title">@T["Rebuild Lucene Search Indices"]</h4>
+<p>@T["Rebuild all or specified Lucene search indices."]</p>

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexResetDeploymentStep.Fields.Edit.cshtml

@@ -1,14 +1,14 @@
 @model LuceneIndexResetDeploymentStepViewModel
 
-<h5>@T["Reset Search Indexes"]</h5>
+<h5>@T["Reset Lucene Search Indices"]</h5>
 
 <div class="mb-3 mt-4 mb-5">
     <div class="row">
         <div class="col">
             <div class="form-check">
                 <label class="form-check-label">
                     <input class="form-check-input" asp-for="IncludeAll" data-element-id-to-collapse="indexes-list" />
-                    @T["Include all Search Indexes."]
+                    @T["Include all Lucene search indices."]
                 </label>
             </div>
         </div>
@@ -18,7 +18,7 @@
 <div id="indexes-list" class="mt-4 mb-5 collapse @(Model.IncludeAll ? "" : "show")">
     <div class="row">
         <div class="col-small">
-            <span class="hint">@T["The Search Indexes to reset as part of the plan."]</span>
+            <span class="hint">@T["The Lucene Search Indices to reset as part of the plan."]</span>
         </div>
     </div>
     <div class="row">

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexResetDeploymentStep.Fields.Summary.cshtml

@@ -8,7 +8,7 @@
     var indexNames = Model.Value.IndexNames;
 }
 
-<h5>@T["Reset Search Indexes"]</h5>
+<h5>@T["Reset Lucene Search Indices"]</h5>
 
 @if (includeAll)
 {

src/OrchardCore.Modules/OrchardCore.Lucene/Views/Items/LuceneIndexResetDeploymentStep.Fields.Thumbnail.cshtml

@@ -1,4 +1,4 @@
 @model dynamic
 
-<h4 class="card-title">@T["Reset Search Indices"]</h4>
-<p>@T["Reset all or specified search indexes."]</p>
+<h4 class="card-title">@T["Reset Lucene Search Indices"]</h4>
+<p>@T["Reset all or specified Lucene search indices."]</p>

src/OrchardCore.Themes/TheBlogTheme/Recipes/blog.lucene.search.recipe.json

@@ -73,6 +73,12 @@
           ]
         }
       ]
+    },
+    {
+      "name": "lucene-index-rebuild",
+      "Indices": [
+        "Search"
+      ]
     }
   ]
 }

src/OrchardCore.Themes/TheBlogTheme/Recipes/blog.recipe.json

@@ -1292,6 +1292,6 @@
           "Quality": 100
         }
       }
-    }    
+    }
   ]
 }

src/docs/reference/modules/Recipes/README.md

@@ -148,9 +148,11 @@ You can also set the default Lucene Settings.
     }
 ```
 
-### Reset Lucene Index Step
+### Reset Lucene Search Index Step
 
 This Reset Lucene Index Step resets a lucene index.
+Restarts the indexing process from the beginning in order to update current content items.
+It doesn't delete existing entries from the index.
 
 ```json
     {
@@ -161,9 +163,10 @@ This Reset Lucene Index Step resets a lucene index.
     }
 ```
 
-### Rebuild Lucene Index Step
+### Rebuild Lucene Search Index Step
 
 This Rebuild Lucene Index Step rebuilds a lucene index.
+Deletes and recreates the full index content.
 
 ```json
     {