Add timeout exception for .NET 5 or greater targets.

skwasjer · Mar 24, 2023 · 6448126 · 6448126
1 parent df1bbfa
commit 6448126
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/src/MockHttp/Responses/TimeoutBehavior.cs b/src/MockHttp/Responses/TimeoutBehavior.cs
@@ -17,14 +17,27 @@ public TimeoutBehavior(TimeSpan timeoutAfter)
 
     public Task HandleAsync(MockHttpRequestContext requestContext, HttpResponseMessage responseMessage, ResponseHandlerDelegate next, CancellationToken cancellationToken)
     {
-        // It is somewhat unintuitive to throw TaskCanceledException but this is what HttpClient does atm,
+        // It is somewhat unintuitive to throw TaskCanceledException but this is what HttpClient does,
         // so we simulate same behavior.
         // https://github.com/dotnet/corefx/issues/20296
+        // Beginning in .NET 5, the TaskCanceledException's inner exception is a TimeoutException to clarify client timeout.
+
         return Task.Delay(_timeoutAfter, cancellationToken)
             .ContinueWith(_ =>
                 {
                     var tcs = new TaskCompletionSource<HttpResponseMessage>();
+#if NET5_0_OR_GREATER
+                    if (!cancellationToken.IsCancellationRequested)
+                    {
+                        tcs.TrySetException(new TaskCanceledException(null, new TimeoutException()));
+                    }
+                    else
+                    {
+                        tcs.TrySetCanceled();
+                    }
+#else
                     tcs.TrySetCanceled();
+#endif
                     return tcs.Task;
                 },
                 TaskScheduler.Current)

diff --git a/test/MockHttp.Tests/Responses/TimeoutBehaviorTests.cs b/test/MockHttp.Tests/Responses/TimeoutBehaviorTests.cs
@@ -21,7 +21,13 @@ public async Task Given_timeout_when_sending_should_timeout_after_time_passed(in
 
         // Assert
         sw.Start();
+
+#if NET5_0_OR_GREATER
+        await act.Should().ThrowAsync<TaskCanceledException>().WithInnerException(typeof(TimeoutException), "the timeout expired");
+#else
         await act.Should().ThrowAsync<TaskCanceledException>("the timeout expired");
+#endif
+
         sw.Elapsed.Should()
             // Allow 5% diff.
             .BeGreaterThan(timeout - TimeSpan.FromMilliseconds(timeoutInMilliseconds * 0.95));
@@ -41,7 +47,7 @@ public async Task Given_cancellation_token_is_cancelled_when_sending_should_thro
         Func<Task> act = () => sut.HandleAsync(new MockHttpRequestContext(new HttpRequestMessage()), new HttpResponseMessage(), next.Object, ct);
 
         // Assert
-        await act.Should().ThrowAsync<TaskCanceledException>();
+        await act.Should().ThrowAsync<TaskCanceledException>().Where(ex => ex.InnerException == null);
         sw.Elapsed.Should().BeLessThan(timeout);
         next.VerifyNoOtherCalls();
     }