SocketHttpHandler: include host+IP information in HttpRequestException #38131

antonfirsov · 2020-06-19T00:19:53Z

Fix #1326 by appending host:port info to HttpRequestException's message when connection fails.

Didn't change the inner SocketException, since it would require subclassing SocketException, which would add unnecessary complexity here.

ghost · 2020-06-19T00:19:59Z

Tagging subscribers to this area: @dotnet/ncl
Notify danmosemsft if you want to be subscribed.

antonfirsov · 2020-06-19T00:20:51Z

src/libraries/System.Net.Http/tests/FunctionalTests/HttpClientTest.cs

@@ -205,6 +205,15 @@ public async Task GetContentAsync_ErrorStatusCode_ExpectedExceptionThrown(bool w
            }
        }

+        [Fact]
+        [OuterLoop("Slow - Negative connection test")]
+        public async Task GetContentAsync_WhenCanNotConnect_ExceptionContainsHostInfo()


This should likely belong to a SocketsHttpHandler test, but I'm new to HTTP codebase, and couldn't figure out where. Any suggestion?

I think this is a good enough place for this test.

ManickaP · 2020-06-19T08:16:43Z

src/libraries/System.Net.Http/tests/FunctionalTests/HttpClientTest.cs

@@ -205,6 +205,15 @@ public async Task GetContentAsync_ErrorStatusCode_ExpectedExceptionThrown(bool w
            }
        }

+        [Fact]
+        [OuterLoop("Slow - Negative connection test")]
+        public async Task GetContentAsync_WhenCanNotConnect_ExceptionContainsHostInfo()


I think this is a good enough place for this test.

ManickaP · 2020-06-19T08:20:21Z

src/libraries/System.Net.Http/tests/FunctionalTests/HttpClientTest.cs

+        [OuterLoop("Slow - Negative connection test")]
+        public async Task GetContentAsync_WhenCanNotConnect_ExceptionContainsHostInfo()
+        {
+            using var client = new HttpClient(new SocketsHttpHandler());


In tests, the HttpClient is usually created via CreateHttpClient(), e.g.: using HttpClient httpClient = CreateHttpClient();. Is there any reason here to create it directly?

Both questions depend on what we consider to be the SUT. I can't decide what is a good functional unit to test this feature against. HttpClient with default setup or SocketsHttpHandler?

I have no preference, want to go with existing practices.

Well, similarly looking test is here: https://github.com/dotnet/runtime/blob/master/src/libraries/Common/tests/System/Net/Http/HttpClientHandlerTest.cs#L2667-L2677
But that's a shared test code which gets executed for WinHttpHandler as well.
Maybe it would be sufficient to just add to the existing test something like:

if (!IsWinHttpHandler) { Assert.Contains(expected, exception.Message); }

Note that we have many such ifs in the shared test code, so this wouldn't be a revolutionary idea.

Since I don't think it's worth to cover all the cases HttpClientHandlerTest covers, decided to keep the test in HttpClientTest. Added CreateHttpClient() usage.

wfurt

looks generally good to me. I left few comments.

wfurt · 2020-06-19T17:13:55Z

src/libraries/System.Net.Http/tests/FunctionalTests/HttpClientTest.cs

@@ -205,6 +205,15 @@ public async Task GetContentAsync_ErrorStatusCode_ExpectedExceptionThrown(bool w
            }
        }

+        [Fact]
+        [OuterLoop("Slow - Negative connection test")]


why this would be slow if it connects to local host? that should fail quickly, right?

A failed connection attempt takes long on Windows. AFAIK this is because winsock will retry the connection up to 3 times even with localhost.

how much delay do you see? The tests I was running were still pretty quick. I'm fine with leaving this outerloop.

Failing bare Socket connections attempts take almost 2 seconds usually. This test runs even longer for some reason (about 4 seconds on my PC).

src/libraries/System.Net.Http/tests/FunctionalTests/HttpClientTest.cs

wfurt · 2020-06-19T17:17:48Z

