move from newtonsoft to system.text.json (#599)

madhon · YogeshPraj · web-flow · commit 95c63409c041 · 2024-08-23T01:54:31.000+01:00
Co-authored-by: YogeshPraj &lt;yoprajap@microsoft.com&gt;
diff --git a/benchmark/RulesEngineBenchmark/Program.cs b/benchmark/RulesEngineBenchmark/Program.cs
@@ -3,14 +3,15 @@
 
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Running;
-using Newtonsoft.Json;
 using RulesEngine.Models;
 using System;
 using System.Collections.Generic;
 using System.IO;
 
 namespace RulesEngineBenchmark
 {
+    using System.Text.Json;
+
     [MemoryDiagnoser]
     public class REBenchmark
     {
@@ -34,7 +35,7 @@ public REBenchmark()
             }
 
             var fileData = File.ReadAllText(files[0]);
-            workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
+            workflow = JsonSerializer.Deserialize<List<Workflow>>(fileData);
 
             rulesEngine = new RulesEngine.RulesEngine(workflow.ToArray(), new ReSettings {
                 EnableFormattedErrorMessage = false,
diff --git a/demo/DemoApp/EFDemo.cs b/demo/DemoApp/EFDemo.cs
@@ -2,8 +2,6 @@
 //  Licensed under the MIT License.
 
 using DemoApp.EFDataExample;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using RulesEngine.Models;
 using System;
 using System.Collections.Generic;
@@ -15,6 +13,8 @@
 
 namespace DemoApp
 {
+    using System.Text.Json;
+
     public class EFDemo
     {
         public void Run()
@@ -24,11 +24,9 @@ public void Run()
             var orderInfo = "{\"totalOrders\": 5,\"recurringItems\": 2}";
             var telemetryInfo = "{\"noOfVisitsPerMonth\": 10,\"percentageOfBuyingToVisit\": 15}";
 
-            var converter = new ExpandoObjectConverter();
-
-            dynamic input1 = JsonConvert.DeserializeObject<ExpandoObject>(basicInfo, converter);
-            dynamic input2 = JsonConvert.DeserializeObject<ExpandoObject>(orderInfo, converter);
-            dynamic input3 = JsonConvert.DeserializeObject<ExpandoObject>(telemetryInfo, converter);
+           dynamic input1 = JsonSerializer.Deserialize<ExpandoObject>(basicInfo);
+            dynamic input2 = JsonSerializer.Deserialize<ExpandoObject>(orderInfo);
+            dynamic input3 = JsonSerializer.Deserialize<ExpandoObject>(telemetryInfo);
 
             var inputs = new dynamic[]
                 {
@@ -42,7 +40,7 @@ public void Run()
                 throw new Exception("Rules not found.");
 
             var fileData = File.ReadAllText(files[0]);
-            var workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
+            var workflow = JsonSerializer.Deserialize<List<Workflow>>(fileData);
 
             RulesEngineDemoContext db = new RulesEngineDemoContext();
             if (db.Database.EnsureCreated())
diff --git a/demo/DemoApp/JSONDemo.cs b/demo/DemoApp/JSONDemo.cs
@@ -1,8 +1,6 @@
 ﻿// Copyright (c) Microsoft Corporation.
 //  Licensed under the MIT License.
 
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using RulesEngine.Models;
 using System;
 using System.Collections.Generic;
@@ -12,6 +10,8 @@
 
 namespace DemoApp
 {
+    using System.Text.Json;
+
     public class JSONDemo
     {
         public void Run()
@@ -21,11 +21,11 @@ public void Run()
             var orderInfo = "{\"totalOrders\": 5,\"recurringItems\": 2}";
             var telemetryInfo = "{\"noOfVisitsPerMonth\": 10,\"percentageOfBuyingToVisit\": 15}";
 
-            var converter = new ExpandoObjectConverter();
 
-            dynamic input1 = JsonConvert.DeserializeObject<ExpandoObject>(basicInfo, converter);
-            dynamic input2 = JsonConvert.DeserializeObject<ExpandoObject>(orderInfo, converter);
-            dynamic input3 = JsonConvert.DeserializeObject<ExpandoObject>(telemetryInfo, converter);
+
+            dynamic input1 = JsonSerializer.Deserialize<ExpandoObject>(basicInfo);
+            dynamic input2 = JsonSerializer.Deserialize<ExpandoObject>(orderInfo);
+            dynamic input3 = JsonSerializer.Deserialize<ExpandoObject>(telemetryInfo);
 
             var inputs = new dynamic[]
                 {
@@ -39,7 +39,7 @@ public void Run()
                 throw new Exception("Rules not found.");
 
             var fileData = File.ReadAllText(files[0]);
-            var workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
+            var workflow = JsonSerializer.Deserialize<List<Workflow>>(fileData);
 
             var bre = new RulesEngine.RulesEngine(workflow.ToArray(), null);
 
diff --git a/demo/DemoApp/NestedInputDemo.cs b/demo/DemoApp/NestedInputDemo.cs
@@ -1,7 +1,6 @@
 ﻿// Copyright (c) Microsoft Corporation.
 //  Licensed under the MIT License.
 
-using Newtonsoft.Json;
 using RulesEngine.Extensions;
 using RulesEngine.Models;
 using System;
@@ -10,6 +9,8 @@
 
 namespace DemoApp
 {
+    using System.Text.Json;
+
     internal class ListItem
     {
         public int Id { get; set; }
@@ -49,7 +50,7 @@ public void Run()
             }
 
             var fileData = File.ReadAllText(files[0]);
-            var Workflows = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
+            var Workflows = JsonSerializer.Deserialize<List<Workflow>>(fileData);
 
             var bre = new RulesEngine.RulesEngine(Workflows.ToArray(), null);
             foreach (var workflow in Workflows)
diff --git a/src/RulesEngine/Actions/ActionContext.cs b/src/RulesEngine/Actions/ActionContext.cs
@@ -1,13 +1,14 @@
 ﻿// Copyright (c) Microsoft Corporation.
 //  Licensed under the MIT License.
 
-using Newtonsoft.Json;
 using RulesEngine.Models;
 using System;
 using System.Collections.Generic;
 
 namespace RulesEngine.Actions
 {
+    using System.Text.Json;
+
     public class ActionContext
     {
         private readonly IDictionary<string, string> _context;
@@ -27,7 +28,7 @@ public ActionContext(IDictionary<string, object> context, RuleResultTree parentR
                         value =  kv.Value.ToString();
                         break;
                     default:
-                        value = JsonConvert.SerializeObject(kv.Value);
+                        value = JsonSerializer.Serialize(kv.Value);
                         break;
 
                 }
@@ -70,7 +71,7 @@ public T GetContext<T>(string name)
                 {
                     return (T)Convert.ChangeType(_context[name], typeof(T));
                 }
-                return JsonConvert.DeserializeObject<T>(_context[name]);
+                return JsonSerializer.Deserialize<T>(_context[name]);
             }
             catch (KeyNotFoundException)
             {
diff --git a/src/RulesEngine/Models/Rule.cs b/src/RulesEngine/Models/Rule.cs
@@ -1,13 +1,13 @@
 ﻿// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 
 namespace RulesEngine.Models
 {
+    using System.Text.Json.Serialization;
+
     /// <summary>
     /// Rule class
     /// </summary>
@@ -33,7 +33,7 @@ public class Rule
         /// </summary>
         public bool Enabled { get; set; } = true;
 
-        [JsonConverter(typeof(StringEnumConverter))]
+        [JsonConverter (typeof(JsonStringEnumConverter))]
         public RuleExpressionType RuleExpressionType { get; set; } = RuleExpressionType.LambdaExpression;
         public IEnumerable<string> WorkflowsToInject { get; set; }
         public IEnumerable<Rule> Rules { get; set; }
diff --git a/src/RulesEngine/Models/Workflow.cs b/src/RulesEngine/Models/Workflow.cs
@@ -1,8 +1,6 @@
 ﻿// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using Newtonsoft.Json.Converters;
-using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
diff --git a/src/RulesEngine/RulesEngine.cs b/src/RulesEngine/RulesEngine.cs
@@ -2,8 +2,6 @@
 // Licensed under the MIT License.
 
 using FluentValidation;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 using RulesEngine.Actions;
 using RulesEngine.Exceptions;
 using RulesEngine.ExpressionBuilders;
@@ -20,10 +18,13 @@
 
 namespace RulesEngine
 {
+    using System.Text.Json;
+    using System.Text.Json.Nodes;
+
     /// <summary>
     /// 
     /// </summary>
-    /// <seealso cref="RulesEngine.Interfaces.IRulesEngine" />
+    /// <seealso cref="IRulesEngine" />
     public class RulesEngine : IRulesEngine
     {
         #region Variables
@@ -38,7 +39,7 @@ public class RulesEngine : IRulesEngine
         #region Constructor
         public RulesEngine(string[] jsonConfig, ReSettings reSettings = null) : this(reSettings)
         {
-            var workflow = jsonConfig.Select(item => JsonConvert.DeserializeObject<Workflow>(item)).ToArray();
+            var workflow = jsonConfig.Select(item => JsonSerializer.Deserialize<Workflow>(item)).ToArray();
             AddWorkflow(workflow);
         }
 
@@ -403,7 +404,7 @@ private IEnumerable<RuleResultTree> FormatErrorMessages(IEnumerable<RuleResultTr
                             {
                                 var arrParams = inputs?.Select(c => new { Name = c.Key, c.Value });
                                 var model = arrParams?.Where(a => string.Equals(a.Name, property))?.FirstOrDefault();
-                                var value = model?.Value != null ? JsonConvert.SerializeObject(model?.Value) : null;
+                                var value = model?.Value != null ? JsonSerializer.Serialize(model?.Value) : null;
                                 errorMessage = errorMessage?.Replace($"$({property})", value ?? $"$({property})");
                             }
                         }
@@ -430,10 +431,10 @@ private static string UpdateErrorMessage(string errorMessage, IDictionary<string
             var model = arrParams?.Where(a => string.Equals(a.Name, typeName))?.FirstOrDefault();
             if (model != null)
             {
-                var modelJson = JsonConvert.SerializeObject(model?.Value);
-                var jObj = JObject.Parse(modelJson);
-                JToken jToken = null;
-                var val = jObj?.TryGetValue(propertyName, StringComparison.OrdinalIgnoreCase, out jToken);
+                var modelJson = JsonSerializer.Serialize(model?.Value);
+                var jObj = JsonObject.Parse(modelJson).AsObject();
+                JsonNode jToken = null;
+                var val = jObj?.TryGetPropertyValue(propertyName, out jToken);
                 errorMessage = errorMessage.Replace($"$({property})", jToken != null ? jToken?.ToString() : $"({property})");
             }
 
diff --git a/src/RulesEngine/RulesEngine.csproj b/src/RulesEngine/RulesEngine.csproj
@@ -33,15 +33,27 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="FastExpressionCompiler" Version="4.0.1" />
+    <PackageReference Include="FastExpressionCompiler" Version="4.1.0" />
     <PackageReference Include="FluentValidation" Version="11.9.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+
     <PackageReference Include="System.Linq.Dynamic.Core" Version="1.4.3" />
+
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <PackageReference Include="System.Text.Json" Version="6.0.9" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+    <PackageReference Include="System.Text.Json" Version="8.0.0" />
+  </ItemGroup>
+  
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
-    <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
+
+    <PackageReference Include="System.Text.Json" Version="8.0.0" />
+    <PackageReference Include="Microsoft.CSharp" Version="4.7.0"/>
+
   </ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,14 @@`
`1`	`1`	`// Copyright (c) Microsoft Corporation.`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`		`-using Newtonsoft.Json;`
`5`	`4`	`using RulesEngine.Models;`
`6`	`5`	`using System;`
`7`	`6`	`using System.Collections.Generic;`
`8`	`7`
`9`	`8`	`namespace RulesEngine.Actions`
`10`	`9`	`{`
	`10`	`+ using System.Text.Json;`
	`11`	`+`
`11`	`12`	`public class ActionContext`
`12`	`13`	`{`
`13`	`14`	`private readonly IDictionary<string, string> _context;`
`@@ -27,7 +28,7 @@ public ActionContext(IDictionary<string, object> context, RuleResultTree parentR`
`27`	`28`	`value = kv.Value.ToString();`
`28`	`29`	`break;`
`29`	`30`	`default:`
`30`		`- value = JsonConvert.SerializeObject(kv.Value);`
	`31`	`+ value = JsonSerializer.Serialize(kv.Value);`
`31`	`32`	`break;`
`32`	`33`
`33`	`34`	`}`
`@@ -70,7 +71,7 @@ public T GetContext<T>(string name)`
`70`	`71`	`{`
`71`	`72`	`return (T)Convert.ChangeType(_context[name], typeof(T));`
`72`	`73`	`}`
`73`		`- return JsonConvert.DeserializeObject<T>(_context[name]);`
	`74`	`+ return JsonSerializer.Deserialize<T>(_context[name]);`
`74`	`75`	`}`
`75`	`76`	`catch (KeyNotFoundException)`
`76`	`77`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,6 @@`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`	`4`	`using FluentValidation;`
`5`		`-using Newtonsoft.Json;`
`6`		`-using Newtonsoft.Json.Linq;`
`7`	`5`	`using RulesEngine.Actions;`
`8`	`6`	`using RulesEngine.Exceptions;`
`9`	`7`	`using RulesEngine.ExpressionBuilders;`
`@@ -20,10 +18,13 @@`
`20`	`18`
`21`	`19`	`namespace RulesEngine`
`22`	`20`	`{`
	`21`	`+ using System.Text.Json;`
	`22`	`+ using System.Text.Json.Nodes;`
	`23`	`+`
`23`	`24`	`/// <summary>`
`24`	`25`	`///`
`25`	`26`	`/// </summary>`
`26`		`- /// <seealso cref="RulesEngine.Interfaces.IRulesEngine" />`
	`27`	`+ /// <seealso cref="IRulesEngine" />`
`27`	`28`	`public class RulesEngine : IRulesEngine`
`28`	`29`	`{`
`29`	`30`	`#region Variables`
`@@ -38,7 +39,7 @@ public class RulesEngine : IRulesEngine`
`38`	`39`	`#region Constructor`
`39`	`40`	`public RulesEngine(string[] jsonConfig, ReSettings reSettings = null) : this(reSettings)`
`40`	`41`	`{`
`41`		`- var workflow = jsonConfig.Select(item => JsonConvert.DeserializeObject<Workflow>(item)).ToArray();`
	`42`	`+ var workflow = jsonConfig.Select(item => JsonSerializer.Deserialize<Workflow>(item)).ToArray();`
`42`	`43`	`AddWorkflow(workflow);`
`43`	`44`	`}`
`44`	`45`
`@@ -403,7 +404,7 @@ private IEnumerable<RuleResultTree> FormatErrorMessages(IEnumerable<RuleResultTr`
`403`	`404`	`{`
`404`	`405`	`var arrParams = inputs?.Select(c => new { Name = c.Key, c.Value });`
`405`	`406`	`var model = arrParams?.Where(a => string.Equals(a.Name, property))?.FirstOrDefault();`
`406`		`- var value = model?.Value != null ? JsonConvert.SerializeObject(model?.Value) : null;`
	`407`	`+ var value = model?.Value != null ? JsonSerializer.Serialize(model?.Value) : null;`
`407`	`408`	`errorMessage = errorMessage?.Replace($"$({property})", value ?? $"$({property})");`
`408`	`409`	`}`
`409`	`410`	`}`
`@@ -430,10 +431,10 @@ private static string UpdateErrorMessage(string errorMessage, IDictionary<string`
`430`	`431`	`var model = arrParams?.Where(a => string.Equals(a.Name, typeName))?.FirstOrDefault();`
`431`	`432`	`if (model != null)`
`432`	`433`	`{`
`433`		`- var modelJson = JsonConvert.SerializeObject(model?.Value);`
`434`		`- var jObj = JObject.Parse(modelJson);`
`435`		`- JToken jToken = null;`
`436`		`- var val = jObj?.TryGetValue(propertyName, StringComparison.OrdinalIgnoreCase, out jToken);`
	`434`	`+ var modelJson = JsonSerializer.Serialize(model?.Value);`
	`435`	`+ var jObj = JsonObject.Parse(modelJson).AsObject();`
	`436`	`+ JsonNode jToken = null;`
	`437`	`+ var val = jObj?.TryGetPropertyValue(propertyName, out jToken);`
`437`	`438`	`errorMessage = errorMessage.Replace($"$({property})", jToken != null ? jToken?.ToString() : $"({property})");`
`438`	`439`	`}`
`439`	`440`