Log warning and skip discovery for compiled models built for a different provider (#37840)

Fixes #35517

Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

Author: Copilot

src/EFCore.Design/Design/Internal/DbContextOperations.cs

@@ -259,6 +259,7 @@ private IReadOnlyList<string> ScaffoldCompiledModel(
         outputDir = Path.GetFullPath(Path.Combine(_projectDir, outputDir));
 
         var scaffolder = services.GetRequiredService<ICompiledModelScaffolder>();
+        var databaseProvider = context.GetService<IDatabaseProvider>();
 
         var finalModelNamespace = modelNamespace ?? GetNamespaceFromOutputPath(outputDir) ?? "";
 
@@ -273,6 +274,7 @@ private IReadOnlyList<string> ScaffoldCompiledModel(
                 UseNullableReferenceTypes = _nullable,
                 Suffix = suffix,
                 ForNativeAot = nativeAot,
+                ProviderName = databaseProvider.Name,
                 GeneratedFileNames = generatedFileNames
             });
 

src/EFCore.Design/Scaffolding/CompiledModelCodeGenerationOptions.cs

@@ -44,6 +44,12 @@ public class CompiledModelCodeGenerationOptions
     /// <value> A value indicating whether the generated code should be compatible with NativeAOT. </value>
     public virtual bool ForNativeAot { get; set; }
 
+    /// <summary>
+    ///     Gets or sets the database provider name to embed in the compiled model.
+    /// </summary>
+    /// <value> The database provider name. </value>
+    public virtual string? ProviderName { get; set; }
+
     /// <summary>
     ///     Gets or sets the set of file names generated so far.
     /// </summary>

src/EFCore.Design/Scaffolding/Internal/CSharpRuntimeModelCodeGenerator.cs

@@ -66,7 +66,7 @@ public virtual IReadOnlyCollection<ScaffoldedFile> GenerateModel(
         var nullable = false;
         var scaffoldedFiles = new List<ScaffoldedFile>();
 
-        var assemblyAttributesCode = CreateAssemblyAttributes(options.ModelNamespace, options.ContextType, nullable);
+        var assemblyAttributesCode = CreateAssemblyAttributes(options.ModelNamespace, options.ContextType, options.ProviderName, nullable);
         var assemblyInfoFileName = UniquifyFileName(options.ContextType.ShortDisplayName() + AssemblyAttributesSuffix, options);
         scaffoldedFiles.Add(new ScaffoldedFile(assemblyInfoFileName, assemblyAttributesCode));
 
@@ -174,6 +174,7 @@ private static string GenerateHeader(SortedSet<string> namespaces, string curren
     private string CreateAssemblyAttributes(
         string @namespace,
         Type contextType,
+        string? providerName,
         bool nullable)
     {
         var mainBuilder = new IndentedStringBuilder();
@@ -183,7 +184,15 @@ private string CreateAssemblyAttributes(
 
         mainBuilder
             .Append("[assembly: DbContextModel(typeof(").Append(_code.Reference(contextType))
-            .Append("), typeof(").Append(GetModelClassName(contextType)).AppendLine("))]");
+            .Append("), typeof(").Append(GetModelClassName(contextType)).Append(")");
+
+        if (providerName != null)
+        {
+            mainBuilder
+                .Append(", ProviderName = ").Append(_code.Literal(providerName));
+        }
+
+        mainBuilder.AppendLine(")]");
 
         return GenerateHeader(namespaces, currentNamespace: "", nullable) + mainBuilder;
     }

src/EFCore/Diagnostics/CoreEventId.cs

@@ -90,6 +90,7 @@ private enum Id
         ServiceProviderDebugInfo,
         RedundantAddServicesCallWarning,
         OldModelVersionWarning,
+        CompiledModelProviderMismatchWarning,
 
         // Model and ModelValidation events
         ShadowPropertyCreated = CoreBaseId + 600,
@@ -491,6 +492,19 @@ private static EventId MakeInfraId(Id id)
     /// </remarks>
     public static readonly EventId OldModelVersionWarning = MakeInfraId(Id.OldModelVersionWarning);
 
+    /// <summary>
+    ///     A compiled model was found but was built for a different database provider.
+    /// </summary>
+    /// <remarks>
+    ///     <para>
+    ///         This event is in the <see cref="DbLoggerCategory.Infrastructure" /> category.
+    ///     </para>
+    ///     <para>
+    ///         This event uses the <see cref="ProviderMismatchEventData" /> payload when used with a <see cref="DiagnosticSource" />.
+    ///     </para>
+    /// </remarks>
+    public static readonly EventId CompiledModelProviderMismatchWarning = MakeInfraId(Id.CompiledModelProviderMismatchWarning);
+
     private static readonly string _modelPrefix = DbLoggerCategory.Model.Name + ".";
 
     private static EventId MakeModelId(Id id)

src/EFCore/Diagnostics/CoreLoggerExtensions.cs

@@ -230,6 +230,46 @@ private static string OldModelVersion(EventDefinitionBase definition, EventData
             ProductInfo.GetVersion());
     }
 
+    /// <summary>
+    ///     Logs for the <see cref="CoreEventId.CompiledModelProviderMismatchWarning" /> event.
+    /// </summary>
+    /// <param name="diagnostics">The diagnostics logger to use.</param>
+    /// <param name="compiledProviderName">The provider name stored in the compiled model.</param>
+    /// <param name="currentProviderName">The provider name currently configured.</param>
+    public static void CompiledModelProviderMismatchWarning(
+        this IDiagnosticsLogger<DbLoggerCategory.Infrastructure> diagnostics,
+        string compiledProviderName,
+        string currentProviderName)
+    {
+        var definition = CoreResources.LogCompiledModelProviderMismatch(diagnostics);
+
+        if (diagnostics.ShouldLog(definition))
+        {
+            definition.Log(
+                diagnostics,
+                compiledProviderName,
+                currentProviderName);
+        }
+
+        if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
+        {
+            var eventData = new ProviderMismatchEventData(
+                definition,
+                CompiledModelProviderMismatch,
+                compiledProviderName,
+                currentProviderName);
+
+            diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);
+        }
+    }
+
+    private static string CompiledModelProviderMismatch(EventDefinitionBase definition, EventData payload)
+    {
+        var d = (EventDefinition<string, string>)definition;
+        var p = (ProviderMismatchEventData)payload;
+        return d.GenerateMessage(p.CompiledProviderName, p.CurrentProviderName);
+    }
+
     /// <summary>
     ///     Logs for the <see cref="CoreEventId.OptimisticConcurrencyException" /> event.
     /// </summary>

src/EFCore/Diagnostics/LoggingDefinitions.cs

@@ -106,6 +106,15 @@ public abstract class LoggingDefinitions
     [EntityFrameworkInternal]
     public EventDefinitionBase? LogOldModelVersion;
 
+    /// <summary>
+    ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+    ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
+    ///     any release. You should only use it directly in your code with extreme caution and knowing that
+    ///     doing so can result in application failures when updating to a new Entity Framework Core release.
+    /// </summary>
+    [EntityFrameworkInternal]
+    public EventDefinitionBase? LogCompiledModelProviderMismatch;
+
     /// <summary>
     ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
     ///     the same compatibility standards as public APIs. It may be changed or removed without notice in

src/EFCore/Diagnostics/ProviderMismatchEventData.cs

@@ -0,0 +1,41 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.EntityFrameworkCore.Diagnostics;
+
+    /// <summary>
+    ///     A <see cref="DiagnosticSource" /> event payload class for provider mismatch warnings.
+    /// </summary>
+    /// <remarks>
+    ///     See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information and examples.
+    /// </remarks>
+    public class ProviderMismatchEventData : EventData
+    {
+        /// <summary>
+        ///     Constructs the event payload.
+        /// </summary>
+        /// <param name="eventDefinition">The event definition.</param>
+        /// <param name="messageGenerator">A delegate that generates a log message for this event.</param>
+        /// <param name="compiledProviderName">The provider name stored with the model.</param>
+        /// <param name="currentProviderName">The provider name currently configured.</param>
+        public ProviderMismatchEventData(
+            EventDefinitionBase eventDefinition,
+            Func<EventDefinitionBase, EventData, string> messageGenerator,
+            string compiledProviderName,
+            string currentProviderName)
+            : base(eventDefinition, messageGenerator)
+        {
+            CompiledProviderName = compiledProviderName;
+            CurrentProviderName = currentProviderName;
+        }
+
+        /// <summary>
+        ///     The provider name stored with the model.
+        /// </summary>
+        public virtual string CompiledProviderName { get; }
+
+        /// <summary>
+        ///     The provider name currently configured.
+        /// </summary>
+        public virtual string CurrentProviderName { get; }
+}

src/EFCore/Infrastructure/DbContextModelAttribute.cs

@@ -41,4 +41,9 @@ public DbContextModelAttribute(
     ///     Gets the compiled model.
     /// </summary>
     public Type ModelType { get; }
+
+    /// <summary>
+    ///     Gets the database provider name used to build the compiled model.
+    /// </summary>
+    public string? ProviderName { get; set; }
 }

src/EFCore/Internal/DbContextServices.cs

@@ -67,7 +67,22 @@ private IModel CreateModel(bool designTime)
             _inOnModelCreating = true;
 
             var dependencies = _scopedProvider!.GetRequiredService<ModelCreationDependencies>();
-            var modelFromOptions = CoreOptions?.Model ?? FindCompiledModel(_currentContext!.Context.GetType());
+
+            string? mismatchedProviderName = null;
+            var modelFromOptions = CoreOptions?.Model;
+            if (modelFromOptions == null)
+            {
+                var providers = _scopedProvider!.GetService<IEnumerable<IDatabaseProvider>>()?.ToList();
+                var providerName = providers is [var provider] ? provider.Name : null;
+
+                modelFromOptions = FindCompiledModel(_currentContext!.Context.GetType(), providerName, out mismatchedProviderName);
+
+                if (mismatchedProviderName != null)
+                {
+                    var logger = _scopedProvider!.GetRequiredService<IDiagnosticsLogger<DbLoggerCategory.Infrastructure>>();
+                    logger.CompiledModelProviderMismatchWarning(mismatchedProviderName, providerName!);
+                }
+            }
 
             var modelVersion = modelFromOptions?.GetProductVersion();
             if (modelVersion != null)
@@ -105,17 +120,27 @@ private IModel CreateModel(bool designTime)
             _inOnModelCreating = false;
         }
 
-        static IModel? FindCompiledModel(Type contextType)
+        static IModel? FindCompiledModel(Type contextType, string? providerName, out string? mismatchedProviderName)
         {
+            mismatchedProviderName = null;
             var contextAssembly = contextType.Assembly;
             IModel? model = null;
+            string? firstMismatchedProvider = null;
             foreach (var modelAttribute in contextAssembly.GetCustomAttributes<DbContextModelAttribute>())
             {
                 if (modelAttribute.ContextType != contextType)
                 {
                     continue;
                 }
 
+                if (modelAttribute.ProviderName != null
+                    && providerName != null
+                    && modelAttribute.ProviderName != providerName)
+                {
+                    firstMismatchedProvider ??= modelAttribute.ProviderName;
+                    continue;
+                }
+
                 var modelType = modelAttribute.ModelType;
 
                 var instanceProperty = modelType.GetProperty("Instance", BindingFlags.Public | BindingFlags.Static);
@@ -135,6 +160,11 @@ private IModel CreateModel(bool designTime)
                 model = (IModel)instanceProperty.GetValue(null)!;
             }
 
+            if (model == null)
+            {
+                mismatchedProviderName = firstMismatchedProvider;
+            }
+
             return model;
         }
     }