Remove usage of Newtonsoft.Json in favor of System.Text.Json

Directory.Packages.props

@@ -15,7 +15,6 @@
     <PackageVersion Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.1.0" />
-    <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="NuGet.Common" Version="6.13.2" />
     <PackageVersion Include="NuGet.Packaging" Version="6.13.2" />

gen/DocumentFormat.OpenXml.Generator.Models/Converters/QualifiedNameConverter.cs

@@ -2,25 +2,26 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using DocumentFormat.OpenXml.Generator.Models;
-using Newtonsoft.Json;
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace DocumentFormat.OpenXml.Generator.Converters;
 
 internal class QualifiedNameConverter : JsonConverter<QName>
 {
-    public override QName? ReadJson(JsonReader reader, Type objectType, QName? existingValue, bool hasExistingValue, JsonSerializer serializer)
+    public override QName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        if (reader.TokenType != JsonToken.String)
+        if (reader.TokenType != JsonTokenType.String)
         {
             throw new InvalidOperationException("QName must be encoded as a string");
         }
 
-        var str = serializer.Deserialize<string>(reader) ?? string.Empty;
-
+        var str = reader.GetString() ?? string.Empty;
         return QName.Parse(str);
     }
 
-    public override void WriteJson(JsonWriter writer, QName? value, JsonSerializer serializer)
+    public override void Write(Utf8JsonWriter writer, QName value, JsonSerializerOptions options)
     {
         throw new NotImplementedException();
     }

gen/DocumentFormat.OpenXml.Generator.Models/Converters/TypedQNameConverter.cs

@@ -2,20 +2,22 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using DocumentFormat.OpenXml.Generator.Models;
-using Newtonsoft.Json;
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace DocumentFormat.OpenXml.Generator.Converters;
 
 internal class TypedQNameConverter : JsonConverter<TypedQName>
 {
-    public override TypedQName? ReadJson(JsonReader reader, Type objectType, TypedQName? existingValue, bool hasExistingValue, JsonSerializer serializer)
+    public override TypedQName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        if (reader.TokenType != JsonToken.String)
+        if (reader.TokenType != JsonTokenType.String)
         {
             throw new InvalidOperationException("TypedQName must be encoded as a string");
         }
 
-        var str = serializer.Deserialize<string>(reader) ?? string.Empty;
+        var str = reader.GetString() ?? string.Empty;
         var split = str.Split('/');
 
         if (split.Length != 2)
@@ -26,7 +28,7 @@ internal class TypedQNameConverter : JsonConverter<TypedQName>
         return new TypedQName(QName.Parse(split[0]), QName.Parse(split[1]));
     }
 
-    public override void WriteJson(JsonWriter writer, TypedQName? value, JsonSerializer serializer)
+    public override void Write(Utf8JsonWriter writer, TypedQName value, JsonSerializerOptions options)
     {
         throw new NotImplementedException();
     }

gen/DocumentFormat.OpenXml.Generator.Models/DocumentFormat.OpenXml.Generator.Models.csproj

@@ -9,7 +9,7 @@
     <RootNamespace>DocumentFormat.OpenXml.Generator</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" PrivateAssets="all" />
+    <PackageReference Include="System.Text.Json" PrivateAssets="all" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="System.Collections.Immutable" />

gen/DocumentFormat.OpenXml.Generator.Models/OpenXmlGeneratorDataSource.cs

