Intercept async detached func 5586 (#5588)

* repro issue: InterceptAsync seems to run func() as a detached task #5586

* resolved issue: InterceptAsync seems to run func() as a detached task #5586

* added notes: "func might not get awaited"

* Fix API breaking changes

* Remove null default value

Co-authored-by: Gregorius Soedharmo <[email protected]>

Author: brah-mcdude

src/core/Akka.TestKit.Tests/TestEventListenerTests/AllTestForEventFilterBase.cs

@@ -186,6 +186,20 @@ await _testingEventFilter.ForLogLevel(LogLevel).ExpectAsync(0, actionAsync: asyn
             });
         }
 
+        // issue: InterceptAsync seems to run func() as a detached task #5586
+        [Fact]
+        public async Task InterceptAsync_should_await_func()
+        {
+            await Assert.ThrowsAnyAsync<FalseException>(async () =>
+            {
+                await _testingEventFilter.ForLogLevel(LogLevel).ExpectAsync(0, async () =>
+                {
+                    Assert.False(true);
+                    await Task.CompletedTask;
+                }, TimeSpan.FromSeconds(.1));
+            });
+        }
+
         [Fact]
         public void Messages_can_be_muted()
         {

src/core/Akka.TestKit/EventFilter/IEventFilterApplier.cs

@@ -87,7 +87,7 @@ public interface IEventFilterApplier
         /// <param name="expectedCount">The expected number of events</param>
         /// <param name="action">The action.</param>
         Task ExpectAsync(int expectedCount, Action action);
-        
+
         /// <summary>
         /// Executes <paramref name="actionAsync"/> task and expects the specified number
         /// of events to be logged during the execution.
@@ -99,6 +99,18 @@ public interface IEventFilterApplier
         /// <param name="actionAsync">The async action.</param>
         Task ExpectAsync(int expectedCount, Func<Task> actionAsync);
 
+        /// <summary>
+        /// Executes <paramref name="actionAsync"/> task and expects the specified number
+        /// of events to be logged during the execution.
+        /// This method fails and throws an exception if more events than expected are logged,
+        /// or if a timeout occurs. The timeout is taken from the config value
+        /// "akka.test.filter-leeway", see <see cref="TestKitSettings.TestEventFilterLeeway"/>.
+        /// </summary>
+        /// <param name="expectedCount">The expected number of events</param>
+        /// <param name="actionAsync">The async action.</param>
+        /// <param name="timeout"></param>
+        Task ExpectAsync(int expectedCount, Func<Task> actionAsync, TimeSpan? timeout);
+
         /// <summary>
         /// Executes <paramref name="action"/> and expects the specified number
         /// of events to be logged during the execution.
@@ -183,13 +195,14 @@ public interface IEventFilterApplier
         /// <param name="func">The function.</param>
         /// <returns>The returned value from <paramref name="func"/>.</returns>
         T Expect<T>(int expectedCount, Func<T> func);
-        
+
         /// <summary>
         /// Executes <paramref name="func"/> and expects the specified number
         /// of events to be logged during the execution.
         /// This function fails and throws an exception if more events than expected are logged,
         /// or if a timeout occurs. The timeout is taken from the config value
         /// "akka.test.filter-leeway", see <see cref="TestKitSettings.TestEventFilterLeeway"/>.
+        /// Note: <paramref name="func"/> might not get awaited.
         /// </summary>
         /// <typeparam name="T">The return value of the function</typeparam>
         /// <param name="expectedCount">The expected number of events</param>

src/core/Akka.TestKit/EventFilter/Internal/EventFilterApplier.cs

@@ -93,8 +93,14 @@ public void Expect(int expectedCount, Action action)
         /// Async version of Expect
         /// </summary>
         public Task ExpectAsync(int expectedCount, Func<Task> actionAsync)
+            => InternalExpectAsync(actionAsync, _actorSystem, expectedCount, null);
+
+        /// <summary>
+        /// Async version of Expect
+        /// </summary>
+        public Task ExpectAsync(int expectedCount, Func<Task> actionAsync, TimeSpan? timeout)
         {
-            return InternalExpectAsync(actionAsync, _actorSystem, expectedCount, null);
+            return InternalExpectAsync(actionAsync, _actorSystem, expectedCount, timeout);
         }
 
         /// <summary>
@@ -198,6 +204,7 @@ public T Expect<T>(int expectedCount, TimeSpan timeout, Func<T> func)
 
         /// <summary>
         /// Async version of Expect
+        /// Note: <paramref name="func"/> might not get awaited.
         /// </summary>
         public async Task<T> ExpectAsync<T>(int expectedCount, TimeSpan timeout, Func<T> func)
         {