Merge pull request #3679 from marticliment/dynamic-json-{de}serialization

Author: marticliment

src/UniGetUI.Core.Classes.Tests/UniGetUI.Core.Classes.Tests.csproj

@@ -1,7 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-
-
   <PropertyGroup>
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>

src/UniGetUI.Core.Data/CoreData.cs

@@ -1,5 +1,6 @@
 using System.Diagnostics;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Text.Json.Serialization.Metadata;
 using UniGetUI.Core.Logging;
 
@@ -357,12 +358,6 @@ private static string GetNewDataDirectoryOrMoveOld(string old_path, string new_p
             }
         }
 
-        public static JsonSerializerOptions SerializingOptions = new()
-        {
-            TypeInfoResolverChain = { new DefaultJsonTypeInfoResolver() },
-            WriteIndented = true,
-        };
-
         private static int GetCodePage()
         {
             try

src/UniGetUI.Core.Data/UniGetUI.Core.Data.csproj

@@ -15,4 +15,8 @@
   <ItemGroup>
     <Compile Include="..\SharedAssemblyInfo.cs" Link="SharedAssemblyInfo.cs" />
   </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="YamlDotNet" Version="16.3.0" />
+  </ItemGroup>
 </Project>

src/UniGetUI.Core.IconStore/IconDatabase.cs

@@ -91,7 +91,7 @@ public async Task LoadIconAndScreenshotsDatabaseAsync()
             {
                 IconScreenshotDatabase_v2 JsonData = JsonSerializer.Deserialize<IconScreenshotDatabase_v2>(
                     await File.ReadAllTextAsync(IconsAndScreenshotsFile),
-                    CoreData.SerializingOptions
+                    SerializationHelpers.DefaultOptions
                     );
                 if (JsonData.icons_and_screenshots is not null)
                 {

src/UniGetUI.Core.Settings.Tests/SettingsTest.cs

@@ -173,7 +173,7 @@ public void TestListSettings(string SettingName, string[] ls1Array, int[] ls2Arr
             Assert.Equal("this is now a test case", Settings.GetListItem<string>(SettingName, 3));
             Assert.Null(Settings.GetListItem<string>(SettingName, 4));
 
-            Assert.Equal(Settings.GetListItem<string>(SettingName, 0), JsonSerializer.Deserialize<List<string>>(File.ReadAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{SettingName}.json")), CoreData.SerializingOptions)[0]);
+            Assert.Equal(Settings.GetListItem<string>(SettingName, 0), JsonSerializer.Deserialize<List<string>>(File.ReadAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{SettingName}.json")), Settings.SerializationOptions)[0]);
             Settings.ClearList(SettingName);
             Assert.Empty(Settings.GetList<object>(SettingName) ?? ["this shouldn't be null; something's wrong"]);
 
@@ -226,7 +226,7 @@ public void TestDictionarySettings(string SettingName, string[] keyArray, int[]
             Settings.SetDictionaryItem(randStr, "key", 12);
             Assert.Equal(12, Settings.GetDictionaryItem<string, int>(randStr, "key"));
             Settings.SetDictionary(SettingName, test);
-            Assert.Equal(JsonSerializer.Serialize(test, CoreData.SerializingOptions), File.ReadAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{SettingName}.json")));
+            Assert.Equal(JsonSerializer.Serialize(test, Settings.SerializationOptions), File.ReadAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{SettingName}.json")));
             Assert.Equal(test[keyArray[0]]?.sub.count, Settings.GetDictionary<string, SerializableTest?>(SettingName)?[keyArray[0]]?.sub.count);
             Assert.Equal(test[keyArray[1]]?.sub.count, Settings.GetDictionaryItem<string, SerializableTest?>(SettingName, keyArray[1])?.sub.count);
             Settings.SetDictionaryItem(SettingName, keyArray[0], test[keyArray[1]]);
@@ -257,7 +257,7 @@ public void TestDictionarySettings(string SettingName, string[] keyArray, int[]
             Assert.True(Settings.DictionaryContainsValue<string, SerializableTest?>(SettingName, test[keyArray[2]]));
 
             Assert.Equal(
-                JsonSerializer.Serialize(Settings.GetDictionary<string, SerializableTest>(SettingName), CoreData.SerializingOptions),
+                JsonSerializer.Serialize(Settings.GetDictionary<string, SerializableTest>(SettingName), Settings.SerializationOptions),
                 File.ReadAllText(Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{SettingName}.json"))
             );
 

src/UniGetUI.Core.Settings/SettingsEngine_Dictionaries.cs

@@ -43,7 +43,7 @@ public static partial class Settings
                         if (result != "")
                         {
 
-                            Dictionary<K, V?>? item = JsonSerializer.Deserialize<Dictionary<K, V?>>(result, CoreData.SerializingOptions);
+                            Dictionary<K, V?>? item = JsonSerializer.Deserialize<Dictionary<K, V?>>(result, SerializationOptions);
                             if (item is not null)
                             {
                                 value = item;
@@ -90,7 +90,7 @@ public static void SetDictionary<K, V>(string setting, Dictionary<K, V> value)
             try
             {
 
-                if (value.Count != 0) File.WriteAllText(file, JsonSerializer.Serialize(value, CoreData.SerializingOptions));
+                if (value.Count != 0) File.WriteAllText(file, JsonSerializer.Serialize(value, SerializationOptions));
                 else if (File.Exists(file)) File.Delete(file);
             }
             catch (Exception e)

src/UniGetUI.Core.Settings/SettingsEngine_Extras.cs

@@ -1,4 +1,6 @@
 using System.Net;
+using System.Text.Json;
+using System.Text.Json.Serialization.Metadata;
 using Windows.Security.Credentials;
 using UniGetUI.Core.Logging;
 
@@ -83,4 +85,11 @@ public static void SetProxyCredentials(string username, string password)
             Logger.Error(ex);
         }
     }
+
+    public static JsonSerializerOptions SerializationOptions = new()
+    {
+        TypeInfoResolver = new DefaultJsonTypeInfoResolver(),
+        AllowTrailingCommas = true,
+        WriteIndented = true,
+    };
 }

src/UniGetUI.Core.Settings/SettingsEngine_ImportExport.cs

@@ -17,7 +17,7 @@ public static void ExportToJSON(string path)
             settings.Add(Path.GetFileName(entry), File.ReadAllText(entry));
         }
 
-        File.WriteAllText(path, JsonSerializer.Serialize(settings, CoreData.SerializingOptions));
+        File.WriteAllText(path, JsonSerializer.Serialize(settings, SerializationOptions));
     }
 
     public static void ImportFromJSON(string path)
@@ -31,7 +31,7 @@ public static void ImportFromJSON(string path)
         }
 
         ResetSettings();
-        Dictionary<string, string> settings = JsonSerializer.Deserialize<Dictionary<string, string>>(File.ReadAllText(path), CoreData.SerializingOptions) ?? [];
+        Dictionary<string, string> settings = JsonSerializer.Deserialize<Dictionary<string, string>>(File.ReadAllText(path), SerializationOptions) ?? [];
         foreach (KeyValuePair<string, string> entry in settings)
         {
             if(new[] {"OperationHistory", "WinGetAlreadyUpgradedPackages.json", "TelemetryClientToken", "CurrentSessionToken"}.Contains(entry.Key))

src/UniGetUI.Core.Settings/SettingsEngine_Lists.cs

@@ -39,7 +39,7 @@ public static partial class Settings
                     {
                         if (result != "")
                         {
-                            List<T>? item = JsonSerializer.Deserialize<List<T>>(result, CoreData.SerializingOptions);
+                            List<T>? item = JsonSerializer.Deserialize<List<T>>(result, SerializationOptions);
                             if (item is not null)
                             {
                                 value = item;
@@ -76,7 +76,7 @@ public static void SetList<T>(string setting, List<T> value)
             var file = Path.Join(CoreData.UniGetUIUserConfigurationDirectory, $"{setting}.json");
             try
             {
-                if (value.Count != 0) File.WriteAllText(file, JsonSerializer.Serialize(value, CoreData.SerializingOptions));
+                if (value.Count != 0) File.WriteAllText(file, JsonSerializer.Serialize(value, SerializationOptions));
                 else if (File.Exists(file)) File.Delete(file);
             }
             catch (Exception e)

src/UniGetUI.Core.Tools.Tests/MetaTests.cs

@@ -17,10 +17,12 @@ public void TestJsonSerializationOptions()
             var lines = File.ReadAllLines(file);
             var jsonSerCount = lines.Count(x => x.Contains("JsonSerializer.Serialize"));
             var jsonDeserCount = lines.Count(x => x.Contains("JsonSerializer.Deserialize"));
-            var serialOptionsCount = lines.Count(x => x.Contains("CoreData.SerializingOptions"));
-            Assert.True((jsonSerCount + jsonDeserCount) <= serialOptionsCount,
+            var serialOptionsCount1 = lines.Count(x => x.Contains("SerializationHelpers.DefaultOptions"));
+            var serialOptionsCount2 = lines.Count(x => x.Contains("SerializationHelpers.ImportBundleOptions"));
+            var serialOptionsCount3 = lines.Count(x => x.Contains("SerializationOptions"));
+            Assert.True((jsonSerCount + jsonDeserCount) <= serialOptionsCount1 + serialOptionsCount2 + serialOptionsCount3,
                 $"Failing on {file}. The specified file does not serialize and/or deserialize JSON with" +
-                $" the proper CoreData.SerializingOptions set");
+                $" the proper CoreData.DefaultOptions set");
         }
     }