Moving to System.Text.Json (#314)

Ellerbach · web-flow · commit b56ec8bf4219 · 2025-02-14T11:11:26.000Z
diff --git a/nanoFirmwareFlasher.Library/CloudsmithPackageInfo.cs b/nanoFirmwareFlasher.Library/CloudsmithPackageInfo.cs
@@ -3,24 +3,24 @@
 // See LICENSE file in the project root for full license information.
 //
 
-using Newtonsoft.Json;
 using System;
+using System.Text.Json.Serialization;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
     [Serializable]
     internal class CloudsmithPackageInfo
     {
-        [JsonProperty("version")]
+        [JsonPropertyName("version")]
         public string Version { get; set; }
 
-        [JsonProperty("cdn_url")]
+        [JsonPropertyName("cdn_url")]
         public string DownloadUrl { get; set; }
 
-        [JsonProperty("name")]
+        [JsonPropertyName("name")]
         public string TargetName { get; set; }
 
-        [JsonProperty("uploaded_at")]
+        [JsonPropertyName("uploaded_at")]
         public DateTime PackageDate { get; set; }
     }
 }
diff --git a/nanoFirmwareFlasher.Library/FileDeployment/FileDeploymentManager.cs b/nanoFirmwareFlasher.Library/FileDeployment/FileDeploymentManager.cs
@@ -3,11 +3,11 @@
 
 using System;
 using System.IO;
+using System.Text.Json;
 using System.Threading.Tasks;
 using nanoFramework.Tools.Debugger;
 using nanoFramework.Tools.Debugger.Extensions;
 using nanoFramework.Tools.FirmwareFlasher.DeploymentHelpers;
-using Newtonsoft.Json;
 
 namespace nanoFramework.Tools.FirmwareFlasher.FileDeployment
 {
@@ -25,7 +25,12 @@ public class FileDeploymentManager
         /// </summary>
         public FileDeploymentManager(string configFilePath, string originalPort, VerbosityLevel verbosity)
         {
-            _configuration = JsonConvert.DeserializeObject<FileDeploymentConfiguration>(File.ReadAllText(configFilePath));
+            var options = new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+            };
+
+            _configuration = JsonSerializer.Deserialize<FileDeploymentConfiguration>(File.ReadAllText(configFilePath), options);
             _serialPort = string.IsNullOrEmpty(_configuration.SerialPort) ? originalPort : _configuration.SerialPort;
             _verbosity = verbosity;
         }
