Merge pull request #83 from contentstack/refactor/DX-1473

refactor: Updating to system.text.json

Author: harshithad0703

.github/workflows/jira.yml

@@ -21,7 +21,7 @@ jobs:
           project: ${{ secrets.JIRA_PROJECT }}
           issuetype: ${{ secrets.JIRA_ISSUE_TYPE }}
           summary: |
-            ${{ github.event.pull_request.title }}
+            Snyk | Vulnerability | ${{ github.event.repository.name }} | ${{ github.event.pull_request.title }}
           description: |
             PR: ${{ github.event.pull_request.html_url }}
 

.github/workflows/sca-scan.yml

@@ -6,18 +6,10 @@ jobs:
   security-sca:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@master
-      - name: Setup .NET Core @ Latest
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: "7.0.x"
-      - name: Run Dotnet Restore
-        run: |
-          dotnet restore
+      - uses: actions/checkout@master
       - name: Run Snyk to check for vulnerabilities
         uses: snyk/actions/dotnet@master
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
-          args: --file=Contentstack.Core/obj/project.assets.json --fail-on=all
+          args: --fail-on=all

.talismanrc

@@ -1,6 +1,6 @@
 fileignoreconfig:
 - filename: Contentstack.Core/Internals/HttpRequestHandler.cs
-  checksum: 93c1659f3bc7527956f0fd12db46441297fac3a4366d273bcbb3425d2351300e
+  checksum: 29bb8548d65cdc5800fc939e526797bb3515f528d8082a58a0c9c6215dec1651
 - filename: Contentstack.Core/Models/Entry.cs
   checksum: 79320b005882981fd7c79fe73832f28284db686927942e46b422ac9e88405023
 - filename: Contentstack.Core/ContentstackClient.cs

CODEOWNERS

@@ -1 +1 @@
-* @contentstack/security-admin
+* @contentstack/security-admin

Contentstack.Core/Configuration/LivePreviewConfig.cs

@@ -1,6 +1,4 @@
-using System;
-using System.Collections;
-using Newtonsoft.Json.Linq;
+using System.Text.Json;
 
 namespace Contentstack.Core.Configuration
 {
@@ -13,6 +11,6 @@ public class LivePreviewConfig
         internal string LivePreview { get; set; }
         internal string ContentTypeUID { get; set; }
         internal string EntryUID { get; set; }
-        internal JObject PreviewResponse { get; set; }
+        internal JsonElement PreviewResponse { get; set; }
     }
 }

Contentstack.Core/Contentstack.Core.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net47;net472;</TargetFrameworks>
+    <TargetFrameworks>net7.0</TargetFrameworks>
     <PackageId>contentstack.csharp</PackageId>
     <Authors>Contentstack</Authors>
     <Description>.NET SDK for the Contentstack Content Delivery API.</Description>
@@ -28,7 +28,6 @@
     <AllowUnsafeBlocks></AllowUnsafeBlocks>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
     <PackageReference Include="Markdig" Version="0.36.2" />
     <PackageReference Include="contentstack.utils" Version="1.0.5" />

Contentstack.Core/ContentstackClient.cs

@@ -1,18 +1,17 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
-using Contentstack.Core.Internals;
-using Contentstack.Core.Configuration;
-using Microsoft.Extensions.Options;
-using Contentstack.Core.Models;
-using Newtonsoft.Json.Linq;
-using Newtonsoft.Json;
+using System.IO;
 using System.Linq;
-using System.Threading.Tasks;
 using System.Net;
-using System.IO;
-using System.Collections;
-using Contentstack.Utils;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Threading.Tasks;
+using Contentstack.Core.Configuration;
 using Contentstack.Core.Interfaces;
