Merge pull request #35 from vonhoff/34-freezing-under-heavy-load

vonhoff · web-flow · commit 23cab11a571d · 2025-07-13T09:45:41.000+02:00
Refactor RichTextBoxSink and formatting classes to improve performance
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,12 +1,9 @@
-## Release Notes - Serilog.Sinks.RichTextBox.WinForms.Colored v3.1.2
+## Release Notes - Serilog.Sinks.RichTextBox.WinForms.Colored v3.1.3
 
 ### What Changed
 
-- Fixed a bug where cross-thread log messages during form construction caused `System.InvalidOperationException` due to premature access of the RichTextBox.
-
-### Contributors
-
-- [Steffen S. Hellestøl](https://github.com/SteffenSH)
+- Fixed performance issues when logging large numbers of complex messages that could cause application freezing.
+- Fixed `ArgumentOutOfRangeException` thrown from `RtfBuilder.Clear()`
 
 ### Resources
 
diff --git a/Serilog.Sinks.RichTextBox.WinForms.Colored/Serilog.Sinks.RichTextBox.WinForms.Colored.csproj b/Serilog.Sinks.RichTextBox.WinForms.Colored/Serilog.Sinks.RichTextBox.WinForms.Colored.csproj
@@ -22,9 +22,10 @@
         <TargetFrameworks>net462;net471;net6.0-windows;net8.0-windows;net9.0-windows;netcoreapp3.0-windows;netcoreapp3.1-windows</TargetFrameworks>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <UseWindowsForms>true</UseWindowsForms>
-        <Version>3.1.2</Version>
+        <Version>3.1.3</Version>
         <PackageReleaseNotes>
-- Fixed a bug where cross-thread log messages during form construction caused `System.InvalidOperationException` due to premature access of the RichTextBox.
+- Fixed performance issues when logging large numbers of complex messages that could cause application freezing.
+- Fixed `ArgumentOutOfRangeException` thrown from `RtfBuilder.Clear()`
 
 See repository for more information:
 https://github.com/vonhoff/Serilog.Sinks.RichTextBox.WinForms.Colored
diff --git a/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Formatting/DisplayValueFormatter.cs b/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Formatting/DisplayValueFormatter.cs
@@ -30,7 +30,7 @@ public class DisplayValueFormatter : ValueFormatter
     {
         private readonly IFormatProvider? _formatProvider;
         private readonly StringBuilder _scalarBuilder = new();
-        private readonly StringBuilder _stringBuilder = new();
+        private readonly StringBuilder _literalBuilder = new(64);
         private JsonValueFormatter? _jsonValueFormatter;
 
         public DisplayValueFormatter(Theme theme, IFormatProvider? formatProvider) : base(theme, formatProvider)
@@ -53,9 +53,9 @@ private void FormatLiteralValue(ScalarValue scalar, IRtfCanvas canvas, string? f
                     return;
 
                 case byte[] bytes:
-                    _stringBuilder.Clear();
-                    _stringBuilder.Append('"').Append(Convert.ToBase64String(bytes)).Append('"');
-                    Theme.Render(canvas, StyleToken.String, _stringBuilder.ToString());
+                    _literalBuilder.Clear();
+                    _literalBuilder.Append('"').Append(Convert.ToBase64String(bytes)).Append('"');
+                    Theme.Render(canvas, StyleToken.String, _literalBuilder.ToString());
                     return;
 
                 case bool b:
@@ -90,9 +90,9 @@ private void RenderString(string text, IRtfCanvas canvas, string? format, bool i
             }
             else
             {
-                _stringBuilder.Clear();
-                _stringBuilder.Append('"').Append(text.Replace("\"", "\\\"")).Append('"');
-                Theme.Render(canvas, StyleToken.String, _stringBuilder.ToString());
+                _literalBuilder.Clear();
+                _literalBuilder.Append('"').Append(text.Replace("\"", "\\\"")).Append('"');
+                Theme.Render(canvas, StyleToken.String, _literalBuilder.ToString());
             }
         }
 
diff --git a/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Formatting/JsonValueFormatter.cs b/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Formatting/JsonValueFormatter.cs
@@ -218,65 +218,55 @@ private void FormatLiteralValue(ScalarValue scalar, IRtfCanvas canvas)
             }
         }
 
