chore: add ManagedReference YAML roundtrip tests

Author: filzrev

src/Docfx.Build.ManagedReference/BuildOutputs/ApiReferenceBuildOutput.cs

@@ -179,11 +179,21 @@ public class ApiReferenceBuildOutput
     [YamlIgnore]
     [Newtonsoft.Json.JsonExtensionData]
     [System.Text.Json.Serialization.JsonExtensionData]
-    public CompositeDictionary MetadataJson =>
-        CompositeDictionary
+    [System.Text.Json.Serialization.JsonInclude]
+    public CompositeDictionary MetadataJson
+    {
+        get
+        {
+            return CompositeDictionary
             .CreateBuilder()
             .Add(string.Empty, Metadata)
             .Create();
+        }
+        private init
+        {
+            // init or getter is required for deserialize data with System.Text.Json.
+        }
+    }
 
     private bool _needExpand = true;
 

src/Docfx.Common/Json/JsonUtility.cs

@@ -91,9 +91,11 @@ private static bool IsSupported()
             {
                 // TODO: Return `true` for types that support serialize/deserializenon with System.Text.Json.
                 case "Docfx.Build.Engine.XRefMap":
-                case "Docfx.DataContracts.ManagedReference.PageViewModel":
                     return true;
 
+                case "Docfx.DataContracts.ManagedReference.PageViewModel":
+                    return true; // TODO: Need to support ExtensionData
+
                 // Intermediate types for tests. it's expected to be removed later (And return true by default).
                 case "Docfx.Plugins.MarkdownServiceProperties":
                     return true;

src/Docfx.DataContracts.Common/JTokenConverter.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Reflection;
+using Docfx.Common;
 using Newtonsoft.Json.Linq;
 
 namespace Docfx.DataContracts.Common;
@@ -18,6 +20,24 @@ public static T Convert<T>(object obj)
         {
             return jToken.ToObject<T>();
         }
+
+        // Custom code path for `System.Text.Json` deserialization.
+        // `ObjectToInferredTypesConverter` deserialize items as `List<object>`.
+        // So it need to convert `List<object>` to `List<TItem>`.
+        if (obj is List<object> list && IsListType<T>())
+        {
+            var json = JsonUtility.Serialize(list);
+            var result = JsonUtility.Deserialize<T>(new StringReader(json));
+            return result;
+        }
+
         throw new InvalidCastException();
     }
+
+    private static bool IsListType<T>()
+    {
+        var type = typeof(T);
+        return type.GetTypeInfo().IsGenericType
+            && type.GetGenericTypeDefinition() == typeof(List<>);
+    }
 }

src/Docfx.DataContracts.Common/ReferenceViewModel.cs

@@ -86,17 +86,27 @@ public class ReferenceViewModel
     [YamlIgnore]
     [Newtonsoft.Json.JsonExtensionData]
     [System.Text.Json.Serialization.JsonExtensionData]
+    [System.Text.Json.Serialization.JsonInclude]
     [UniqueIdentityReferenceIgnore]
     [MarkdownContentIgnore]
-    public CompositeDictionary AdditionalJson =>
-        CompositeDictionary
+    public CompositeDictionary AdditionalJson
+    {
+        get
+        {
+            return CompositeDictionary
             .CreateBuilder()
             .Add(Constants.ExtensionMemberPrefix.Name, NameInDevLangs, JTokenConverter.Convert<string>)
             .Add(Constants.ExtensionMemberPrefix.NameWithType, NameWithTypeInDevLangs, JTokenConverter.Convert<string>)
             .Add(Constants.ExtensionMemberPrefix.FullName, FullNameInDevLangs, JTokenConverter.Convert<string>)
             .Add(Constants.ExtensionMemberPrefix.Spec, Specs, JTokenConverter.Convert<List<SpecViewModel>>)
             .Add(string.Empty, Additional)
             .Create();
+        }
+        private init
+        {
+            // init or getter is required for deserialize data with System.Text.Json.
+        }
+    }
 
     public ReferenceViewModel Clone()
     {

src/Docfx.Dotnet/ManagedReference/Models/ItemViewModel.cs

@@ -378,14 +378,24 @@ public string FullNameForVB
     [YamlIgnore]
     [Newtonsoft.Json.JsonExtensionData]
     [System.Text.Json.Serialization.JsonExtensionData]
+    [System.Text.Json.Serialization.JsonInclude]
     [UniqueIdentityReferenceIgnore]
     [MarkdownContentIgnore]
-    public IDictionary<string, object> ExtensionData =>
-        CompositeDictionary
+    public IDictionary<string, object> ExtensionData
+    {
+        get
+        {
+            return CompositeDictionary
             .CreateBuilder()
             .Add(Constants.ExtensionMemberPrefix.Name, Names, JTokenConverter.Convert<string>)
             .Add(Constants.ExtensionMemberPrefix.NameWithType, NamesWithType, JTokenConverter.Convert<string>)
             .Add(Constants.ExtensionMemberPrefix.FullName, FullNames, JTokenConverter.Convert<string>)
             .Add(string.Empty, Metadata)
             .Create();
+        }
+        private init
+        {
+            // init or getter is required for deserialize data with System.Text.Json.
+        }
+    }
 }

