From b1d9476ff190e214a5080dcddddb17c65839c19e Mon Sep 17 00:00:00 2001 From: eidheim Date: Sun, 23 Jun 2019 12:41:32 +0200 Subject: [PATCH] Client: added support for server-sent events, and improved the chunked transfer code. Also some cleanup of especially the client code, and added a few additional tests. --- client_http.hpp | 175 ++++++++++++++++++++++++++++++++-------------- server_http.hpp | 10 +-- tests/io_test.cpp | 129 +++++++++++++++++++++++++++------- 3 files changed, 228 insertions(+), 86 deletions(-) diff --git a/client_http.hpp b/client_http.hpp index c13b4d3..68e1639 100644 --- a/client_http.hpp +++ b/client_http.hpp @@ -88,10 +88,17 @@ namespace SimpleWeb { std::unique_ptr socket; // Socket must be unique_ptr since asio::ssl::stream is not movable bool in_use = false; + bool event_stream = false; bool attempt_reconnect = true; std::unique_ptr timer; + void close() noexcept { + error_code ec; + socket->lowest_layer().shutdown(asio::ip::tcp::socket::shutdown_both, ec); + socket->lowest_layer().cancel(ec); + } + void set_timeout(long seconds = 0) noexcept { if(seconds == 0) seconds = timeout; @@ -103,10 +110,8 @@ namespace SimpleWeb { std::weak_ptr self_weak(this->shared_from_this()); // To avoid keeping Connection instance alive longer than needed timer->async_wait([self_weak](const error_code &ec) { if(!ec) { - if(auto self = self_weak.lock()) { - error_code ec; - self->socket->lowest_layer().cancel(ec); - } + if(auto self = self_weak.lock()) + self->close(); } }); } @@ -144,8 +149,8 @@ namespace SimpleWeb { /// Convenience function to perform synchronous request. The io_service is run within this function. /// If reusing the io_service for other tasks, use the asynchronous request functions instead. /// Do not use concurrently with the asynchronous request functions. - std::shared_ptr request(const std::string &method, const std::string &path = std::string("/"), - string_view content = "", const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + /// When requesting Server-Sent Events: will throw on asio::error::eof, please use asynchronous request functions instead. + std::shared_ptr request(const std::string &method, const std::string &path = {"/"}, string_view content = {}, const CaseInsensitiveMultimap &header = {}) { std::shared_ptr response; error_code ec; request(method, path, content, header, [&response, &ec](std::shared_ptr response_, const error_code &ec_) { @@ -174,8 +179,8 @@ namespace SimpleWeb { /// Convenience function to perform synchronous request. The io_service is run within this function. /// If reusing the io_service for other tasks, use the asynchronous request functions instead. /// Do not use concurrently with the asynchronous request functions. - std::shared_ptr request(const std::string &method, const std::string &path, std::istream &content, - const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + /// When requesting Server-Sent Events: will throw on asio::error::eof, please use asynchronous request functions instead. + std::shared_ptr request(const std::string &method, const std::string &path, std::istream &content, const CaseInsensitiveMultimap &header = {}) { std::shared_ptr response; error_code ec; request(method, path, content, header, [&response, &ec](std::shared_ptr response_, const error_code &ec_) { @@ -203,6 +208,7 @@ namespace SimpleWeb { /// Asynchronous request where setting and/or running Client's io_service is required. /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, const std::string &path, string_view content, const CaseInsensitiveMultimap &header, std::function, const error_code &)> &&request_callback_) { auto session = std::make_shared(config.max_response_streambuf_size, get_connection(), create_request_header(method, path, header)); @@ -212,7 +218,8 @@ namespace SimpleWeb { if(auto session = session_weak.lock()) { { std::lock_guard lock(this->connections_mutex); - session->connection->in_use = false; + if(!session->connection->event_stream) + session->connection->in_use = false; // Remove unused connections, but keep one open for HTTP persistent connection: std::size_t unused_connections = 0; @@ -245,31 +252,38 @@ namespace SimpleWeb { write_stream << "Content-Length: " << content.size() << "\r\n"; } } - write_stream << "\r\n" - << content; + write_stream << "\r\n"; + write_stream.write(content.data(), static_cast(content.size())); connect(session); } /// Asynchronous request where setting and/or running Client's io_service is required. /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, const std::string &path, string_view content, std::function, const error_code &)> &&request_callback_) { request(method, path, content, CaseInsensitiveMultimap(), std::move(request_callback_)); } /// Asynchronous request where setting and/or running Client's io_service is required. + /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, const std::string &path, std::function, const error_code &)> &&request_callback_) { request(method, path, std::string(), CaseInsensitiveMultimap(), std::move(request_callback_)); } /// Asynchronous request where setting and/or running Client's io_service is required. + /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, std::function, const error_code &)> &&request_callback_) { request(method, std::string("/"), std::string(), CaseInsensitiveMultimap(), std::move(request_callback_)); } /// Asynchronous request where setting and/or running Client's io_service is required. + /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, const std::string &path, std::istream &content, const CaseInsensitiveMultimap &header, std::function, const error_code &)> &&request_callback_) { auto session = std::make_shared(config.max_response_streambuf_size, get_connection(), create_request_header(method, path, header)); @@ -279,7 +293,8 @@ namespace SimpleWeb { if(auto session = session_weak.lock()) { { std::lock_guard lock(this->connections_mutex); - session->connection->in_use = false; + if(!session->connection->event_stream) + session->connection->in_use = false; // Remove unused connections, but keep one open for HTTP persistent connection: std::size_t unused_connections = 0; @@ -323,6 +338,8 @@ namespace SimpleWeb { } /// Asynchronous request where setting and/or running Client's io_service is required. + /// Do not use concurrently with the synchronous request functions. + /// When requesting Server-Sent Events: request_callback might be called more than twice, first call with empty contents on open, and with ec = asio::error::eof on last call void request(const std::string &method, const std::string &path, std::istream &content, std::function, const error_code &)> &&request_callback_) { request(method, path, content, CaseInsensitiveMultimap(), std::move(request_callback_)); @@ -332,8 +349,7 @@ namespace SimpleWeb { void stop() noexcept { std::lock_guard lock(connections_mutex); for(auto it = connections.begin(); it != connections.end();) { - error_code ec; - (*it)->socket->lowest_layer().cancel(ec); + (*it)->close(); it = connections.erase(it); } } @@ -457,10 +473,11 @@ namespace SimpleWeb { auto lock = session->connection->handler_runner->continue_lock(); if(!lock) return; - if((!ec || ec == asio::error::not_found) && session->response->streambuf.size() == session->response->streambuf.max_size()) { + if(session->response->streambuf.size() == session->response->streambuf.max_size()) { session->callback(make_error_code::make_error_code(errc::message_size)); return; } + if(!ec) { session->connection->attempt_reconnect = true; std::size_t num_additional_bytes = session->response->streambuf.size() - bytes_transferred; @@ -480,13 +497,13 @@ namespace SimpleWeb { auto lock = session->connection->handler_runner->continue_lock(); if(!lock) return; - if(!ec) { - if(session->response->streambuf.size() == session->response->streambuf.max_size()) { - session->callback(make_error_code::make_error_code(errc::message_size)); - return; - } - session->callback(ec); + if(session->response->streambuf.size() == session->response->streambuf.max_size()) { + session->callback(make_error_code::make_error_code(errc::message_size)); + return; } + + if(!ec) + session->callback(ec); else session->callback(ec); }); @@ -496,6 +513,14 @@ namespace SimpleWeb { } else if((header_it = session->response->header.find("Transfer-Encoding")) != session->response->header.end() && header_it->second == "chunked") { auto chunks_streambuf = std::make_shared(this->config.max_response_streambuf_size); + + // Copy leftover bytes + std::ostream ostream(chunks_streambuf.get()); + auto size = session->response->streambuf.size(); + std::unique_ptr buffer(new char[size]); + session->response->content.read(buffer.get(), static_cast(size)); + ostream.write(buffer.get(), static_cast(size)); + this->read_chunked_transfer_encoded(session, chunks_streambuf); } else if(session->response->http_version < "1.1" || ((header_it = session->response->header.find("Session")) != session->response->header.end() && header_it->second == "close")) { @@ -505,22 +530,38 @@ namespace SimpleWeb { auto lock = session->connection->handler_runner->continue_lock(); if(!lock) return; - - { - std::lock_guard lock(this->connections_mutex); - this->connections.erase(session->connection); + if(session->response->streambuf.size() == session->response->streambuf.max_size()) { + session->callback(make_error_code::make_error_code(errc::message_size)); + return; } if(!ec) { - if(session->response->streambuf.size() == session->response->streambuf.max_size()) - session->callback(make_error_code::make_error_code(errc::message_size)); - else - session->callback(ec); + { + std::lock_guard lock(this->connections_mutex); + this->connections.erase(session->connection); + } + session->callback(ec); } else session->callback(ec == asio::error::eof ? error_code() : ec); }); } + else if(((header_it = session->response->header.find("Content-Type")) != session->response->header.end() && header_it->second == "text/event-stream")) { + session->connection->event_stream = true; + + auto events_streambuf = std::make_shared(this->config.max_response_streambuf_size); + + // Copy leftover bytes + std::ostream ostream(events_streambuf.get()); + auto size = session->response->streambuf.size(); + std::unique_ptr buffer(new char[size]); + session->response->content.read(buffer.get(), static_cast(size)); + ostream.write(buffer.get(), static_cast(size)); + + session->callback(ec); // Connection to a Server-Sent Events resource is opened + + this->read_server_sent_event(session, events_streambuf); + } else session->callback(ec); } @@ -533,7 +574,7 @@ namespace SimpleWeb { session->connection = create_connection(); session->connection->attempt_reconnect = false; session->connection->in_use = true; - session->response = std::shared_ptr(new Response(session->response->streambuf.max_size())); + session->response = std::shared_ptr(new Response(this->config.max_response_streambuf_size)); connections.emplace(session->connection); lock.unlock(); this->connect(session); @@ -551,18 +592,20 @@ namespace SimpleWeb { void read_chunked_transfer_encoded(const std::shared_ptr &session, const std::shared_ptr &chunks_streambuf) { session->connection->set_timeout(); - asio::async_read_until(*session->connection->socket, session->response->streambuf, "\r\n", [this, session, chunks_streambuf](const error_code &ec, size_t bytes_transferred) { + asio::async_read_until(*session->connection->socket, *chunks_streambuf, "\r\n", [this, session, chunks_streambuf](const error_code &ec, size_t bytes_transferred) { session->connection->cancel_timeout(); auto lock = session->connection->handler_runner->continue_lock(); if(!lock) return; - if((!ec || ec == asio::error::not_found) && session->response->streambuf.size() == session->response->streambuf.max_size()) { + if(chunks_streambuf->size() == chunks_streambuf->max_size()) { session->callback(make_error_code::make_error_code(errc::message_size)); return; } + if(!ec) { + std::istream istream(chunks_streambuf.get()); std::string line; - getline(session->response->content, line); + getline(istream, line); bytes_transferred -= line.size() + 1; line.pop_back(); unsigned long length = 0; @@ -574,22 +617,22 @@ namespace SimpleWeb { return; } - auto num_additional_bytes = session->response->streambuf.size() - bytes_transferred; + auto num_additional_bytes = chunks_streambuf->size() - bytes_transferred; if((2 + length) > num_additional_bytes) { session->connection->set_timeout(); - asio::async_read(*session->connection->socket, session->response->streambuf, asio::transfer_exactly(2 + length - num_additional_bytes), [this, session, chunks_streambuf, length](const error_code &ec, size_t /*bytes_transferred*/) { + asio::async_read(*session->connection->socket, *chunks_streambuf, asio::transfer_exactly(2 + length - num_additional_bytes), [this, session, chunks_streambuf, length](const error_code &ec, size_t /*bytes_transferred*/) { session->connection->cancel_timeout(); auto lock = session->connection->handler_runner->continue_lock(); if(!lock) return; - if(!ec) { - if(session->response->streambuf.size() == session->response->streambuf.max_size()) { - session->callback(make_error_code::make_error_code(errc::message_size)); - return; - } - this->read_chunked_transfer_encoded_chunk(session, chunks_streambuf, length); + if(chunks_streambuf->size() == chunks_streambuf->max_size()) { + session->callback(make_error_code::make_error_code(errc::message_size)); + return; } + + if(!ec) + this->read_chunked_transfer_encoded_chunk(session, chunks_streambuf, length); else session->callback(ec); }); @@ -603,31 +646,55 @@ namespace SimpleWeb { } void read_chunked_transfer_encoded_chunk(const std::shared_ptr &session, const std::shared_ptr &chunks_streambuf, unsigned long length) { - std::ostream tmp_stream(chunks_streambuf.get()); + std::istream istream(chunks_streambuf.get()); if(length > 0) { + std::ostream ostream(&session->response->streambuf); std::unique_ptr buffer(new char[length]); - session->response->content.read(buffer.get(), static_cast(length)); - tmp_stream.write(buffer.get(), static_cast(length)); - if(chunks_streambuf->size() == chunks_streambuf->max_size()) { + istream.read(buffer.get(), static_cast(length)); + ostream.write(buffer.get(), static_cast(length)); + if(session->response->streambuf.size() == session->response->streambuf.max_size()) { session->callback(make_error_code::make_error_code(errc::message_size)); return; } } // Remove "\r\n" - session->response->content.get(); - session->response->content.get(); + istream.get(); + istream.get(); if(length > 0) read_chunked_transfer_encoded(session, chunks_streambuf); - else { - if(chunks_streambuf->size() > 0) { - std::ostream ostream(&session->response->streambuf); - ostream << chunks_streambuf.get(); + else + session->callback(error_code()); + } + + void read_server_sent_event(const std::shared_ptr &session, const std::shared_ptr &events_streambuf) { + session->connection->set_timeout(); + asio::async_read_until(*session->connection->socket, *events_streambuf, "\n\n", [this, session, events_streambuf](const error_code &ec, std::size_t /*bytes_transferred*/) { + session->connection->cancel_timeout(); + auto lock = session->connection->handler_runner->continue_lock(); + if(!lock) + return; + if(events_streambuf->size() == events_streambuf->max_size()) { + session->callback(make_error_code::make_error_code(errc::message_size)); + return; } - error_code ec; - session->callback(ec); - } + + if(!ec) { + std::istream istream(events_streambuf.get()); + std::ostream ostream(&session->response->streambuf); + std::string line; + while(std::getline(istream, line) && !line.empty()) { + ostream.write(line.data(), static_cast(line.size())); + ostream.put('\n'); + } + + session->callback(ec); + read_server_sent_event(session, events_streambuf); + } + else + session->callback(ec); + }); } }; diff --git a/server_http.hpp b/server_http.hpp index 2321964..336deef 100644 --- a/server_http.hpp +++ b/server_http.hpp @@ -145,13 +145,13 @@ namespace SimpleWeb { } /// Convenience function for writing status line, potential header fields, and empty content - void write(StatusCode status_code = StatusCode::success_ok, const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + void write(StatusCode status_code = StatusCode::success_ok, const CaseInsensitiveMultimap &header = {}) { *this << "HTTP/1.1 " << SimpleWeb::status_code(status_code) << "\r\n"; write_header(header, 0); } /// Convenience function for writing status line, header fields, and content - void write(StatusCode status_code, string_view content, const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + void write(StatusCode status_code, string_view content, const CaseInsensitiveMultimap &header = {}) { *this << "HTTP/1.1 " << SimpleWeb::status_code(status_code) << "\r\n"; write_header(header, content.size()); if(!content.empty()) @@ -159,7 +159,7 @@ namespace SimpleWeb { } /// Convenience function for writing status line, header fields, and content - void write(StatusCode status_code, std::istream &content, const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + void write(StatusCode status_code, std::istream &content, const CaseInsensitiveMultimap &header = {}) { *this << "HTTP/1.1 " << SimpleWeb::status_code(status_code) << "\r\n"; content.seekg(0, std::ios::end); auto size = content.tellg(); @@ -170,12 +170,12 @@ namespace SimpleWeb { } /// Convenience function for writing success status line, header fields, and content - void write(string_view content, const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + void write(string_view content, const CaseInsensitiveMultimap &header = {}) { write(StatusCode::success_ok, content, header); } /// Convenience function for writing success status line, header fields, and content - void write(std::istream &content, const CaseInsensitiveMultimap &header = CaseInsensitiveMultimap()) { + void write(std::istream &content, const CaseInsensitiveMultimap &header = {}) { write(StatusCode::success_ok, content, header); } diff --git a/tests/io_test.cpp b/tests/io_test.cpp index ebed11c..b5e1a9b 100644 --- a/tests/io_test.cpp +++ b/tests/io_test.cpp @@ -141,6 +141,40 @@ int main() { response->write("6\r\nSimple\r\n3\r\nWeb\r\nE\r\n in\r\n\r\nchunks.\r\n0\r\n\r\n", {{"Transfer-Encoding", "chunked"}}); }; + server.resource["^/event-stream$"]["GET"] = [](shared_ptr response, shared_ptr /*request*/) { + thread work_thread([response] { + response->close_connection_after_response = true; // Unspecified content length + + // Send header + promise header_error; + response->write({{"Content-Type", "text/event-stream"}}); + response->send([&header_error](const SimpleWeb::error_code &ec) { + header_error.set_value(static_cast(ec)); + }); + ASSERT(!header_error.get_future().get()); + + *response << "data: 1\n\n"; + promise error; + response->send([&error](const SimpleWeb::error_code &ec) { + error.set_value(static_cast(ec)); + }); + ASSERT(!error.get_future().get()); + + // Write result + *response << "data: 2\n\n"; + }); + work_thread.detach(); + }; + + server.resource["^/session-close$"]["GET"] = [](shared_ptr response, shared_ptr /*request*/) { + response->close_connection_after_response = true; // Unspecified content length + response->write("test", {{"Session", "close"}}); + }; + server.resource["^/session-close-without-correct-header$"]["GET"] = [](shared_ptr response, shared_ptr /*request*/) { + response->close_connection_after_response = true; // Unspecified content length + response->write("test"); + }; + thread server_thread([&server]() { // Start server server.start(); @@ -237,6 +271,16 @@ int main() { auto r = client.request("POST", "/chunked", "6\r\nSimple\r\n3\r\nWeb\r\nE\r\n in\r\n\r\nchunks.\r\n0\r\n\r\n", {{"Transfer-Encoding", "chunked"}}); ASSERT(r->content.string() == "SimpleWeb in\r\n\r\nchunks."); } + + // Test reconnecting + for(int c = 0; c < 20; ++c) { + auto r = client.request("GET", "/session-close"); + ASSERT(r->content.string() == "test"); + } + for(int c = 0; c < 20; ++c) { + auto r = client.request("GET", "/session-close-without-correct-header"); + ASSERT(r->content.string() == "test"); + } } { HttpClient client("localhost:8080"); @@ -294,6 +338,37 @@ int main() { client.io_service->run(); ASSERT(call); + // Test event-stream + { + vector calls(4, 0); + std::size_t call_num = 0; + client.request("GET", "/event-stream", [&calls, &call_num](shared_ptr response, const SimpleWeb::error_code &ec) { + calls.at(call_num) = 1; + if(call_num == 0) { + ASSERT(response->content.string().empty()); + ASSERT(!ec); + } + else if(call_num == 1) { + ASSERT(response->content.string() == "data: 1\n"); + ASSERT(!ec); + } + else if(call_num == 2) { + ASSERT(response->content.string() == "data: 2\n"); + ASSERT(!ec); + } + else if(call_num == 3) { + ASSERT(response->content.string().empty()); + ASSERT(ec == SimpleWeb::asio::error::eof); + } + ++call_num; + }); + SimpleWeb::restart(*client.io_service); + client.io_service->run(); + for(auto call : calls) + ASSERT(call); + } + + // Test concurrent requests from same client { vector calls(100, 0); vector threads; @@ -318,6 +393,33 @@ int main() { ASSERT(call); } + // Test concurrent synchronous request calls from same client + { + HttpClient client("localhost:8080"); + { + vector calls(5, 0); + vector threads; + for(size_t c = 0; c < 5; ++c) { + threads.emplace_back([c, &client, &calls] { + try { + auto r = client.request("GET", "/match/123"); + ASSERT(SimpleWeb::status_code(r->status_code) == SimpleWeb::StatusCode::success_ok); + ASSERT(r->content.string() == "123"); + calls[c] = 1; + } + catch(...) { + ASSERT(false); + } + }); + } + for(auto &thread : threads) + thread.join(); + ASSERT(client.connections.size() == 1); + for(auto call : calls) + ASSERT(call); + } + } + // Test concurrent requests from different clients { vector calls(10, 0); @@ -340,33 +442,6 @@ int main() { } } - // Test concurrent synchronous request calls - { - HttpClient client("localhost:8080"); - { - vector calls(2, 0); - vector threads; - for(size_t c = 0; c < 2; ++c) { - threads.emplace_back([c, &client, &calls] { - try { - auto r = client.request("GET", "/match/123"); - ASSERT(SimpleWeb::status_code(r->status_code) == SimpleWeb::StatusCode::success_ok); - ASSERT(r->content.string() == "123"); - calls[c] = 1; - } - catch(...) { - ASSERT(false); - } - }); - } - for(auto &thread : threads) - thread.join(); - ASSERT(client.connections.size() == 1); - for(auto call : calls) - ASSERT(call); - } - } - // Test multiple requests through a persistent connection { HttpClient client("localhost:8080");