ref: delete Timer-Abstraction and change to System.Threading.Timer

src/Sentry/Internal/BatchProcessor.cs

@@ -1,4 +1,4 @@
-using System.Timers;
+using Sentry.Extensibility;
 using Sentry.Protocol;
 using Sentry.Protocol.Envelopes;
 
@@ -16,23 +16,21 @@ namespace Sentry.Internal;
 internal sealed class BatchProcessor : IDisposable
 {
     private readonly IHub _hub;
-    private readonly BatchProcessorTimer _timer;
+    private readonly TimeSpan _batchInterval;
+    private readonly IDiagnosticLogger? _diagnosticLogger;
+    private readonly Timer _timer;
     private readonly BatchBuffer<SentryLog> _logs;
     private readonly object _lock;
 
     private DateTime _lastFlush = DateTime.MinValue;
 
-    public BatchProcessor(IHub hub, int batchCount, TimeSpan batchInterval)
-        : this(hub, batchCount, new TimersBatchProcessorTimer(batchInterval))
-    {
-    }
-
-    public BatchProcessor(IHub hub, int batchCount, BatchProcessorTimer timer)
+    public BatchProcessor(IHub hub, int batchCount, TimeSpan batchInterval, IDiagnosticLogger? diagnosticLogger)
     {
         _hub = hub;
+        _batchInterval = batchInterval;
+        _diagnosticLogger = diagnosticLogger;
 
-        _timer = timer;
-        _timer.Elapsed += OnIntervalElapsed;
+        _timer = new Timer(OnIntervalElapsed, this, Timeout.Infinite, Timeout.Infinite);
 
         _logs = new BatchBuffer<SentryLog>(batchCount);
         _lock = new object();
@@ -54,11 +52,11 @@ private void EnqueueCore(SentryLog log)
 
         if (isFirstLog && !_logs.IsFull)
         {
-            _timer.Enabled = true;
+            EnableTimer();
         }
         else if (_logs.IsFull)
         {
-            _timer.Enabled = false;
+            DisableTimer();
             Flush();
         }
     }
@@ -71,23 +69,31 @@ private void Flush()
         _ = _hub.CaptureEnvelope(Envelope.FromLog(new StructuredLog(logs)));
     }
 
-    private void OnIntervalElapsed(object? sender, ElapsedEventArgs e)
+    internal void OnIntervalElapsed(object? state)
     {
-        _timer.Enabled = false;
-
         lock (_lock)
         {
-            if (!_logs.IsEmpty && e.SignalTime > _lastFlush)
+            if (!_logs.IsEmpty && DateTime.UtcNow > _lastFlush)
             {
                 Flush();
             }
         }
     }
 
+    private void EnableTimer()
+    {
+        var updated = _timer.Change(_batchInterval, Timeout.InfiniteTimeSpan);
+        Debug.Assert(updated, "Timer was not successfully enabled.");
+    }
+
+    private void DisableTimer()
+    {
+        var updated = _timer.Change(Timeout.Infinite, Timeout.Infinite);
+        Debug.Assert(updated, "Timer was not successfully disabled.");
+    }
+
     public void Dispose()
     {
-        _timer.Enabled = false;
-        _timer.Elapsed -= OnIntervalElapsed;
         _timer.Dispose();
     }
 }

src/Sentry/Internal/DefaultSentryStructuredLogger.cs

@@ -19,7 +19,7 @@ internal DefaultSentryStructuredLogger(IHub hub, SentryOptions options, ISystemC
         _options = options;
         _clock = clock;
 
-        _batchProcessor = new BatchProcessor(hub, ClampBatchCount(options.Experimental.InternalBatchSize), ClampBatchInterval(options.Experimental.InternalBatchTimeout));
+        _batchProcessor = new BatchProcessor(hub, ClampBatchCount(options.Experimental.InternalBatchSize), ClampBatchInterval(options.Experimental.InternalBatchTimeout), _options.DiagnosticLogger);
     }
 
     private static int ClampBatchCount(int batchCount)

test/Sentry.Tests/Internals/BatchProcessorTests.cs

@@ -1,49 +1,47 @@
 #nullable enable
 
-using System.Timers;
-
 namespace Sentry.Tests.Internals;
 