src/Docfx.Dotnet/ManagedReference/Models/SyntaxDetailViewModel.cs

@@ -89,11 +89,21 @@ public string ContentForVB
     [YamlIgnore]
     [Newtonsoft.Json.JsonExtensionData]
     [System.Text.Json.Serialization.JsonExtensionData]
+    [System.Text.Json.Serialization.JsonInclude]
     [UniqueIdentityReferenceIgnore]
     [MarkdownContentIgnore]
-    public IDictionary<string, object> ExtensionData =>
-        CompositeDictionary
+    public IDictionary<string, object> ExtensionData
+    {
+        get
+        {
+            return CompositeDictionary
             .CreateBuilder()
             .Add(Constants.ExtensionMemberPrefix.Content, Contents, JTokenConverter.Convert<string>)
             .Create();
+        }
+        private init
+        {
+            // init or getter is required for deserialize data with System.Text.Json.
+        }
+    }
 }

test/docfx.Tests/Api.verified.cs

@@ -1163,6 +1163,7 @@ public ApiReferenceBuildOutput() { }
         public System.Collections.Generic.Dictionary<string, object> Metadata { get; set; }
         [Newtonsoft.Json.JsonExtensionData]
         [System.Text.Json.Serialization.JsonExtensionData]
+        [System.Text.Json.Serialization.JsonInclude]
         [YamlDotNet.Serialization.YamlIgnore]
         public Docfx.Common.CompositeDictionary MetadataJson { get; }
         [Newtonsoft.Json.JsonProperty("name")]
@@ -2503,6 +2504,7 @@ public ReferenceViewModel() { }
         [Docfx.DataContracts.Common.UniqueIdentityReferenceIgnore]
         [Newtonsoft.Json.JsonExtensionData]
         [System.Text.Json.Serialization.JsonExtensionData]
+        [System.Text.Json.Serialization.JsonInclude]
         [YamlDotNet.Serialization.YamlIgnore]
         public Docfx.Common.CompositeDictionary AdditionalJson { get; }
         [Newtonsoft.Json.JsonProperty("commentId")]
@@ -2877,6 +2879,7 @@ public ItemViewModel() { }
         [Docfx.DataContracts.Common.UniqueIdentityReferenceIgnore]
         [Newtonsoft.Json.JsonExtensionData]
         [System.Text.Json.Serialization.JsonExtensionData]
+        [System.Text.Json.Serialization.JsonInclude]
         [YamlDotNet.Serialization.YamlIgnore]
         public System.Collections.Generic.IDictionary<string, object> ExtensionData { get; }
         [Docfx.Common.EntityMergers.MergeOption(Docfx.Common.EntityMergers.MergeOption.Ignore)]
@@ -3152,6 +3155,7 @@ public SyntaxDetailViewModel() { }
         [Docfx.DataContracts.Common.UniqueIdentityReferenceIgnore]
         [Newtonsoft.Json.JsonExtensionData]
         [System.Text.Json.Serialization.JsonExtensionData]
+        [System.Text.Json.Serialization.JsonInclude]
         [YamlDotNet.Serialization.YamlIgnore]
         public System.Collections.Generic.IDictionary<string, object> ExtensionData { get; }
         [Newtonsoft.Json.JsonProperty("parameters")]

test/docfx.Tests/SerializationTests/TestData/ManagedReference/BuildFromAssembly.yml

@@ -0,0 +1,32 @@
+### YamlMime:ManagedReference
+items:
+- uid: BuildFromAssembly
+  commentId: N:BuildFromAssembly
+  id: BuildFromAssembly
+  children:
+  - BuildFromAssembly.Class1
+  - BuildFromAssembly.Issue5432
+  langs:
+  - csharp
+  - vb
+  name: BuildFromAssembly
+  nameWithType: BuildFromAssembly
+  fullName: BuildFromAssembly
+  type: Namespace
+  assemblies:
+  - BuildFromAssembly
+references:
+- uid: BuildFromAssembly.Class1
+  commentId: T:BuildFromAssembly.Class1
+  isExternal: true
+  href: BuildFromAssembly.Class1.html
+  name: Class1
+  nameWithType: Class1
+  fullName: BuildFromAssembly.Class1
+- uid: BuildFromAssembly.Issue5432
+  commentId: T:BuildFromAssembly.Issue5432
+  isExternal: true
+  href: BuildFromAssembly.Issue5432.html
+  name: Issue5432
+  nameWithType: Issue5432
+  fullName: BuildFromAssembly.Issue5432