Skip to content
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.

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

HTTP: Warning and test fix #943

Merged
merged 11 commits into from
Oct 21, 2024
6 changes: 5 additions & 1 deletion plugins/http_plugin/http_plugin.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ namespace eosio {
// returns true if `category` is enabled in http_plugin
bool http_plugin::is_enabled(api_category category) const {
return std::any_of(my->categories_by_address.begin(), my->categories_by_address.end(),
[&category, this](const auto& entry) {
[&category](const auto& entry) {
const auto& [address, categories] = entry;
return categories.contains(category);
});
Expand All @@ -635,6 +635,10 @@ namespace eosio {
my->plugin_state->update_metrics = std::move(fun);
}

size_t http_plugin::bytes_in_flight() const {
return my->plugin_state->bytes_in_flight;
}

std::atomic<bool>& http_plugin::listening() {
return my->listening;
}
Expand Down
2 changes: 2 additions & 0 deletions plugins/http_plugin/include/eosio/http_plugin/http_plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ namespace eosio {

void register_update_metrics(std::function<void(metrics)>&& fun);

size_t bytes_in_flight() const;

std::atomic<bool>& listening();
private:
std::shared_ptr<class http_plugin_impl> my;
Expand Down
26 changes: 24 additions & 2 deletions plugins/http_plugin/tests/unit_tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,7 @@ BOOST_FIXTURE_TEST_CASE(bytes_in_flight, http_plugin_test_fixture) {
boost::beast::http::request<boost::beast::http::empty_body> req(boost::beast::http::verb::get, "/4megabyte", 11);
req.keep_alive(true);
req.set(http::field::host, "127.0.0.1:8891");
s.wait(boost::asio::ip::tcp::socket::wait_write);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of this and the wait_read below? Why would the socket not be writable here? And if it isn't writable why does it matter before a sync write is issued?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed. I'll remove.

boost::beast::http::write(s, req);
}
};
Expand All @@ -622,6 +623,12 @@ BOOST_FIXTURE_TEST_CASE(bytes_in_flight, http_plugin_test_fixture) {
return count_of_status_replies;
};

auto wait_for_no_bytes_in_flight = [&](uint16_t max = std::numeric_limits<uint16_t>::max()) {
while (http_plugin->bytes_in_flight() > 0 && --max)
std::this_thread::sleep_for(std::chrono::milliseconds(5));
BOOST_CHECK(max > 0);
};


//send a single request to start with
send_4mb_requests(1u);
Expand All @@ -642,13 +649,15 @@ BOOST_FIXTURE_TEST_CASE(bytes_in_flight, http_plugin_test_fixture) {

//load up some more requests that exceed max
send_4mb_requests(32u);
//make sure got to the point http threads had responses queued
std::this_thread::sleep_for(std::chrono::seconds(1));
//now rip these connections out before the responses are completely sent
connections.clear();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understood your description right, this is the area that is problematic. Between this line and the line below the http plugin needs to have cleaned up all its ownstanding async_writes. Just closing the socket here does indeed send the FIN but the http threads need time to wake up and handle that error on the async_write to then clear out what's in flight.

I wonder if what might work is to shutdown each connection and then async_read on each one until getting confirmation the remote side disconnected via an error code.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would likely work. I added a check for bytes_in_flight since that is really what we want to test anyway. We want to verify that bytes in flight goes to 0 once connections are closed.

wait_for_no_bytes_in_flight();
//send some requests that should work still
send_4mb_requests(8u);
r = drain_http_replies();
for (const auto& e : r) {
ilog( "response: ${f}, count: ${c}", ("f", std::string(obsolete_reason(e.first)))("c", e.second));
}
BOOST_REQUIRE_EQUAL(r[boost::beast::http::status::ok], 8u);
}

Expand Down Expand Up @@ -684,6 +693,7 @@ BOOST_FIXTURE_TEST_CASE(requests_in_flight, http_plugin_test_fixture) {
for(boost::asio::ip::tcp::socket& c : connections) {
boost::beast::http::response<boost::beast::http::string_body> resp;
boost::beast::flat_buffer buffer;
c.wait(boost::asio::ip::tcp::socket::wait_read);
boost::beast::http::read(c, buffer, resp);

count_of_status_replies[resp.result()]++;
Expand All @@ -694,12 +704,19 @@ BOOST_FIXTURE_TEST_CASE(requests_in_flight, http_plugin_test_fixture) {
return count_of_status_replies;
};

auto wait_for_no_bytes_in_flight = [&](uint16_t max = std::numeric_limits<uint16_t>::max()) {
while (http_plugin->bytes_in_flight() > 0 && --max)
std::this_thread::sleep_for(std::chrono::milliseconds(5));
BOOST_CHECK(max > 0);
};


//8 requests to start with
send_requests(8u);
std::unordered_map<boost::beast::http::status, size_t> r = scan_http_replies();
BOOST_REQUIRE_EQUAL(r[boost::beast::http::status::ok], 8u);
connections.clear();
wait_for_no_bytes_in_flight();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this test case has to do with requests in flight, not bytes, so this feels mismatched but maybe it still serves enough of its purpose?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A requests in flight would be better and useful to verify in both cases. I'll add it.


//24 requests will exceed threshold
send_requests(24u);
Expand All @@ -708,12 +725,17 @@ BOOST_FIXTURE_TEST_CASE(requests_in_flight, http_plugin_test_fixture) {
BOOST_REQUIRE_GT(r[boost::beast::http::status::service_unavailable], 0u);
BOOST_REQUIRE_EQUAL(r[boost::beast::http::status::service_unavailable] + r[boost::beast::http::status::ok], 24u);
connections.clear();
wait_for_no_bytes_in_flight();

//requests should still work
send_requests(8u);
r = scan_http_replies();
for (const auto& e : r) {
ilog( "response: ${f}, count: ${c}", ("f", std::string(obsolete_reason(e.first)))("c", e.second));
}
BOOST_REQUIRE_EQUAL(r[boost::beast::http::status::ok], 8u);
connections.clear();
wait_for_no_bytes_in_flight();
}

//A warning for future tests: destruction of http_plugin_test_fixture sometimes does not destroy http_plugin's listeners. Tests
Expand Down
Loading