Move NonNullableConventionState to CoreAnnotationNames (#35359)

Co-authored-by: ajcvickers <[email protected]> Fixes #34996
dotnet · Jan 7, 2025 · cc16006 · cc16006
1 parent 2954996
commit cc16006
Show file tree

Hide file tree

Showing 46 changed files with 6,463 additions and 4,552 deletions.
diff --git a/src/EFCore/Metadata/Conventions/NonNullableConventionBase.cs b/src/EFCore/Metadata/Conventions/NonNullableConventionBase.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.EntityFrameworkCore.Metadata.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Metadata.Conventions;
 
@@ -14,8 +15,6 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Conventions;
 /// </remarks>
 public abstract class NonNullableConventionBase : IModelFinalizingConvention
 {
-    private const string StateAnnotationName = "NonNullableConventionState";
-
     /// <summary>
     ///     Creates a new instance of <see cref="NonNullableConventionBase" />.
     /// </summary>
@@ -50,8 +49,8 @@ protected virtual bool TryGetNullabilityInfo(
         }
 
         var annotation =
-            modelBuilder.Metadata.FindAnnotation(StateAnnotationName)
-            ?? modelBuilder.Metadata.AddAnnotation(StateAnnotationName, new NullabilityInfoContext());
+            modelBuilder.Metadata.FindAnnotation(CoreAnnotationNames.NonNullableConventionState)
+            ?? modelBuilder.Metadata.AddAnnotation(CoreAnnotationNames.NonNullableConventionState, new NullabilityInfoContext());
 
         var nullabilityInfoContext = (NullabilityInfoContext)annotation.Value!;
 
@@ -69,5 +68,6 @@ protected virtual bool TryGetNullabilityInfo(
     public virtual void ProcessModelFinalizing(
         IConventionModelBuilder modelBuilder,
         IConventionContext<IConventionModelBuilder> context)
-        => modelBuilder.Metadata.RemoveAnnotation(StateAnnotationName);
+    {
+    }
 }
diff --git a/src/EFCore/Metadata/Internal/CoreAnnotationNames.cs b/src/EFCore/Metadata/Internal/CoreAnnotationNames.cs
@@ -372,6 +372,14 @@ public static class CoreAnnotationNames
     /// </summary>
     public const string UnsafeAccessors = "UnsafeAccessors";
 
+    /// <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>
+    public const string NonNullableConventionState = "NonNullableConventionState";
+
     /// <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
@@ -426,6 +434,7 @@ public static class CoreAnnotationNames
         JsonValueReaderWriterType,
         ElementType,
         SkipNavigationBeingConfigured,
-        UnsafeAccessors
+        UnsafeAccessors,
+        NonNullableConventionState
     };
 }
diff --git a/test/EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/BigModel/ManyTypesEntityType.cs b/test/EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/BigModel/ManyTypesEntityType.cs
diff --git a/.../EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/BigModel/ManyTypesUnsafeAccessors.cs b/.../EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/BigModel/ManyTypesUnsafeAccessors.cs
@@ -25,6 +25,9 @@ public static class ManyTypesUnsafeAccessors
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<BoolNestedCollection>k__BackingField")]
         public static extern ref bool[][] BoolNestedCollection(CompiledModelTestBase.ManyTypes @this);
 
