Skip to content

Implement HTTP client timeout #10261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JunielKatarn merged 6 commits into from
Jul 19, 2022
Merged

Implement HTTP client timeout #10261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
166d95d
Implement hard-coded timeout
JunielKatarn Jul 13, 2022
37cc8a4
Create timeout from JS args
JunielKatarn Jul 13, 2022
ef8fc80
Timeout only for values greater than 0
JunielKatarn Jul 14, 2022
1133bab
Change files
JunielKatarn Jul 14, 2022
803042a
Remove variable sendRequestAny
JunielKatarn Jul 14, 2022
c87c2c5
Remove unused captures
JunielKatarn Jul 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/react-native-windows-42dec614-af90-4b29-b8c7-f266415ea240.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Implement HTTP client timeout",
"packageName": "react-native-windows",
"email": "julio.rocha@microsoft.com",
"dependentChangeType": "patch"
}
6 changes: 3 additions & 3 deletions vnext/Desktop.IntegrationTests/HttpOriginPolicyIntegrationTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ TEST_CLASS(HttpOriginPolicyIntegrationTest)
{}, /*data*/
"text",
false, /*useIncrementalUpdates*/
1000, /*timeout*/
0, /*timeout*/
clientArgs.WithCredentials, /*withCredentials*/
[](int64_t){} /*reactCallback*/
);
Expand Down Expand Up @@ -201,7 +201,7 @@ TEST_CLASS(HttpOriginPolicyIntegrationTest)
{}, /*data*/
"text",
false, /*useIncrementalUpdates*/
1000, /*timeout*/
0, /*timeout*/
clientArgs.WithCredentials, /*withCredentials*/
[](int64_t) {} /*reactCallback*/
);
Expand Down Expand Up @@ -300,7 +300,7 @@ TEST_CLASS(HttpOriginPolicyIntegrationTest)
//{} /*bodyData*/,
"text",
false /*useIncrementalUpdates*/,
1000 /*timeout*/,
0 /*timeout*/,
false /*withCredentials*/,
[](int64_t) {} /*callback*/
);
Expand Down
108 changes: 103 additions & 5 deletions vnext/Desktop.IntegrationTests/HttpResourceIntegrationTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ TEST_CLASS (HttpResourceIntegrationTest) {
{}, /*data*/
"text",
false,
1000 /*timeout*/,
0 /*timeout*/,
false /*withCredentials*/,
[](int64_t) {});

Expand Down Expand Up @@ -139,7 +139,7 @@ TEST_CLASS (HttpResourceIntegrationTest) {
{}, /*data*/
"text",
false,
1000 /*timeout*/,
0 /*timeout*/,
false /*withCredentials*/,
[](int64_t) {});
//clang-format on
Expand Down Expand Up @@ -172,7 +172,7 @@ TEST_CLASS (HttpResourceIntegrationTest) {
promise.set_value();
});

resource->SendRequest("GET", "http://nonexistinghost", 0, {}, {}, "text", false, 1000, false, [](int64_t) {});
resource->SendRequest("GET", "http://nonexistinghost", 0, {}, {}, "text", false, 0, false, [](int64_t) {});

promise.get_future().wait();

Expand Down Expand Up @@ -256,7 +256,7 @@ TEST_CLASS (HttpResourceIntegrationTest) {
{}, /*data*/
"text",
false,
1000 /*timeout*/,
0 /*timeout*/,
false /*withCredentials*/,
[](int64_t) {});
//clang-format on
Expand Down Expand Up @@ -339,7 +339,7 @@ TEST_CLASS (HttpResourceIntegrationTest) {
{}, /*data*/
"text",
false, /*useIncrementalUpdates*/
1000 /*timeout*/,
0 /*timeout*/,
false /*withCredentials*/,
[](int64_t) {});
//clang-format on
Expand All @@ -354,6 +354,104 @@ TEST_CLASS (HttpResourceIntegrationTest) {
Assert::AreEqual(static_cast<int64_t>(200), getResponse.StatusCode);
Assert::AreEqual({"Redirect Content"}, content);
}

