Simplify the Azure Search AI events and centralize setting the FullIn…

…dexName (#17596)
OrchardCMS · Mar 10, 2025 · 2b129dd · 2b129dd
1 parent d711ff5
commit 2b129dd
Show file tree

Hide file tree

Showing 24 changed files with 218 additions and 172 deletions.
diff --git a/src/OrchardCore.Modules/OrchardCore.Search.AzureAI/Controllers/AdminController.cs b/src/OrchardCore.Modules/OrchardCore.Search.AzureAI/Controllers/AdminController.cs
@@ -250,25 +250,22 @@ public async Task<IActionResult> CreatePost(string source)
         {
             try
             {
-                await _indexSettingsService.SetMappingsAsync(settings);
+                await _indexSettingsService.CreateAsync(settings);
 
                 if (await _indexManager.CreateAsync(settings))
                 {
-                    await _indexSettingsService.UpdateAsync(settings);
                     await _indexSettingsService.SynchronizeAsync(settings);
                     await _notifier.SuccessAsync(H["Index <em>{0}</em> created successfully.", settings.IndexName]);
 
                     return RedirectToAction(nameof(Index));
                 }
-                else
-                {
-                    await _notifier.ErrorAsync(H["An error occurred while creating the index."]);
-                }
+
+                await _notifier.ErrorAsync(H["An error occurred while creating the index."]);
             }
             catch (Exception e)
             {
                 await _notifier.ErrorAsync(H["An error occurred while creating the index."]);
-                _logger.LogError(e, "An error occurred while creating an index {IndexName}.", _indexManager.GetFullIndexName(settings.IndexName));
+                _logger.LogError(e, "An error occurred while creating an index {IndexName}.", settings.IndexFullName);
             }
         }
 
@@ -328,8 +325,6 @@ public async Task<IActionResult> EditPost(string id)
         {
             try
             {
-                await _indexSettingsService.SetMappingsAsync(settings);
-
                 if (!await _indexManager.CreateAsync(settings))
                 {
                     await _notifier.ErrorAsync(H["An error occurred while updating the index."]);
@@ -348,7 +343,7 @@ public async Task<IActionResult> EditPost(string id)
             {
                 await _notifier.ErrorAsync(H["An error occurred while updating the index."]);
 
-                _logger.LogError(e, "An error occurred while updating an index {IndexName}.", _indexManager.GetFullIndexName(settings.IndexName));
+                _logger.LogError(e, "An error occurred while updating an index {IndexName}.", settings.IndexFullName);
             }
         }
 
@@ -420,7 +415,6 @@ public async Task<IActionResult> Rebuild(string id)
             return NotFound();
         }
 
-        await _indexSettingsService.SetMappingsAsync(settings);
         await _indexSettingsService.ResetAsync(settings);
         await _indexSettingsService.UpdateAsync(settings);
         await _indexManager.RebuildAsync(settings);
@@ -458,7 +452,6 @@ public async Task<IActionResult> Reset(string id)
             return RedirectToAction(nameof(Index));
         }
 
-        await _indexSettingsService.SetMappingsAsync(settings);
         await _indexSettingsService.ResetAsync(settings);
         await _indexSettingsService.UpdateAsync(settings);
         await _indexSettingsService.SynchronizeAsync(settings);

diff --git a/...ore.Modules/OrchardCore.Search.AzureAI/Drivers/AzureAISearchIndexSettingsDisplayDriver.cs b/...ore.Modules/OrchardCore.Search.AzureAI/Drivers/AzureAISearchIndexSettingsDisplayDriver.cs
@@ -68,7 +68,6 @@ public override async Task<IDisplayResult> UpdateAsync(AzureAISearchIndexSetting
             }
 
             settings.IndexName = model.IndexName;
-            settings.IndexFullName = _indexManager.GetFullIndexName(model.IndexName);
         }
 
         settings.AnalyzerName = model.AnalyzerName;