+using Contentstack.Core.Internals;
+using Contentstack.Core.Models;
+using Microsoft.Extensions.Options;
 
 namespace Contentstack.Core
 {
@@ -24,7 +23,16 @@ public class ContentstackClient
         /// <summary>
         /// Gets or sets the settings that should be used for deserialization.
         /// </summary>
-        public JsonSerializerSettings SerializerSettings { get; set; } = new JsonSerializerSettings();
+        public JsonSerializerOptions SerializerSettings { get; set; } = new JsonSerializerOptions
+        {
+            PropertyNameCaseInsensitive = true,
+            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+            Converters = {
+                new JsonStringEnumConverter(),
+                new CustomUtcDateTimeConverter(),
+                new CustomNullableUtcDateTimeConverter(),
+            }
+        };
 
         #region Internal Variables
 
@@ -35,7 +43,6 @@ internal string StackApiKey
         }
         private ContentstackOptions _options;
 
-        internal JsonSerializer Serializer => JsonSerializer.Create(SerializerSettings);
         internal string _SyncUrl
         {
             get
@@ -133,10 +140,6 @@ public ContentstackClient(IOptions<ContentstackOptions> options)
                     throw new InvalidOperationException("Add PreviewToken or ManagementToken in LivePreviewConfig");
                 }
             }
-            this.SerializerSettings.DateParseHandling = DateParseHandling.None;
-            this.SerializerSettings.DateFormatHandling = DateFormatHandling.IsoDateFormat;
-            this.SerializerSettings.DateTimeZoneHandling = DateTimeZoneHandling.Utc;
-            this.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
 
             foreach (Type t in CSJsonConverterAttribute.GetCustomAttribute(typeof(CSJsonConverterAttribute)))
             {
@@ -209,22 +212,18 @@ internal static ContentstackException GetContentstackError(Exception ex)
                 using (var reader = new StreamReader(stream))
                 {
                     errorMessage = reader.ReadToEnd();
-                    JObject data = JObject.Parse(errorMessage.Replace("\r\n", ""));
+                    var data = JsonSerializer.Deserialize<JsonElement>(errorMessage);
 
-                    JToken token = data["error_code"];
-                    if (token != null)
-                        errorCode = token.Value<int>();
+                    if (data.TryGetProperty("error_code", out var token))
+                        errorCode = token.GetInt32();
 
-                    token = data["error_message"];
-                    if (token != null)
-                        errorMessage = token.Value<string>();
+                    if (data.TryGetProperty("error_message", out token))
+                        errorMessage = token.GetString();
 
-                    token = data["errors"];
-                    if (token != null)
-                        errors = token.ToObject<Dictionary<string, object>>();
+                    if (data.TryGetProperty("errors", out token))
+                        errors = JsonSerializer.Deserialize<Dictionary<string, object>>(token.GetRawText());
 
-                    var response = exResp as HttpWebResponse;
-                    if (response != null)
+                    if (exResp is HttpWebResponse response)
                         statusCode = response.StatusCode;
                 }
             }
@@ -326,8 +325,8 @@ public async Task<IList> GetContentTypes(Dictionary<string, object> param = null
             {
                 HttpRequestHandler RequestHandler = new HttpRequestHandler(this);
                 var outputResult = await RequestHandler.ProcessRequest(_Url, headers, mainJson, Branch: this.Config.Branch, timeout: this.Config.Timeout, proxy: this.Config.Proxy);
-                JObject data = JsonConvert.DeserializeObject<JObject>(outputResult.Replace("\r\n", ""), this.SerializerSettings);
-                IList contentTypes = (IList)data["content_types"];
+                var data = JsonSerializer.Deserialize<JsonElement>(outputResult);
+                var contentTypes = data.GetProperty("content_types").EnumerateArray().ToList();
                 return contentTypes;
             }
             catch (Exception ex)
@@ -336,7 +335,7 @@ public async Task<IList> GetContentTypes(Dictionary<string, object> param = null
             }
         }
 
