Merge pull request #15 from Makaopior/fix/async-timeout-exception

Throw TimeoutException instead of OperationCanceledException when RawQueryAsync method times out

Author: jsakamoto

RELEASE-NOTES.txt

@@ -1,3 +1,6 @@
+v.6.1.0
+- Throw TimeoutException instead of OperationCanceledException when RawQueryAsync method times out
+
 v.6.0.0
 - [BREAKING CHANGE] The Default timeout for communication with servers was changed to 2 seconds, and the default retry count was changed to 3 times (Issue #10 by Makaopior)
 - Improved resolving an organization name from a raw response text from a WHOIS server

WhoisClient.NET.Test/IrregularCaseTests.cs

@@ -1,4 +1,5 @@
-using System.Net.Sockets;
+using System;
+using System.Net.Sockets;
 using System.Text;
 using NUnit.Framework;
 using Whois.NET;
@@ -110,6 +111,49 @@ public async Task Default_Timeout_Async_Test()
             cts.Token.IsCancellationRequested.IsFalse();
         }
 
+        [Test]
+        public void Default_Timeout_WithExceptionRethrow_Test()
+        {
+            // Given: a server that never shuts down
+            using var server = new MockServer((client, token) => Task.Delay(int.MaxValue, token));
+
+            // When: a query is made to the server
+            using var cts = new CancellationTokenSource(millisecondsDelay: 5000);
+            var action = () => Task.Run(() =>
+                WhoisClient.RawQuery("example.jp", options: new()
+                {
+                    Server = "localhost",
+                    Port = server.Port,
+                    RethrowExceptions = true
+                }), cts.Token);
+
+            // Then: IOException should be thrown
+            Assert.ThrowsAsync<IOException>(new AsyncTestDelegate(action));
+
+            cts.Token.IsCancellationRequested.IsFalse();
+        }
+
+        [Test]
+        public void Default_Timeout_WithExceptionRethrow_Async_Test()
+        {
+            // Given: a server that never shuts down
+            using var server = new MockServer((client, token) => Task.Delay(int.MaxValue, token));
+
+            // When: a query is made to the server
+            using var cts = new CancellationTokenSource(millisecondsDelay: 5000);
+            var action = () => WhoisClient.RawQueryAsync("example.jp", options: new()
+            {
+                Server = "localhost",
+                Port = server.Port,
+                RethrowExceptions = true
+            }, cts.Token);
+
+            // Then: TimeoutException should be thrown
+            Assert.ThrowsAsync<TimeoutException>(new AsyncTestDelegate(action));
+
+            cts.Token.IsCancellationRequested.IsFalse();
+        }
+
         [Test]
         public async Task Default_RetryCount_Test()
         {

WhoisClient.NET/WhoisClient.NET.csproj

@@ -9,7 +9,7 @@
     <AssemblyName>WhoisClient</AssemblyName>
     <Product>WhoisClient.NET</Product>
     <Authors>J.Sakamoto, Keith J. Jones, Martijn Storck, Makaopior</Authors>
-    <Version>6.0.0</Version>
+    <Version>6.1.0</Version>
     <Copyright>Copyright 2012-2025 J.Sakamoto; 2016 Keith J. Jones; 2023 Martijn Storck; 2025 Makaopior; Ms-PL License.</Copyright>
     <PackageLicenseExpression>MS-PL</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/jsakamoto/WhoisClient.NET/</PackageProjectUrl>

WhoisClient.NET/WhoisClient.cs

@@ -468,15 +468,22 @@ private static async Task InvokeAsync(Func<CancellationToken, Task> action, int
             using (var linked = CancellationTokenSource.CreateLinkedTokenSource(token, timeoutCancellation.Token))
             {
 #if NETCOREAPP
-                await action(linked.Token);
+                try
+                {
+                    await action(linked.Token);
+                }
+                catch (OperationCanceledException) when (!token.IsCancellationRequested)
+                {
+                    throw new TimeoutException("Socket operation timeout");
+                }
 #else
                 var mainTask = action(linked.Token);
                 var timeoutTask = Task.Delay(Timeout.Infinite, timeoutCancellation.Token);
                 var cancellationTask = Task.Delay(Timeout.Infinite, token);
 
                 var firstCompletedTask = await Task.WhenAny(mainTask, timeoutTask, cancellationTask);
 
-                if (firstCompletedTask == timeoutTask) throw new TimeoutException();
+                if (firstCompletedTask == timeoutTask) throw new TimeoutException("Socket operation timeout");
                 if (firstCompletedTask == cancellationTask) token.ThrowIfCancellationRequested();
 #endif
             }