Merge pull request #11 from nblumhardt/tt

Fix $type round-tripping

Author: nblumhardt

src/Serilog.Formatting.Compact.Reader/LogEventReader.cs

@@ -29,11 +29,11 @@ namespace Serilog.Formatting.Compact.Reader
     /// </summary>
     public class LogEventReader : IDisposable
     {
-        static readonly MessageTemplateParser _parser = new MessageTemplateParser();
+        static readonly MessageTemplateParser Parser = new MessageTemplateParser();
         readonly TextReader _text;
         readonly JsonSerializer _serializer;
 
-        int _lineNumber = 0;
+        int _lineNumber;
 
         /// <summary>
         /// Construct a <see cref="LogEventReader"/>.
@@ -42,9 +42,7 @@ public class LogEventReader : IDisposable
         /// <param name="serializer">If specified, a JSON serializer used when converting event documents.</param>
         public LogEventReader(TextReader text, JsonSerializer serializer = null)
         {
-            if (text == null) throw new ArgumentNullException(nameof(text));
-
-            _text = text;
+            _text = text ?? throw new ArgumentNullException(nameof(text));
             _serializer = serializer ?? CreateSerializer();
         }
 
@@ -126,26 +124,25 @@ static LogEvent ReadFromJObject(int lineNumber, JObject jObject)
             }
 
             var level = LogEventLevel.Information;
-            string l;
-            if (TryGetOptionalField(lineNumber, jObject, ClefFields.Level, out l))
+            if (TryGetOptionalField(lineNumber, jObject, ClefFields.Level, out string l))
                 level = (LogEventLevel)Enum.Parse(typeof(LogEventLevel), l);
             Exception exception = null;
-            string ex;
-            if (TryGetOptionalField(lineNumber, jObject, ClefFields.Exception, out ex))
+            if (TryGetOptionalField(lineNumber, jObject, ClefFields.Exception, out string ex))
                 exception = new TextException(ex);
 
             var unrecognized = jObject.Properties().Where(p => ClefFields.IsUnrecognized(p.Name));
+            // ReSharper disable once PossibleMultipleEnumeration
             if (unrecognized.Any())
             {
+                // ReSharper disable once PossibleMultipleEnumeration
                 var names = string.Join(", ", unrecognized.Select(p => $"`{p.Name}`"));
                 throw new InvalidDataException($"{names} on line {lineNumber} are unrecognized.");
             }
 
-            var parsedTemplate = _parser.Parse(messageTemplate);
+            var parsedTemplate = Parser.Parse(messageTemplate);
             var renderings = Enumerable.Empty<Rendering>();
 
-            JToken r;
-            if (jObject.TryGetValue(ClefFields.Renderings, out r))
+            if (jObject.TryGetValue(ClefFields.Renderings, out JToken r))
             {
                 var renderedByIndex = r as JArray;
                 if (renderedByIndex == null)
@@ -178,15 +175,6 @@ static LogEvent ReadFromJObject(int lineNumber, JObject jObject)
             return new LogEvent(timestamp, level, exception, parsedTemplate, properties);
         }
 
-        static string GetRequiredField(int lineNumber, JObject data, string field)
-        {
-            string value;
-            if (!TryGetOptionalField(lineNumber, data, field, out value))
-                throw new InvalidDataException($"The data on line {lineNumber} does not include the required `{field}` field.");
-
-            return value;
-        }
-
         static bool TryGetOptionalField(int lineNumber, JObject data, string field, out string value)
         {
             JToken token;
@@ -214,8 +202,8 @@ static DateTimeOffset GetRequiredTimestampField(int lineNumber, JObject data, st
                 var dt = token.Value<JValue>().Value;
                 if (dt is DateTimeOffset)
                     return (DateTimeOffset)dt;
-                else
-                    return (DateTime)dt;
+
+                return (DateTime)dt;
             }
 
             if (token.Type != JTokenType.String)

src/Serilog.Formatting.Compact.Reader/PropertyFactory.cs

@@ -14,15 +14,15 @@
 
 using Newtonsoft.Json.Linq;
 using Serilog.Events;
-using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Threading.Tasks;
 
 namespace Serilog.Formatting.Compact.Reader
 {
     static class PropertyFactory
     {
+        const string TypeTagPropertyName = "$type";
+
         public static LogEventProperty CreateProperty(string name, JToken value, IEnumerable<Rendering> renderings)
         {
             return new LogEventProperty(name, CreatePropertyValue(value, renderings));
@@ -33,28 +33,23 @@ static LogEventPropertyValue CreatePropertyValue(JToken value, IEnumerable<Rende
             if (value.Type == JTokenType.Null)
                 return new ScalarValue(null);
 
-            var obj = value as JObject;
-            if (obj != null)
+            if (value is JObject obj)
             {
                 JToken tt;
-                obj.TryGetValue("$typeTag", out tt);
+                obj.TryGetValue(TypeTagPropertyName, out tt);
                 return new StructureValue(
-                    obj.Properties().Where(kvp => kvp.Name != "$typeTag").Select(kvp => CreateProperty(kvp.Name, kvp.Value, null)),
+                    obj.Properties().Where(kvp => kvp.Name != TypeTagPropertyName).Select(kvp => CreateProperty(kvp.Name, kvp.Value, null)),
                     tt?.Value<string>());
             }
 
-            var arr = value as JArray;
-            if (arr != null)
+            if (value is JArray arr)
             {
                 return new SequenceValue(arr.Select(v => CreatePropertyValue(v, null)));
             }
 
             var raw = value.Value<JValue>().Value;
 
-            if (renderings != null)
-                return new RenderableScalarValue(raw, renderings);
-
-            return new ScalarValue(raw);
+            return renderings != null ? new RenderableScalarValue(raw, renderings) : new ScalarValue(raw);
         }
     }
 }

test/Serilog.Formatting.Compact.Reader.Tests/LogEventReaderTests.cs

@@ -61,5 +61,15 @@ public void HandlesDefaultJsonNetSerialization()
 
             Assert.Equal(DateTimeOffset.Parse("2016-10-12T04:20:58.0554314Z"), evt.Timestamp);
         }
+
+        [Fact]
+        public void RoundTripsTypeTags()
+        {
+            const string document = "{\"@t\":\"2016-10-12T04:20:58.0554314Z\",\"@m\":\"Hello\",\"User\":{\"$type\":\"TestUser\",\"Name\":\"nblumhardt\"}}";
+            var evt = LogEventReader.ReadFromString(document);
+
+            var user = (StructureValue)evt.Properties["User"];
+            Assert.Equal("TestUser", user.TypeTag);
+        }
     }
 }