Add TreatNullObliviousAsNonNullable setting.

dotnet · Jun 14, 2024 · d5f9a62 · d5f9a62
1 parent af194e5
commit d5f9a62
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 3 deletions.
diff --git a/src/libraries/System.Text.Json/ref/System.Text.Json.cs b/src/libraries/System.Text.Json/ref/System.Text.Json.cs
@@ -907,7 +907,8 @@ public sealed partial class JsonSchemaExporterOptions
     {
         public JsonSchemaExporterOptions() { }
         public static System.Text.Json.Schema.JsonSchemaExporterOptions Default { get { throw null; } }
-        public System.Func<JsonSchemaExporterContext, System.Text.Json.Nodes.JsonNode, System.Text.Json.Nodes.JsonNode>? TransformSchemaNode { get; init; }
+        public System.Func<JsonSchemaExporterContext, System.Text.Json.Nodes.JsonNode, System.Text.Json.Nodes.JsonNode>? TransformSchemaNode { get { throw null; } init { } }
+        public bool TreatNullObliviousAsNonNullable { get { throw null; } init { } }
     }
 }
 namespace System.Text.Json.Serialization

diff --git a/src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs b/src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs
@@ -349,7 +349,7 @@ JsonSchema CompleteSchema(ref GenerationState state, JsonSchema schema)
                 {
                     bool isNullableSchema = propertyInfo != null
                         ? propertyInfo.IsGetNullable || propertyInfo.IsSetNullable
-                        : typeInfo.CanBeNull && !parentPolymorphicTypeIsNonNullable;
+                        : typeInfo.CanBeNull && !parentPolymorphicTypeIsNonNullable && !state.ExporterOptions.TreatNullObliviousAsNonNullable;
 
                     if (isNullableSchema)
                     {

diff --git a/src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporterOptions.cs b/src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporterOptions.cs
@@ -15,6 +15,16 @@ public sealed class JsonSchemaExporterOptions
         /// </summary>
         public static JsonSchemaExporterOptions Default { get; } = new();
 
+        /// <summary>
+        /// Determines whether non-nullable schemas should be generated for null oblivious reference types.
+        /// </summary>
+        /// <remarks>
+        /// Defaults to <see langword="false"/>. Due to restrictions in the run-time representation of nullable reference types
+        /// most occurences are null oblivious and are treated as nullable by the serializer. A notable exception to that rule
+        /// are nullability annotations of field, property and constructor parameters which are represented in the contract metadata.
+        /// </remarks>
+        public bool TreatNullObliviousAsNonNullable { get; init; }
+
         /// <summary>
         /// Defines a callback that is invoked for every schema that is generated within the type graph.
         /// </summary>

diff --git a/src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.TestTypes.cs b/src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.TestTypes.cs
@@ -288,6 +288,27 @@ public static IEnumerable<ITestData> GetTestDataCore()
                 }
                 """);
 
+            // Same as above with non-nullable reference type handling
+            yield return new TestData<PocoWithRecursiveMembers>(
+                Value: new() { Value = 1, Next = new() { Value = 2, Next = new() { Value = 3 } } },
+                AdditionalValues: [new() { Value = 1, Next = null }],
+                ExpectedJsonSchema: """
+                {
+                    "type": "object",
+                    "properties": {
+                        "Value": { "type": "integer" },
+                        "Next": {
+                            "type": ["object", "null"],
+                            "properties": {
+                                "Value": { "type": "integer" },
+                                "Next": { "$ref": "#/properties/Next" }
+                            }
+                        }
+                    }
+                }
+                """,
+                Options: new() { TreatNullObliviousAsNonNullable = true });
+
             // Same as above but using an anchor-based reference scheme
             yield return new TestData<PocoWithRecursiveMembers>(
                 Value: new() { Value = 1, Next = new() { Value = 2, Next = new() { Value = 3 } } },
@@ -398,6 +419,22 @@ public static IEnumerable<ITestData> GetTestDataCore()
                 }
                 """);
 
+            // Same as above but with non-nullable reference type handling
+            yield return new TestData<PocoWithRecursiveCollectionElement>(
+                Value: new() { Children = [new(), new() { Children = [] }] },
+                ExpectedJsonSchema: """
+                {
+                    "type": "object",
+                    "properties": {
+                        "Children": {
+                            "type": "array",
+                            "items": { "$ref" : "#" }
+                        }
+                    }
+                }
+                """,
+                Options: new() { TreatNullObliviousAsNonNullable = true });
+
             yield return new TestData<PocoWithRecursiveDictionaryValue>(
                 Value: new() { Children = new() { ["key1"] = new(), ["key2"] = new() { Children = new() { ["key3"] = new() }  } } },
                 ExpectedJsonSchema: """
@@ -412,6 +449,22 @@ public static IEnumerable<ITestData> GetTestDataCore()
                 }
                 """);
 