diff --git a/src/OrchardCore.Modules/OrchardCore.Search.AzureAI/Startup.cs b/src/OrchardCore.Modules/OrchardCore.Search.AzureAI/Startup.cs
@@ -7,12 +7,14 @@
 using OrchardCore.DisplayManagement.Handlers;
 using OrchardCore.Modules;
 using OrchardCore.Navigation;
+using OrchardCore.Recipes;
 using OrchardCore.Search.Abstractions;
 using OrchardCore.Search.AzureAI.Deployment;
 using OrchardCore.Search.AzureAI.Drivers;
 using OrchardCore.Search.AzureAI.Handlers;
 using OrchardCore.Search.AzureAI.Migrations;
 using OrchardCore.Search.AzureAI.Models;
+using OrchardCore.Search.AzureAI.Recipes;
 using OrchardCore.Search.AzureAI.Services;
 
 namespace OrchardCore.Search.AzureAI;
@@ -32,6 +34,17 @@ public override void ConfigureServices(IServiceCollection services)
     }
 }
 
+[RequireFeatures("OrchardCore.Recipes.Core")]
+public sealed class RecipeStartup : StartupBase
+{
+    public override void ConfigureServices(IServiceCollection services)
+    {
+        services.AddRecipeExecutionStep<AzureAISearchIndexRebuildStep>();
+        services.AddRecipeExecutionStep<AzureAISearchIndexResetStep>();
+        services.AddRecipeExecutionStep<AzureAISearchIndexSettingsStep>();
+    }
+}
+
 [RequireFeatures("OrchardCore.Search")]
 public sealed class SearchStartup : StartupBase
 {

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Extensions/ServiceCollectionExtensions.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Extensions/ServiceCollectionExtensions.cs
@@ -2,10 +2,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using OrchardCore.ContentManagement.Handlers;
-using OrchardCore.Recipes;
 using OrchardCore.Search.AzureAI.Handlers;
 using OrchardCore.Search.AzureAI.Models;
-using OrchardCore.Search.AzureAI.Recipes;
 using OrchardCore.Search.AzureAI.Services;
 using OrchardCore.Security.Permissions;
 
@@ -25,10 +23,7 @@ public static IServiceCollection AddAzureAISearchServices(this IServiceCollectio
         services.AddScoped<IAzureAISearchFieldIndexEvents, DefaultAzureAISearchFieldIndexEvents>();
         services.AddScoped<AzureAISearchIndexSettingsService>();
         services.AddSingleton<AzureAIClientFactory>();
-
-        services.AddRecipeExecutionStep<AzureAISearchIndexRebuildStep>();
-        services.AddRecipeExecutionStep<AzureAISearchIndexResetStep>();
-        services.AddRecipeExecutionStep<AzureAISearchIndexSettingsStep>();
+        services.AddSingleton<AzureAISearchIndexNameService>();
 
         return services;
     }

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Handlers/AzureAISearchIndexHandler.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Handlers/AzureAISearchIndexHandler.cs
@@ -8,13 +8,25 @@ namespace OrchardCore.Search.AzureAI.Handlers;
 
 public sealed class AzureAISearchIndexHandler : AzureAISearchIndexSettingsHandlerBase
 {
+    private readonly AzureAISearchIndexNameService _searchIndexNameService;
+
     private readonly IStringLocalizer S;
 
-    public AzureAISearchIndexHandler(IStringLocalizer<AzureAISearchIndexHandler> stringLocalizer)
+    public AzureAISearchIndexHandler(
+        AzureAISearchIndexNameService searchIndexNameService,
+        IStringLocalizer<AzureAISearchIndexHandler> stringLocalizer)
     {
+        _searchIndexNameService = searchIndexNameService;
         S = stringLocalizer;
     }
 
+    public override Task CreatingAsync(AzureAISearchIndexSettingsCreateContext context)
+    {
+        context.Settings.IndexFullName = _searchIndexNameService.GetFullIndexName(context.Settings.IndexName);
+
+        return Task.CompletedTask;
+    }
+
     public override Task InitializingAsync(AzureAISearchIndexSettingsInitializingContext context)
         => PopulateAsync(context.Settings, context.Data);
 

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Handlers/ContentAzureAISearchIndexHandler.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Handlers/ContentAzureAISearchIndexHandler.cs
@@ -38,12 +38,18 @@ public ContentAzureAISearchIndexHandler(
         S = stringLocalizer;
     }
 
+    public override Task CreatingAsync(AzureAISearchIndexSettingsCreateContext context)
+        => SetMappingAsync(context.Settings);
+
+    public override Task UpdatingAsync(AzureAISearchIndexSettingsUpdateContext context)
+        => SetMappingAsync(context.Settings);
+
     public override Task InitializingAsync(AzureAISearchIndexSettingsInitializingContext context)
         => PopulateAsync(context.Settings, context.Data);
 
     private static Task PopulateAsync(AzureAISearchIndexSettings settings, JsonNode data)
     {
-        if (!string.Equals(AzureAISearchConstants.ContentsIndexSource, settings.Source, StringComparison.OrdinalIgnoreCase))
+        if (!CanHandle(settings))
         {
             return Task.CompletedTask;
         }
@@ -90,7 +96,7 @@ private static Task PopulateAsync(AzureAISearchIndexSettings settings, JsonNode
 
     public override Task ValidatingAsync(AzureAISearchIndexSettingsValidatingContext context)
     {
-        if (!string.Equals(AzureAISearchConstants.ContentsIndexSource, context.Settings.Source, StringComparison.OrdinalIgnoreCase))
+        if (!CanHandle(context.Settings))
         {
             return Task.CompletedTask;
         }
@@ -119,7 +125,7 @@ public override Task ResetAsync(AzureAISearchIndexSettingsResetContext context)
 
     public override Task SynchronizedAsync(AzureAISearchIndexSettingsSynchronizedContext context)
     {
-        if (!string.Equals(AzureAISearchConstants.ContentsIndexSource, context.Settings.Source, StringComparison.OrdinalIgnoreCase))
+        if (!CanHandle(context.Settings))
         {
             return Task.CompletedTask;
         }
@@ -133,7 +139,7 @@ public override Task SynchronizedAsync(AzureAISearchIndexSettingsSynchronizedCon
 
     public override Task ExportingAsync(AzureAISearchIndexSettingsExportingContext context)
     {
-        if (!string.Equals(AzureAISearchConstants.ContentsIndexSource, context.Settings.Source, StringComparison.OrdinalIgnoreCase))
+        if (!CanHandle(context.Settings))
         {
             return Task.CompletedTask;
         }
@@ -155,13 +161,14 @@ public override Task ExportingAsync(AzureAISearchIndexSettingsExportingContext c
         return Task.CompletedTask;
     }
 
-    public override async Task MappingAsync(AzureAISearchMappingContext context)
+    private async Task SetMappingAsync(AzureAISearchIndexSettings settings)
     {
-        if (!string.Equals(AzureAISearchConstants.ContentsIndexSource, context.Settings.Source, StringComparison.OrdinalIgnoreCase))
+        if (!CanHandle(settings))
         {
             return;
         }
-        var metadata = context.Settings.As<ContentIndexMetadata>();
+
+        var metadata = settings.As<ContentIndexMetadata>();
 
         foreach (var contentType in metadata.IndexedContentTypes ?? [])
         {
@@ -170,8 +177,8 @@ public override async Task MappingAsync(AzureAISearchMappingContext context)
             var buildIndexContext = new BuildIndexContext(index, contentItem, [contentType], new AzureAISearchContentIndexSettings());
             await _contentItemIndexHandlers.InvokeAsync(x => x.BuildIndexAsync(buildIndexContext), _logger);
 
-            await AddIndexMappingAsync(context.Settings.IndexMappings, IndexingConstants.ContentItemIdKey, new DocumentIndexEntry(IndexingConstants.ContentItemIdKey, contentItem.ContentItemId, Types.Text, DocumentIndexOptions.Keyword), context.Settings);
-            await AddIndexMappingAsync(context.Settings.IndexMappings, IndexingConstants.ContentItemVersionIdKey, new DocumentIndexEntry(IndexingConstants.ContentItemVersionIdKey, contentItem.ContentItemId, Types.Text, DocumentIndexOptions.Keyword), context.Settings);
+            await AddIndexMappingAsync(settings.IndexMappings, IndexingConstants.ContentItemIdKey, new DocumentIndexEntry(IndexingConstants.ContentItemIdKey, contentItem.ContentItemId, Types.Text, DocumentIndexOptions.Keyword), settings);
+            await AddIndexMappingAsync(settings.IndexMappings, IndexingConstants.ContentItemVersionIdKey, new DocumentIndexEntry(IndexingConstants.ContentItemVersionIdKey, contentItem.ContentItemId, Types.Text, DocumentIndexOptions.Keyword), settings);
 
             foreach (var entry in index.Entries)
             {
@@ -180,11 +187,16 @@ public override async Task MappingAsync(AzureAISearchMappingContext context)
                     continue;
                 }
 
-                await AddIndexMappingAsync(context.Settings.IndexMappings, safeFieldName, entry, context.Settings);
+                await AddIndexMappingAsync(settings.IndexMappings, safeFieldName, entry, settings);
             }
         }
     }
 
+    private static bool CanHandle(AzureAISearchIndexSettings settings)
+    {
+        return string.Equals(AzureAISearchConstants.ContentsIndexSource, settings.Source, StringComparison.OrdinalIgnoreCase);
+    }
+
     private async Task AddIndexMappingAsync(IList<AzureAISearchIndexMap> indexMappings, string safeFieldName, DocumentIndexEntry entry, AzureAISearchIndexSettings settings)
     {
         var indexMap = new AzureAISearchIndexMap(safeFieldName, entry.Type, entry.Options)

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/IAzureAISearchIndexSettingsHandler.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/IAzureAISearchIndexSettingsHandler.cs
@@ -6,11 +6,15 @@ public interface IAzureAISearchIndexSettingsHandler
 {
     Task InitializingAsync(AzureAISearchIndexSettingsInitializingContext context);
 
-    Task UpdatedAsync(AzureAISearchIndexSettingsUpdatedContext context);
+    Task CreatingAsync(AzureAISearchIndexSettingsCreateContext context);
 
-    Task ValidatingAsync(AzureAISearchIndexSettingsValidatingContext context);
+    Task CreatedAsync(AzureAISearchIndexSettingsCreateContext context);
+
+    Task UpdatingAsync(AzureAISearchIndexSettingsUpdateContext context);
 
-    Task MappingAsync(AzureAISearchMappingContext context);
+    Task UpdatedAsync(AzureAISearchIndexSettingsUpdateContext context);
+
+    Task ValidatingAsync(AzureAISearchIndexSettingsValidatingContext context);
 
     Task ResetAsync(AzureAISearchIndexSettingsResetContext context);
 

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexCreateContext.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexCreateContext.cs
@@ -4,13 +4,10 @@ public class AzureAISearchIndexCreateContext
 {
     public AzureAISearchIndexSettings Settings { get; }
 
-    public string IndexFullName { get; }
-
-    public AzureAISearchIndexCreateContext(AzureAISearchIndexSettings settings, string indexFullName)
+    public AzureAISearchIndexCreateContext(AzureAISearchIndexSettings settings)
     {
         ArgumentNullException.ThrowIfNull(settings);
 
         Settings = settings;
-        IndexFullName = indexFullName;
     }
 }
diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexRebuildContext.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexRebuildContext.cs
@@ -4,13 +4,10 @@ public class AzureAISearchIndexRebuildContext
 {
     public AzureAISearchIndexSettings Settings { get; }
 
-    public string IndexFullName { get; }
-
-    public AzureAISearchIndexRebuildContext(AzureAISearchIndexSettings settings, string indexFullName)
+    public AzureAISearchIndexRebuildContext(AzureAISearchIndexSettings settings)
     {
         ArgumentNullException.ThrowIfNull(settings);
 
         Settings = settings;
-        IndexFullName = indexFullName;
     }
 }
diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettings.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettings.cs
@@ -16,7 +16,7 @@ public class AzureAISearchIndexSettings : Entity
 
     public string QueryAnalyzerName { get; set; }
 
-    public IList<AzureAISearchIndexMap> IndexMappings { get; set; }
+    public IList<AzureAISearchIndexMap> IndexMappings { get; init; } = [];
 
     private long _lastTaskId;
 

diff --git a/...ardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsCreateContext.cs b/...ardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsCreateContext.cs
@@ -0,0 +1,13 @@
+namespace OrchardCore.Search.AzureAI.Models;
+
+public class AzureAISearchIndexSettingsCreateContext
+{
+    public AzureAISearchIndexSettings Settings { get; }
+
+    public AzureAISearchIndexSettingsCreateContext(AzureAISearchIndexSettings settings)
+    {
+        ArgumentNullException.ThrowIfNull(settings);
+
+        Settings = settings;
+    }
+}
diff --git a/...ardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsUpdateContext.cs b/...ardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsUpdateContext.cs
@@ -0,0 +1,13 @@
+namespace OrchardCore.Search.AzureAI.Models;
+
+public class AzureAISearchIndexSettingsUpdateContext
+{
+    public AzureAISearchIndexSettings Settings { get; }
+
+    public AzureAISearchIndexSettingsUpdateContext(AzureAISearchIndexSettings settings)
+    {
+        ArgumentNullException.ThrowIfNull(settings);
+
+        Settings = settings;
+    }
+}
diff --git a/...rdCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsUpdatedContext.cs b/...rdCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchIndexSettingsUpdatedContext.cs
diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchMappingContext.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Models/AzureAISearchMappingContext.cs
diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Recipes/AzureAISearchIndexRebuildStep.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Recipes/AzureAISearchIndexRebuildStep.cs
@@ -41,7 +41,6 @@ await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync(AzureAISearchIndexRebuildD
 
             foreach (var settings in indexSettings)
             {
-                await indexSettingsService.SetMappingsAsync(settings);
                 await indexSettingsService.ResetAsync(settings);
                 await indexSettingsService.UpdateAsync(settings);
                 await indexManager.RebuildAsync(settings);

diff --git a/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Recipes/AzureAISearchIndexResetStep.cs b/src/OrchardCore/OrchardCore.Search.AzureAI.Core/Recipes/AzureAISearchIndexResetStep.cs
@@ -41,13 +41,10 @@ await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync(AzureAISearchIndexRebuildD
 
             foreach (var settings in indexSettings)
             {
-                await indexSettingsService.SetMappingsAsync(settings);
                 await indexSettingsService.ResetAsync(settings);
                 await indexSettingsService.UpdateAsync(settings);
                 if (!await indexManager.ExistsAsync(settings.IndexName))
                 {
-                    settings.IndexFullName = indexManager.GetFullIndexName(settings.IndexName);
-
                     await indexManager.CreateAsync(settings);
                 }
-Original file line number
+Diff line change
@@ Expand Up @@
                 }
                 settings.IndexName = model.IndexName;
-                settings.IndexFullName = _indexManager.GetFullIndexName(model.IndexName);
             }
             settings.AnalyzerName = model.AnalyzerName;
@@ Expand Down @@