fix: allows all printable characters as format values

The existing implementation used .IsPunctuation + IsLetterOrDigit with an override for '+' and ' '. That left some conspicuous holes and the spec itself is just "^\}" so basically anything goes in a format string. This allows for them and this does seem to have a reasonably large impact on the DefaultConsoleOutputTemplate parsing method. Everything else was within error bounds and no impact at all on memory allocs.
serilog · May 27, 2024 · 920b8c8 · 920b8c8
1 parent e1a0047
commit 920b8c8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 11 deletions.
diff --git a/src/Serilog/Parsing/MessageTemplateParser.cs b/src/Serilog/Parsing/MessageTemplateParser.cs
@@ -228,17 +228,10 @@ static bool TryGetDestructuringHint(char c, out Destructuring destructuring)
         }
     }
 
-    static bool IsValidInDestructuringHint(char c)
-    {
-        return c is '@' or '$';
-    }
-
     static bool IsValidInFormat(char c)
     {
-        return c != '}' &&
-               (char.IsLetterOrDigit(c) ||
-                char.IsPunctuation(c) ||
-                c is ' ' or '+');
+        // This is the entire ascii printable range minus '}' and DEL
+        return (byte)c >= 32 && (byte)c < 127 && c != '}';
     }
 
     static TextToken ParseTextToken(int startAt, string messageTemplate, out int next)

diff --git a/test/Serilog.Tests/Parsing/MessageTemplateParserTests.cs b/test/Serilog.Tests/Parsing/MessageTemplateParserTests.cs
@@ -243,10 +243,22 @@ public void FormatsCanContainColons()
     }
 
     [Fact]
-    public void APropertyWithValidNameAndInvalidFormatIsParsedAsText()
+    public void FormatsCanContainSymbolsAndOperators()
     {
         AssertParsedAs("{Hello:HH$MM}",
-            new TextToken("{Hello:HH$MM}"));
+            new PropertyToken("Hello", "{Hello:HH$MM}", "HH$MM"));
+
+        AssertParsedAs("{Hello:HH<MM}",
+            new PropertyToken("Hello", "{Hello:HH<MM}", "HH<MM"));
+
+        AssertParsedAs("{Hello:HH#MM}",
+            new PropertyToken("Hello", "{Hello:HH#MM}", "HH#MM"));
+
+        AssertParsedAs("{Hello:HH+MM}",
+            new PropertyToken("Hello", "{Hello:HH+MM}", "HH+MM"));
+
+        AssertParsedAs("{Hello:HH`MM}",
+            new PropertyToken("Hello", "{Hello:HH`MM}", "HH`MM"));
     }
 
     [Fact]