fix: only include FakeTimeProvider in debug mode

egil · egil · commit a56cb147725b · 2023-05-24T16:21:49.000Z
diff --git a/src/TimeProviderExtensions/ManualTimeProvider.cs b/src/TimeProviderExtensions/ManualTimeProvider.cs
@@ -5,8 +5,6 @@
 using System.Linq;
 using System.Runtime.CompilerServices;
 using System.Text;
-using Microsoft.Extensions.Time.Testing;
-using static Microsoft.Extensions.Time.Testing.FakeTimeProviderTimer;
 
 namespace TimeProviderExtensions;
 
diff --git a/src/TimeProviderExtensions/Microsoft.Extensions.Time.Testing/FakeTimeProvider.cs b/src/TimeProviderExtensions/Microsoft.Extensions.Time.Testing/FakeTimeProvider.cs
@@ -1,3 +1,4 @@
+#if !RELEASE
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
@@ -12,7 +13,7 @@ namespace Microsoft.Extensions.Time.Testing;
 /// <summary>
 /// A synthetic clock used to provide deterministic behavior in tests.
 /// </summary>
-internal class FakeTimeProvider : TimeProvider
+public class FakeTimeProvider : TimeProvider
 {
     internal static readonly DateTimeOffset Epoch = new(2000, 1, 1, 0, 0, 0, 0, TimeSpan.Zero);
 
@@ -182,4 +183,5 @@ private void WakeWaiters(List<FakeTimeProviderTimer.Waiter> waiters)
             }
         }
     }
-}
+}
+#endif
diff --git a/src/TimeProviderExtensions/Microsoft.Extensions.Time.Testing/FakeTimeProviderTimer.cs b/src/TimeProviderExtensions/Microsoft.Extensions.Time.Testing/FakeTimeProviderTimer.cs
@@ -1,3 +1,4 @@
+#if !RELEASE
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
@@ -162,4 +163,5 @@ public static long IfOutOfRange(long argument, long min, long max, [CallerArgume
 
         return argument;
     }
-}
+}
+#endif
diff --git a/test/TimeProviderExtensions.Tests/GlobalSuppressions.cs b/test/TimeProviderExtensions.Tests/GlobalSuppressions.cs
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderCancelAfter.cs.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderCancelAfter.cs.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderDelayTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderDelayTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderPeriodicTimerTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderPeriodicTimerTests.cs
@@ -1,5 +1,5 @@
 #if NET6_0_OR_GREATER
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderTimerTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderTimerTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderTimestampTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderTimestampTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/ManualTimeProviderWaitAsyncTests.cs b/test/TimeProviderExtensions.Tests/ManualTimeProviderWaitAsyncTests.cs
@@ -1,13 +1,13 @@
 #if NET6_0_OR_GREATER
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
 #endif
 
 namespace TimeProviderExtensions;
 
-internal class ManualTimeProviderWaitAsyncTests
+public class ManualTimeProviderWaitAsyncTests
 {
     internal const uint MaxSupportedTimeout = 0xfffffffe;
     private readonly static TimeSpan DelayedTaskDelay = TimeSpan.FromMilliseconds(2);
diff --git a/test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/FakeTimeProviderTests.cs b/test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/FakeTimeProviderTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
diff --git a/test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/FakeTimeProviderTimerTests.cs b/test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/FakeTimeProviderTimerTests.cs
@@ -1,4 +1,4 @@
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;
 #else
 using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;
@@ -182,7 +182,7 @@ await fakeTimeProvider.Delay(
         });
     }
 
-#if TargetMicrosoftTestTimeProvider
+#if TargetMicrosoftTestTimeProvider && !RELEASE
 
     [Fact]
     public void TimerChangeDueTimeOutOfRangeThrows()
@@ -244,40 +244,5 @@ public void WaiterRemovedAfterDispose()
         Assert.Equal(2, timer2Counter);
         Assert.Equal(1, waitersCountAfter);
     }
-
-#if RELEASE // In Release only since this might not work if the timer reference being tracked by the debugger
-    [Fact]
-    public void WaiterRemovedWhenCollectedWithoutDispose()
-    {
-        var timer1Counter = 0;
-        var timer2Counter = 0;
-
-        var timeProvider = new SutTimeProvider();
-        var waitersCountStart = timeProvider.Waiters.Count;
-
-        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.Waiters.Count;
-
-        timeProvider.Advance(TimeSpan.FromMilliseconds(1));
-
-        // Force the finalizer on timer1 to ensure Dispose is releasing the waiter object
-        // even when a Timer is not disposed
-        timer1 = null;
-        GC.Collect();
-        GC.WaitForPendingFinalizers();
-
-        timeProvider.Advance(TimeSpan.FromMilliseconds(1));
-
-        var waitersCountAfter = timeProvider.Waiters.Count;
-
-        Assert.Equal(0, waitersCountStart);
-        Assert.Equal(2, waitersCountDuring);
-        Assert.Equal(1, timer1Counter);
-        Assert.Equal(2, timer2Counter);
-        Assert.Equal(1, waitersCountAfter);
-    }
-#endif
 #endif
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if !RELEASE`
`1`	`2`	`// Licensed to the .NET Foundation under one or more agreements.`
`2`	`3`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`4`
`@@ -12,7 +13,7 @@ namespace Microsoft.Extensions.Time.Testing;`
`12`	`13`	`/// <summary>`
`13`	`14`	`/// A synthetic clock used to provide deterministic behavior in tests.`
`14`	`15`	`/// </summary>`
`15`		`-internal class FakeTimeProvider : TimeProvider`
	`16`	`+public class FakeTimeProvider : TimeProvider`
`16`	`17`	`{`
`17`	`18`	`internal static readonly DateTimeOffset Epoch = new(2000, 1, 1, 0, 0, 0, 0, TimeSpan.Zero);`
`18`	`19`
`@@ -182,4 +183,5 @@ private void WakeWaiters(List<FakeTimeProviderTimer.Waiter> waiters)`
`182`	`183`	`}`
`183`	`184`	`}`
`184`	`185`	`}`
`185`		`-}`
	`186`	`+}`
	`187`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#if TargetMicrosoftTestTimeProvider`
	`1`	`+#if TargetMicrosoftTestTimeProvider && !RELEASE`
`2`	`2`	`using SutTimeProvider = Microsoft.Extensions.Time.Testing.FakeTimeProvider;`
`3`	`3`	`#else`
`4`	`4`	`using SutTimeProvider = TimeProviderExtensions.ManualTimeProvider;`