feat: Migrate to System.Text.Json (#436)

BREAKING CHANGE:

Existing projects must migrate from using `JsonPropertyAttributes` to `JsonPropertyNameAttributes`.
The YAML serializer is also shared with `kubernetes-client` and is no longer overridable via injection.
`Microsoft.Rest.HttpOperationException` no longer exists, any place this is used must move to `k8s.Autorest.HttpOperationException`.

Author: Silvenga

src/KubeOps/KubeOps.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
     <Import Project="..\..\config\Common.targets" />
     <Import Project="..\..\config\CodeAnalysis.targets" />
@@ -25,7 +25,7 @@
 
     <ItemGroup>
         <PackageReference Include="CompareNETObjects" Version="4.77.0" />
-        <PackageReference Include="DotnetKubernetesClient" Version="2.1.11" />
+        <PackageReference Include="DotnetKubernetesClient" Version="2.1.12" />
         <PackageReference Include="JsonDiffPatch" Version="2.0.55" />
         <PackageReference Include="Localtunnel" Version="1.0.4" />
         <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.0.1" />

src/KubeOps/Operator/Builder/OperatorBuilder.cs

@@ -3,7 +3,6 @@
 using DotnetKubernetesClient;
 using k8s;
 using k8s.Models;
-using KellermanSoftware.CompareNetObjects;
 using KubeOps.Operator.Caching;
 using KubeOps.Operator.Controller;
 using KubeOps.Operator.DevOps;
@@ -20,7 +19,6 @@
 using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Microsoft.Extensions.Logging;
 using Prometheus;
-using YamlDotNet.Serialization;
 
 namespace KubeOps.Operator.Builder;
 
@@ -189,14 +187,6 @@ internal IOperatorBuilder AddOperatorBase(OperatorSettings settings)
         Services.AddTransient<ValidatingWebhookConfigurationBuilder>();
         Services.AddTransient<IWebhookMetadataBuilder, WebhookMetadataBuilder>();
 
-        Services.AddTransient(
-            _ => new SerializerBuilder()
-                .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull)
-                .WithNamingConvention(new NamingConvention())
-                .WithTypeConverter(new Yaml.ByteArrayStringYamlConverter())
-                .WithTypeConverter(new IntOrStringYamlConverter())
-                .Build());
-
         Services.AddTransient<EntitySerializer>();
 
         Services.AddSingleton<IKubernetesClient, KubernetesClient>();

src/KubeOps/Operator/Commands/Management/Install.cs

@@ -2,10 +2,10 @@
 using System.Linq;
 using System.Threading.Tasks;
 using DotnetKubernetesClient;
+using k8s.Autorest;
 using KubeOps.Operator.Entities;
 using McMaster.Extensions.CommandLineUtils;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Rest;
 
 namespace KubeOps.Operator.Commands.Management;
 

src/KubeOps/Operator/Commands/Management/Uninstall.cs

@@ -2,10 +2,10 @@
 using System.Linq;
 using System.Threading.Tasks;
 using DotnetKubernetesClient;
+using k8s.Autorest;
 using KubeOps.Operator.Entities;
 using McMaster.Extensions.CommandLineUtils;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Rest;
 
 namespace KubeOps.Operator.Commands.Management;
 

src/KubeOps/Operator/Entities/Extensions/EntityToCrdExtensions.cs

@@ -4,14 +4,14 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Reflection;
+using System.Text.Json.Serialization;
 using DotnetKubernetesClient.Entities;
 using k8s;
 using k8s.Models;
 using KubeOps.Operator.Entities.Annotations;
 using KubeOps.Operator.Errors;
 using KubeOps.Operator.Util;
 using Namotion.Reflection;
-using Newtonsoft.Json;
 
 namespace KubeOps.Operator.Entities.Extensions;
 
@@ -362,7 +362,7 @@ private static void ProcessType(
                         MapProperty(prop, additionalColumns, $"{jsonPath}.{GetPropertyName(prop)}"))));
         props.Required = type.GetProperties()
             .Where(prop => prop.GetCustomAttribute<RequiredAttribute>() != null)