-public class BatchProcessorTests
+public class BatchProcessorTests : IDisposable
 {
     private readonly IHub _hub;
-    private readonly FakeBatchProcessorTimer _timer;
+    private readonly InMemoryDiagnosticLogger _diagnosticLogger;
     private readonly List<Envelope> _envelopes;
 
     public BatchProcessorTests()
     {
         _hub = Substitute.For<IHub>();
-        _timer = new FakeBatchProcessorTimer();
+        _diagnosticLogger = new InMemoryDiagnosticLogger();
 
         _envelopes = [];
         _hub.CaptureEnvelope(Arg.Do<Envelope>(arg => _envelopes.Add(arg)));
     }
 
-    [Theory]
+    [Theory(Skip = "May no longer be required after feedback.")]
     [InlineData(-1)]
     [InlineData(0)]
     public void Ctor_CountOutOfRange_Throws(int count)
     {
-        var ctor = () => new BatchProcessor(_hub, count, TimeSpan.FromMilliseconds(10));
+        var ctor = () => new BatchProcessor(_hub, count, TimeSpan.FromMilliseconds(10), _diagnosticLogger);
 
         Assert.Throws<ArgumentOutOfRangeException>(ctor);
     }
 
-    [Theory]
+    [Theory(Skip = "May no longer be required after feedback.")]
     [InlineData(-1)]
     [InlineData(0)]
     [InlineData(int.MaxValue + 1.0)]
     public void Ctor_IntervalOutOfRange_Throws(double interval)
     {
-        var ctor = () => new BatchProcessor(_hub, 1, TimeSpan.FromMilliseconds(interval));
+        var ctor = () => new BatchProcessor(_hub, 1, TimeSpan.FromMilliseconds(interval), _diagnosticLogger);
 
         Assert.Throws<ArgumentException>(ctor);
     }
 
     [Fact]
     public void Enqueue_NeitherSizeNorTimeoutReached_DoesNotCaptureEnvelope()
     {
-        using var processor = new BatchProcessor(_hub, 2, _timer);
+        using var processor = new BatchProcessor(_hub, 2, Timeout.InfiniteTimeSpan, _diagnosticLogger);
 
         processor.Enqueue(CreateLog("one"));
 
@@ -54,7 +52,7 @@ public void Enqueue_NeitherSizeNorTimeoutReached_DoesNotCaptureEnvelope()
     [Fact]
     public void Enqueue_SizeReached_CaptureEnvelope()
     {
-        using var processor = new BatchProcessor(_hub, 2, _timer);
+        using var processor = new BatchProcessor(_hub, 2, Timeout.InfiniteTimeSpan, _diagnosticLogger);
 
         processor.Enqueue(CreateLog("one"));
         processor.Enqueue(CreateLog("two"));
@@ -66,11 +64,11 @@ public void Enqueue_SizeReached_CaptureEnvelope()
     [Fact]
     public void Enqueue_TimeoutReached_CaptureEnvelope()
     {
-        using var processor = new BatchProcessor(_hub, 2, _timer);
+        using var processor = new BatchProcessor(_hub, 2, Timeout.InfiniteTimeSpan, _diagnosticLogger);
 
         processor.Enqueue(CreateLog("one"));
 
-        _timer.InvokeElapsed(DateTime.Now);
+        processor.OnIntervalElapsed(null);
 
         AssertCaptureEnvelope(1);
         AssertEnvelope("one");
@@ -79,11 +77,11 @@ public void Enqueue_TimeoutReached_CaptureEnvelope()
     [Fact]
     public void Enqueue_BothSizeAndTimeoutReached_CaptureEnvelopeOnce()
     {
-        using var processor = new BatchProcessor(_hub, 2, _timer);
+        using var processor = new BatchProcessor(_hub, 2, Timeout.InfiniteTimeSpan, _diagnosticLogger);
 
         processor.Enqueue(CreateLog("one"));
         processor.Enqueue(CreateLog("two"));
-        _timer.InvokeElapsed(DateTime.Now);
+        processor.OnIntervalElapsed(null);
 
         AssertCaptureEnvelope(1);
         AssertEnvelope("one", "two");
@@ -92,11 +90,11 @@ public void Enqueue_BothSizeAndTimeoutReached_CaptureEnvelopeOnce()
     [Fact]
     public void Enqueue_BothTimeoutAndSizeReached_CaptureEnvelopes()
     {
-        using var processor = new BatchProcessor(_hub, 2, _timer);
+        using var processor = new BatchProcessor(_hub, 2, Timeout.InfiniteTimeSpan, _diagnosticLogger);
 
-        _timer.InvokeElapsed(DateTime.Now);
+        processor.OnIntervalElapsed(null);
         processor.Enqueue(CreateLog("one"));
-        _timer.InvokeElapsed(DateTime.Now);
+        processor.OnIntervalElapsed(null);
         processor.Enqueue(CreateLog("two"));
         processor.Enqueue(CreateLog("three"));
 
@@ -149,24 +147,9 @@ private static void AssertEnvelope(Envelope envelope, string[] expected)
         Assert.NotNull(log);
         Assert.Equal(expected, log.Items.ToArray().Select(static item => item.Message));
     }
-}
-
-internal sealed class FakeBatchProcessorTimer : BatchProcessorTimer
-{
-    public override bool Enabled { get; set; }
-
-    public override event EventHandler<ElapsedEventArgs> Elapsed = null!;
 
-    internal void InvokeElapsed(DateTime signalTime)
+    public void Dispose()
     {
-#if NET9_0_OR_GREATER
-        var e = new ElapsedEventArgs(signalTime);
-#else
-        var type = typeof(ElapsedEventArgs);
-        var ctor = BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.CreateInstance;
-        var instance = Activator.CreateInstance(type, ctor, null, [signalTime], null);
-        var e = (ElapsedEventArgs)instance!;
-#endif
-        Elapsed.Invoke(this, e);
+        Assert.Empty(_diagnosticLogger.Entries);
     }
 }

test/Sentry.Tests/SentryStructuredLoggerTests.cs

@@ -221,7 +221,7 @@ public void Log_InvalidBeforeSendLog_DoesNotCaptureEnvelope()
         entry.Args.Should().BeEmpty();
     }
 
-    [Fact]
+    [Fact(Skip = "May no longer be required after feedback.")]
     public void Dispose_Log_Throws()
     {
         _fixture.Options.Experimental.EnableLogs = true;