Throw a better exception when the model is read-only.

Fixes #15812

src/EFCore/Infrastructure/Annotatable.cs

@@ -33,6 +33,26 @@ public class Annotatable : IMutableAnnotatable
         public virtual IEnumerable<Annotation> GetAnnotations()
             => _annotations?.Values ?? Enumerable.Empty<Annotation>();
 
+        /// <summary>
+        ///     <para>Indicates whether the current object is read-only.</para>
+        ///     <para>
+        ///         Annotations cannot be changed when the object is read-only.
+        ///         Runtime annotations cannot be changed when the object is not read-only.
+        ///     </para>
+        /// </summary>
+        protected virtual bool IsReadonly => false;
+
+        /// <summary>
+        ///     Throws if the model is not read-only.
+        /// </summary>
+        protected virtual void EnsureReadonly(bool shouldBeReadonly = true)
+        {
+            if (!shouldBeReadonly && IsReadonly)
+            {
+                throw new InvalidOperationException(CoreStrings.ModelReadOnly);
+            }
+        }
+
         /// <summary>
         ///     Adds an annotation to this object. Throws if an annotation with the specified name already exists.
         /// </summary>
@@ -97,6 +117,8 @@ public virtual void SetAnnotation(string name, object? value)
             [NotNull] Annotation annotation,
             [CanBeNull] Annotation? oldAnnotation)
         {
+            EnsureReadonly(false);
+
             if (_annotations == null)
             {
                 _annotations = new SortedDictionary<string, Annotation>();
@@ -146,6 +168,7 @@ public virtual void SetAnnotation(string name, object? value)
         public virtual Annotation? RemoveAnnotation([NotNull] string name)
         {
             Check.NotNull(name, nameof(name));
+            EnsureReadonly(false);
 
             var annotation = FindAnnotation(name);
             if (annotation == null)

src/EFCore/Metadata/Builders/CollectionNavigationBuilder.cs

@@ -302,7 +302,7 @@ protected virtual IMutableSkipNavigation WithLeftManyNavigation([NotNull] string
                     foreignKey, DeclaringEntityType, RelatedEntityType, navigationMember.Name, inverseName);
             }
 
-            using (foreignKey.DeclaringEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (foreignKey.DeclaringEntityType.Model.DelayConventions())
             {
                 foreignKey.DeclaringEntityType.Builder.HasNoRelationship(foreignKey, ConfigurationSource.Explicit);
                 Builder = null;
@@ -348,7 +348,7 @@ private IMutableSkipNavigation WithRightManyNavigation(MemberIdentity navigation
                     foreignKey, DeclaringEntityType, RelatedEntityType, inverseName, navigationName);
             }
 
-            using (((EntityType)RelatedEntityType).Model.ConventionDispatcher.DelayConventions())
+            using (((EntityType)RelatedEntityType).Model.DelayConventions())
             {
                 if (conflictingNavigation != null)
                 {

src/EFCore/Metadata/Builders/EntityTypeBuilder.cs

@@ -486,7 +486,7 @@ public virtual IndexBuilder HasIndex([NotNull] params string[] propertyNames)
         private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string navigationName)
         {
             IMutableForeignKey foreignKey;
-            using (var batch = Builder.Metadata.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = Builder.Metadata.Model.DelayConventions())
             {
                 var navigationMember = new MemberIdentity(navigationName);
                 var relationship = Builder.HasOwnership(ownedType, navigationMember, ConfigurationSource.Explicit);
@@ -700,7 +700,7 @@ private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string
         private OwnedNavigationBuilder OwnsManyBuilder(in TypeIdentity ownedType, string navigationName)
         {
             IMutableForeignKey foreignKey;
-            using (var batch = Builder.Metadata.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = Builder.Metadata.Model.DelayConventions())
             {
                 var navigationMember = new MemberIdentity(navigationName);
                 var relationship = Builder.HasOwnership(ownedType, navigationMember, ConfigurationSource.Explicit);

src/EFCore/Metadata/Builders/EntityTypeBuilder`.cs

@@ -697,7 +697,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             where TRelatedEntity : class
         {
             InternalForeignKeyBuilder relationship;
-            using (var batch = Builder.Metadata.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = Builder.Metadata.Model.DelayConventions())
             {
                 relationship = Builder.HasOwnership(ownedType, navigation, ConfigurationSource.Explicit);
                 relationship.IsUnique(true, ConfigurationSource.Explicit);
@@ -1081,7 +1081,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             where TRelatedEntity : class
         {
             InternalForeignKeyBuilder relationship;
-            using (var batch = Builder.Metadata.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = Builder.Metadata.Model.DelayConventions())
             {
                 relationship = Builder.HasOwnership(ownedType, navigation, ConfigurationSource.Explicit);
 

src/EFCore/Metadata/Builders/OwnedNavigationBuilder.cs

@@ -77,7 +77,7 @@ protected virtual InternalForeignKeyBuilder Builder
         protected virtual T UpdateBuilder<T>([NotNull] Func<T> configure)
         {
             IConventionForeignKey foreignKey = _builder.Metadata;
-            var result = DependentEntityType.Model.ConventionDispatcher.Run(configure, ref foreignKey);
+            var result = DependentEntityType.Model.Track(configure, ref foreignKey);
             if (foreignKey != null)
             {
                 _builder = ((ForeignKey)foreignKey).Builder;
@@ -429,7 +429,7 @@ public virtual IndexBuilder HasIndex([NotNull] params string[] propertyNames)
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsOneBuilder(new TypeIdentity(ownedTypeName), navigationName));
                 return this;
@@ -472,7 +472,7 @@ public virtual IndexBuilder HasIndex([NotNull] params string[] propertyNames)
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsOneBuilder(new TypeIdentity(ownedTypeName, ownedType), navigationName));
                 return this;
@@ -512,7 +512,7 @@ public virtual IndexBuilder HasIndex([NotNull] params string[] propertyNames)
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsOneBuilder(new TypeIdentity(ownedType, (Model)OwnedEntityType.Model), navigationName));
                 return this;
@@ -522,7 +522,7 @@ public virtual IndexBuilder HasIndex([NotNull] params string[] propertyNames)
         private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string navigationName)
         {
             IMutableForeignKey foreignKey;
-            using (var batch = DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = DependentEntityType.Model.DelayConventions())
             {
                 var navigationMember = MemberIdentity.Create(navigationName);
                 var relationship = DependentEntityType.Builder.HasOwnership(ownedType, navigationMember, ConfigurationSource.Explicit);
@@ -654,7 +654,7 @@ private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsManyBuilder(new TypeIdentity(ownedTypeName), navigationName));
                 return this;
@@ -696,7 +696,7 @@ private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsManyBuilder(new TypeIdentity(ownedTypeName, ownedType), navigationName));
                 return this;
@@ -735,7 +735,7 @@ private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(OwnsManyBuilder(new TypeIdentity(ownedType, DependentEntityType.Model), navigationName));
                 return this;
@@ -745,7 +745,7 @@ private OwnedNavigationBuilder OwnsOneBuilder(in TypeIdentity ownedType, string
         private OwnedNavigationBuilder OwnsManyBuilder(in TypeIdentity ownedType, string navigationName)
         {
             IMutableForeignKey foreignKey;
-            using (var batch = DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = DependentEntityType.Model.DelayConventions())
             {
                 var navigationMember = MemberIdentity.Create(navigationName);
                 var relationship = DependentEntityType.Builder.HasOwnership(ownedType, navigationMember, ConfigurationSource.Explicit);

src/EFCore/Metadata/Builders/OwnedNavigationBuilder`.cs

@@ -636,7 +636,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             where TNewDependentEntity : class
         {
             InternalForeignKeyBuilder relationship;
-            using (var batch = DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = DependentEntityType.Model.DelayConventions())
             {
                 relationship = DependentEntityType.Builder.HasOwnership(ownedType, navigation, ConfigurationSource.Explicit);
                 relationship.IsUnique(true, ConfigurationSource.Explicit);
@@ -799,7 +799,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(
                     OwnsManyBuilder<TNewDependentEntity>(
@@ -932,7 +932,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             Check.NotEmpty(navigationName, nameof(navigationName));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(
                     OwnsManyBuilder<TNewDependentEntity>(
@@ -973,7 +973,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             Check.NotNull(navigationExpression, nameof(navigationExpression));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(
                     OwnsManyBuilder<TNewDependentEntity>(
@@ -1018,7 +1018,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             Check.NotNull(navigationExpression, nameof(navigationExpression));
             Check.NotNull(buildAction, nameof(buildAction));
 
-            using (DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (DependentEntityType.Model.DelayConventions())
             {
                 buildAction(
                     OwnsManyBuilder<TNewDependentEntity>(
@@ -1034,7 +1034,7 @@ public new virtual IndexBuilder<TEntity> HasIndex([NotNull] params string[] prop
             where TNewRelatedEntity : class
         {
             InternalForeignKeyBuilder relationship;
-            using (var batch = DependentEntityType.Model.ConventionDispatcher.DelayConventions())
+            using (var batch = DependentEntityType.Model.DelayConventions())
             {
                 relationship = DependentEntityType.Builder.HasOwnership(ownedType, navigation, ConfigurationSource.Explicit);
                 relationship.IsUnique(false, ConfigurationSource.Explicit);

src/EFCore/Metadata/Builders/ReferenceNavigationBuilder.cs

@@ -244,7 +244,7 @@ private InternalForeignKeyBuilder WithOneBuilder(MemberIdentity reference)
                 InternalForeignKeyBuilder.ThrowForConflictingNavigation(Builder.Metadata, referenceName, false);
             }
 
-            using var batch = Builder.Metadata.DeclaringEntityType.Model.ConventionDispatcher.DelayConventions();
+            using var batch = Builder.Metadata.DeclaringEntityType.Model.DelayConventions();
             var builder = Builder.IsUnique(true, ConfigurationSource.Explicit);
             var foreignKey = builder.Metadata;
             if (foreignKey.IsSelfReferencing()

src/EFCore/Metadata/Builders/ReferenceReferenceBuilder.cs

@@ -191,7 +191,7 @@ public virtual ReferenceReferenceBuilder HasAnnotation([NotNull] string annotati
                         dependentEntityTypeName));
             }
 
-            using var batch = dependentEntityType.Model.ConventionDispatcher.DelayConventions();
+            using var batch = dependentEntityType.Model.DelayConventions();
             var builder = Builder.HasEntityTypes(
                 GetOtherEntityType(dependentEntityType), dependentEntityType, ConfigurationSource.Explicit);
             builder = hasForeignKey(builder, dependentEntityType);
@@ -301,7 +301,7 @@ public virtual ReferenceReferenceBuilder HasAnnotation([NotNull] string annotati
                         principalEntityTypeName));
             }
 
-            using var batch = principalEntityType.Model.ConventionDispatcher.DelayConventions();
+            using var batch = principalEntityType.Model.DelayConventions();
             var builder = Builder.HasEntityTypes(
                 principalEntityType, GetOtherEntityType(principalEntityType), ConfigurationSource.Explicit);
             builder = hasPrincipalKey(builder);

src/EFCore/Metadata/Conventions/Internal/ConventionDispatcher.cs

@@ -592,7 +592,7 @@ public virtual IConventionBatch DelayConventions()
         ///     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>
-        public virtual T Run<T>([NotNull] Func<T> func, [CanBeNull] ref IConventionForeignKey foreignKey)
+        public virtual T Track<T>([NotNull] Func<T> func, [CanBeNull] ref IConventionForeignKey foreignKey)
         {
             var batch = DelayConventions();
             using var foreignKeyReference = Tracker.Track(foreignKey);

src/EFCore/Metadata/IConventionModel.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore.Metadata.Builders;
+using Microsoft.EntityFrameworkCore.Metadata.Conventions;
 
 #nullable enable
 
@@ -29,6 +30,18 @@ public interface IConventionModel : IModel, IConventionAnnotatable
         /// </summary>
         new IConventionModelBuilder Builder { get; }
 
+        /// <summary>
+        ///     <para>
+        ///         Prevents conventions from being executed immediately when a metadata aspect is modified. All the delayed conventions
+        ///         will be executed after the returned object is disposed.
+        ///     </para>
+        ///     <para>
+        ///         This is useful when performing multiple operations that depend on each other.
+        ///     </para>
+        /// </summary>
+        /// <returns> An object that should be disposed to execute the delayed conventions. </returns>
+        IConventionBatch DelayConventions();
+
         /// <summary>
         ///     <para>
         ///         Adds a shadow state entity type to the model.

src/EFCore/Metadata/IMutableModel.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using JetBrains.Annotations;
+using Microsoft.EntityFrameworkCore.Metadata.Conventions;
 
 #nullable enable
 
@@ -23,6 +24,18 @@ namespace Microsoft.EntityFrameworkCore.Metadata
     /// </summary>
     public interface IMutableModel : IModel, IMutableAnnotatable
     {
+        /// <summary>
+        ///     <para>
+        ///         Prevents conventions from being executed immediately when a metadata aspect is modified. All the delayed conventions
+        ///         will be executed after the returned object is disposed.
+        ///     </para>
+        ///     <para>
+        ///         This is useful when performing multiple operations that depend on each other.
+        ///     </para>
+        /// </summary>
+        /// <returns> An object that should be disposed to execute the delayed conventions. </returns>
+        IConventionBatch DelayConventions();
+
         /// <summary>
         ///     <para>
         ///         Adds a shadow state entity type to the model.