-        private async Task<JObject> GetLivePreviewData()
+        private async Task<JsonElement> GetLivePreviewData()
         {
 
             Dictionary<String, object> headerAll = new Dictionary<string, object>();
@@ -368,8 +367,8 @@ private async Task<JObject> GetLivePreviewData()
             {
                 HttpRequestHandler RequestHandler = new HttpRequestHandler(this);
                 var outputResult = await RequestHandler.ProcessRequest(String.Format("{0}/content_types/{1}/entries/{2}", this.Config.getLivePreviewUrl(this.LivePreviewConfig), this.LivePreviewConfig.ContentTypeUID, this.LivePreviewConfig.EntryUID), headerAll, mainJson, Branch: this.Config.Branch, isLivePreview: true, timeout: this.Config.Timeout, proxy: this.Config.Proxy);
-                JObject data = JsonConvert.DeserializeObject<JObject>(outputResult.Replace("\r\n", ""), this.SerializerSettings);
-                return (JObject)data["entry"];
+                var data = JsonSerializer.Deserialize<JsonElement>(outputResult);
+                return data.GetProperty("entry");
             }
             catch (Exception ex)
             {
@@ -786,7 +785,7 @@ private async Task<SyncStack> GetResultAsync(string Init = "false", SyncType Syn
             {
                 HttpRequestHandler requestHandler = new HttpRequestHandler(this);
                 string js = await requestHandler.ProcessRequest(_SyncUrl, _LocalHeaders, mainJson, Branch: this.Config.Branch, timeout: this.Config.Timeout, proxy: this.Config.Proxy);
-                SyncStack stackSyncOutput = JsonConvert.DeserializeObject<SyncStack>(js);
+                SyncStack stackSyncOutput = JsonSerializer.Deserialize<SyncStack>(js);
                 return stackSyncOutput;
             }
             catch (Exception ex)

Contentstack.Core/Internals/AssetJsonConverter.cs

@@ -1,27 +1,27 @@
 using System;
-using Contentstack.Core;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using Contentstack.Core.Models;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace Contentstack.Core.Internals
 {
     [CSJsonConverter("AssetJsonConverter")]
     public class AssetJsonConverter : JsonConverter<Asset>
     {
-        public override Asset ReadJson(JsonReader reader, Type objectType, Asset existingValue, bool hasExistingValue, JsonSerializer serializer)
+        public override Asset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
         {
-            JObject jObject = JObject.Load(reader);
-            JsonSerializerSettings SerializerSettings = new JsonSerializerSettings();
-            JsonSerializer Serializer = JsonSerializer.Create(SerializerSettings);
-            Asset asset = jObject.ToObject<Asset>(Serializer);
-            asset.ParseObject(jObject);
-            return asset;
+            using (JsonDocument document = JsonDocument.ParseValue(ref reader))
+            {
+                JsonElement root = document.RootElement;
+                Asset asset = JsonSerializer.Deserialize<Asset>(root.GetRawText(), options);
+                asset.ParseObject(root);
+                return asset;
+            }
         }
 
-        public override void WriteJson(JsonWriter writer, Asset value, JsonSerializer serializer)
+        public override void Write(Utf8JsonWriter writer, Asset value, JsonSerializerOptions options)
         {
             throw new NotImplementedException();
         }
     }
-}
+}

Contentstack.Core/Internals/ContentStackError.cs

@@ -1,8 +1,8 @@
-using Newtonsoft.Json;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Net;
-
+using System.Text.Json.Serialization;
+
 namespace Contentstack.Core.Internals
 {
     /// <summary>
@@ -33,7 +33,7 @@ public class ContentstackException : Exception
         /// <summary>
         /// This is error message.
         /// </summary>
-        [JsonProperty("error_message")]
+        [JsonPropertyName("error_message")]
         public string ErrorMessage
         {
             get
@@ -50,13 +50,13 @@ public string ErrorMessage
         /// <summary>
         /// This is error code.
         /// </summary>
-        [JsonProperty("error_code")]
+        [JsonPropertyName("error_code")]
         public int ErrorCode { get; set; }
 
         /// <summary>
         /// Set of errors in detail.
         /// </summary>
-        [JsonProperty("errors")]
+        [JsonPropertyName("errors")]
         public Dictionary<string, object> Errors { get; set; }
 
         #endregion

Contentstack.Core/Internals/ContentstackConvert.cs

@@ -1,9 +1,5 @@
-using Newtonsoft.Json;
-using System;
+using System;
 using System.IO;
-using System.Net.NetworkInformation;
-using System.Security.Cryptography;
-using System.Text;
 using System.Text.RegularExpressions;
 
 namespace Contentstack.Core.Internals