Merge pull request #606 from leeoades/bugfix/really-guarantee-sync-co…

…ntext-lost Created a custom awaiter that guarantees that we complete on a different threadpool thread.
dotnet-state-machine · Dec 3, 2024 · 94867a0 · 94867a0
2 parents 7223486 + 4941336
commit 94867a0
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/test/Stateless.Tests/Stateless.Tests.csproj b/test/Stateless.Tests/Stateless.Tests.csproj
@@ -20,7 +20,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="xunit" Version="2.4.0" />
     <PackageReference Include="xunit.analyzers" Version="0.10.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />

diff --git a/test/Stateless.Tests/SynchronizationContextFixture.cs b/test/Stateless.Tests/SynchronizationContextFixture.cs
@@ -1,4 +1,6 @@
+using System;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
 using Xunit;
@@ -41,15 +43,16 @@ private void CaptureSyncContext()
 
     private async Task LoseSyncContext()
     {
-        await Task.Run(() => { }).ConfigureAwait(false); // Switch synchronization context and continue
+        await new CompletesOnDifferentThreadAwaitable(); // Switch synchronization context and continue
         Assert.NotEqual(_customSynchronizationContext, SynchronizationContext.Current);
     }
 
     /// <summary>
-    /// Tests capture the SynchronizationContext at various points through out their execution.
-    /// This asserts that every capture is the expected SynchronizationContext instance and that is hasn't been lost. 
+    /// Tests capture the SynchronizationContext at various points throughout their execution.
+    /// This asserts that every capture is the expected SynchronizationContext instance and that it hasn't been lost. 
     /// </summary>
     /// <param name="numberOfExpectedCalls">Ensure that we have the expected number of captures</param>
+    // ReSharper disable once ParameterOnlyUsedForPreconditionCheck.Local
     private void AssertSyncContextAlwaysRetained(int numberOfExpectedCalls)
     {
         Assert.Equal(numberOfExpectedCalls, _capturedSyncContext.Count);
@@ -154,7 +157,7 @@ public async Task Multiple_Deactivations_should_retain_SyncContext()
 
         // ASSERT
         AssertSyncContextAlwaysRetained(3);
-    }
+     }
 
     [Fact]
     public async Task Multiple_OnEntry_should_retain_SyncContext()
@@ -338,4 +341,21 @@ public async Task InternalTransition_firing_a_sync_action_should_retain_SyncCont
         // ASSERT
         AssertSyncContextAlwaysRetained(1);
     }
+
+    private class CompletesOnDifferentThreadAwaitable
+    {
+        public CompletesOnDifferentThreadAwaiter GetAwaiter() => new();
+
+        internal class CompletesOnDifferentThreadAwaiter : INotifyCompletion
+        {
+            public void GetResult() { }
+
+            public bool IsCompleted => false;
+
+            public void OnCompleted(Action continuation)
+            {
+                ThreadPool.QueueUserWorkItem(_ => continuation());
+            }
+        }
+    }
 }