updating prune to return entire data set rather than dropping data. if more fields than allowed are present will return an object that matches platform expectations

Author: danatcofo

Src/StackifyLib/Utils/HelperFunctions.cs

@@ -1,12 +1,9 @@
-using System.Collections;
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
-using System.ComponentModel;
 using System.Linq;
 using System.Reflection;
 using System.Text;
-using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Linq;
 
 
@@ -28,7 +25,6 @@ public class HelperFunctions
         public static string SerializeDebugData(object logObject, bool serializeSimpleTypes, Dictionary<string, object> properties = null)
         {
             Type t = null;
-      //      TypeInfo typeInfo = null;
             JObject jObject = null;
 
             try
@@ -86,8 +82,6 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
                             {
                                 jObject.Add("objectType", type.FullName);
                             }
-
-                            PruneJObject(jObject, Config.LoggingJsonMaxFields);
                         }
                         else if (token is JArray)
                         {
@@ -152,8 +146,6 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
                                     }
                                 }
                             }
-
-                            PruneJObject(jObject, Config.LoggingJsonMaxFields);
                         }
                         else if (token is JValue)
                         {
@@ -212,51 +204,50 @@ public static string SerializeDebugData(object logObject, bool serializeSimpleTy
 
             if (jObject != null)
             {
+
+                jObject = GetPrunedObject(jObject, Config.LoggingJsonMaxFields);
+
                 return JsonConvert.SerializeObject(jObject, serializerSettings);
             }
 
             return null;
         }
 
-
-        private static void PruneJObject(JObject obj, int maxFields)
+        /// <summary>
+        ///     If the <see cref="JObject"/> provided has move fields than maxFields
+        ///     will return a simplified <see cref="JObject"/> with original as an unparsed string message,
+        ///     otherwise will return original <see cref="JObject"/>
+        /// </summary>
+        private static JObject GetPrunedObject(JObject obj, int maxFields)
         {
-            var count = 0;
+            var fieldCount = GetFieldCount(obj);
 
-            var itemsToRemove = PruneJTokenRecursive(obj, maxFields, ref count);
-
-            foreach (var item in itemsToRemove)
+            if (fieldCount > maxFields)
             {
-                item.Remove();
+                return new JObject
+                {
+                    { "invalid", true },
+                    { "message", obj.ToString() }
+                };
             }
+
+            return obj;
         }
 
-        private static List<JToken> PruneJTokenRecursive(JToken obj, int maxFields, ref int count)
+        private static int GetFieldCount(JToken obj)
         {
-            if (obj is JProperty || obj is JArray)
-            {
-                count++;
-            }
-
-            var itemsToRemove = new List<JToken>();
-
-            foreach (var item in obj.Children())
+            switch (obj.Type)
             {
-                if (count >= maxFields)
-                {
-                    if (item is JProperty)
-                    {
-                        itemsToRemove.Add(item);
-                    }
-                }
-
-                itemsToRemove.AddRange(PruneJTokenRecursive(item, maxFields, ref count));
+                case JTokenType.Array:
+                case JTokenType.Object:
+                    return obj.Children().Sum(i => GetFieldCount(i));
+                case JTokenType.Property:
+                    return GetFieldCount(obj.Value<JProperty>().Value);
+                default:
+                    return 1;
             }
-
-            return itemsToRemove;
         }
 
-
         public static bool IsValueType(object obj)
         {
             if (obj == null)
@@ -270,18 +261,6 @@ public static bool IsValueType(object obj)
 #endif
         }
 
-
-        //public static dynamic ToDynamic(object value)
-        //{
-        //    IDictionary<string, object> expando = new ExpandoObject();
-
-        //    foreach (PropertyDescriptor property in TypeDescriptor.GetProperties(value.GetType()))
-        //        expando.Add(property.Name, property.GetValue(value));
-
-        //    return expando as ExpandoObject;
-        //}
-
-
         public static string CleanPartialUrl(string url)
         {
             if (string.IsNullOrEmpty(url) || !url.Contains("/"))

test/StackifyLib.UnitTests/JsonSerialization_Tests.cs

@@ -3,6 +3,8 @@
 using System.Diagnostics;
 using System.Text;
 using FluentAssertions;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -27,7 +29,11 @@ public void Should_Prune_Object()
 
             output.WriteLine(result);
 
-            result.Should().NotContain("FieldSixty");
+            var obj = JObject.Parse(result);
+
+            Assert.True(obj.TryGetValue("invalid", out _));
+            Assert.True(obj.TryGetValue("message", out _));
+            Assert.Equal(2, obj.Count);
         }
 
         [Fact]
@@ -45,7 +51,11 @@ public void Should_Prune_Object_Array()
 
             output.WriteLine(result);
 
-            result.Should().NotContain("FieldSixty");
+            var obj = JObject.Parse(result);
+
+            Assert.True(obj.TryGetValue("invalid", out _));
+            Assert.True(obj.TryGetValue("message", out _));
+            Assert.Equal(2, obj.Count);
         }