Use IAIProfileStore and Make AIProviderConnectionsOptionsConfiguration More Forgiving (#410)

Author: MikeAlhayek

Directory.Packages.props

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
-    <OrchardCoreVersion>[3.0.0-preview-18959, )</OrchardCoreVersion>
+    <OrchardCoreVersion>[3.0.0-preview-18960, )</OrchardCoreVersion>
     <ModelContextProtocolVersion>1.1.0</ModelContextProtocolVersion>
   </PropertyGroup>
   <ItemGroup>

src/Core/CrestApps.OrchardCore.AI.Core/AIProfileStoreExtensions.cs

@@ -5,7 +5,6 @@
 using CrestApps.OrchardCore.AI.Models;
 using CrestApps.OrchardCore.Core.Handlers;
 using CrestApps.OrchardCore.Models;
-using CrestApps.OrchardCore.Services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Localization;
 using OrchardCore.Liquid;
@@ -16,21 +15,21 @@ namespace CrestApps.OrchardCore.AI.Core.Handlers;
 public sealed class AIProfileHandler : CatalogEntryHandlerBase<AIProfile>
 {
     private readonly IHttpContextAccessor _httpContextAccessor;
-    private readonly INamedCatalog<AIProfile> _profilesCatalog;
+    private readonly IAIProfileStore _profileStore;
     private readonly ILiquidTemplateManager _liquidTemplateManager;
     private readonly IClock _clock;
 
     internal readonly IStringLocalizer S;
 
     public AIProfileHandler(
         IHttpContextAccessor httpContextAccessor,
-        INamedCatalog<AIProfile> profilesCatalog,
+        IAIProfileStore profileStore,
         ILiquidTemplateManager liquidTemplateManager,
         IClock clock,
         IStringLocalizer<AIProfileHandler> stringLocalizer)
     {
         _httpContextAccessor = httpContextAccessor;
-        _profilesCatalog = profilesCatalog;
+        _profileStore = profileStore;
         _liquidTemplateManager = liquidTemplateManager;
         _clock = clock;
         S = stringLocalizer;
@@ -50,7 +49,7 @@ public override async Task ValidatingAsync(ValidatingContext<AIProfile> context)
         }
         else
         {
-            var profile = await _profilesCatalog.FindByNameAsync(context.Model.Name);
+            var profile = await _profileStore.FindByNameAsync(context.Model.Name);
 
             if (profile is not null && profile.ItemId != context.Model.ItemId)
             {

src/Core/CrestApps.OrchardCore.AI.Core/CatalogExtensions.cs

@@ -26,9 +26,20 @@ public AIProviderConnectionsOptionsConfiguration(
 
     public void Configure(AIProviderOptions options)
     {
-        var document = _documentManager.GetOrCreateMutableAsync()
-            .GetAwaiter()
-            .GetResult();
+        DictionaryDocument<AIProviderConnection> document;
+
+        try
+        {
+            document = _documentManager.GetOrCreateMutableAsync()
+                .GetAwaiter()
+                .GetResult();
+        }
+        catch (Exception ex)
+        {
+            _logger.LogWarning(ex, "Unable to load AI provider connections from the database. This may occur if the module migrations have not yet been applied or the data is corrupted.");
+
+            return;
+        }
 
         if (document.Records.Count == 0)
         {
@@ -45,65 +56,72 @@ public void Configure(AIProviderOptions options)
 
         foreach (var group in groups)
         {
-            if (!options.Providers.TryGetValue(group.ProviderName, out var provider))
+            try
             {
-                provider = new AIProvider()
+                if (!options.Providers.TryGetValue(group.ProviderName, out var provider))
                 {
-                    Connections = new Dictionary<string, AIProviderConnectionEntry>(),
-                };
-            }
-
-            AIProviderConnection defaultConnection = null;
+                    provider = new AIProvider()
+                    {
+                        Connections = new Dictionary<string, AIProviderConnectionEntry>(),
+                    };
+                }
 
-            foreach (var connection in group.Connections)
-            {
-                var mappingContext = new InitializingAIProviderConnectionContext(connection);
+                AIProviderConnection defaultConnection = null;
 
-                if (defaultConnection is null && connection.IsDefault)
+                foreach (var connection in group.Connections)
                 {
-                    defaultConnection = connection;
-                }
+                    var mappingContext = new InitializingAIProviderConnectionContext(connection);
 
-                if (string.IsNullOrEmpty(connection.ItemId))
-                {
-                    continue;
-                }
+                    if (defaultConnection is null && connection.IsDefault)
+                    {
+                        defaultConnection = connection;
+                    }
+
+                    if (string.IsNullOrEmpty(connection.ItemId))
+                    {
+                        continue;
+                    }
 
 #pragma warning disable CS0618 // Obsolete deployment name fields retained for backward compatibility
-                mappingContext.Values["ChatDeploymentName"] = connection.ChatDeploymentName;
-                mappingContext.Values["EmbeddingDeploymentName"] = connection.EmbeddingDeploymentName;
-                mappingContext.Values["UtilityDeploymentName"] = connection.UtilityDeploymentName;
-                mappingContext.Values["ImagesDeploymentName"] = connection.ImagesDeploymentName;
-                mappingContext.Values["SpeechToTextDeploymentName"] = connection.SpeechToTextDeploymentName;
+                    mappingContext.Values["ChatDeploymentName"] = connection.ChatDeploymentName;
+                    mappingContext.Values["EmbeddingDeploymentName"] = connection.EmbeddingDeploymentName;
+                    mappingContext.Values["UtilityDeploymentName"] = connection.UtilityDeploymentName;
+                    mappingContext.Values["ImagesDeploymentName"] = connection.ImagesDeploymentName;
+                    mappingContext.Values["SpeechToTextDeploymentName"] = connection.SpeechToTextDeploymentName;
 #pragma warning restore CS0618
-                mappingContext.Values["ConnectionNameAlias"] = connection.Name;
+                    mappingContext.Values["ConnectionNameAlias"] = connection.Name;
 
-                _handlers.Invoke((handler, ctx) => handler.Initializing(ctx), mappingContext, _logger);
+                    _handlers.Invoke((handler, ctx) => handler.Initializing(ctx), mappingContext, _logger);
 
-                provider.Connections[connection.ItemId] = new AIProviderConnectionEntry(mappingContext.Values);
-            }
+                    provider.Connections[connection.ItemId] = new AIProviderConnectionEntry(mappingContext.Values);
+                }
 
 #pragma warning disable CS0618 // Obsolete deployment name fields retained for backward compatibility
-            if (defaultConnection is not null)
-            {
-                provider.DefaultConnectionName = defaultConnection.ItemId;
-                provider.DefaultChatDeploymentName = defaultConnection.ChatDeploymentName;
-            }
-            else
-            {
-                if (string.IsNullOrEmpty(provider.DefaultChatDeploymentName))
+                if (defaultConnection is not null)
                 {
-                    provider.DefaultChatDeploymentName = provider.Connections.FirstOrDefault().Value.GetChatDeploymentOrDefaultName();
+                    provider.DefaultConnectionName = defaultConnection.ItemId;
+                    provider.DefaultChatDeploymentName = defaultConnection.ChatDeploymentName;
                 }
+                else
+                {
+                    if (string.IsNullOrEmpty(provider.DefaultChatDeploymentName) && provider.Connections.Count > 0)
+                    {
+                        provider.DefaultChatDeploymentName = provider.Connections.First().Value?.GetChatDeploymentOrDefaultName(false);
+                    }
 #pragma warning restore CS0618
 
-                if (string.IsNullOrEmpty(provider.DefaultConnectionName))
-                {
-                    provider.DefaultConnectionName = provider.Connections.FirstOrDefault().Key;
+                    if (string.IsNullOrEmpty(provider.DefaultConnectionName) && provider.Connections.Count > 0)
+                    {
+                        provider.DefaultConnectionName = provider.Connections.First().Key;
+                    }
                 }
-            }
 
-            options.Providers[group.ProviderName] = provider;
+                options.Providers[group.ProviderName] = provider;
+            }
+            catch (Exception ex)
+            {
+                _logger.LogWarning(ex, "Failed to configure AI provider '{ProviderName}' from stored connections. The provider will be skipped. This may occur if the stored connection data is invalid or uses an outdated format. Please review the provider connection settings.", group.ProviderName);
+            }
         }
     }
 }

src/Core/CrestApps.OrchardCore.AI.Core/Handlers/AIProfileHandler.cs

@@ -257,6 +257,9 @@ This branch also includes several important platform improvements that are worth
 - improved OpenXML Excel data extraction
 - unified `DataSourceMetadata` modeling
 - expanded recipe schema support for AI-assisted recipe authoring
+- **cleaned up `AIPermissionsProvider`** — replaced `INamedCatalog<AIProfile>` with `IAIProfileStore` and removed unnecessary wrapper extension methods (`GetProfilesAsync`, `GetAsync`) in favor of calling `IAIProfileStore.GetByTypeAsync` directly
+- **fixed `AIProviderConnectionsOptionsConfiguration` crash** that could make the entire site unusable when stored provider connection data was invalid, corrupted, or in an outdated v1.x format — the configuration now handles errors per provider and logs warnings instead of throwing unhandled exceptions
+- **replaced all `INamedCatalog<AIProfile>` usages with `IAIProfileStore`** across the codebase for improved type safety and clarity — the `INamedCatalog<AIProfile>` DI registration is retained for backward compatibility
 
 Together, these improvements make the whole ecosystem feel more complete, more polished, and more ready for ambitious Orchard Core solutions.
 

src/Core/CrestApps.OrchardCore.AI.Core/Services/AIProviderConnectionsOptionsConfiguration.cs

@@ -1,9 +1,7 @@
 using CrestApps.OrchardCore.AI.Chat.Models;
 using CrestApps.OrchardCore.AI.Chat.ViewModels;
-using CrestApps.OrchardCore.AI.Core;
 using CrestApps.OrchardCore.AI.Core.Indexes;
 using CrestApps.OrchardCore.AI.Models;
-using CrestApps.OrchardCore.Services;
 using Microsoft.AspNetCore.Mvc.Rendering;
 using OrchardCore.DisplayManagement.Handlers;
 using OrchardCore.DisplayManagement.Views;
@@ -15,20 +13,20 @@ namespace CrestApps.OrchardCore.AI.Chat.Drivers;
 /// </summary>
 public sealed class AIChatAnalyticsProfileFilterDisplayDriver : DisplayDriver<AIChatAnalyticsFilter>
 {
-    private readonly INamedCatalog<AIProfile> _profilesCatalog;
+    private readonly IAIProfileStore _profileStore;
 
     public AIChatAnalyticsProfileFilterDisplayDriver(
-        INamedCatalog<AIProfile> profilesCatalog)
+        IAIProfileStore profileStore)
     {
-        _profilesCatalog = profilesCatalog;
+        _profileStore = profileStore;
     }
 
     public override IDisplayResult Edit(AIChatAnalyticsFilter filter, BuildEditorContext context)
     {
         return Initialize<ChatAnalyticsProfileFilterViewModel>("ChatAnalyticsProfileFilter_Edit", async model =>
         {
             model.ProfileId = filter.ProfileId;
-            model.Profiles = (await _profilesCatalog.GetAsync(AIProfileType.Chat))
+            model.Profiles = (await _profileStore.GetByTypeAsync(AIProfileType.Chat))
                 .Select(p => new SelectListItem(p.DisplayText, p.ItemId));
         }).Location("Content:2");
     }

src/CrestApps.OrchardCore.Documentations/docs/changelog/v2.0.0.md

@@ -1,8 +1,6 @@
 using CrestApps.OrchardCore.AI.Chat.ViewModels;
-using CrestApps.OrchardCore.AI.Core;
 using CrestApps.OrchardCore.AI.Core.Models;
 using CrestApps.OrchardCore.AI.Models;
-using CrestApps.OrchardCore.Services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Rendering;
 using Microsoft.Extensions.Localization;
@@ -18,21 +16,21 @@ namespace CrestApps.OrchardCore.AI.Chat.Drivers;
 public sealed class AIChatProfilePartDisplayDriver : ContentPartDisplayDriver<AIProfilePart>
 {
     private readonly IHttpContextAccessor _httpContextAccessor;
-    private readonly INamedCatalog<AIProfile> _profilesCatalog;
+    private readonly IAIProfileStore _profileStore;
     private readonly IAIChatSessionManager _chatSessionManager;
     private readonly PagerOptions _pagerOptions;
 
     internal readonly IStringLocalizer S;
 
     public AIChatProfilePartDisplayDriver(
         IHttpContextAccessor httpContextAccessor,
-        INamedCatalog<AIProfile> profilesCatalog,
+        IAIProfileStore profileStore,
         IAIChatSessionManager chatSessionManager,
         IOptions<PagerOptions> pagerOptions,
         IStringLocalizer<AIChatProfilePartDisplayDriver> stringLocalizer)
     {
         _httpContextAccessor = httpContextAccessor;
-        _profilesCatalog = profilesCatalog;
+        _profileStore = profileStore;
         _chatSessionManager = chatSessionManager;
         _pagerOptions = pagerOptions.Value;
         S = stringLocalizer;
@@ -53,7 +51,7 @@ public override async Task<IDisplayResult> DisplayAsync(AIProfilePart part, Buil
             return null;
         }
 
-        var profile = await _profilesCatalog.FindByIdAsync(part.ProfileId);
+        var profile = await _profileStore.FindByIdAsync(part.ProfileId);
 
         if (profile == null)
         {
@@ -86,7 +84,7 @@ public override IDisplayResult Edit(AIProfilePart part, BuildPartEditorContext c
 
             model.MaxHistoryAllowed = _pagerOptions.MaxPageSize;
 
-            var profiles = await _profilesCatalog.GetProfilesAsync(AIProfileType.Chat);
+            var profiles = await _profileStore.GetByTypeAsync(AIProfileType.Chat);
 
             model.Profiles = profiles.Select(profile => new SelectListItem(profile.DisplayText, profile.ItemId));
 
@@ -103,7 +101,7 @@ public override async Task<IDisplayResult> UpdateAsync(AIProfilePart part, Updat
         {
             context.Updater.ModelState.AddModelError(Prefix, nameof(model.ProfileId), S["The Profile is required."]);
         }
-        else if (await _profilesCatalog.FindByIdAsync(model.ProfileId) == null)
+        else if (await _profileStore.FindByIdAsync(model.ProfileId) == null)
         {
             context.Updater.ModelState.AddModelError(Prefix, nameof(model.ProfileId), S["The Profile is invalid."]);
         }

src/Modules/CrestApps.OrchardCore.AI.Chat/Drivers/AIChatAnalyticsProfileFilterDisplayDriver.cs

@@ -1,6 +1,5 @@
 using CrestApps.OrchardCore.AI.Core;
 using CrestApps.OrchardCore.AI.Models;
-using CrestApps.OrchardCore.Services;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.Localization;
 using Microsoft.Extensions.Options;
@@ -11,24 +10,24 @@ namespace CrestApps.OrchardCore.AI.Chat.Services;
 
 public sealed class ChatAdminMenu : AdminNavigationProvider
 {
-    private readonly INamedCatalog<AIProfile> _profilesCatalog;
+    private readonly IAIProfileStore _profileStore;
     private readonly AIOptions _aiOptions;
 
     internal readonly IStringLocalizer S;
 
     public ChatAdminMenu(
-        INamedCatalog<AIProfile> profilesCatalog,
+        IAIProfileStore profileStore,
         IOptions<AIOptions> aiOptions,
         IStringLocalizer<ChatAdminMenu> stringLocalizer)
     {
-        _profilesCatalog = profilesCatalog;
+        _profileStore = profileStore;
         _aiOptions = aiOptions.Value;
         S = stringLocalizer;
     }
 
     protected override async ValueTask BuildAsync(NavigationBuilder builder)
     {
-        var profiles = await _profilesCatalog.GetAsync(AIProfileType.Chat);
+        var profiles = await _profileStore.GetByTypeAsync(AIProfileType.Chat);
 
         builder
            .Add(S["Artificial Intelligence"], artificialIntelligence =>

src/Modules/CrestApps.OrchardCore.AI.Chat/Drivers/AIProfilePartDisplayDriver.cs

@@ -4,7 +4,6 @@
 @using CrestApps.OrchardCore.AI.Chat.Hubs
 @using CrestApps.OrchardCore.AI.Models
 @using CrestApps.OrchardCore.AI.Chat.ViewModels
-@using CrestApps.OrchardCore.Services
 @using CrestApps.OrchardCore.SignalR.Core.Services
 @using OrchardCore.DisplayManagement
 @using OrchardCore.DisplayManagement.ModelBinding
@@ -20,7 +19,7 @@
 
 @inject IUpdateModelAccessor UpdateModelAccessor
 @inject IDisplayManager<AIChatSessionPrompt> DisplayManager
-@inject INamedCatalog<AIProfile> ProfilesCatalog
+@inject IAIProfileStore ProfilesCatalog
 @inject HubRouteManager HubRouteManager
 @inject IAIChatSessionPromptStore PromptStore
 @{
@@ -32,7 +31,7 @@
     var chatContainerHtmlId = $"{baseId}_ChatContainer";
     var documentBarHtmlId = $"{baseId}_DocumentBar";
 
-    var promptGeneratedProfiles = await ProfilesCatalog.GetAsync(AIProfileType.TemplatePrompt);
+    var promptGeneratedProfiles = await ProfilesCatalog.GetByTypeAsync(AIProfileType.TemplatePrompt);
 
     var shellFeaturesManager = ShellScope.Services.GetRequiredService<IShellFeaturesManager>();
     var enabledFeatures = await shellFeaturesManager.GetEnabledFeaturesAsync();