-        private static void WriteQuotedJsonString(string str, TextWriter output)
+        private static void WriteQuotedJsonString(StringBuilder builder, string str)
         {
-            output.Write('\"');
+            builder.Append('\"');
 
             foreach (var c in str)
             {
                 switch (c)
                 {
                     case '"':
-                        output.Write("\\\"");
+                        builder.Append("\\\"");
                         break;
 
                     case '\\':
-                        output.Write(@"\\");
+                        builder.Append(@"\\");
                         break;
 
                     case '\n':
-                        output.Write("\\n");
+                        builder.Append("\\n");
                         break;
 
                     case '\r':
-                        output.Write("\\r");
+                        builder.Append("\\r");
                         break;
 
                     case '\f':
-                        output.Write("\\f");
+                        builder.Append("\\f");
                         break;
 
                     case '\t':
-                        output.Write("\\t");
+                        builder.Append("\\t");
                         break;
 
                     case < (char)32:
-                        output.Write("\\u");
-                        output.Write(((int)c).ToString("X4"));
+                        builder.Append("\\u");
+                        builder.Append(((int)c).ToString("X4"));
                         break;
 
                     default:
-                        output.Write(c);
+                        builder.Append(c);
                         break;
                 }
             }
-            output.Write('\"');
+            builder.Append('\"');
         }
 
         private string GetQuotedJsonString(string str)
         {
             _jsonStringBuilder.Clear();
-            var estimatedCapacity = str.Length + 2;
-            if (_jsonStringBuilder.Capacity < estimatedCapacity)
-            {
-                _jsonStringBuilder.Capacity = estimatedCapacity;
-            }
-
-            using (var writer = new StringWriter(_jsonStringBuilder))
-            {
-                WriteQuotedJsonString(str, writer);
-            }
-
+            WriteQuotedJsonString(_jsonStringBuilder, str);
             return _jsonStringBuilder.ToString();
         }
     }
diff --git a/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/RichTextBoxSink.cs b/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/RichTextBoxSink.cs
@@ -40,7 +40,6 @@ public class RichTextBoxSink : ILogEventSink, IDisposable
         private readonly CancellationTokenSource _tokenSource;
         private readonly Task _processingTask;
         private bool _disposed;
-        private int _hasNewMessages;
 
         public RichTextBoxSink(RichTextBox richTextBox, RichTextBoxSinkOptions options, ITokenRenderer? renderer = null)
         {
@@ -51,7 +50,6 @@ public RichTextBoxSink(RichTextBox richTextBox, RichTextBoxSinkOptions options,
 
             _buffer = new ConcurrentCircularBuffer<LogEvent>(options.MaxLogLines);
             _signal = new AutoResetEvent(false);
-            _hasNewMessages = 0;
 
             richTextBox.Clear();
             richTextBox.ReadOnly = true;
@@ -78,24 +76,28 @@ public void Dispose()
         public void Emit(LogEvent logEvent)
         {
             _buffer.Add(logEvent);
-            Update();
+            _signal.Set();
         }
 
         public void Clear()
         {
+            if (_disposed)
+            {
+                return;
+            }
+
             _buffer.Clear();
-            Update();
+            _signal.Set();
         }
 
         public void Restore()
         {
-            _buffer.Restore();
-            Update();
-        }
+            if (_disposed)
+            {
+                return;
+            }
 
-        private void Update()
-        {
-            Interlocked.Exchange(ref _hasNewMessages, 1);
+            _buffer.Restore();
             _signal.Set();
         }
 
@@ -104,38 +106,43 @@ private void ProcessMessages(CancellationToken token)
             var builder = new RtfBuilder(_options.Theme);
             var snapshot = new System.Collections.Generic.List<LogEvent>(_options.MaxLogLines);
             var flushInterval = TimeSpan.FromMilliseconds(FlushIntervalMs);
-            var lastFlush = DateTime.UtcNow;
+            var lastFlush = DateTime.MinValue;
 
             while (!token.IsCancellationRequested)
             {
                 _signal.WaitOne();
-
-                if (Interlocked.CompareExchange(ref _hasNewMessages, 0, 1) != 1)
+                if (token.IsCancellationRequested)
                 {
-                    continue;
+                    break;
                 }
 
                 var now = DateTime.UtcNow;
-                var elapsed = now - lastFlush;
-                if (elapsed < flushInterval)
+                var elapsedSinceLastFlush = now - lastFlush;
+                if (elapsedSinceLastFlush < flushInterval)
                 {
-                    var remaining = flushInterval - elapsed;
-                    if (remaining > TimeSpan.Zero)
+                    var remainingTime = flushInterval - elapsedSinceLastFlush;
+                    if (token.WaitHandle.WaitOne(remainingTime))
                     {
-                        Thread.Sleep(remaining);
+                        break;
                     }
                 }
 
-                Interlocked.Exchange(ref _hasNewMessages, 0);
+                _signal.Reset();
                 _buffer.TakeSnapshot(snapshot);
                 builder.Clear();
                 foreach (var evt in snapshot)
                 {
                     _renderer.Render(evt, builder);
                 }
+
+                if (_richTextBox.IsDisposed || _richTextBox.Disposing)
+                {
+                    continue;
+                }
+
                 _richTextBox.SetRtf(builder.Rtf, _options.AutoScroll, token);
                 lastFlush = DateTime.UtcNow;
             }
         }
     }