TEST_METHOD(TimeoutSucceeds) {
auto port = s_port;
string url = "http://localhost:" + std::to_string(port);

promise<void> getPromise;
string error;
int statusCode = 0;

auto server = std::make_shared<HttpServer>(s_port);
server->Callbacks().OnGet = [](const DynamicRequest &) -> ResponseWrapper {
DynamicResponse response;
response.result(http::status::ok);

// Hold response to test client timeout
promise<void> timer;
timer.get_future().wait_for(std::chrono::milliseconds(2000));

return {std::move(response)};
};
server->Start();

auto resource = IHttpResource::Make();
resource->SetOnResponse([&getPromise, &statusCode](int64_t, IHttpResource::Response response) {
statusCode = static_cast<int>(response.StatusCode);
getPromise.set_value();
});
resource->SetOnError([&getPromise, &error](int64_t, string &&errorMessage) {
error = std::move(errorMessage);
getPromise.set_value();
});
resource->SendRequest(
"GET",
std::move(url),
0, /*requestId*/
{}, /*headers*/
{}, /*data*/
"text", /*responseType*/
false, /*useIncrementalUpdates*/
6000, /*timeout*/
false, /*withCredentials*/
[](int64_t) {} /*callback*/);

getPromise.get_future().wait();
server->Stop();

Assert::AreEqual({}, error);
Assert::AreEqual(200, statusCode);
}

TEST_METHOD(TimeoutFails) {
auto port = s_port;
string url = "http://localhost:" + std::to_string(port);

promise<void> getPromise;
string error;
int statusCode = 0;

auto server = std::make_shared<HttpServer>(s_port);
server->Callbacks().OnGet = [](const DynamicRequest &) -> ResponseWrapper {
DynamicResponse response;
response.result(http::status::ok);

// Hold response to test client timeout
promise<void> timer;
timer.get_future().wait_for(std::chrono::milliseconds(4000));

return {std::move(response)};
};
server->Start();

auto resource = IHttpResource::Make();
resource->SetOnResponse([&getPromise, &statusCode](int64_t, IHttpResource::Response response) {
statusCode = static_cast<int>(response.StatusCode);
getPromise.set_value();
});
resource->SetOnError([&getPromise, &error](int64_t, string &&errorMessage) {
error = std::move(errorMessage);
getPromise.set_value();
});
resource->SendRequest(
"GET",
std::move(url),
0, /*requestId*/
{}, /*headers*/
{}, /*data*/
"text", /*responseType*/
false, /*useIncrementalUpdates*/
2000, /*timeout*/
false, /*withCredentials*/
[](int64_t) {} /*callback*/);

getPromise.get_future().wait();
server->Stop();

Assert::AreEqual({"[0x800705b4] This operation returned because the timeout period expired."}, error);
Assert::AreEqual(0, statusCode);
}
};

/*static*/ uint16_t HttpResourceIntegrationTest::s_port = 4444;
1 change: 1 addition & 0 deletions vnext/Shared/Networking/IHttpResource.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ struct IHttpResource {
/// </param>
/// <param name="timeout">
/// Request timeout in miliseconds.
/// Note: A value of 0 means no timeout. The resource will await the response indefinitely.
/// </param>
/// <param name="withCredentials">
/// Allow including credentials in request.
Expand Down
27 changes: 26 additions & 1 deletion vnext/Shared/Networking/WinRTHttpResource.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,32 @@ fire_and_forget WinRTHttpResource::PerformSendRequest(HttpRequestMessage &&reque
auto sendRequestOp = self->m_client.SendRequestAsync(coRequest);
self->TrackResponse(coReqArgs->RequestId, sendRequestOp);

co_await lessthrow_await_adapter<ResponseOperation>{sendRequestOp};
if (coReqArgs->Timeout > 0) {
// See https://devblogs.microsoft.com/oldnewthing/20220415-00/?p=106486
auto timedOut = std::make_shared<bool>(false);
auto sendRequestTimeout = [](auto timedOut, auto milliseconds) -> ResponseOperation {
// Convert milliseconds to "ticks" (10^-7 seconds)
co_await winrt::resume_after(winrt::Windows::Foundation::TimeSpan{milliseconds * 10000});
*timedOut = true;
co_return nullptr;
}(timedOut, coReqArgs->Timeout);

co_await lessthrow_await_adapter<ResponseOperation>{winrt::when_any(sendRequestOp, sendRequestTimeout)};

// Cancel either still unfinished coroutine.
sendRequestTimeout.Cancel();
sendRequestOp.Cancel();

if (*timedOut) {
if (self->m_onError) {
self->m_onError(coReqArgs->RequestId, Utilities::HResultToString(HRESULT_FROM_WIN32(ERROR_TIMEOUT)));
}
co_return self->UntrackResponse(coReqArgs->RequestId);
}
} else {
co_await lessthrow_await_adapter<ResponseOperation>{sendRequestOp};
}

auto result = sendRequestOp.ErrorCode();
if (result < 0) {
if (self->m_onError) {
Expand Down