fix: Remove modification/usage of default JsonSerializerSettings (#243)

* Remove modification/usage of default JsonSerializerSettings * Move default JsonSerializerSettings to OperatorSettings property * Remove JsonSerializerSettings setter
buehler · Aug 13, 2021 · 56e1bd3 · 56e1bd3
1 parent 5f73fb2
commit 56e1bd3
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 25 deletions.
diff --git a/src/KubeOps/Operator/Builder/OperatorBuilder.cs b/src/KubeOps/Operator/Builder/OperatorBuilder.cs
@@ -109,23 +109,6 @@ internal IOperatorBuilder AddOperatorBase(OperatorSettings settings)
         {
             Services.AddSingleton(settings);
 
-            var jsonSettings = new JsonSerializerSettings
-            {
-                DateFormatHandling = DateFormatHandling.IsoDateFormat,
-                DateTimeZoneHandling = DateTimeZoneHandling.Utc,
-                NullValueHandling = NullValueHandling.Ignore,
-                ReferenceLoopHandling = ReferenceLoopHandling.Serialize,
-                ContractResolver = new NamingConvention(),
-                Converters = new List<JsonConverter>
-                {
-                    new StringEnumConverter { CamelCaseText = true },
-                    new Iso8601TimeSpanConverter(),
-                },
-                DateFormatString = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.ffffffK",
-            };
-            Services.AddTransient(_ => jsonSettings);
-            JsonConvert.DefaultSettings = () => jsonSettings;
-
             Services.AddTransient(
                 _ => new SerializerBuilder()
                     .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull)

diff --git a/src/KubeOps/Operator/HostExtensions.cs b/src/KubeOps/Operator/HostExtensions.cs
@@ -1,9 +1,7 @@
 using System.Threading.Tasks;
 using KubeOps.Operator.Commands;
 using McMaster.Extensions.CommandLineUtils;
-using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
-using Newtonsoft.Json;
 
 namespace KubeOps.Operator
 {
@@ -28,8 +26,6 @@ public static Task<int> RunOperatorAsync(this IHost host, string[] args)
                 .UseDefaultConventions()
                 .UseConstructorInjection(host.Services);
 
-            JsonConvert.DefaultSettings = () => host.Services.GetRequiredService<JsonSerializerSettings>();
-
             return app.ExecuteAsync(args);
         }
     }

diff --git a/src/KubeOps/Operator/OperatorSettings.cs b/src/KubeOps/Operator/OperatorSettings.cs
@@ -1,6 +1,11 @@
-using System.Reflection;
+using System.Collections.Generic;
+using System.Reflection;
 using System.Text.RegularExpressions;
 using DotnetKubernetesClient;
+using KubeOps.Operator.Serialization;
+using Microsoft.Rest.Serialization;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace KubeOps.Operator
 {
@@ -90,5 +95,20 @@ public sealed class OperatorSettings
         /// </para>
         /// </summary>
         public bool DefaultRequeueAsSameType { get; set; } = false;
+
+        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 { CamelCaseText = true },
+                new Iso8601TimeSpanConverter(),
+            },
+            DateFormatString = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.ffffffK",
+        };
     }
 }
diff --git a/src/KubeOps/Operator/Serialization/EntitySerializer.cs b/src/KubeOps/Operator/Serialization/EntitySerializer.cs
@@ -9,10 +9,10 @@ internal class EntitySerializer
         private readonly ISerializer _yaml;
         private readonly JsonSerializerSettings _jsonSettings;
 
-        public EntitySerializer(ISerializer yaml, JsonSerializerSettings jsonSettings)
+        public EntitySerializer(ISerializer yaml, OperatorSettings operatorSettings)
         {
             _yaml = yaml;
-            _jsonSettings = jsonSettings;
+            _jsonSettings = operatorSettings.SerializerSettings;
             _jsonSettings.Formatting = Formatting.Indented;
             _jsonSettings.NullValueHandling = NullValueHandling.Ignore;
         }

diff --git a/src/KubeOps/Operator/Webhooks/IAdmissionWebhook{TEntity, TResult}.cs b/src/KubeOps/Operator/Webhooks/IAdmissionWebhook{TEntity, TResult}.cs
@@ -113,8 +113,11 @@ Task<TResult> DeleteAsync(TEntity oldEntity, bool dryRun)
                         return;
                     }
 
+                    var jsonSerializerSettings = context.RequestServices.GetRequiredService<OperatorSettings>()
+                        .SerializerSettings;
+
                     using var reader = new StreamReader(context.Request.Body);
-                    var review = JsonConvert.DeserializeObject<AdmissionReview<TEntity>>(await reader.ReadToEndAsync());
+                    var review = JsonConvert.DeserializeObject<AdmissionReview<TEntity>>(await reader.ReadToEndAsync(), jsonSerializerSettings);
 
                     if (review.Request == null)
                     {