-}
+}
diff --git a/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Rtf/RtfBuilder.cs b/Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Rtf/RtfBuilder.cs
@@ -179,6 +179,7 @@ public void Dispose()
         public void Clear()
         {
             _body.Clear();
+            _documentBuilder.Clear();
 
             const int maxRetainedBuilderSize = 64 * 1024;
             if (_body.Capacity > maxRetainedBuilderSize)

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public class DisplayValueFormatter : ValueFormatter`
`30`	`30`	`{`
`31`	`31`	`private readonly IFormatProvider? _formatProvider;`
`32`	`32`	`private readonly StringBuilder _scalarBuilder = new();`
`33`		`- private readonly StringBuilder _stringBuilder = new();`
	`33`	`+ private readonly StringBuilder _literalBuilder = new(64);`
`34`	`34`	`private JsonValueFormatter? _jsonValueFormatter;`
`35`	`35`
`36`	`36`	`public DisplayValueFormatter(Theme theme, IFormatProvider? formatProvider) : base(theme, formatProvider)`
`@@ -53,9 +53,9 @@ private void FormatLiteralValue(ScalarValue scalar, IRtfCanvas canvas, string? f`
`53`	`53`	`return;`
`54`	`54`
`55`	`55`	`case byte[] bytes:`
`56`		`- _stringBuilder.Clear();`
`57`		`- _stringBuilder.Append('"').Append(Convert.ToBase64String(bytes)).Append('"');`
`58`		`- Theme.Render(canvas, StyleToken.String, _stringBuilder.ToString());`
	`56`	`+ _literalBuilder.Clear();`
	`57`	`+ _literalBuilder.Append('"').Append(Convert.ToBase64String(bytes)).Append('"');`
	`58`	`+ Theme.Render(canvas, StyleToken.String, _literalBuilder.ToString());`
`59`	`59`	`return;`
`60`	`60`
`61`	`61`	`case bool b:`
`@@ -90,9 +90,9 @@ private void RenderString(string text, IRtfCanvas canvas, string? format, bool i`
`90`	`90`	`}`
`91`	`91`	`else`
`92`	`92`	`{`
`93`		`- _stringBuilder.Clear();`
`94`		`- _stringBuilder.Append('"').Append(text.Replace("\"", "\\\"")).Append('"');`
`95`		`- Theme.Render(canvas, StyleToken.String, _stringBuilder.ToString());`
	`93`	`+ _literalBuilder.Clear();`
	`94`	`+ _literalBuilder.Append('"').Append(text.Replace("\"", "\\\"")).Append('"');`
	`95`	`+ Theme.Render(canvas, StyleToken.String, _literalBuilder.ToString());`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@ public class RichTextBoxSink : ILogEventSink, IDisposable`
`40`	`40`	`private readonly CancellationTokenSource _tokenSource;`
`41`	`41`	`private readonly Task _processingTask;`
`42`	`42`	`private bool _disposed;`
`43`		`- private int _hasNewMessages;`
`44`	`43`
`45`	`44`	`public RichTextBoxSink(RichTextBox richTextBox, RichTextBoxSinkOptions options, ITokenRenderer? renderer = null)`
`46`	`45`	`{`
`@@ -51,7 +50,6 @@ public RichTextBoxSink(RichTextBox richTextBox, RichTextBoxSinkOptions options,`
`51`	`50`
`52`	`51`	`_buffer = new ConcurrentCircularBuffer<LogEvent>(options.MaxLogLines);`
`53`	`52`	`_signal = new AutoResetEvent(false);`
`54`		`- _hasNewMessages = 0;`
`55`	`53`
`56`	`54`	`richTextBox.Clear();`
`57`	`55`	`richTextBox.ReadOnly = true;`
`@@ -78,24 +76,28 @@ public void Dispose()`
`78`	`76`	`public void Emit(LogEvent logEvent)`
`79`	`77`	`{`
`80`	`78`	`_buffer.Add(logEvent);`
`81`		`- Update();`
	`79`	`+ _signal.Set();`
`82`	`80`	`}`
`83`	`81`
`84`	`82`	`public void Clear()`
`85`	`83`	`{`
	`84`	`+ if (_disposed)`
	`85`	`+ {`
	`86`	`+ return;`
	`87`	`+ }`
	`88`	`+`
`86`	`89`	`_buffer.Clear();`
`87`		`- Update();`
	`90`	`+ _signal.Set();`
`88`	`91`	`}`
`89`	`92`
`90`	`93`	`public void Restore()`
`91`	`94`	`{`
`92`		`- _buffer.Restore();`
`93`		`- Update();`
`94`		`- }`
	`95`	`+ if (_disposed)`
	`96`	`+ {`
	`97`	`+ return;`
	`98`	`+ }`
`95`	`99`
`96`		`- private void Update()`
`97`		`- {`
`98`		`- Interlocked.Exchange(ref _hasNewMessages, 1);`
	`100`	`+ _buffer.Restore();`
`99`	`101`	`_signal.Set();`
`100`	`102`	`}`
`101`	`103`
`@@ -104,38 +106,43 @@ private void ProcessMessages(CancellationToken token)`
`104`	`106`	`var builder = new RtfBuilder(_options.Theme);`
`105`	`107`	`var snapshot = new System.Collections.Generic.List<LogEvent>(_options.MaxLogLines);`
`106`	`108`	`var flushInterval = TimeSpan.FromMilliseconds(FlushIntervalMs);`
`107`		`- var lastFlush = DateTime.UtcNow;`
	`109`	`+ var lastFlush = DateTime.MinValue;`
`108`	`110`
`109`	`111`	`while (!token.IsCancellationRequested)`
`110`	`112`	`{`
`111`	`113`	`_signal.WaitOne();`
`112`		`-`
`113`		`- if (Interlocked.CompareExchange(ref _hasNewMessages, 0, 1) != 1)`
	`114`	`+ if (token.IsCancellationRequested)`
`114`	`115`	`{`
`115`		`- continue;`
	`116`	`+ break;`
`116`	`117`	`}`
`117`	`118`
`118`	`119`	`var now = DateTime.UtcNow;`
`119`		`- var elapsed = now - lastFlush;`
`120`		`- if (elapsed < flushInterval)`
	`120`	`+ var elapsedSinceLastFlush = now - lastFlush;`
	`121`	`+ if (elapsedSinceLastFlush < flushInterval)`
`121`	`122`	`{`
`122`		`- var remaining = flushInterval - elapsed;`
`123`		`- if (remaining > TimeSpan.Zero)`
	`123`	`+ var remainingTime = flushInterval - elapsedSinceLastFlush;`
	`124`	`+ if (token.WaitHandle.WaitOne(remainingTime))`
`124`	`125`	`{`
`125`		`- Thread.Sleep(remaining);`
	`126`	`+ break;`
`126`	`127`	`}`
`127`	`128`	`}`
`128`	`129`
`129`		`- Interlocked.Exchange(ref _hasNewMessages, 0);`
	`130`	`+ _signal.Reset();`
`130`	`131`	`_buffer.TakeSnapshot(snapshot);`
`131`	`132`	`builder.Clear();`
`132`	`133`	`foreach (var evt in snapshot)`
`133`	`134`	`{`
`134`	`135`	`_renderer.Render(evt, builder);`
`135`	`136`	`}`
	`137`	`+`
	`138`	`+ if (_richTextBox.IsDisposed \|\| _richTextBox.Disposing)`
	`139`	`+ {`
	`140`	`+ continue;`
	`141`	`+ }`
	`142`	`+`
`136`	`143`	`_richTextBox.SetRtf(builder.Rtf, _options.AutoScroll, token);`
`137`	`144`	`lastFlush = DateTime.UtcNow;`
`138`	`145`	`}`
`139`	`146`	`}`
`140`	`147`	`}`
`141`		`-}`
	`148`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,7 @@ public void Dispose()`
`179`	`179`	`public void Clear()`
`180`	`180`	`{`
`181`	`181`	`_body.Clear();`
	`182`	`+ _documentBuilder.Clear();`
`182`	`183`
`183`	`184`	`const int maxRetainedBuilderSize = 64 * 1024;`
`184`	`185`	`if (_body.Capacity > maxRetainedBuilderSize)`