Merge pull request #742 from PHOENIXCONTACT/fix/specific-dbcontexts

Fixed usage of specific DbContext implementation

Author: dbeuchler

VERSION

@@ -1 +1 @@
-6.3.1
+6.5.0

src/Moryx.Model/Attributes/ModelConfiguratorAttribute.cs

@@ -0,0 +1,26 @@
+// Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
+// Licensed under the Apache License, Version 2.0
+
+using System;
+
+namespace Moryx.Model.Attributes;
+
+/// <summary>
+/// Registration attribute for data model configurators
+/// </summary>
+[AttributeUsage(AttributeTargets.Class)]
+public class ModelConfiguratorAttribute : Attribute
+{
+    /// <summary>
+    /// Configurator used for the context
+    /// </summary>
+    public Type ConfiguratorType { get; }
+
+    /// <summary>
+    /// Creates a new instance of <see cref="ModelConfiguratorAttribute"/>
+    /// </summary>
+    public ModelConfiguratorAttribute(Type configuratorType)
+    {
+        ConfiguratorType = configuratorType;
+    }
+}

src/Moryx.Model/Configuration/ModelConfiguratorBase.cs

@@ -7,9 +7,9 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore.Infrastructure;
 using Microsoft.Extensions.Logging;
 using Moryx.Configuration;
+using Moryx.Model.Attributes;
 using Moryx.Tools;
 
 namespace Moryx.Model.Configuration
@@ -46,12 +46,16 @@ public void Initialize(Type contextType, IConfigManager configManager, ILogger l
             Logger = logger;
 
             // Load Config
-            _configName = contextType.FullName + ".DbConfig";
+            // TODO: Config name should be the name of the base type of the generic DbContext e.g. FooDbContext instead of SqliteFooDbContext. Rework in future version and use base context-type or config wrapper directly.
+            var modelConfiguratorAttr = contextType.GetCustomAttribute<ModelConfiguratorAttribute>();
+            var contextBaseType = modelConfiguratorAttr != null ? contextType.BaseType : contextType;
+            
+            _configName = contextBaseType!.FullName + ".DbConfig";
             Config = _configManager.GetConfiguration<TConfig>(_configName);
 
             // If database is empty, fill with TargetModel name
             if (string.IsNullOrWhiteSpace(Config.ConnectionSettings.Database))
-                Config.ConnectionSettings.Database = contextType.Name;
+                Config.ConnectionSettings.Database = contextBaseType.Name;
         }
 
         /// <inheritdoc />

src/Moryx.Model/DbContextManager.cs

@@ -24,39 +24,40 @@ public class DbContextManager : IDbContextManager
         private ModelWrapper[] _knownModels;
         private readonly ILoggerFactory _loggerFactory;
         private readonly IConfigManager _configManager;
+        private static readonly Type[] AllDbContextTypes;
+        static DbContextManager()
+        {
+            AllDbContextTypes = ReflectionTool.GetPublicClasses(typeof(DbContext))
+                .Where(type => type != typeof(DbContext) && typeof(DbContext).IsAssignableFrom(type)).ToArray();
+        }
 
         /// <inheritdoc />
         public DbContextManager(IConfigManager configManager, ILoggerFactory loggerFactory)
         {
             _loggerFactory = loggerFactory;
             _configManager = configManager;
 
-            var dbContextTypes = ReflectionTool.GetPublicClasses(
-                typeof(DbContext), 
-                type => type != typeof(DbContext) && !type.GetCustomAttributes<DatabaseSpecificContextAttribute>().Any());
-
-            _knownModels = dbContextTypes
+            var baseDbContextTypes = AllDbContextTypes
+                .Where(type => !type.GetCustomAttributes<DatabaseSpecificContextAttribute>().Any());
+            
+            _knownModels = baseDbContextTypes
                 .Select(dbContextType =>
                 {
                     var config = configManager.GetConfiguration<DatabaseConfig<DatabaseConnectionSettings>>(ConfigFilename(dbContextType));
-
                     var configuratorType = !string.IsNullOrEmpty(config.ConfiguratorTypename)
                         ? Type.GetType(config.ConfiguratorTypename)
                         : DefaultConfigurator();
 
-                    return new
+                    // Try to find specific DbContext for the configurator
+                    // If no specific context found, use the base one
+                    var specificDbContext = GetSpecificDbContext(dbContextType, configuratorType);
+
+                    return new ModelWrapper
                     {
                         DbContextType = dbContextType,
-                        ConfiguratorType = configuratorType,
+                        SpecificDbContext = specificDbContext,
+                        Configurator = (IModelConfigurator)Activator.CreateInstance(configuratorType)
                     };
-                }).Select(t =>
-                {
-                    var wrapper = new ModelWrapper
-                    {
-                        DbContextType = t.DbContextType,
-                        Configurator = (IModelConfigurator)Activator.CreateInstance(t.ConfiguratorType)
-                    };
-                    return wrapper;
                 }).ToArray();
 
             foreach (var wrapper in _knownModels)
@@ -65,6 +66,7 @@ public DbContextManager(IConfigManager configManager, ILoggerFactory loggerFacto
             }
         }
 
