Merge pull request #67 from nblumhardt/suppress-execution-context-flow

Prevent capturing of the sink-creation-time `ExecutionContext` by the batching loop/batched sink

src/Serilog.Sinks.PeriodicBatching/Sinks/PeriodicBatching/PeriodicBatchingSink.cs

@@ -75,7 +75,11 @@ public PeriodicBatchingSink(IBatchedLogEventSink batchedSink, PeriodicBatchingSi
         _waitForShutdownSignal = Task.Delay(Timeout.InfiniteTimeSpan, _shutdownSignal.Token)
             .ContinueWith(e => e.Exception, TaskContinuationOptions.OnlyOnFaulted);
 
-        _runLoop = Task.Run(LoopAsync);
+        // The conditional here is no longer required in .NET 8+ (dotnet/runtime#82912)
+        using (ExecutionContext.IsFlowSuppressed() ? (IDisposable?)null : ExecutionContext.SuppressFlow())
+        {
+            _runLoop = Task.Run(LoopAsync);
+        }
     }
 
     /// <summary>

test/Serilog.Sinks.PeriodicBatching.Tests/PeriodicBatchingSinkTests.cs

@@ -86,4 +86,27 @@ public void WhenAnEventIsEnqueuedItIsWrittenToABatchOnDisposeWhileRunning()
         Assert.True(bs.IsDisposed);
         Assert.False(bs.WasCalledAfterDisposal);
     }
+
+    [Fact]
+    public void ExecutionContextDoesNotFlowToBatchedSink()
+    {
+        var local = new AsyncLocal<int>
+        {
+            Value = 5
+        };
+
+        var observed = 17;
+        var bs = new CallbackBatchedSink(_ =>
+        {
+            observed = local.Value;
+            return Task.CompletedTask;
+        });
+
+        var pbs = new PeriodicBatchingSink(bs, new());
+        var evt = Some.InformationEvent();
+        pbs.Emit(evt);
+        pbs.Dispose();
+
+        Assert.Equal(default(int), observed);
+    }
 }

test/Serilog.Sinks.PeriodicBatching.Tests/Support/CallbackBatchedSink.cs

@@ -0,0 +1,16 @@
+using Serilog.Events;
+
+namespace Serilog.Sinks.PeriodicBatching.Tests.Support;
+
+class CallbackBatchedSink(Func<IEnumerable<LogEvent>, Task> callback) : IBatchedLogEventSink
+{
+    public Task EmitBatchAsync(IEnumerable<LogEvent> batch)
+    {
+        return callback(batch);
+    }
+
+    public Task OnEmptyBatchAsync()
+    {
+        return Task.CompletedTask;
+    }
+}