src/libraries/System.Net.Http/src/System/Net/Http/SocketsHttpHandler/ConnectHelper.cs

        {
            return CancellationHelper.ShouldWrapInOperationCanceledException(error, cancellationToken) ?
                CancellationHelper.CreateOperationCanceledException(error, cancellationToken) :
-                new HttpRequestException(error.Message, error, RequestRetryType.RetryOnNextProxy);
+                new HttpRequestException($"{error.Message} {host}:{port}", error, RequestRetryType.RetryOnNextProxy);


How this would look if host is IPv6 address? Do you know if it already comes in with the surrounding []?

Yes, the brackets are being added here:

runtime/src/libraries/System.Net.Http/src/System/Net/Http/SocketsHttpHandler/HttpAuthority.cs

Lines 26 to 29 in 4b03513

// TODO https://github.com/dotnet/runtime/issues/25782:

// Uri.IdnHost is missing '[', ']' characters around IPv6 address.

// So, we need to add them manually for now.

IdnHost = uri.HostNameType == UriHostNameType.IPv6 ? "[" + uri.IdnHost + "]" : uri.IdnHost;

src/libraries/System.Net.Http/src/System/Net/Http/SocketsHttpHandler/ConnectHelper.cs

antonfirsov · 2020-07-02T20:53:30Z

/azp run runtime-libraries outerloop

azure-pipelines · 2020-07-02T20:53:44Z

Azure Pipelines successfully started running 1 pipeline(s).

wfurt

LGTM

antonfirsov · 2020-07-08T12:19:26Z

/azp run runtime-libraries outerloop

azure-pipelines · 2020-07-08T12:19:39Z

Azure Pipelines successfully started running 1 pipeline(s).

antonfirsov · 2020-07-08T17:33:14Z

Opened #38945 for the unrelated test failure.

antonfirsov added 3 commits June 19, 2020 01:56

fix exception message

d8af193

add test

d92c0de

remove unnecessary using

46d6d2e

Dotnet-GitSync-Bot added the area-System.Net.Http label Jun 19, 2020

antonfirsov commented Jun 19, 2020

View reviewed changes

antonfirsov added this to the 5.0.0 milestone Jun 19, 2020

antonfirsov mentioned this pull request Jun 19, 2020

SocketHttpHandler: exception is missing host/port text #1326

Closed

antonfirsov requested a review from a team June 19, 2020 00:24

ManickaP reviewed Jun 19, 2020

View reviewed changes

wfurt reviewed Jun 19, 2020

View reviewed changes

stephentoub reviewed Jun 19, 2020

View reviewed changes

src/libraries/System.Net.Http/src/System/Net/Http/SocketsHttpHandler/ConnectHelper.cs Outdated Show resolved Hide resolved

antonfirsov added 3 commits June 30, 2020 23:13

improve test

877ca25

use CreateHttpClient()

b76bdce

add brackets

2bcadb7

antonfirsov added 2 commits July 7, 2020 22:39

Merge branch 'master' into af/better-httpconnectexception

025e06c

fix build

8e561ef

wfurt approved these changes Jul 8, 2020

View reviewed changes

antonfirsov merged commit 80e954f into dotnet:master Jul 8, 2020

ghost locked as resolved and limited conversation to collaborators Dec 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SocketHttpHandler: include host+IP information in HttpRequestException #38131

SocketHttpHandler: include host+IP information in HttpRequestException #38131

antonfirsov commented Jun 19, 2020 •

edited

Loading

ghost commented Jun 19, 2020

antonfirsov Jun 19, 2020

ManickaP Jun 19, 2020

ManickaP Jun 19, 2020

ManickaP Jun 19, 2020

antonfirsov Jun 19, 2020

ManickaP Jun 19, 2020 •

edited

Loading

antonfirsov Jun 30, 2020 •

edited

Loading

wfurt left a comment

wfurt Jun 19, 2020

antonfirsov Jun 30, 2020 •

edited

Loading

wfurt Jul 7, 2020

antonfirsov Jul 7, 2020

wfurt Jun 19, 2020

antonfirsov Jun 30, 2020

antonfirsov commented Jul 2, 2020

azure-pipelines bot commented Jul 2, 2020

wfurt left a comment

antonfirsov commented Jul 8, 2020

azure-pipelines bot commented Jul 8, 2020

antonfirsov commented Jul 8, 2020

	// TODO https://github.com/dotnet/runtime/issues/25782:
	// Uri.IdnHost is missing '[', ']' characters around IPv6 address.
	// So, we need to add them manually for now.
	IdnHost = uri.HostNameType == UriHostNameType.IPv6 ? "[" + uri.IdnHost + "]" : uri.IdnHost;

SocketHttpHandler: include host+IP information in HttpRequestException #38131

SocketHttpHandler: include host+IP information in HttpRequestException #38131

Conversation

antonfirsov commented Jun 19, 2020 • edited Loading

ghost commented Jun 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ManickaP Jun 19, 2020 • edited Loading

Choose a reason for hiding this comment

antonfirsov Jun 30, 2020 • edited Loading

Choose a reason for hiding this comment

wfurt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antonfirsov Jun 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antonfirsov commented Jul 2, 2020

azure-pipelines bot commented Jul 2, 2020

wfurt left a comment

Choose a reason for hiding this comment

antonfirsov commented Jul 8, 2020

azure-pipelines bot commented Jul 8, 2020

antonfirsov commented Jul 8, 2020

antonfirsov commented Jun 19, 2020 •

edited

Loading

ManickaP Jun 19, 2020 •

edited

Loading

antonfirsov Jun 30, 2020 •

edited

Loading

antonfirsov Jun 30, 2020 •

edited

Loading