refactor: tweaks to code and improved debugging display

Author: egil

src/TimeProviderExtensions/ManualTimeProvider.ManualTimer.cs

@@ -73,7 +73,7 @@ private void Dispose(bool _)
             scheduledCallback = null;
         }
 
-        private static void ValidateTimeSpanRange(TimeSpan time, [CallerArgumentExpression("time")] string? parameter = null)
+        private static void ValidateTimeSpanRange(TimeSpan time, [CallerArgumentExpression(nameof(time))] string? parameter = null)
         {
             long tm = (long)time.TotalMilliseconds;
             if (tm < -1)

src/TimeProviderExtensions/ManualTimeProvider.ManualTimerScheduledCallback.cs

@@ -14,7 +14,7 @@ public partial class ManualTimeProvider : TimeProvider
     // the GC should be collect the ManualTimer in case users forget to dispose it.
     // If all the references captured by this type was part of the ManualTimer
     // type, the finalizer would not be invoked on ManualTimer if a callback was scheduled.
-    private sealed class ManualTimerScheduler : IComparable<ManualTimerScheduler>
+    private sealed class ManualTimerScheduler
     {
         private readonly TimerCallback callback;
         private readonly object? state;
@@ -32,11 +32,6 @@ public ManualTimerScheduler(ManualTimeProvider timeProvider, TimerCallback callb
             this.state = state;
         }
 
-        public int CompareTo(ManualTimerScheduler? other)
-            => other is not null
-            ? Comparer<DateTimeOffset>.Default.Compare(CallbackTime, other.CallbackTime)
-            : -1;
-
         public override string ToString()
             => running
             ? $"Next callback invocation {CallbackTime.ToString("yyyy-MM-ddTHH:mm:ss.fff", CultureInfo.InvariantCulture)}"

src/TimeProviderExtensions/ManualTimeProvider.cs

@@ -9,7 +9,7 @@ namespace TimeProviderExtensions;
 /// <remarks>
 /// Learn more at <see href="https://github.com/egil/TimeProviderExtensions"/>.
 /// </remarks>
-[DebuggerDisplay("{ToString()}. Scheduled callback count: {ScheduledCallbackCount}")]
+[DebuggerDisplay("UtcNow: {ToString(),nq}. Scheduled timer callbacks: {callbacks.Count}. Auto advance amount: {autoAdvanceAmount,nq}.")]
 public partial class ManualTimeProvider : TimeProvider
 {
     internal const uint MaxSupportedTimeout = 0xfffffffe;
@@ -24,7 +24,7 @@ public partial class ManualTimeProvider : TimeProvider
     /// <summary>
     /// Gets the number of callbacks that are scheduled to be triggered in the future.
     /// </summary>
-    internal int ScheduledCallbackCount => callbacks.Count;
+    internal int ScheduledCallbacks => callbacks.Count;
 
     /// <summary>
     /// Gets the starting date and time for this provider.

test/TimeProviderExtensions.Tests/ManualTimeProviderWaitAsyncTests.cs

@@ -8,10 +8,7 @@ public class ManualTimeProviderWaitAsyncTests
     private readonly static TimeSpan DelayedTaskDelay = TimeSpan.FromMilliseconds(2);
     private readonly static string StringTaskResult = Guid.NewGuid().ToString();
 
-    private static async Task DelayedTask(TimeProvider provider)
-    {
-        await provider.Delay(DelayedTaskDelay);
-    }
+    private static async Task DelayedTask(TimeProvider provider) => await provider.Delay(DelayedTaskDelay);
 
     private static async Task<string> DelayedStringTask(TimeProvider provider)
     {
@@ -40,8 +37,6 @@ public async Task WaitAsync_timeout_input_validation(Func<ManualTimeProvider, Ta
         await sut.Invoking(invalidInvocation)
             .Should()
             .ThrowAsync<ArgumentOutOfRangeException>();
-        // This should be timeout in all cases, but it seems the .NET 8 implementation sometimes returns dueTime.
-        //.WithParameterName("timeout"); 
     }
 
     public static TheoryData<Func<ManualTimeProvider, Task>> CompletedInvocations { get; } =

test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/TimerTests.cs

@@ -210,20 +210,20 @@ public void WaiterRemovedAfterDispose()
         var timer2Counter = 0;
 
         var timeProvider = new FakeTimeProvider();
-        var waitersCountStart = timeProvider.ScheduledCallbackCount;
+        var waitersCountStart = timeProvider.ScheduledCallbacks;
 
         var timer1 = timeProvider.CreateTimer(_ => timer1Counter++, null, TimeSpan.FromMilliseconds(1), TimeSpan.FromMilliseconds(1));
         var timer2 = timeProvider.CreateTimer(_ => timer2Counter++, null, TimeSpan.FromMilliseconds(1), TimeSpan.FromMilliseconds(1));
 
-        var waitersCountDuring = timeProvider.ScheduledCallbackCount;
+        var waitersCountDuring = timeProvider.ScheduledCallbacks;
 
         timeProvider.Advance(TimeSpan.FromMilliseconds(1));
 
         timer1.Dispose();
 
         timeProvider.Advance(TimeSpan.FromMilliseconds(1));
 
-        var waitersCountAfter = timeProvider.ScheduledCallbackCount;
+        var waitersCountAfter = timeProvider.ScheduledCallbacks;
 
         Assert.Equal(0, waitersCountStart);
         Assert.Equal(2, waitersCountDuring);
@@ -240,12 +240,12 @@ public void WaiterRemovedWhenCollectedWithoutDispose()
         var timer2Counter = 0;
 
         var timeProvider = new FakeTimeProvider();
-        var waitersCountStart = timeProvider.ScheduledCallbackCount;
+        var waitersCountStart = timeProvider.ScheduledCallbacks;
 
         var timer1 = timeProvider.CreateTimer(_ => timer1Counter++, null, TimeSpan.FromMilliseconds(1), TimeSpan.FromMilliseconds(1));
         var timer2 = timeProvider.CreateTimer(_ => timer2Counter++, null, TimeSpan.FromMilliseconds(1), TimeSpan.FromMilliseconds(1));
 
-        var waitersCountDuring = timeProvider.ScheduledCallbackCount;
+        var waitersCountDuring = timeProvider.ScheduledCallbacks;
 
         timeProvider.Advance(TimeSpan.FromMilliseconds(1));
 
@@ -257,7 +257,7 @@ public void WaiterRemovedWhenCollectedWithoutDispose()
 
         timeProvider.Advance(TimeSpan.FromMilliseconds(1));
 
-        var waitersCountAfter = timeProvider.ScheduledCallbackCount;
+        var waitersCountAfter = timeProvider.ScheduledCallbacks;
 
         Assert.Equal(0, waitersCountStart);
         Assert.Equal(2, waitersCountDuring);