Back out message pre-rendering

Author: nblumhardt

src/Serilog.Sinks.Seq/Sinks/Seq/Formatting/CleanMessageTemplateFormatter.cs

@@ -22,8 +22,6 @@
 using Serilog.Formatting.Json;
 using Serilog.Parsing;
 using Serilog.Sinks.Seq.Conventions;
-using Serilog.Sinks.Seq.Formatting;
-
 // ReSharper disable MemberCanBePrivate.Global
 // ReSharper disable PossibleMultipleEnumeration
 
@@ -39,17 +37,16 @@ public class SeqCompactJsonFormatter: ITextFormatter
     readonly IDottedPropertyNameConvention _dottedPropertyNameConvention;
     readonly JsonValueFormatter _valueFormatter;
     readonly IFormatProvider _formatProvider;
-    readonly bool _renderMessages;
 
-    /// <summary>Construct a <see cref="SeqCompactJsonFormatter"/>.</summary>
+    /// <summary>
+    /// Construct a <see cref="SeqCompactJsonFormatter"/>.
+    /// </summary>
     /// <param name="valueFormatter">A value formatter for <see cref="LogEventPropertyValue"/>s on the event.</param>
     /// <param name="formatProvider">An <see cref="IFormatProvider"/> that will be used to render log event tokens.</param>
     public SeqCompactJsonFormatter(IFormatProvider? formatProvider = null, JsonValueFormatter? valueFormatter = null)
     {
         var acceptDottedPropertyNames = AppContext.TryGetSwitch("Serilog.Parsing.MessageTemplateParser.AcceptDottedPropertyNames", out var accept) && accept;
 
-        _renderMessages = acceptDottedPropertyNames || formatProvider != null && !ReferenceEquals(formatProvider, CultureInfo.InvariantCulture);
-
         _dottedPropertyNameConvention = acceptDottedPropertyNames ?
             new UnflattenDottedPropertyNames() :
             new PreserveDottedPropertyNames();
@@ -85,38 +82,26 @@ public void FormatEvent(LogEvent logEvent, TextWriter output)
         output.Write("\",\"@mt\":");
         JsonValueFormatter.WriteQuotedJsonString(logEvent.MessageTemplate.Text, output);
 
-        if (_renderMessages)
-        {
-            // `@m` is normally created during ingestion, however, it must be sent from the client 
-            // to honour non-default IFormatProviders
-            output.Write(",\"@m\":");
-            JsonValueFormatter.WriteQuotedJsonString(
-                CleanMessageTemplateFormatter.Format(logEvent.MessageTemplate, logEvent.Properties, _formatProvider),
-                output);
-        }
-        else
-        {
-            var tokensWithFormat = logEvent.MessageTemplate.Tokens
-                .OfType<PropertyToken>()
-                .Where(pt => pt.Format != null);
+        var tokensWithFormat = logEvent.MessageTemplate.Tokens
+            .OfType<PropertyToken>()
+            .Where(pt => pt.Format != null);
 
-            // Better not to allocate an array in the 99.9% of cases where this is false
-            // ReSharper disable once PossibleMultipleEnumeration
-            if (tokensWithFormat.Any())
+        // Better not to allocate an array in the 99.9% of cases where this is false
+        // ReSharper disable once PossibleMultipleEnumeration
+        if (tokensWithFormat.Any())
+        {
+            output.Write(",\"@r\":[");
+            var delim = "";
+            foreach (var r in tokensWithFormat)
             {
-                output.Write(",\"@r\":[");
-                var delim = "";
-                foreach (var r in tokensWithFormat)
-                {
-                    output.Write(delim);
-                    delim = ",";
-                    var space = new StringWriter();
-                    r.Render(logEvent.Properties, space, _formatProvider);
-                    JsonValueFormatter.WriteQuotedJsonString(space.ToString(), output);
-                }
-
-                output.Write(']');
+                output.Write(delim);
+                delim = ",";
+                var space = new StringWriter();
+                r.Render(logEvent.Properties, space, _formatProvider);
+                JsonValueFormatter.WriteQuotedJsonString(space.ToString(), output);
             }
+
+            output.Write(']');
         }
 
         if (logEvent.Level != LogEventLevel.Information)

src/Serilog.Sinks.Seq/Sinks/Seq/Formatting/Padding.cs

@@ -5,11 +5,9 @@
 using System.Diagnostics;
 using System.Globalization;
 using System.IO;
-using System.Linq;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Serilog.Events;
-using Serilog.Parsing;
 using Xunit;
 // ReSharper disable AccessToDisposedClosure
 // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local
@@ -18,7 +16,7 @@ namespace Serilog.Sinks.Seq.Tests;
 
 public class SeqCompactJsonFormatterTests
 {
-    JObject AssertValidJson(Action<ILogger> act, IFormatProvider? formatProvider = null, Action<JObject>? assert = null)
+    static JObject AssertValidJson(Action<ILogger> act, IFormatProvider? formatProvider = null, Action<JObject>? assert = null)
     {
         var sw = new StringWriter();
         var logger = new LoggerConfiguration()
@@ -48,40 +46,21 @@ public void PropertiesFormatCorrectlyForTheFormatProvider(string cultureName)
     {
         var cultureInfo = new CultureInfo(cultureName);
 
-        var number = Math.PI * 10000;
+        const double number = Math.PI * 10000;
         var date = new DateTime(2024, 7, 19, 10, 00, 59);
-        var currency = 12345.67M;
+        const decimal currency = 12345.67M;
 
-        // Culture-specific formatting differs by .NET version (and possibly OS).
-        var messageBuilder = new StringWriter(cultureInfo);
-        messageBuilder.Write("{0:n} {1} {2:C}", number, date, currency);
-        var expectedMessage = messageBuilder.ToString();
+        // Culture-specific formatting differs by .NET version platform.
+        var expectedNumber = number.ToString("n", cultureInfo);
+        var expectedCurrency = currency.ToString("C", cultureInfo);
 
         AssertValidJson(log => log.Information("{a:n} {b} {c:C}", number, date, currency), cultureInfo, evt =>
         {
-            Assert.Equal(expectedMessage, evt["@m"]!.Value<string>());
-            Assert.Null(evt["@r"]);
+            Assert.Equal(expectedNumber, evt["@r"]![0]!.Value<string>());
+            Assert.Equal(expectedCurrency, evt["@r"]![1]!.Value<string>());
         });
     }
-
-    [Fact]
-    public void MessageNotRenderedForDefaultFormatProvider()
-    {
-        AssertValidJson(log => log.Information("{a}", 1.234), null, evt =>
-        {
-            Assert.Null(evt["@m"]);
-        });
-    }
-
-    [Fact]
-    public void MessageNotRenderedForExplicitInvariantCulture()
-    {
-        AssertValidJson(log => log.Information("{a}", 1.234), CultureInfo.InvariantCulture, evt =>
-        {
-            Assert.Null(evt["@m"]);
-        });
-    }
-
+    
     [Fact]
     public void AnEmptyEventIsValidJson()
     {
@@ -150,9 +129,7 @@ public void TraceAndSpanIdsGenerateValidJson()
     {
         var traceId = ActivityTraceId.CreateRandom();
         var spanId = ActivitySpanId.CreateRandom();
-        var evt = new LogEvent(DateTimeOffset.Now, LogEventLevel.Information, null,
-            new MessageTemplate(Enumerable.Empty<MessageTemplateToken>()), Enumerable.Empty<LogEventProperty>(),
-            traceId, spanId);
+        var evt = new LogEvent(DateTimeOffset.Now, LogEventLevel.Information, null, MessageTemplate.Empty, [], traceId, spanId);
         var json = AssertValidJson(log => log.Write(evt));
         Assert.Equal(traceId.ToHexString(), json["@tr"]);
         Assert.Equal(spanId.ToHexString(), json["@sp"]);