+        // TODO: Reference to an assembly which might not be referencesd in certain setups
         private Type DefaultConfigurator()
         {
             var sqliteModelConfigurator = ReflectionTool.GetAssemblies()
@@ -82,15 +84,31 @@ public void UpdateConfig(Type dbContextType, Type configuratorType, IDatabaseCon
 
             var modelWrapper = _knownModels.First(w => w.DbContextType == dbContextType);
             modelWrapper.Configurator = (IModelConfigurator)Activator.CreateInstance(configuratorType);
-
+            modelWrapper.SpecificDbContext = GetSpecificDbContext(dbContextType, configuratorType);
+            
             InitializeConfigurator(modelWrapper);
         }
 
+        private static Type GetSpecificDbContext(Type dbContextType, Type configuratorType)
+        {
+            return AllDbContextTypes.FirstOrDefault(type =>
+            {
+                if (!dbContextType.IsAssignableFrom(type))
+                    return false;
+                
+                var modelConfiguratorAttr = type.GetCustomAttribute<ModelConfiguratorAttribute>();
+                if (modelConfiguratorAttr == null)
+                    return false;
+                
+                return modelConfiguratorAttr.ConfiguratorType == configuratorType;
+            }) ?? dbContextType;
+        }
+
         private void InitializeConfigurator(ModelWrapper modelWrapper)
         {
             var configuratorType = modelWrapper.Configurator.GetType();
             var logger = _loggerFactory.CreateLogger(configuratorType);
-            modelWrapper.Configurator.Initialize(modelWrapper.DbContextType, _configManager, logger);
+            modelWrapper.Configurator.Initialize(modelWrapper.SpecificDbContext, _configManager, logger);
         }
 
         private string ConfigFilename(Type dbContextType)
@@ -132,6 +150,8 @@ private class ModelWrapper
             public Type DbContextType { get; set; }
 
             public IModelConfigurator Configurator { get; set; }
+            
+            public Type SpecificDbContext { get; set; }
         }
     }
 }

src/Moryx.Products.Model/NpgsqlProductsContext.cs

@@ -4,6 +4,8 @@
 using System.IO;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
+using Moryx.Model.Attributes;
+using Moryx.Model.PostgreSQL;
 using Moryx.Model.PostgreSQL.Attributes;
 
 namespace Moryx.Products.Model
@@ -12,6 +14,7 @@ namespace Moryx.Products.Model
     /// Npgsql specific implementation of <see cref="ProductsContext"/>
     /// </summary>
     [NpgsqlDatabaseContext]
+    [ModelConfigurator(typeof(NpgsqlModelConfigurator))]
     public class NpgsqlProductsContext : ProductsContext
     {
         /// <inheritdoc />

src/Moryx.Products.Model/SqliteProductsContext.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0
 
 using Microsoft.EntityFrameworkCore;
+using Moryx.Model.Attributes;
+using Moryx.Model.Sqlite;
 using Moryx.Model.Sqlite.Attributes;
 
 namespace Moryx.Products.Model
@@ -10,6 +12,7 @@ namespace Moryx.Products.Model
     /// Sqlite specific implementation of <see cref="ProductsContext"/>
     /// </summary>
     [SqliteContext]
+    [ModelConfigurator(typeof(SqliteModelConfigurator))]
     public class SqliteProductsContext : ProductsContext
     {
         /// <inheritdoc />

src/Moryx.Resources.Management/Model/NpgsqlResourcesContext.cs

@@ -4,6 +4,8 @@
 using System.IO;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
+using Moryx.Model.Attributes;
+using Moryx.Model.PostgreSQL;
 using Moryx.Model.PostgreSQL.Attributes;
 
 // ReSharper disable once CheckNamespace
@@ -13,6 +15,7 @@ namespace Moryx.Resources.Model
     /// Npgsql specific implementation of <see cref="ResourcesContext"/>
     /// </summary>
     [NpgsqlDatabaseContext]
+    [ModelConfigurator(typeof(NpgsqlModelConfigurator))]
     public class NpgsqlResourcesContext : ResourcesContext
     {
         /// <inheritdoc />

src/Moryx.Resources.Management/Model/SqliteResourcesContext.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0
 
 using Microsoft.EntityFrameworkCore;
+using Moryx.Model.Attributes;
+using Moryx.Model.Sqlite;
 using Moryx.Model.Sqlite.Attributes;
 
 // ReSharper disable once CheckNamespace
@@ -11,6 +13,7 @@ namespace Moryx.Resources.Model
     /// Sqlite specific implementation of <see cref="ResourcesContext"/>
     /// </summary>
     [SqliteContext]
+    [ModelConfigurator(typeof(SqliteModelConfigurator))]
     public class SqliteResourcesContext : ResourcesContext
     {
         /// <inheritdoc />