+        [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_boolReadOnlyCollection")]
+        public static extern ref List<bool> _boolReadOnlyCollection(CompiledModelTestBase.ManyTypes @this);
+
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<BoolToStringConverterProperty>k__BackingField")]
         public static extern ref bool BoolToStringConverterProperty(CompiledModelTestBase.ManyTypes @this);
 
@@ -199,6 +202,9 @@ public static class ManyTypesUnsafeAccessors
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<Int32NestedCollection>k__BackingField")]
         public static extern ref int[][] Int32NestedCollection(CompiledModelTestBase.ManyTypes @this);
 
+        [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_int32ReadOnlyCollection")]
+        public static extern ref List<int> _int32ReadOnlyCollection(CompiledModelTestBase.ManyTypes @this);
+
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<Int64>k__BackingField")]
         public static extern ref long Int64(CompiledModelTestBase.ManyTypes @this);
 
@@ -412,6 +418,9 @@ public static class ManyTypesUnsafeAccessors
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<StringNestedCollection>k__BackingField")]
         public static extern ref string[][] StringNestedCollection(CompiledModelTestBase.ManyTypes @this);
 
+        [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_stringReadOnlyCollection")]
+        public static extern ref List<string> _stringReadOnlyCollection(CompiledModelTestBase.ManyTypes @this);
+
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<StringToBoolConverterProperty>k__BackingField")]
         public static extern ref string StringToBoolConverterProperty(CompiledModelTestBase.ManyTypes @this);
 
@@ -496,6 +505,9 @@ public static class ManyTypesUnsafeAccessors
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<UInt8Array>k__BackingField")]
         public static extern ref byte[] UInt8Array(CompiledModelTestBase.ManyTypes @this);
 
+        [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_uInt8ReadOnlyCollection")]
+        public static extern ref List<byte> _uInt8ReadOnlyCollection(CompiledModelTestBase.ManyTypes @this);
+
         [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<Uri>k__BackingField")]
         public static extern ref Uri Uri(CompiledModelTestBase.ManyTypes @this);
 

diff --git a/test/EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/No_NativeAOT/ManyTypesEntityType.cs b/test/EFCore.Cosmos.FunctionalTests/Scaffolding/Baselines/No_NativeAOT/ManyTypesEntityType.cs
@@ -32,7 +32,7 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 baseEntityType,
                 discriminatorProperty: "$type",
                 discriminatorValue: "ManyTypes",
-                propertyCount: 166,
+                propertyCount: 170,
                 keyCount: 1);
 
             var id = runtimeEntityType.AddProperty(
@@ -70,6 +70,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("BoolNestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<BoolNestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var boolReadOnlyCollection = runtimeEntityType.AddProperty(
+                "BoolReadOnlyCollection",
+                typeof(IReadOnlyCollection<bool>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("BoolReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_boolReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var boolToStringConverterProperty = runtimeEntityType.AddProperty(
                 "BoolToStringConverterProperty",
                 typeof(bool),
@@ -516,6 +522,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("Int32NestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<Int32NestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var int32ReadOnlyCollection = runtimeEntityType.AddProperty(
+                "Int32ReadOnlyCollection",
+                typeof(IReadOnlyCollection<int>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("Int32ReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_int32ReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var int64 = runtimeEntityType.AddProperty(
                 "Int64",
                 typeof(long),
@@ -991,6 +1003,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("StringNestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<StringNestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var stringReadOnlyCollection = runtimeEntityType.AddProperty(
+                "StringReadOnlyCollection",
+                typeof(IReadOnlyCollection<string>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("StringReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_stringReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var stringToBoolConverterProperty = runtimeEntityType.AddProperty(
                 "StringToBoolConverterProperty",
                 typeof(string),
@@ -1189,6 +1207,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("UInt8Array", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<UInt8Array>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var uInt8ReadOnlyCollection = runtimeEntityType.AddProperty(
+                "UInt8ReadOnlyCollection",
+                typeof(IReadOnlyCollection<byte>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("UInt8ReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_uInt8ReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var uri = runtimeEntityType.AddProperty(
                 "Uri",
                 typeof(Uri),

diff --git a/test/EFCore.Cosmos.FunctionalTests/Scaffolding/CompiledModelCosmosTest.cs b/test/EFCore.Cosmos.FunctionalTests/Scaffolding/CompiledModelCosmosTest.cs
@@ -331,6 +331,7 @@ protected override void BuildBigModel(ModelBuilder modelBuilder, bool jsonColumn
                 b.Ignore(e => e.NullableGuidNestedCollection);
                 b.Ignore(e => e.UInt8NestedCollection);
                 b.Ignore(e => e.NullableUInt8NestedCollection);
+                b.Ignore(e => e.IPAddressReadOnlyCollection);
             });
     }
 

diff --git a/...EFCore.InMemory.FunctionalTests/Scaffolding/Baselines/No_NativeAOT/ManyTypesEntityType.cs b/...EFCore.InMemory.FunctionalTests/Scaffolding/Baselines/No_NativeAOT/ManyTypesEntityType.cs
@@ -27,7 +27,7 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 "Microsoft.EntityFrameworkCore.Scaffolding.CompiledModelTestBase+ManyTypes",
                 typeof(CompiledModelTestBase.ManyTypes),
                 baseEntityType,
-                propertyCount: 258,
+                propertyCount: 263,
                 keyCount: 1);
 
             var id = runtimeEntityType.AddProperty(
@@ -59,6 +59,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("BoolNestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<BoolNestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var boolReadOnlyCollection = runtimeEntityType.AddProperty(
+                "BoolReadOnlyCollection",
+                typeof(IReadOnlyCollection<bool>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("BoolReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_boolReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var boolToStringConverterProperty = runtimeEntityType.AddProperty(
                 "BoolToStringConverterProperty",
                 typeof(bool),
@@ -711,6 +717,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("IPAddressArray", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<IPAddressArray>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var iPAddressReadOnlyCollection = runtimeEntityType.AddProperty(
+                "IPAddressReadOnlyCollection",
+                typeof(IReadOnlyCollection<IPAddress>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("IPAddressReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_ipAddressReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var iPAddressToBytesConverterProperty = runtimeEntityType.AddProperty(
                 "IPAddressToBytesConverterProperty",
                 typeof(IPAddress),
@@ -757,6 +769,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("Int32NestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<Int32NestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var int32ReadOnlyCollection = runtimeEntityType.AddProperty(
+                "Int32ReadOnlyCollection",
+                typeof(IReadOnlyCollection<int>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("Int32ReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_int32ReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var int64 = runtimeEntityType.AddProperty(
                 "Int64",
                 typeof(long),
@@ -1526,6 +1544,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("StringNestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<StringNestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var stringReadOnlyCollection = runtimeEntityType.AddProperty(
+                "StringReadOnlyCollection",
+                typeof(IReadOnlyCollection<string>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("StringReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_stringReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var stringToBoolConverterProperty = runtimeEntityType.AddProperty(
                 "StringToBoolConverterProperty",
                 typeof(string),
@@ -1742,6 +1766,12 @@ public static RuntimeEntityType Create(RuntimeModel model, RuntimeEntityType bas
                 propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("UInt8NestedCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
                 fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("<UInt8NestedCollection>k__BackingField", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
 
+            var uInt8ReadOnlyCollection = runtimeEntityType.AddProperty(
+                "UInt8ReadOnlyCollection",
+                typeof(IReadOnlyCollection<byte>),
+                propertyInfo: typeof(CompiledModelTestBase.ManyTypes).GetProperty("UInt8ReadOnlyCollection", BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly),
+                fieldInfo: typeof(CompiledModelTestBase.ManyTypes).GetField("_uInt8ReadOnlyCollection", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly));
+
             var uri = runtimeEntityType.AddProperty(
                 "Uri",
                 typeof(Uri),

diff --git a/test/EFCore.Specification.Tests/Scaffolding/CompiledModelTestBase.cs b/test/EFCore.Specification.Tests/Scaffolding/CompiledModelTestBase.cs
@@ -221,6 +221,15 @@ protected virtual void BuildBigModel(ModelBuilder modelBuilder, bool jsonColumns
                 b.PrimitiveCollection(e => e.EnumU32AsStringArray).ElementType(b => b.HasConversion<string>());
                 b.PrimitiveCollection(e => e.EnumU64AsStringArray).ElementType(b => b.HasConversion<string>());
 
+                b.Property(e => e.BoolReadOnlyCollection);
+                b.Property(e => e.UInt8ReadOnlyCollection).HasField("_uInt8ReadOnlyCollection");
+                b.Property(e => e.Int32ReadOnlyCollection);
+                b.Property(e => e.StringReadOnlyCollection).HasField("_stringReadOnlyCollection");
+
+                b.PrimitiveCollection(e => e.IPAddressReadOnlyCollection)
+                    .ElementType(b => b.HasConversion<string>())
+                    .HasField("_ipAddressReadOnlyCollection");
+
                 b.Property(e => e.BoolToStringConverterProperty).HasConversion(new BoolToStringConverter("A", "B"));
                 b.Property(e => e.BoolToTwoValuesConverterProperty).HasConversion(new BoolToTwoValuesConverter<byte>(0, 1));
                 b.Property(e => e.BoolToZeroOneConverterProperty).HasConversion<BoolToZeroOneConverter<short>>();
@@ -911,6 +920,27 @@ public class ManyTypes
         public IPAddress?[] NullableIPAddressArray { get; set; } = null!;
         public PhysicalAddress?[] NullablePhysicalAddressArray { get; set; } = null!;
 
+        private List<bool> _boolReadOnlyCollection = [];
+        private List<byte> _uInt8ReadOnlyCollection = [];
+        private List<int> _int32ReadOnlyCollection = [];
+        private List<string> _stringReadOnlyCollection = [];
+        private List<IPAddress> _ipAddressReadOnlyCollection = [];
+
+        public IReadOnlyCollection<bool> BoolReadOnlyCollection
+            => _boolReadOnlyCollection.ToList();
+
+        public IReadOnlyCollection<byte> UInt8ReadOnlyCollection
+            => _uInt8ReadOnlyCollection.ToList();
+
+        public IReadOnlyCollection<int> Int32ReadOnlyCollection
+            => _int32ReadOnlyCollection.ToList();
+
+        public IReadOnlyCollection<string> StringReadOnlyCollection
+            => _stringReadOnlyCollection.ToList();
+
+        public IReadOnlyCollection<IPAddress> IPAddressReadOnlyCollection
+            => _ipAddressReadOnlyCollection.ToList();
+
         public Enum8 Enum8 { get; set; }
         public Enum16 Enum16 { get; set; }
         public Enum32 Enum32 { get; set; }