Merge pull request #1025 from EdwardCooke/ec-1018-nullablefixes

Fix nullable field types due to compiler optimizations +semver:fix
aaubry · Dec 23, 2024 · 380e2c4 · 380e2c4
2 parents d6a3c1f + 60536ac
commit 380e2c4
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -140,7 +140,3 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
 Please see the Releases at https://github.com/aaubry/YamlDotNet/releases
 
-## Sponsorships
-A big shout out to all of our sponsors
-
-[![AWS](Sponsors/aws-logo-small.png)](https://www.github.com/aws)
diff --git a/Sponsors/aws-logo-small.png b/Sponsors/aws-logo-small.png
diff --git a/YamlDotNet.Test/Serialization/DeserializerTest.cs b/YamlDotNet.Test/Serialization/DeserializerTest.cs
@@ -395,7 +395,55 @@ public void DeserializeWithoutDuplicateKeyChecking_YamlWithDuplicateKeys_DoesNot
         }
 
         [Fact]
-        public void EnforceNulalbleTypesWhenNullThrowsException()
+        public void EnforceNullableWhenClassIsDefaultNullableThrows()
+        {
+            var deserializer = new DeserializerBuilder().WithEnforceNullability().Build();
+            var yaml = @"
+TestString: null
+TestBool: null
+TestBool1: null
+";
+            try
+            {
+                var test = deserializer.Deserialize<NullableDefaultClass>(yaml);
+            }
+            catch (YamlException e)
+            {
+                if (e.InnerException is NullReferenceException)
+                {
+                    return;
+                }
+            }
+
+            throw new Exception("Non nullable property was set to null.");
+        }
+
+        [Fact]
+        public void EnforceNullableWhenClassIsNotDefaultNullableThrows()
+        {
+            var deserializer = new DeserializerBuilder().WithEnforceNullability().Build();
+            var yaml = @"
+TestString: null
+TestBool: null
+TestBool1: null
+";
+            try
+            {
+                var test = deserializer.Deserialize<NullableNotDefaultClass>(yaml);
+            }
+            catch (YamlException e)
+            {
+                if (e.InnerException is NullReferenceException)
+                {
+                    return;
+                }
+            }
+
+            throw new Exception("Non nullable property was set to null.");
+        }
+
+        [Fact]
+        public void EnforceNullableTypesWhenNullThrowsException()
         {
             var deserializer = new DeserializerBuilder().WithEnforceNullability().Build();
             var yaml = @"
@@ -610,6 +658,20 @@ public enum EnumMemberedEnum
 #endif
 
 #nullable enable
+        public class NullableDefaultClass
+        {
+            public string? TestString { get; set; }
+            public string? TestBool { get; set; }
+            public string TestBool1 { get; set; } = "";
+        }
+
+        public class NullableNotDefaultClass
+        {
+            public string? TestString { get; set; }
+            public string TestBool { get; set; } = "";
+            public string TestBool1 { get; set; } = "";
+        }
+
         public class NonNullableClass
         {
             public string Test { get; set; } = "Some default value";

diff --git a/YamlDotNet/ReflectionExtensions.cs b/YamlDotNet/ReflectionExtensions.cs
@@ -305,39 +305,34 @@ public static Attribute[] GetAllCustomAttributes<TAttribute>(this PropertyInfo m
             return Attribute.GetCustomAttributes(member, typeof(TAttribute), inherit: true);
         }
 
-        private static readonly ConcurrentDictionary<Type, bool> TypesHaveNullContext = new();
-
         public static bool AcceptsNull(this MemberInfo member)
         {
-            var result = true; //default to allowing nulls, this will be set to false if there is a null context on the type
 #if NET8_0_OR_GREATER
-            var typeHasNullContext = TypesHaveNullContext.GetOrAdd(member.DeclaringType, (Type t) =>
-            {
-                var attributes = t.GetCustomAttributes(typeof(System.Runtime.CompilerServices.NullableContextAttribute), true);
-                return (attributes?.Length ?? 0) > 0;
-            });
+            var classAttributes = member.DeclaringType.GetCustomAttributes(typeof(System.Runtime.CompilerServices.NullableContextAttribute), true);
+            var defaultFlag = classAttributes.OfType<System.Runtime.CompilerServices.NullableContextAttribute>().FirstOrDefault()?.Flag ?? 0;
 
-            if (typeHasNullContext)
-            {
-                // we have a nullable context on that type, only allow null if the NullableAttribute is on the member.
-                var memberAttributes = member.GetCustomAttributes(typeof(System.Runtime.CompilerServices.NullableAttribute), true);
-                result = (memberAttributes?.Length ?? 0) > 0;
-            }
+            // we have a nullable context on that type, only allow null if the NullableAttribute is on the member.
+            var memberAttributes = member.GetCustomAttributes(typeof(System.Runtime.CompilerServices.NullableAttribute), true);
+            var nullableFlag = memberAttributes.OfType<System.Runtime.CompilerServices.NullableAttribute>().FirstOrDefault()?.NullableFlags.Any(flag => flag == 2);
+            var result = nullableFlag ?? defaultFlag == 2;
 
             return result;
 #else
-            var typeHasNullContext = TypesHaveNullContext.GetOrAdd(member.DeclaringType, (Type t) =>
+            var classAttributes = member.DeclaringType.GetCustomAttributes(true);
+            var classAttribute = classAttributes.FirstOrDefault(x => x.GetType().FullName == "System.Runtime.CompilerServices.NullableContextAttribute");
+            var defaultFlag = 0;
+            if (classAttribute != null)
             {
-                var attributes = t.GetCustomAttributes(true);
-                return attributes.Any(x => x.GetType().FullName == "System.Runtime.CompilerServices.NullableContextAttribute");
-            });
-
-            if (typeHasNullContext)
-            {
-                var memberAttributes = member.GetCustomAttributes(true);
-                result = memberAttributes.Any(x => x.GetType().FullName == "System.Runtime.CompilerServices.NullableAttribute");
+                var classAttributeType = classAttribute.GetType();
+                var classProperty = classAttributeType.GetProperty("Flag")!;
+                defaultFlag = (byte)classProperty.GetValue(classAttribute)!;
             }
-
+            var memberAttributes = member.GetCustomAttributes(true);
+            var memberAttribute = memberAttributes.FirstOrDefault(x => x.GetType().FullName == "System.Runtime.CompilerServices.NullableAttribute");
+            var memberAttributeType = memberAttribute?.GetType();
+            var memberProperty = memberAttributeType?.GetProperty("NullableFlags")!;
+            var flags = (byte[])memberProperty.GetValue(memberAttribute)!;
+            var result = flags.Any(x => x == 2) || defaultFlag == 2;
             return result;
 #endif
         }