Merge pull request #29 from nblumhardt/allow-empty-names

Handle empty property names

Author: nblumhardt

asset/icon.png

@@ -0,0 +1,5 @@
+{
+  "sdk": {
+    "version": "5.0.102"
+  }
+}

global.json

@@ -11,6 +11,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "global", "global", "{70BA4A
 		Build.ps1 = Build.ps1
 		LICENSE = LICENSE
 		README.md = README.md
+		.gitattributes = .gitattributes
+		.gitignore = .gitignore
+		global.json = global.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "asset", "asset", "{71DD3779-3435-42D0-BA02-AEA04EE5B1E5}"

serilog-formatting-compact-reader.sln

@@ -30,6 +30,7 @@ namespace Serilog.Formatting.Compact.Reader
     public class LogEventReader : IDisposable
     {
         static readonly MessageTemplateParser Parser = new MessageTemplateParser();
+        static readonly Rendering[] NoRenderings = new Rendering[0];
         readonly TextReader _text;
         readonly JsonSerializer _serializer;
 
@@ -132,7 +133,7 @@ static LogEvent ReadFromJObject(int lineNumber, JObject jObject)
                 new MessageTemplate(Enumerable.Empty<MessageTemplateToken>()) :
                 Parser.Parse(messageTemplate);
 
-            var renderings = Enumerable.Empty<Rendering>();
+            var renderings = NoRenderings;
 
             if (jObject.TryGetValue(ClefFields.Renderings, out JToken r))
             {
@@ -153,13 +154,13 @@ static LogEvent ReadFromJObject(int lineNumber, JObject jObject)
                 .Select(f =>
                 {
                     var name = ClefFields.Unescape(f.Name);
-                    var renderingsByFormat = renderings.Where(rd => rd.Name == name);
+                    var renderingsByFormat = renderings.Length != 0 ? renderings.Where(rd => rd.Name == name).ToArray() : NoRenderings;
                     return PropertyFactory.CreateProperty(name, f.Value, renderingsByFormat);
                 })
                 .ToList();
 
-            string eventId;
-            if (TryGetOptionalField(lineNumber, jObject, ClefFields.EventId, out eventId)) // TODO; should support numeric ids.
+            // TODO: this should attempt to support numeric ids.
+            if (TryGetOptionalField(lineNumber, jObject, ClefFields.EventId, out var eventId))
             {
                 properties.Add(new LogEventProperty("@i", new ScalarValue(eventId)));
             }

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

@@ -0,0 +1,8 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Serilog.Formatting.Compact.Reader.Tests, PublicKey=" +
+                              "0024000004800000940000000602000000240000525341310004000001000100fb8d13fd344a1c" +
+                              "6fe0fe83ef33c1080bf30690765bc6eb0df26ebfdf8f21670c64265b30db09f73a0dea5b3db4c9" +
+                              "d18dbf6d5a25af5ce9016f281014d79dc3b4201ac646c451830fc7e61a2dfd633d34c39f87b818" +
+                              "94191652df5ac63cc40c77f3542f702bda692e6e8a9158353df189007a49da0f3cfd55eb250066" +
+                              "b19485ec")]

src/Serilog.Formatting.Compact.Reader/Properties/AssemblyInfo.cs

@@ -22,21 +22,25 @@ namespace Serilog.Formatting.Compact.Reader
     static class PropertyFactory
     {
         const string TypeTagPropertyName = "$type";
+        const string InvalidPropertyNameSubstitute = "(unnamed)";
 
-        public static LogEventProperty CreateProperty(string name, JToken value, IEnumerable<Rendering> renderings)
+        public static LogEventProperty CreateProperty(string name, JToken value, Rendering[] renderings)
         {
+            // The format allows (does not disallow) empty/null property names, but Serilog cannot represent them.
+            if (!LogEventProperty.IsValidName(name))
+                name = InvalidPropertyNameSubstitute;
+            
             return new LogEventProperty(name, CreatePropertyValue(value, renderings));
         }
 
-        static LogEventPropertyValue CreatePropertyValue(JToken value, IEnumerable<Rendering> renderings)
+        static LogEventPropertyValue CreatePropertyValue(JToken value, Rendering[] renderings)
         {
             if (value.Type == JTokenType.Null)
                 return new ScalarValue(null);
 
             if (value is JObject obj)
             {
-                JToken tt;
-                obj.TryGetValue(TypeTagPropertyName, out tt);
+                obj.TryGetValue(TypeTagPropertyName, out var tt);
                 return new StructureValue(
                     obj.Properties().Where(kvp => kvp.Name != TypeTagPropertyName).Select(kvp => CreateProperty(kvp.Name, kvp.Value, null)),
                     tt?.Value<string>());
@@ -49,7 +53,7 @@ static LogEventPropertyValue CreatePropertyValue(JToken value, IEnumerable<Rende
 
             var raw = value.Value<JValue>().Value;
 
-            return renderings != null && renderings.Any() ? 
+            return renderings != null && renderings.Length != 0 ? 
                 new RenderableScalarValue(raw, renderings) :
                 new ScalarValue(raw);
         }

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

@@ -11,9 +11,9 @@
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
     <PackageId>Serilog.Formatting.Compact.Reader</PackageId>
     <PackageTags>serilog;json</PackageTags>
-    <PackageIconUrl>http://serilog.net/images/serilog-extension-nuget.png</PackageIconUrl>
+    <PackageIcon>icon.png</PackageIcon>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/serilog/serilog-formatting-compact-reader</PackageProjectUrl>
-    <PackageLicenseUrl>http://www.apache.org/licenses/LICENSE-2.0</PackageLicenseUrl>
     <RepositoryUrl>https://github.com/serilog/serilog-formatting-compact-reader</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
   </PropertyGroup>
@@ -29,7 +29,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Folder Include="Properties\" />
+    <None Include="..\..\asset\icon.png" Pack="true" Visible="false" PackagePath="" />
   </ItemGroup>
 
 </Project>

src/Serilog.Formatting.Compact.Reader/Serilog.Formatting.Compact.Reader.csproj

@@ -0,0 +1,28 @@
+using Newtonsoft.Json.Linq;
+using Serilog.Events;
+using Xunit;
+
+namespace Serilog.Formatting.Compact.Reader.Tests
+{
+    public class PropertyFactoryTests
+    {
+        [Fact]
+        public void PropertiesAreConstructed()
+        {
+            const string name = "Test";
+            const string value = "Value";
+            var p = PropertyFactory.CreateProperty(name, new JValue(value), null);
+            Assert.Equal(p.Name, name);
+            var s = Assert.IsType<ScalarValue>(p.Value);
+            Assert.Equal(value, s.Value);
+        }
+
+        [Fact]
+        public void InvalidPropertyNamesAreSubstituted()
+        {
+            const string name = "";
+            var p = PropertyFactory.CreateProperty(name, new JValue((object)null), null);
+            Assert.NotEqual(p.Name, name);
+        }
+    }
+}

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

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net461;netcoreapp2.0;netcoreapp3.1</TargetFrameworks>
+    <TargetFrameworks>net462;net5.0</TargetFrameworks>
     <AssemblyName>Serilog.Formatting.Compact.Reader.Tests</AssemblyName>
     <AssemblyOriginatorKeyFile>../../asset/Serilog.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>