Merge pull request #189 from AlanLiu90/Branch_FixConsole

Fix thread safe issue about console output
Cysharp · Dec 5, 2024 · fc06513 · fc06513
2 parents 395235e + 3f0bfed
commit fc06513
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 22 deletions.
diff --git a/src/ZLogger/AsyncStreamLineMessageWriter.cs b/src/ZLogger/AsyncStreamLineMessageWriter.cs
@@ -17,16 +17,8 @@ public sealed class AsyncStreamLineMessageWriter : IAsyncLogProcessor, IAsyncDis
         readonly Channel<IZLoggerEntry> channel;
         readonly Task writeLoop;
         readonly ZLoggerOptions options;
-        readonly Func<LogLevel, bool>? levelFilter;
-
-        public AsyncStreamLineMessageWriter(Stream stream, ZLoggerOptions options)
-            : this(stream, options, null)
-        {
-        }
 
-        // handling `Func<LogLevel, bool>? levelFilter` correctly is very context dependent.
-        // so only allows internal provider.
-        internal AsyncStreamLineMessageWriter(Stream stream, ZLoggerOptions options, Func<LogLevel, bool>? levelFilter = null)
+        public AsyncStreamLineMessageWriter(Stream stream, ZLoggerOptions options)
         {
             this.newLine = Encoding.UTF8.GetBytes(Environment.NewLine);
             if (newLine.Length == 1)
@@ -46,7 +38,6 @@ internal AsyncStreamLineMessageWriter(Stream stream, ZLoggerOptions options, Fun
 
             this.options = options;
             this.stream = stream;
-            this.levelFilter = levelFilter;
 
             channel = this.options.FullMode switch
             {
@@ -121,7 +112,6 @@ async Task WriteLoop()
             var writer = new StreamBufferWriter(stream);
             var formatter = options.CreateFormatter();
             var withLineBreak = formatter.WithLineBreak;
-            var requireFilterCheck = levelFilter != null;
             var reader = channel.Reader;
 
             while (await reader.WaitToReadAsync().ConfigureAwait(false))
@@ -130,10 +120,6 @@ async Task WriteLoop()
                 {
                     while (reader.TryRead(out var value))
                     {
-                        if (requireFilterCheck && levelFilter!.Invoke(value.LogInfo.LogLevel) == false)
-                        {
-                            continue;
-                        }
                         try
                         {
                             value.FormatUtf8(writer, formatter);

diff --git a/src/ZLogger/Providers/ZLoggerConsoleLoggerProvider.cs b/src/ZLogger/Providers/ZLoggerConsoleLoggerProvider.cs
@@ -27,8 +27,9 @@ public ZLoggerConsoleLoggerProvider(ZLoggerConsoleOptions options)
         {
             var logToStandardErrorThreshold = options.LogToStandardErrorThreshold;
             processor = new DualAsyncLogProcessor(
-                 new AsyncStreamLineMessageWriter(Console.OpenStandardOutput(), this.options, level => level < logToStandardErrorThreshold),
-                 new AsyncStreamLineMessageWriter(Console.OpenStandardError(), this.options, level => level >= logToStandardErrorThreshold));
+                 new AsyncStreamLineMessageWriter(Console.OpenStandardOutput(), this.options),
+                 new AsyncStreamLineMessageWriter(Console.OpenStandardError(), this.options),
+                 level => level < logToStandardErrorThreshold);
         }
     }
 
@@ -52,14 +53,18 @@ public void SetScopeProvider(IExternalScopeProvider scopeProvider)
         this.scopeProvider = scopeProvider;
     }
 
-    sealed class DualAsyncLogProcessor(AsyncStreamLineMessageWriter processor1, AsyncStreamLineMessageWriter processor2) : IAsyncLogProcessor
+    sealed class DualAsyncLogProcessor(AsyncStreamLineMessageWriter processor1, AsyncStreamLineMessageWriter processor2, Func<LogLevel, bool> levelFilter) : IAsyncLogProcessor
     {
         public void Post(IZLoggerEntry log)
         {
-            // Post two entry is dangerous for log-state reference count cache.
-            // However filtered reader-loop does not call Return so ok to post multiple.
-            processor1.Post(log);
-            processor2.Post(log);
+            if (levelFilter(log.LogInfo.LogLevel))
+            {
+                processor1.Post(log);
+            }
+            else
+            {
+                processor2.Post(log);
+            }
         }
 
         public async ValueTask DisposeAsync()