-            .Select(prop => GetPropertyName(prop))
+            .Select(GetPropertyName)
             .ToList();
         if (props.Required.Count == 0)
         {
@@ -389,8 +389,8 @@ private static bool IsSimpleType(Type type) =>
 
     private static string GetPropertyName(PropertyInfo property)
     {
-        var attribute = property.GetCustomAttribute<JsonPropertyAttribute>();
-        var propertyName = attribute?.PropertyName ?? property.Name;
+        var attribute = property.GetCustomAttribute<JsonPropertyNameAttribute>();
+        var propertyName = attribute?.Name ?? property.Name;
         return propertyName.ToCamelCase();
     }
 

src/KubeOps/Operator/Leadership/LeaderElector.cs

@@ -6,11 +6,11 @@
 using System.Threading.Tasks;
 using DotnetKubernetesClient;
 using DotnetKubernetesClient.LabelSelectors;
+using k8s.Autorest;
 using k8s.Models;
 using KubeOps.Operator.Entities.Extensions;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Microsoft.Rest;
 using Timer = System.Timers.Timer;
 
 namespace KubeOps.Operator.Leadership;

src/KubeOps/Operator/OperatorSettings.cs

@@ -4,10 +4,6 @@
 using DotnetKubernetesClient;
 using KellermanSoftware.CompareNetObjects;
 using KubeOps.Operator.Errors;
-using KubeOps.Operator.Serialization;
-using Microsoft.Rest.Serialization;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 
 namespace KubeOps.Operator;
 
@@ -185,15 +181,4 @@ public sealed class OperatorSettings
         AutoClearCache = false,
         MembersToIgnore = new List<string> { "ResourceVersion", "ManagedFields" },
     };
-
-    internal JsonSerializerSettings SerializerSettings { get; } = new()
-    {
-        DateFormatHandling = DateFormatHandling.IsoDateFormat,
-        DateTimeZoneHandling = DateTimeZoneHandling.Utc,
-        NullValueHandling = NullValueHandling.Ignore,
-        ReferenceLoopHandling = ReferenceLoopHandling.Serialize,
-        ContractResolver = new NamingConvention(),
-        Converters = new List<JsonConverter> { new StringEnumConverter(), new Iso8601TimeSpanConverter(), },
-        DateFormatString = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.ffffffK",
-    };
 }

src/KubeOps/Operator/Serialization/EntitySerializer.cs

@@ -1,27 +1,15 @@
 using System;
-using Newtonsoft.Json;
-using YamlDotNet.Serialization;
+using k8s;
 
 namespace KubeOps.Operator.Serialization;
 
 internal class EntitySerializer
 {
-    private readonly ISerializer _yaml;
-    private readonly JsonSerializerSettings _jsonSettings;
-
-    public EntitySerializer(ISerializer yaml, OperatorSettings operatorSettings)
-    {
-        _yaml = yaml;
-        _jsonSettings = operatorSettings.SerializerSettings;
-        _jsonSettings.Formatting = Formatting.Indented;
-        _jsonSettings.NullValueHandling = NullValueHandling.Ignore;
-    }
-
     public string Serialize(object @object, SerializerOutputFormat format = default)
         => format switch
         {
-            SerializerOutputFormat.Yaml => _yaml.Serialize(@object),
-            SerializerOutputFormat.Json => JsonConvert.SerializeObject(@object, _jsonSettings),
+            SerializerOutputFormat.Yaml => KubernetesYaml.Serialize(@object),
+            SerializerOutputFormat.Json => KubernetesJson.Serialize(@object),
             _ => throw new ArgumentOutOfRangeException(),
         };
 }

src/KubeOps/Operator/Serialization/NamingConvention.cs

@@ -1,14 +1,21 @@
-namespace KubeOps.Operator.Webhooks;
+using System.Text.Json.Serialization;
+
+namespace KubeOps.Operator.Webhooks;
 
 internal sealed class AdmissionRequest<TEntity>
 {
+    [JsonPropertyName("uid")]
     public string Uid { get; init; } = string.Empty;
 
+    [JsonPropertyName("operation")]
     public string Operation { get; init; } = string.Empty;
 
+    [JsonPropertyName("object")]
     public TEntity? Object { get; set; }
 
+    [JsonPropertyName("oldObject")]
     public TEntity? OldObject { get; set; }
 
+    [JsonPropertyName("dryRun")]
     public bool DryRun { get; set; }
 }