+            // Same as above but with non-nullable reference type handling
+            yield return new TestData<PocoWithRecursiveDictionaryValue>(
+                Value: new() { Children = new() { ["key1"] = new(), ["key2"] = new() { Children = new() { ["key3"] = new() } } } },
+                ExpectedJsonSchema: """
+                {
+                    "type": "object",
+                    "properties": {
+                        "Children": {
+                            "type": "object",
+                            "additionalProperties": { "$ref" : "#" }
+                        }
+                    }
+                }
+                """,
+                Options: new() { TreatNullObliviousAsNonNullable = true });
+
             yield return new TestData<PocoWithDescription>(
                 Value: new() { X = 42 },
                 ExpectedJsonSchema: """
@@ -1390,7 +1443,7 @@ IEnumerable<ITestData> ITestData.GetTestDataForAllValues()
             {
                 yield return this;
 
-                if (default(T) is null)
+                if (default(T) is null && Options?.TreatNullObliviousAsNonNullable != true)
                 {
                     yield return this with { Value = default, AdditionalValues = null };
                 }

diff --git a/src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs b/src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs
@@ -41,6 +41,33 @@ public void TestTypes_SerializedValueMatchesGeneratedSchema(ITestData testData)
             AssertDocumentMatchesSchema(schema, instance);
         }
 
+        [Theory]
+        [InlineData(typeof(string), "string")]
+        [InlineData(typeof(int[]), "array")]
+        [InlineData(typeof(Dictionary<string, int>), "object")]
+        [InlineData(typeof(SimplePoco), "object")]
+        public void TreatNullObliviousAsNonNullable_False_MarksReferenceTypesAsNullable(Type referenceType, string expectedType)
+        {
+            Assert.True(!referenceType.IsValueType);
+            var config = new JsonSchemaExporterOptions { TreatNullObliviousAsNonNullable = false };
+            JsonNode schema = Serializer.DefaultOptions.GetJsonSchemaAsNode(referenceType, config);
+            JsonArray arr = Assert.IsType<JsonArray>(schema["type"]);
+            Assert.Equal([expectedType, "null"], arr.Select(e => (string)e!));
+        }
+
+        [Theory]
+        [InlineData(typeof(string), "string")]
+        [InlineData(typeof(int[]), "array")]
+        [InlineData(typeof(Dictionary<string, int>), "object")]
+        [InlineData(typeof(SimplePoco), "object")]
+        public void TreatNullObliviousAsNonNullable_True_MarksReferenceTypesAsNonNullable(Type referenceType, string expectedType)
+        {
+            Assert.True(!referenceType.IsValueType);
+            var config = new JsonSchemaExporterOptions { TreatNullObliviousAsNonNullable = true };
+            JsonNode schema = Serializer.DefaultOptions.GetJsonSchemaAsNode(referenceType, config);
+            Assert.Equal(expectedType, (string)schema["type"]!);
+        }
+
         [Theory]
         [InlineData(typeof(Type))]
         [InlineData(typeof(MethodInfo))]
@@ -95,6 +122,23 @@ public void ReferenceHandlePreserve_Enabled_ThrowsNotSupportedException()
             Assert.Contains("ReferenceHandler.Preserve", ex.Message);
         }
 
+        [Theory]
+        [InlineData(false)]
+        [InlineData(true)]
+        public void JsonSchemaExporterOptions_DefaultSettings(bool useSingleton)
+        {
+            JsonSchemaExporterOptions options = useSingleton ? JsonSchemaExporterOptions.Default : new();
+
+            Assert.False(options.TreatNullObliviousAsNonNullable);
+            Assert.Null(options.TransformSchemaNode);
+        }
+
+        [Fact]
+        public void JsonSchemaExporterOptions_Default_IsSame()
+        {
+            Assert.Same(JsonSchemaExporterOptions.Default, JsonSchemaExporterOptions.Default);
+        }
+
         protected void AssertValidJsonSchema(Type type, string expectedJsonSchema, JsonNode actualJsonSchema)
         {
             JsonNode? expectedJsonSchemaNode = JsonNode.Parse(expectedJsonSchema, documentOptions: new() { CommentHandling = JsonCommentHandling.Skip, AllowTrailingCommas = true });