Replace Newtonsoft.Json with System.Text.Json (#109)

sommmen · web-flow · commit 86af828bdc3d · 2024-01-26T16:23:36.000+01:00
* Removed package, now builds. - IgnoreNullValues is obsolete, i kept is because it IgnoreCondition is >net7 - Removed package from core, and readded package in MongoDbProvider, only used there. Test project(s) still use newtonsoft.json, but we can evaluate this later. * feat(error): Fix test and use problem details - https://andrewlock.net/creating-a-custom-error-handler-middleware-function/ * chore: Replace jsonnet with stj in test projects. ---------
diff --git a/src/Serilog.Ui.Core/Serilog.Ui.Core.csproj b/src/Serilog.Ui.Core/Serilog.Ui.Core.csproj
@@ -8,6 +8,5 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
-		<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 	</ItemGroup>
 </Project>
diff --git a/src/Serilog.Ui.MongoDbProvider/Serilog.Ui.MongoDbProvider.csproj b/src/Serilog.Ui.MongoDbProvider/Serilog.Ui.MongoDbProvider.csproj
@@ -9,6 +9,7 @@
 	<ItemGroup>
 		<PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
 		<PackageReference Include="MongoDB.Driver" Version="2.21.0" />
+		<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 	</ItemGroup>
 
 	<ItemGroup>
diff --git a/src/Serilog.Ui.Web/Endpoints/SerilogUiAppRoutes.cs b/src/Serilog.Ui.Web/Endpoints/SerilogUiAppRoutes.cs
@@ -1,23 +1,22 @@
 ﻿using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
-using Newtonsoft.Json;
+using System.Text.Json;
 using System;
 using System.IO;
 using System.Text;
 using System.Threading.Tasks;
-using Newtonsoft.Json.Serialization;
 using Ardalis.GuardClauses;
 
 namespace Serilog.Ui.Web.Endpoints
 {
     internal class SerilogUiAppRoutes : ISerilogUiAppRoutes
     {
-        private static readonly JsonSerializerSettings _jsonSerializerOptions = new()
+        private static readonly JsonSerializerOptions JsonSerializerOptions = new()
         {
-            NullValueHandling = NullValueHandling.Ignore,
-            ContractResolver = new CamelCasePropertyNamesContractResolver(),
-            Formatting = Formatting.None
+            IgnoreNullValues = true,
+            PropertyNamingPolicy = JsonNamingPolicy.CamelCase
         };
+
         private readonly IAppStreamLoader _streamLoader;
 
         public SerilogUiAppRoutes(IAppStreamLoader appStreamLoader)
@@ -67,7 +66,7 @@ private static async Task<string> LoadStream(Stream stream, UiOptions options)
         {
             var htmlStringBuilder = new StringBuilder(await new StreamReader(stream).ReadToEndAsync());
             var authType = options.Authorization.AuthenticationType.ToString();
-            var encodeAuthOpts = Uri.EscapeDataString(JsonConvert.SerializeObject(new { options.RoutePrefix, authType, options.HomeUrl }, _jsonSerializerOptions));
+            var encodeAuthOpts = Uri.EscapeDataString(JsonSerializer.Serialize(new { options.RoutePrefix, authType, options.HomeUrl }, JsonSerializerOptions));
 
             htmlStringBuilder
                 .Replace("%(Configs)", encodeAuthOpts)
diff --git a/src/Serilog.Ui.Web/Endpoints/SerilogUiEndpoints.cs b/src/Serilog.Ui.Web/Endpoints/SerilogUiEndpoints.cs
@@ -1,26 +1,26 @@
 ﻿using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Serialization;
+using System.Text.Json;
 using Serilog.Ui.Core;
 using System;
 using System.Globalization;
 using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
 
 namespace Serilog.Ui.Web.Endpoints
 {
     internal class SerilogUiEndpoints : ISerilogUiEndpoints
     {
         private readonly ILogger<SerilogUiEndpoints> _logger;
-        private static readonly JsonSerializerSettings _jsonSerializerOptions = new()
+        private static readonly JsonSerializerOptions JsonSerializerOptions = new()
         {
-            NullValueHandling = NullValueHandling.Ignore,
-            ContractResolver = new CamelCasePropertyNamesContractResolver(),
-            Formatting = Formatting.None
+            IgnoreNullValues = true,
+            PropertyNamingPolicy = JsonNamingPolicy.CamelCase
         };
+
         private string[] _providerKeys;
 
         public SerilogUiEndpoints(ILogger<SerilogUiEndpoints> logger)
@@ -41,7 +41,7 @@ public async Task GetApiKeysAsync(HttpContext httpContext)
                     _providerKeys = aggregateDataProvider.Keys.ToArray();
                 }
 
-                var result = JsonConvert.SerializeObject(_providerKeys);
+                var result = JsonSerializer.Serialize(_providerKeys, JsonSerializerOptions);
                 httpContext.Response.StatusCode = (int)HttpStatusCode.OK;
                 await httpContext.Response.WriteAsync(result);
             }
@@ -85,7 +85,7 @@ private static async Task<string> FetchLogsAsync(HttpContext httpContext)
 
             var (logs, total) = await provider.FetchDataAsync(currentPage, count, level, textSearch, start, end);
 
-            var result = JsonConvert.SerializeObject(new { logs, total, count, currentPage }, _jsonSerializerOptions);
+            var result = JsonSerializer.Serialize(new { logs, total, count, currentPage }, JsonSerializerOptions);
 
             return result;
         }
@@ -113,16 +113,38 @@ private static (int currPage, int count, string dbKey, string level, string text
             return (currentPage, currentCount, keyStr, levelStr, searchStr, outputStartDate, outputEndDate);
         }
 
+        /// <summary>
+        /// Returns an industry standard ProblemDetails object.
+        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7807"/>
+        /// </summary>
+        /// <param name="httpContext"></param>
+        /// <param name="ex"></param>
+        /// <returns></returns>
         private Task OnError(HttpContext httpContext, Exception ex)
         {
             _logger.LogError(ex, "@Message", ex.Message);
-            httpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
 
-            var errorMessage = httpContext.Request.IsLocal()
-                ? JsonConvert.SerializeObject(new { errorMessage = ex.Message })
-                : JsonConvert.SerializeObject(new { errorMessage = "Internal server error" });
+            httpContext.Response.StatusCode = (int) HttpStatusCode.InternalServerError;
+            httpContext.Response.ContentType = "application/problem+json";
+
+            var includeDetails = httpContext.Request.IsLocal();
+
+            var title = includeDetails ? "An error occured: " + ex.Message : "An error occured";
+            var details = includeDetails ? ex.ToString() : null;
+
+            var problem = new ProblemDetails
+            {
+                Status = httpContext.Response.StatusCode,
+                Title = title,
+                Detail = details,
+                Extensions =
+                {
+                    ["traceId"] = httpContext.TraceIdentifier
+                }
+            };
 
-            return httpContext.Response.WriteAsync(JsonConvert.SerializeObject(new { errorMessage }));
+            var stream = httpContext.Response.Body;
+            return JsonSerializer.SerializeAsync(stream, problem);
         }
     }
 }
diff --git a/src/Serilog.Ui.Web/Serilog.UI.nuspec b/src/Serilog.Ui.Web/Serilog.UI.nuspec
@@ -19,25 +19,21 @@
 			<group targetFramework=".NETCoreApp3.1">
 				<dependency id="Ardalis.GuardClauses" version="4.0.1" exclude="Build,Analyzers" />
 				<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="3.1.3" exclude="Build,Analyzers" />
-				<dependency id="Newtonsoft.Json" version="13.0.3" exclude="Build,Analyzers" />
 				<dependency id="Scrutor" version="4.2.2" exclude="Build,Analyzers" />
 			</group>
 			<group targetFramework=".NET5.0">
 				<dependency id="Ardalis.GuardClauses" version="4.0.1" exclude="Build,Analyzers" />
 				<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="5.0.0" exclude="Build,Analyzers" />
-				<dependency id="Newtonsoft.Json" version="13.0.3" exclude="Build,Analyzers" />
 				<dependency id="Scrutor" version="4.2.2" exclude="Build,Analyzers" />
 			</group>
 			<group targetFramework=".NET6.0">
 				<dependency id="Ardalis.GuardClauses" version="4.0.1" exclude="Build,Analyzers" />
 				<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="6.0.0" exclude="Build,Analyzers" />
-				<dependency id="Newtonsoft.Json" version="13.0.3" exclude="Build,Analyzers" />
 				<dependency id="Scrutor" version="4.2.2" exclude="Build,Analyzers" />
 			</group>
 			<group targetFramework=".NET7.0">
 				<dependency id="Ardalis.GuardClauses" version="4.0.1" exclude="Build,Analyzers" />
 				<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="7.0.0" exclude="Build,Analyzers" />
-				<dependency id="Newtonsoft.Json" version="13.0.3" exclude="Build,Analyzers" />
 				<dependency id="Scrutor" version="4.2.2" exclude="Build,Analyzers" />
 			</group>
 		</dependencies>
diff --git a/tests/Serilog.Ui.Common.Tests/DataSamples/LogModelFaker.cs b/tests/Serilog.Ui.Common.Tests/DataSamples/LogModelFaker.cs
@@ -1,5 +1,4 @@
 ﻿using Bogus;
-using Newtonsoft.Json;
 using Serilog.Ui.Core;
 using System;
 using System.Collections.Generic;
@@ -22,7 +21,7 @@ private static Faker<LogModel> LogsRules()
              .RuleFor(p => p.RowNo, f => f.Database.Random.Int())
              .RuleFor(p => p.Level, f => f.PickRandom(LogLevels))
              .RuleFor(p => p.Properties, PropertiesFaker.SerializedProperties)
-             .RuleFor(p => p.Exception, (f) => JsonConvert.SerializeObject(f.System.Exception()))
+             .RuleFor(p => p.Exception, (f) => f.System.Exception().ToString())
              .RuleFor(p => p.Message, f => f.System.Random.Words(6))
              .RuleFor(p => p.PropertyType, f => f.System.CommonFileType())
              .RuleFor(p => p.Timestamp, f => new DateTime(f.Date.Recent().Ticks, DateTimeKind.Utc));
diff --git a/tests/Serilog.Ui.Common.Tests/DataSamples/LogModelPropsCollector.cs b/tests/Serilog.Ui.Common.Tests/DataSamples/LogModelPropsCollector.cs
@@ -8,6 +8,11 @@ namespace Serilog.Ui.Common.Tests.DataSamples
     public class LogModelPropsCollector
     {
         public LogModelPropsCollector(IEnumerable<LogModel> models)
+            : this(models.ToList())
+        {
+        }
+
+        public LogModelPropsCollector(ICollection<LogModel> models)
         {
             DataSet = models.ToList();
             Collect(models);
@@ -19,7 +24,7 @@ public LogModelPropsCollector(IEnumerable<LogModel> models)
         public IEnumerable<DateTime> TimesSamples { get; private set; }
         public IEnumerable<string> MessagePiecesSamples { get; private set; }
 
-        private void Collect(IEnumerable<LogModel> models)
+        private void Collect(ICollection<LogModel> models)
         {
             Example = models.First();
 
@@ -29,15 +34,15 @@ private void Collect(IEnumerable<LogModel> models)
 
             MessagePiecesSamples = new List<string>
             {
-                models.ElementAtOrDefault(0).Message,
-                models.ElementAtOrDefault(1).Message.Substring(1, models.ElementAtOrDefault(1).Message.Length / 2),
-                models.ElementAtOrDefault(2).Message.Substring(1, models.ElementAtOrDefault(2).Message.Length / 2),
+                models.ElementAt(0).Message,
+                models.ElementAt(1).Message.Substring(1, models.ElementAt(1).Message.Length / 2),
+                models.ElementAt(2).Message.Substring(1, models.ElementAt(2).Message.Length / 2),
             };
             TimesSamples = new List<DateTime>
             {
-                models.ElementAtOrDefault(0).Timestamp,
-                models.ElementAtOrDefault(1).Timestamp,
-                models.ElementAtOrDefault(2).Timestamp,
+                models.ElementAt(0).Timestamp,
+                models.ElementAt(1).Timestamp,
+                models.ElementAt(2).Timestamp,
             }.OrderBy(p => p.Ticks);
         }
     }
diff --git a/tests/Serilog.Ui.Common.Tests/DataSamples/MongoDbLogModelFaker.cs b/tests/Serilog.Ui.Common.Tests/DataSamples/MongoDbLogModelFaker.cs
@@ -1,29 +1,37 @@
 ﻿using MongoDB.Bson;
-using Newtonsoft.Json;
 using Serilog.Ui.Common.Tests.FakeObjectModels;
 using Serilog.Ui.MongoDbProvider;
-using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text.Json;
+using Bogus;
 
 namespace Serilog.Ui.Common.Tests.DataSamples
 {
     public static class MongoDbLogModelFaker
     {
         public static (IEnumerable<MongoDbLogModel> logs, LogModelPropsCollector collector) Logs(int generationCount)
         {
-            var originalLogs = LogModelFaker.Logs(generationCount);
+            var originalLogs = LogModelFaker.Logs(generationCount)
+                .ToList();
+
             var modelCollector = new LogModelPropsCollector(originalLogs);
-            return (originalLogs.Select(p => new MongoDbLogModel
+
+            var faker = new Faker();
+            
+            var logs = originalLogs.Select(p => new MongoDbLogModel
             {
                 Id = p.RowNo,
                 Level = p.Level,
                 RenderedMessage = p.Message,
                 Timestamp = p.Timestamp,
                 UtcTimeStamp = p.Timestamp.ToUniversalTime(),
-                Properties = JsonConvert.DeserializeObject<Properties>(p.Properties),
-                Exception = JsonConvert.DeserializeObject<Exception>(p.Exception).ToBsonDocument(),
-            }), modelCollector);
+                Properties = JsonSerializer.Deserialize<Properties>(p.Properties),
+                Exception = faker.System.Exception() // Serialization round-trip not possible for an exception, so we generate a new exception.
+                    .ToBsonDocument(),
+            });
+
+            return (logs, modelCollector);
         }
 
         public static (IEnumerable<MongoDbLogModel> logs, LogModelPropsCollector collector) Logs() => Logs(20);
diff --git a/tests/Serilog.Ui.Common.Tests/DataSamples/PropertiesFaker.cs b/tests/Serilog.Ui.Common.Tests/DataSamples/PropertiesFaker.cs
@@ -1,16 +1,16 @@
-﻿using Bogus;
+﻿using System.Text.Json;
+using Bogus;
 using Microsoft.Extensions.Logging;
-using Newtonsoft.Json;
 using Serilog.Ui.Common.Tests.FakeObjectModels;
 
 namespace Serilog.Ui.Common.Tests.DataSamples
 {
     internal static class PropertiesFaker
     {
-        internal static Faker<Properties> Properties = new Faker<Properties>()
-            .RuleFor(p => p.EventId, f => JsonConvert.SerializeObject(new EventId(f.Random.Int(), f.Hacker.Noun())))
+        private static readonly Faker<Properties> Properties = new Faker<Properties>()
+            .RuleFor(p => p.EventId, f => new EventId(f.Random.Int(), f.Hacker.Noun()))
             .RuleForType(typeof(string), p => p.System.Random.Words(3));
 
-        internal static string SerializedProperties = JsonConvert.SerializeObject(Properties.Generate());
+        internal static readonly string SerializedProperties = JsonSerializer.Serialize(Properties.Generate());
     }
 }
diff --git a/tests/Serilog.Ui.Common.Tests/FakeObjectModels/Properties.cs b/tests/Serilog.Ui.Common.Tests/FakeObjectModels/Properties.cs
@@ -1,13 +1,42 @@
-﻿namespace Serilog.Ui.Common.Tests.FakeObjectModels
+﻿using System;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using System.Text.Json.Serialization;
+using Microsoft.Extensions.Logging;
+
+namespace Serilog.Ui.Common.Tests.FakeObjectModels
 {
     internal class Properties
     {
         public string SourceContext { get; set; }
 
-        public object EventId { get; set; }
+        [JsonConverter(typeof(EventIdConverter))]
+        public EventId EventId { get; set; }
 
         public string Protocol { get; set; }
 
         public string Host { get; set; }
     }
+
+    /// <summary>
+    /// A custom converter for the <see cref="EventId"/> class, since constructing an immutable struct type is not supported when [JsonConstructor] is not used.
+    /// See: <see href="https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/immutability"/>
+    /// </summary>
+    internal class EventIdConverter : JsonConverter<EventId>
+    {
+        public override EventId Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+        {
+            var obj = (JsonObject) JsonNode.Parse(ref reader) ?? throw new JsonException();
+
+            var id = (obj[nameof(EventId.Id)] ?? throw new JsonException()).GetValue<int>();
+            var name = (obj[nameof(EventId.Name)] ?? throw new JsonException()).GetValue<string>();
+            return new EventId(id, name);
+        }
+
+        public override void Write(Utf8JsonWriter writer, EventId value, JsonSerializerOptions options)
+        {
+            // STJ handles writing fine, so we just delegate to the default implementation.
+            ((JsonConverter<EventId>)JsonSerializerOptions.Default.GetConverter(typeof(EventId))).Write(writer, value, options);
+        }
+    }
 }
diff --git a/tests/Serilog.Ui.PostgreSqlProvider.Tests/Util/PostgresTestProvider.cs b/tests/Serilog.Ui.PostgreSqlProvider.Tests/Util/PostgresTestProvider.cs
@@ -42,7 +42,8 @@ protected override async Task CheckDbReadinessAsync()
 
         protected override async Task InitializeAdditionalAsync()
         {
-            var logs = LogModelFaker.Logs(100);
+            var logs = LogModelFaker.Logs(100)
+                .ToList();
 
             // manual conversion due to current implementation, based on a INT level column
             var postgresTableLogs = logs.Select(p => new
diff --git a/tests/Serilog.Ui.Web.Tests/Endpoints/SerilogUiEndpointsTest.cs b/tests/Serilog.Ui.Web.Tests/Endpoints/SerilogUiEndpointsTest.cs
diff --git a/tests/Serilog.Ui.Web.Tests/Utilities/InMemoryDataProvider/InMemoryDataProvider.cs b/tests/Serilog.Ui.Web.Tests/Utilities/InMemoryDataProvider/InMemoryDataProvider.cs

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,11 @@ namespace Serilog.Ui.Common.Tests.DataSamples`
`8`	`8`	`public class LogModelPropsCollector`
`9`	`9`	`{`
`10`	`10`	`public LogModelPropsCollector(IEnumerable<LogModel> models)`
	`11`	`+ : this(models.ToList())`
	`12`	`+ {`
	`13`	`+ }`
	`14`	`+`
	`15`	`+ public LogModelPropsCollector(ICollection<LogModel> models)`
`11`	`16`	`{`
`12`	`17`	`DataSet = models.ToList();`
`13`	`18`	`Collect(models);`
`@@ -19,7 +24,7 @@ public LogModelPropsCollector(IEnumerable<LogModel> models)`
`19`	`24`	`public IEnumerable<DateTime> TimesSamples { get; private set; }`
`20`	`25`	`public IEnumerable<string> MessagePiecesSamples { get; private set; }`
`21`	`26`
`22`		`- private void Collect(IEnumerable<LogModel> models)`
	`27`	`+ private void Collect(ICollection<LogModel> models)`
`23`	`28`	`{`
`24`	`29`	`Example = models.First();`
`25`	`30`
`@@ -29,15 +34,15 @@ private void Collect(IEnumerable<LogModel> models)`
`29`	`34`
`30`	`35`	`MessagePiecesSamples = new List<string>`
`31`	`36`	`{`
`32`		`- models.ElementAtOrDefault(0).Message,`
`33`		`- models.ElementAtOrDefault(1).Message.Substring(1, models.ElementAtOrDefault(1).Message.Length / 2),`
`34`		`- models.ElementAtOrDefault(2).Message.Substring(1, models.ElementAtOrDefault(2).Message.Length / 2),`
	`37`	`+ models.ElementAt(0).Message,`
	`38`	`+ models.ElementAt(1).Message.Substring(1, models.ElementAt(1).Message.Length / 2),`
	`39`	`+ models.ElementAt(2).Message.Substring(1, models.ElementAt(2).Message.Length / 2),`
`35`	`40`	`};`
`36`	`41`	`TimesSamples = new List<DateTime>`
`37`	`42`	`{`
`38`		`- models.ElementAtOrDefault(0).Timestamp,`
`39`		`- models.ElementAtOrDefault(1).Timestamp,`
`40`		`- models.ElementAtOrDefault(2).Timestamp,`
	`43`	`+ models.ElementAt(0).Timestamp,`
	`44`	`+ models.ElementAt(1).Timestamp,`
	`45`	`+ models.ElementAt(2).Timestamp,`
`41`	`46`	`}.OrderBy(p => p.Ticks);`
`42`	`47`	`}`
`43`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`		`-using Bogus;`
	`1`	`+using System.Text.Json;`
	`2`	`+using Bogus;`
`2`	`3`	`using Microsoft.Extensions.Logging;`
`3`		`-using Newtonsoft.Json;`
`4`	`4`	`using Serilog.Ui.Common.Tests.FakeObjectModels;`
`5`	`5`
`6`	`6`	`namespace Serilog.Ui.Common.Tests.DataSamples`
`7`	`7`	`{`
`8`	`8`	`internal static class PropertiesFaker`
`9`	`9`	`{`
`10`		`- internal static Faker<Properties> Properties = new Faker<Properties>()`
`11`		`- .RuleFor(p => p.EventId, f => JsonConvert.SerializeObject(new EventId(f.Random.Int(), f.Hacker.Noun())))`
	`10`	`+ private static readonly Faker<Properties> Properties = new Faker<Properties>()`
	`11`	`+ .RuleFor(p => p.EventId, f => new EventId(f.Random.Int(), f.Hacker.Noun()))`
`12`	`12`	`.RuleForType(typeof(string), p => p.System.Random.Words(3));`
`13`	`13`
`14`		`- internal static string SerializedProperties = JsonConvert.SerializeObject(Properties.Generate());`
	`14`	`+ internal static readonly string SerializedProperties = JsonSerializer.Serialize(Properties.Generate());`
`15`	`15`	`}`
`16`	`16`	`}`