Merge pull request #157 from jamierushton/master

#47 Allow NULL and default values to be serialised

Author: niemyjski

src/Exceptionless/Serializer/DefaultJsonSerializer.cs

@@ -16,8 +16,6 @@ public class DefaultJsonSerializer : IJsonSerializer {
         public DefaultJsonSerializer() {
             _serializerSettings = new JsonSerializerSettings {
                 ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
-                NullValueHandling = NullValueHandling.Ignore,
-                DefaultValueHandling = DefaultValueHandling.Ignore,
                 PreserveReferencesHandling = PreserveReferencesHandling.None,
                 ContractResolver = new ExceptionlessContractResolver()
             };
@@ -73,7 +71,7 @@ private bool ShouldSerialize(JsonTextWriterWithDepth jw, JsonProperty property,
 
                 object value = property.ValueProvider.GetValue(obj);
                 if (value == null)
-                    return false;
+                    return true;
 
                 if (typeof(ICollection).GetTypeInfo().IsAssignableFrom(property.PropertyType.GetTypeInfo())) {
                     var collection = value as ICollection;

test/Exceptionless.Tests/Serializer/SerializerTests.cs

@@ -15,17 +15,6 @@ protected virtual IJsonSerializer GetSerializer() {
             return new DefaultJsonSerializer();
         }
 
-        [Fact]
-        public void CanSerialize() {
-            var data = new SampleModel {
-                Date = DateTime.Now,
-                Message = "Testing"
-            };
-            IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data, new[] { "Date" });
-            Assert.Equal(@"{""message"":""Testing""}", json);
-        }
-
         [Fact]
         public void CanSerializeEvent() {
             var ev = new Event {
@@ -34,36 +23,45 @@ public void CanSerializeEvent() {
             };
             ev.Data["FirstName"] = "Blake";
 
+            var exclusions = new[] { nameof(Event.Type), nameof(Event.Source), "Date", nameof(Event.Geo), nameof(Event.Count), nameof(Event.ReferenceId), nameof(Event.Tags), nameof(Event.Value) };
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(ev, new[] { "Date" });
+            string json = serializer.Serialize(ev, exclusions);
             Assert.Equal(@"{""message"":""Testing"",""data"":{""FirstName"":""Blake""}}", json);
         }
 
-
         [Fact]
         public void CanExcludeProperties() {
             var data = new SampleModel {
                 Date = DateTime.Now,
                 Message = "Testing"
             };
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data, new[] { "Date" });
+            string json = serializer.Serialize(data, new[] { nameof(SampleModel.Date), nameof(SampleModel.Number), nameof(SampleModel.Bool), nameof(SampleModel.DateOffset), nameof(SampleModel.Collection), nameof(SampleModel.Dictionary), nameof(SampleModel.Nested) });
             Assert.Equal(@"{""message"":""Testing""}", json);
         }
 
         [Fact]
         public void CanExcludeNestedProperties() {
-            var data = new SampleModel {
-                Date = DateTime.Now,
+            var data = new NestedModel {
+                Number = 1,
                 Message = "Testing",
-                Nested = new SampleModel {
-                    Date = DateTime.Now,
-                    Message = "Nested"
+                Nested = new NestedModel {
+                    Message = "Nested",
+                    Number = 2
                 }
             };
+
+            IJsonSerializer serializer = GetSerializer();
+            string json = serializer.Serialize(data, new[] { nameof(NestedModel.Number) });
+            Assert.Equal(@"{""message"":""Testing"",""nested"":{""message"":""Nested"",""nested"":null}}", json);
+        }
+
+        [Fact]
+        public void ShouldIncludeNullObjects() {
+            var data = new DefaultsModel();
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data, new[] { "Date" });
-            Assert.Equal(@"{""message"":""Testing"",""nested"":{""message"":""Nested""}}", json);
+            string json = serializer.Serialize(data);
+            Assert.Equal(@"{""number"":0,""bool"":false,""message"":null,""collection"":null,""dictionary"":null}", json);
         }
 
         [Fact]
@@ -87,44 +85,45 @@ public void CanExcludeMultiwordProperties() {
         }
 
         [Fact]
-        public void WillIgnoreDefaultValues() {
-            var data = new SampleModel {
-                Number = 0,
-                Bool = false
-            };
+        public void ShouldIncludeDefaultValues() {
+            var data = new SampleModel();
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data);
-            Assert.Equal(@"{}", json);
+            string json = serializer.Serialize(data, new []{ nameof(SampleModel.Date), nameof(SampleModel.DateOffset) });
+            Assert.Equal(@"{""number"":0,""bool"":false,""message"":null,""dictionary"":null,""collection"":null,""nested"":null}", json);
             var model = serializer.Deserialize<SampleModel>(json);
             Assert.Equal(data.Number, model.Number);
             Assert.Equal(data.Bool, model.Bool);
+            Assert.Equal(data.Message, model.Message);
+            Assert.Equal(data.Collection, model.Collection);
+            Assert.Equal(data.Dictionary, model.Dictionary);
+            Assert.Equal(data.Nested, model.Nested);
         }
 
         [Fact]
         public void CanSetMaxDepth() {
-            var data = new SampleModel {
+            var data = new NestedModel {
                 Message = "Level 1",
-                Nested = new SampleModel {
+                Nested = new NestedModel {
                     Message = "Level 2",
-                    Nested = new SampleModel {
+                    Nested = new NestedModel {
                         Message = "Level 3"
                     }
                 }
             };
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data, maxDepth: 2);
+            string json = serializer.Serialize(data, new[] { nameof(NestedModel.Number) }, maxDepth: 2);
             Assert.Equal(@"{""message"":""Level 1"",""nested"":{""message"":""Level 2""}}", json);
         }
 
         [Fact]
         public void WillIgnoreEmptyCollections() {
-            var data = new SampleModel {
-                Date = DateTime.Now,
+            var data = new DefaultsModel {
                 Message = "Testing",
-                Collection = new Collection<string>()
+                Collection = new Collection<string>(),
+                Dictionary = new Dictionary<string, string>()
             };
             IJsonSerializer serializer = GetSerializer();
-            string json = serializer.Serialize(data, new[] { "Date" });
+            string json = serializer.Serialize(data, new[] { nameof(DefaultsModel.Bool), nameof(DefaultsModel.Number) });
             Assert.Equal(@"{""message"":""Testing""}", json);
         }
 
@@ -158,21 +157,24 @@ public void WillSerializeDeepExceptionWithStackInformation() {
                 try {
                     try {
                         throw new ArgumentException("This is the innermost argument exception", "wrongArg");
-                    } catch (Exception e1) {
+                    }
+                    catch (Exception e1) {
                         throw new TargetInvocationException("Target invocation exception.", e1);
                     }
-                } catch (Exception e2) {
+                }
+                catch (Exception e2) {
                     throw new TargetInvocationException("Outer Exception. This is some text of the outer exception.", e2);
                 }
-            } catch (Exception ex) {
+            }
+            catch (Exception ex) {
                 var client = CreateClient();
                 var error = ex.ToErrorModel(client);
                 var ev = new Event();
                 ev.Data[Event.KnownDataKeys.Error] = error;
 
                 IJsonSerializer serializer = GetSerializer();
                 string json = serializer.Serialize(ev);
-                
+
                 Assert.Contains(String.Format("\"line_number\":{0}", error.Inner.Inner.StackTrace.Single().LineNumber), json);
             }
         }
@@ -193,17 +195,31 @@ public class Blah {
         public string BlahId { get; set; }
     }
 
+    public class NestedModel {
+        public int Number { get; set; }
+        public string Message { get; set; }
+        public NestedModel Nested { get; set; }
+    }
+
     public class SampleModel {
         public int Number { get; set; }
         public bool Bool { get; set; }
-        public string Message { get; set; }
         public DateTime Date { get; set; }
+        public string Message { get; set; }
         public DateTimeOffset DateOffset { get; set; }
         public IDictionary<string, string> Dictionary { get; set; }
-        public ICollection<string> Collection { get; set; } 
+        public ICollection<string> Collection { get; set; }
         public SampleModel Nested { get; set; }
     }
 
+    public class DefaultsModel {
+        public int Number { get; set; }
+        public bool Bool { get; set; }
+        public string Message { get; set; }
+        public ICollection<string> Collection { get; set; }
+        public IDictionary<string, string> Dictionary { get; set; }
+    }
+
     public class User {
         public string FirstName { get; set; }
         public string LastName { get; set; }