diff --git a/nanoFirmwareFlasher.Library/FirmwareArchiveManager.cs b/nanoFirmwareFlasher.Library/FirmwareArchiveManager.cs
@@ -4,8 +4,8 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Text.Json;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
@@ -55,7 +55,12 @@ public List<CloudSmithPackageDetail> GetTargetList(
             {
                 foreach (string filePath in Directory.EnumerateFiles(_archivePath, $"*{INFOFILE_EXTENSION}"))
                 {
-                    PersistedPackageInformation packageInformation = JsonConvert.DeserializeObject<PersistedPackageInformation>(File.ReadAllText(filePath));
+                    var options = new JsonSerializerOptions
+                    {
+                        PropertyNameCaseInsensitive = true,
+                    };
+
+                    PersistedPackageInformation packageInformation = JsonSerializer.Deserialize<PersistedPackageInformation>(File.ReadAllText(filePath), options);
                     if (packageInformation.IsPreview == preview &&
                         (platform is null || platform.Value.ToString().Equals(packageInformation.Platform, StringComparison.OrdinalIgnoreCase)))
                     {
@@ -83,7 +88,7 @@ public CloudSmithPackageDetail GetLatestVersion(
             {
                 foreach (string filePath in Directory.EnumerateFiles(_archivePath, $"{target}-*{INFOFILE_EXTENSION}"))
                 {
-                    PersistedPackageInformation packageInformation = JsonConvert.DeserializeObject<PersistedPackageInformation>(File.ReadAllText(filePath));
+                    PersistedPackageInformation packageInformation = JsonSerializer.Deserialize<PersistedPackageInformation>(File.ReadAllText(filePath));
                     if (packageInformation is not null && packageInformation.IsPreview == preview)
                     {
                         if (Version.TryParse(packageInformation.Version, out Version version))
@@ -192,7 +197,7 @@ public async Task<ExitCodes> DownloadFirmwareFromRepository(
                 };
                 File.WriteAllText(
                     $"{(fwFilePath.EndsWith(".zip") ? fwFilePath : Path.GetDirectoryName(fwFilePath))}{INFOFILE_EXTENSION}",
-                    JsonConvert.SerializeObject(packageInformation)
+                    JsonSerializer.Serialize(packageInformation)
                 );
             }
             return result;
diff --git a/nanoFirmwareFlasher.Library/FirmwarePackage.cs b/nanoFirmwareFlasher.Library/FirmwarePackage.cs
@@ -8,12 +8,12 @@
 using System.Linq;
 using System.Net.Http;
 using System.Reflection;
+using System.Text.Json;
 using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.ApplicationInsights.DataContracts;
 using nanoFramework.Tools.Debugger;
-using Newtonsoft.Json;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
@@ -198,7 +198,12 @@ public static List<CloudSmithPackageDetail> GetTargetList(
                 return targetPackages;
             }
 
-            List<CloudSmithPackageDetailJson> deserializedPackages = JsonConvert.DeserializeObject<List<CloudSmithPackageDetailJson>>(responseBody);
+            var options = new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+            };
+
+            List<CloudSmithPackageDetailJson> deserializedPackages = JsonSerializer.Deserialize<List<CloudSmithPackageDetailJson>>(responseBody, options);
             targetPackages.AddRange(from p in deserializedPackages
                                     select new CloudSmithPackageDetail()
                                     {
@@ -660,7 +665,7 @@ private static async Task<DownloadUrlResult> GetDownloadUrlAsync(
                 else
                 {
                     // parse response
-                    packageInfo = JsonConvert.DeserializeObject<List<CloudsmithPackageInfo>>(responseBody);
+                    packageInfo = JsonSerializer.Deserialize<List<CloudsmithPackageInfo>>(responseBody);
 
                     // sanity check
                     if (packageInfo.Count != 1)
diff --git a/nanoFirmwareFlasher.Library/NetworkDeployment/NetworkDeploymentManager.cs b/nanoFirmwareFlasher.Library/NetworkDeployment/NetworkDeploymentManager.cs
@@ -5,11 +5,11 @@
 using System.IO;
 using System.Net;
 using System.Text;
+using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using nanoFramework.Tools.Debugger;
 using nanoFramework.Tools.FirmwareFlasher.DeploymentHelpers;
-using Newtonsoft.Json;
 
 namespace nanoFramework.Tools.FirmwareFlasher.NetworkDeployment
 {
@@ -30,7 +30,12 @@ public class NetworkDeploymentManager
         /// <param name="verbosity">The verbosity level.</param>
         public NetworkDeploymentManager(string configFilePath, string originalPort, VerbosityLevel verbosity)
         {
-            _configuration = JsonConvert.DeserializeObject<NetworkDeploymentConfiguration>(File.ReadAllText(configFilePath));
+            var options = new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+            };
+
+            _configuration = JsonSerializer.Deserialize<NetworkDeploymentConfiguration>(File.ReadAllText(configFilePath), options);
             _serialPort = string.IsNullOrEmpty(_configuration.SerialPort) ? originalPort : _configuration.SerialPort;
             _verbosity = verbosity;
         }
@@ -299,10 +304,10 @@ public async Task<ExitCodes> DeployAsync()
                     // Read the device certificates from the file
                     deviceCertificatesBytes = File.ReadAllBytes(_configuration.DeviceCertificatesPath);
                 }
-
-                CheckNullPemTermination(deviceCertificatesBytes);
+                
                 if (deviceCertificatesBytes != null)
                 {
+                    CheckNullPemTermination(deviceCertificatesBytes);
                     // deploy the client certificates
                     OutputWriter.Write($"Updating client certificates...");
                     var clientCertificates = device.DebugEngine.GetAllX509DeviceCertificates();
@@ -339,10 +344,10 @@ public async Task<ExitCodes> DeployAsync()
                     // Read the CA certificates from the file
                     caCertificatesBytes = File.ReadAllBytes(_configuration.CACertificatesPath);
                 }
-
-                CheckNullPemTermination(caCertificatesBytes);
+                
                 if (caCertificatesBytes != null)
                 {
+                    CheckNullPemTermination(caCertificatesBytes);
                     // deploy the client certificates
                     OutputWriter.Write($"Updating client certificates...");
                     var caCertificates = device.DebugEngine.GetAllX509Certificates();
diff --git a/nanoFirmwareFlasher.Library/nanoFirmwareFlasher.Library.csproj b/nanoFirmwareFlasher.Library/nanoFirmwareFlasher.Library.csproj
@@ -63,7 +63,6 @@
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.1" />
     <PackageReference Include="nanoFramework.Tools.Debugger.Net" Version="2.5.10" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.146" PrivateAssets="All" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageReference Include="System.IO.Ports" Version="8.0.0" />
diff --git a/nanoFirmwareFlasher.Library/packages.lock.json b/nanoFirmwareFlasher.Library/packages.lock.json
@@ -50,12 +50,6 @@
         "resolved": "3.6.146",
         "contentHash": "W1eQ8hD9Y/cZ2+ilgxECl003xr1hybpN3fMxoTlMqg++BixETBMWzS4y9s08oHJKXgKtudsoxhITNOEf1OR66w=="
       },
-      "Newtonsoft.Json": {
-        "type": "Direct",
-        "requested": "[13.0.3, )",
-        "resolved": "13.0.3",
-        "contentHash": "HrC5BXdl00IP9zeV+0Z848QWPAoCr9P3bDEZguI+gkLcBKAOxix/tLEAAHC+UvDNPv4a2d18lOReHMOagPa+zQ=="
-      },
       "System.ComponentModel.Annotations": {
         "type": "Direct",
         "requested": "[5.0.0, )",
@@ -304,12 +298,6 @@
         "resolved": "3.6.146",
         "contentHash": "W1eQ8hD9Y/cZ2+ilgxECl003xr1hybpN3fMxoTlMqg++BixETBMWzS4y9s08oHJKXgKtudsoxhITNOEf1OR66w=="
       },
-      "Newtonsoft.Json": {
-        "type": "Direct",
-        "requested": "[13.0.3, )",
-        "resolved": "13.0.3",
-        "contentHash": "HrC5BXdl00IP9zeV+0Z848QWPAoCr9P3bDEZguI+gkLcBKAOxix/tLEAAHC+UvDNPv4a2d18lOReHMOagPa+zQ=="
-      },
       "System.ComponentModel.Annotations": {
         "type": "Direct",
         "requested": "[5.0.0, )",
diff --git a/nanoFirmwareFlasher.Tool/Program.cs b/nanoFirmwareFlasher.Tool/Program.cs
@@ -10,14 +10,15 @@
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 using System.Threading.Tasks;
 using CommandLine;
 using CommandLine.Text;
 using Microsoft.Extensions.Configuration;
 using nanoFramework.Tools.FirmwareFlasher.Extensions;
 using nanoFramework.Tools.FirmwareFlasher.FileDeployment;
 using nanoFramework.Tools.FirmwareFlasher.NetworkDeployment;
-using Newtonsoft.Json;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
@@ -130,8 +131,13 @@ private static void CheckVersion()
 
                     HttpResponseMessage response = client.GetAsync("https://api.github.com/repos/nanoframework/nanoFirmwareFlasher/releases/latest").Result;
 
-                    dynamic responseContent = JsonConvert.DeserializeObject(response.Content.ReadAsStringAsync().Result);
-                    string tagName = responseContent.tag_name.ToString();
+                    var options = new JsonSerializerOptions
+                    {
+                        PropertyNameCaseInsensitive = true,
+                    };
+
+                    JsonNode responseContent = JsonSerializer.Deserialize<JsonNode>(response.Content.ReadAsStringAsync().Result, options);
+                    string tagName = responseContent["tag_name"].ToString();
 
                     latestVersion = Version.Parse(tagName.Substring(1));
                 }
diff --git a/nanoFirmwareFlasher.Tool/packages.lock.json b/nanoFirmwareFlasher.Tool/packages.lock.json
@@ -133,11 +133,6 @@
         "resolved": "1.1.3",
         "contentHash": "3Wrmi0kJDzClwAC+iBdUBpEKmEle8FQNsCs77fkiOIw/9oYA07bL1EZNX0kQ2OMN3xpwvl0vAtOCYY3ndDNlhQ=="
       },
-      "Newtonsoft.Json": {
-        "type": "Transitive",
-        "resolved": "13.0.3",
-        "contentHash": "HrC5BXdl00IP9zeV+0Z848QWPAoCr9P3bDEZguI+gkLcBKAOxix/tLEAAHC+UvDNPv4a2d18lOReHMOagPa+zQ=="
-      },
       "Polly": {
         "type": "Transitive",
         "resolved": "7.2.4",
@@ -734,7 +729,6 @@
           "Microsoft.ApplicationInsights": "[2.22.0, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
           "Microsoft.Extensions.Configuration.Json": "[8.0.1, )",
-          "Newtonsoft.Json": "[13.0.3, )",
           "System.ComponentModel.Annotations": "[5.0.0, )",
           "System.IO.Ports": "[8.0.0, )",
           "System.Net.Http": "[4.3.4, )",

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`	`using System;`
`5`	`5`	`using System.Collections.Generic;`
`6`	`6`	`using System.IO;`
	`7`	`+using System.Text.Json;`
`7`	`8`	`using System.Threading.Tasks;`
`8`		`-using Newtonsoft.Json;`
`9`	`9`
`10`	`10`	`namespace nanoFramework.Tools.FirmwareFlasher`
`11`	`11`	`{`
`@@ -55,7 +55,12 @@ public List<CloudSmithPackageDetail> GetTargetList(`
`55`	`55`	`{`
`56`	`56`	`foreach (string filePath in Directory.EnumerateFiles(_archivePath, $"*{INFOFILE_EXTENSION}"))`
`57`	`57`	`{`
`58`		`- PersistedPackageInformation packageInformation = JsonConvert.DeserializeObject<PersistedPackageInformation>(File.ReadAllText(filePath));`
	`58`	`+ var options = new JsonSerializerOptions`
	`59`	`+ {`
	`60`	`+ PropertyNameCaseInsensitive = true,`
	`61`	`+ };`
	`62`	`+`
	`63`	`+ PersistedPackageInformation packageInformation = JsonSerializer.Deserialize<PersistedPackageInformation>(File.ReadAllText(filePath), options);`
`59`	`64`	`if (packageInformation.IsPreview == preview &&`
`60`	`65`	`(platform is null \|\| platform.Value.ToString().Equals(packageInformation.Platform, StringComparison.OrdinalIgnoreCase)))`
`61`	`66`	`{`
`@@ -83,7 +88,7 @@ public CloudSmithPackageDetail GetLatestVersion(`
`83`	`88`	`{`
`84`	`89`	`foreach (string filePath in Directory.EnumerateFiles(_archivePath, $"{target}-*{INFOFILE_EXTENSION}"))`
`85`	`90`	`{`
`86`		`- PersistedPackageInformation packageInformation = JsonConvert.DeserializeObject<PersistedPackageInformation>(File.ReadAllText(filePath));`
	`91`	`+ PersistedPackageInformation packageInformation = JsonSerializer.Deserialize<PersistedPackageInformation>(File.ReadAllText(filePath));`
`87`	`92`	`if (packageInformation is not null && packageInformation.IsPreview == preview)`
`88`	`93`	`{`
`89`	`94`	`if (Version.TryParse(packageInformation.Version, out Version version))`
`@@ -192,7 +197,7 @@ public async Task<ExitCodes> DownloadFirmwareFromRepository(`
`192`	`197`	`};`
`193`	`198`	`File.WriteAllText(`
`194`	`199`	`$"{(fwFilePath.EndsWith(".zip") ? fwFilePath : Path.GetDirectoryName(fwFilePath))}{INFOFILE_EXTENSION}",`
`195`		`- JsonConvert.SerializeObject(packageInformation)`
	`200`	`+ JsonSerializer.Serialize(packageInformation)`
`196`	`201`	`);`
`197`	`202`	`}`
`198`	`203`	`return result;`