@@ -4,25 +4,25 @@
 using DocumentFormat.OpenXml.Generator.Converters;
 using DocumentFormat.OpenXml.Generator.Models;
 using DocumentFormat.OpenXml.Generator.Schematron;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using System.Collections.Immutable;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace DocumentFormat.OpenXml.Generator;
 
 public record OpenXmlGeneratorDataSource
 {
-    private static readonly JsonSerializerSettings _settings = new()
+    private static readonly JsonSerializerOptions _options = new()
     {
         Converters =
         {
-            new StringEnumConverter(),
+            new JsonStringEnumConverter(),
             new QualifiedNameConverter(),
             new TypedQNameConverter(),
         },
     };
 
-    public static T? Deserialize<T>(string? content) => content is null ? default : JsonConvert.DeserializeObject<T>(content, _settings);
+    public static T? Deserialize<T>(string? content) => content is null ? default : JsonSerializer.Deserialize<T>(content, _options);
 
     public ImmutableArray<NamespaceInfo> KnownNamespaces { get; init; } = ImmutableArray.Create<NamespaceInfo>();
 

gen/DocumentFormat.OpenXml.Generator/SourceGenerator.targets

@@ -7,10 +7,7 @@
   <ItemGroup>
     <ProjectReference Include="@(OoxGenerator)" OutputItemType="Analyzer" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true" GlobalPropertiesToRemove="TargetFramework" />
   </ItemGroup>
-  <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" PrivateAssets="all" GeneratePathProperty="true" />
-    <Analyzer Include="$(PkgNewtonsoft_Json)\lib\netstandard2.0\*.dll" Visible="false" />
-  </ItemGroup>
+
   <ItemGroup>
     <AdditionalFiles Include="@(OpenXmlDataNamespace)" OpenXml="Namespace" LinkBase="data" />
     <AdditionalFiles Include="@(OpenXmlDataSchematron)" OpenXml="Schematron" LinkBase="data" />

test/Directory.Build.targets

@@ -18,7 +18,6 @@
       </ItemGroup>
 
       <ItemGroup>
-        <PackageReference Include="Newtonsoft.Json" />
         <PackageReference Include="System.Text.Json" />
         <PackageReference Include="System.ValueTuple" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" />

test/DocumentFormat.OpenXml.Framework.Tests/TestUtility.cs

@@ -4,15 +4,18 @@
 using System;
 using System.IO;
 using System.Reflection;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Xunit;
 
 namespace DocumentFormat.OpenXml.Framework.Tests
 {
     internal static class TestUtility
     {
         private static readonly JsonSerializerOptions _options = new()
         {
+            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
             Converters =
             {
                 new OpenXmlNamespaceConverter(),
@@ -22,6 +25,17 @@ internal static class TestUtility
             WriteIndented = true,
         };
 
+        public static void ValidateJsonFileContentsAreEqual(Stream stream1, Stream stream2)
+        {
+            using var reader1 = new StreamReader(stream1);
+            using var reader2 = new StreamReader(stream2);
+
+            var expected = reader1.ReadToEnd().Replace("\r\n", "\n");
+            var actual = reader2.ReadToEnd().Replace("\r\n", "\n");
+
+            Assert.Equal(expected, actual);
+        }
+
 #nullable enable
 
         public static T? Deserialize<T>(string name)

test/DocumentFormat.OpenXml.Packaging.Tests/ITestOutputHelperExtenstions.cs

@@ -1,23 +1,23 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using DocumentFormat.OpenXml.Framework;
 using DocumentFormat.OpenXml.Framework.Tests;
-using System;
 using System.IO;
 using Xunit;
 
 namespace DocumentFormat.OpenXml.Tests
 {
     internal static class ITestOutputHelperExtenstions
     {
-        public static void WriteObjectToTempFile<T>(this ITestOutputHelper output, string name, T obj)
+        public static string WriteObjectToTempFile<T>(this ITestOutputHelper output, string name, T obj)
         {
             var tmp = Path.GetTempFileName();
 
             output.WriteLine($"Wrote {name} to temp path {tmp}");
 
             File.WriteAllText(tmp, TestUtility.Serialize(obj));
+
+            return tmp;
         }
     }
 }

test/DocumentFormat.OpenXml.Packaging.Tests/PartConstraintRuleTests.cs

@@ -3,15 +3,17 @@
 
 using DocumentFormat.OpenXml.Features;
 using DocumentFormat.OpenXml.Framework;
+using DocumentFormat.OpenXml.Framework.Tests;
 using DocumentFormat.OpenXml.Packaging;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
+using DocumentFormat.OpenXml.Packaging.Tests;
 using NSubstitute;
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using Xunit;
 
 namespace DocumentFormat.OpenXml.Tests
@@ -86,10 +88,9 @@ public void ValidatePart(Type partType)
             }
 
             Assert.NotNull(expectedConstraints.Parts);
-#if DEBUG
+
             _output.WriteObjectToTempFile("expected constraints", expectedConstraints.Parts.OrderBy(p => p.RelationshipType));
             _output.WriteObjectToTempFile("actual constraints", constraints.Rules.OrderBy(p => p.RelationshipType).Select(p => new PartConstraintRule2(p)));
-#endif
 
             Assert.Equal(
                 expectedConstraints.Parts.OrderBy(p => p.RelationshipType),
@@ -119,7 +120,13 @@ public void ExportData()
                 })
                 .OrderBy(d => d.Name, StringComparer.Ordinal);
 
-            _output.WriteObjectToTempFile("typed parts", result);
+            var output = _output.WriteObjectToTempFile("typed parts", result);
+
+            using (var expectedStream = typeof(ParticleTests).GetTypeInfo().Assembly.GetManifestResourceStream("DocumentFormat.OpenXml.Packaging.Tests.data.PartConstraintData.json"))
+            using (var actualStream = new FileStream(output, FileMode.Open, FileAccess.Read))
+            {
+                TestUtility.ValidateJsonFileContentsAreEqual(expectedStream!, actualStream);
+            }
         }
 
         public static IEnumerable<object[]> GetOpenXmlParts() => GetParts().Select(p => new[] { p });
@@ -134,9 +141,7 @@ private static IEnumerable<Type> GetParts() => typeof(SpreadsheetDocument)
 
         private static OpenXmlPart InitializePart(Type type)
         {
-#nullable disable
-            var part = (OpenXmlPart)Activator.CreateInstance(type, true);
-#nullable enable
+            var part = (OpenXmlPart)Activator.CreateInstance(type, true)!;
 
             var appType = Substitute.For<IApplicationTypeFeature>();
             appType.Type.Returns(ApplicationType.None);
@@ -148,7 +153,7 @@ private static OpenXmlPart InitializePart(Type type)
 
         private static ConstraintData GetConstraintData(OpenXmlPart part) => _cachedConstraintData.Value[part.GetType().FullName!];
 
-        private static Lazy<Dictionary<string, ConstraintData>> _cachedConstraintData = new Lazy<Dictionary<string, ConstraintData>>(() =>
+        private static readonly Lazy<Dictionary<string, ConstraintData>> _cachedConstraintData = new(() =>
         {
             var names = typeof(PartConstraintRuleTests).GetTypeInfo().Assembly.GetManifestResourceNames();
 
@@ -157,7 +162,15 @@ private static OpenXmlPart InitializePart(Type type)
             using (var reader = new StreamReader(stream!))
             {
 #nullable disable
-                return JsonConvert.DeserializeObject<ConstraintData[]>(reader.ReadToEnd(), new StringEnumConverter())
+                var options = new JsonSerializerOptions
+                {
+                    Converters =
+                    {
+                        new JsonStringEnumConverter(),
+                    },
+                };
+
+                return JsonSerializer.Deserialize<ConstraintData[]>(reader.ReadToEnd(), options)
                     .ToDictionary(t => t.Name, StringComparer.Ordinal);
 #nullable enable
             }