//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2024, the clio developers. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ //============================================================================== #include "util/AsioContextTestFixture.hpp" #include "util/Taggable.hpp" #include "util/UnsupportedType.hpp" #include "util/config/Config.hpp" #include "web/SubscriptionContextInterface.hpp" #include "web/ng/Connection.hpp" #include "web/ng/Error.hpp" #include "web/ng/ProcessingPolicy.hpp" #include "web/ng/Request.hpp" #include "web/ng/Response.hpp" #include "web/ng/impl/ConnectionHandler.hpp" #include "web/ng/impl/MockHttpConnection.hpp" #include "web/ng/impl/MockWsConnection.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace web::ng::impl; using namespace web::ng; using testing::Return; namespace beast = boost::beast; namespace http = boost::beast::http; namespace websocket = boost::beast::websocket; struct ConnectionHandlerTest : SyncAsioContextTest { ConnectionHandlerTest(ProcessingPolicy policy, std::optional maxParallelConnections) : tagFactory_{util::Config{}}, connectionHandler_{policy, maxParallelConnections, tagFactory_, std::nullopt} { } template static std::unexpected makeError(BoostErrorType error) { if constexpr (std::same_as) { return std::unexpected{http::make_error_code(error)}; } else if constexpr (std::same_as) { return std::unexpected{websocket::make_error_code(error)}; } else if constexpr (std::same_as || std::same_as || std::same_as || std::same_as) { return std::unexpected{boost::asio::error::make_error_code(error)}; } else { static_assert(util::Unsupported, "Wrong error type"); } } template static std::expected makeRequest(Args&&... args) { return Request{std::forward(args)...}; } util::TagDecoratorFactory tagFactory_; ConnectionHandler connectionHandler_; util::TagDecoratorFactory tagDecoratorFactory_{util::Config(boost::json::object{{"log_tag_style", "uint"}})}; StrictMockHttpConnectionPtr mockHttpConnection_ = std::make_unique("1.2.3.4", beast::flat_buffer{}, tagDecoratorFactory_); StrictMockWsConnectionPtr mockWsConnection_ = std::make_unique("1.2.3.4", beast::flat_buffer{}, tagDecoratorFactory_); }; struct ConnectionHandlerSequentialProcessingTest : ConnectionHandlerTest { ConnectionHandlerSequentialProcessingTest() : ConnectionHandlerTest(ProcessingPolicy::Sequential, std::nullopt) { } }; TEST_F(ConnectionHandlerSequentialProcessingTest, ReceiveError) { EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive).WillOnce(Return(makeError(http::error::end_of_stream))); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, ReceiveError_CloseConnection) { EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive).WillOnce(Return(makeError(boost::asio::error::timed_out))); EXPECT_CALL(*mockHttpConnection_, close); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_NoHandler_Send) { EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(Return(makeRequest("some_request", Request::HttpHeaders{}))) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(*mockHttpConnection_, send).WillOnce([](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), "WebSocket is not supported by this server"); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_BadTarget_Send) { std::string const target = "/some/target"; std::string const requestMessage = "some message"; EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(Return(makeRequest(http::request{http::verb::get, target, 11, requestMessage}))) .WillOnce(Return(makeError(http::error::end_of_stream))); EXPECT_CALL(*mockHttpConnection_, send).WillOnce([](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), "Bad target"); auto const httpResponse = std::move(response).intoHttpResponse(); EXPECT_EQ(httpResponse.result(), http::status::bad_request); EXPECT_EQ(httpResponse.version(), 11); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_BadMethod_Send) { EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(Return(makeRequest(http::request{http::verb::acl, "/", 11}))) .WillOnce(Return(makeError(http::error::end_of_stream))); EXPECT_CALL(*mockHttpConnection_, send).WillOnce([](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), "Unsupported http method"); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_Send) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(Return(makeRequest(requestMessage, Request::HttpHeaders{}))) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call).WillOnce([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockWsConnection_, send).WillOnce([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, SendSubscriptionMessage) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const subscriptionMessage = "subscription message"; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(Return(makeRequest("", Request::HttpHeaders{}))) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call) .WillOnce([&](Request const& request, auto&&, web::SubscriptionContextPtr subscriptionContext, auto&&) { EXPECT_NE(subscriptionContext, nullptr); subscriptionContext->send(std::make_shared(subscriptionMessage)); return Response(http::status::ok, "", request); }); EXPECT_CALL(*mockWsConnection_, send).WillOnce(Return(std::nullopt)); EXPECT_CALL(*mockWsConnection_, sendBuffer) .WillOnce([&subscriptionMessage](boost::asio::const_buffer buffer, auto&&, auto&&) { EXPECT_EQ(boost::beast::buffers_to_string(buffer), subscriptionMessage); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, SubscriptionContextIsDisconnectedAfterProcessingFinished) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); testing::StrictMock> onDisconnectHook; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); testing::Expectation const expectationReceiveCalled = EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(Return(makeRequest("", Request::HttpHeaders{}))) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call) .WillOnce([&](Request const& request, auto&&, web::SubscriptionContextPtr subscriptionContext, auto&&) { EXPECT_NE(subscriptionContext, nullptr); subscriptionContext->onDisconnect(onDisconnectHook.AsStdFunction()); return Response(http::status::ok, "", request); }); EXPECT_CALL(*mockWsConnection_, send).WillOnce(Return(std::nullopt)); EXPECT_CALL(onDisconnectHook, Call).After(expectationReceiveCalled); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, SubscriptionContextIsNullForHttpConnection) { std::string const target = "/some/target"; testing::StrictMock> postHandlerMock; connectionHandler_.onPost(target, postHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; auto const returnRequest = Return(makeRequest(http::request{http::verb::post, target, 11, requestMessage})); EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(returnRequest) .WillOnce(Return(makeError(http::error::partial_message))); EXPECT_CALL(postHandlerMock, Call) .WillOnce([&](Request const& request, auto&&, web::SubscriptionContextPtr subscriptionContext, auto&&) { EXPECT_EQ(subscriptionContext, nullptr); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockHttpConnection_, send).WillOnce([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return std::nullopt; }); EXPECT_CALL(*mockHttpConnection_, close); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_Send_Loop) { std::string const target = "/some/target"; testing::StrictMock> postHandlerMock; connectionHandler_.onPost(target, postHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; auto const returnRequest = Return(makeRequest(http::request{http::verb::post, target, 11, requestMessage})); EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(Return(makeError(http::error::partial_message))); EXPECT_CALL(postHandlerMock, Call).Times(3).WillRepeatedly([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockHttpConnection_, send) .Times(3) .WillRepeatedly([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return std::nullopt; }); EXPECT_CALL(*mockHttpConnection_, close); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Receive_Handle_SendError) { std::string const target = "/some/target"; testing::StrictMock> getHandlerMock; std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; connectionHandler_.onGet(target, getHandlerMock.AsStdFunction()); EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive) .WillOnce(Return(makeRequest(http::request{http::verb::get, target, 11, requestMessage}))); EXPECT_CALL(getHandlerMock, Call).WillOnce([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockHttpConnection_, send).WillOnce([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return makeError(http::error::end_of_stream).error(); }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerSequentialProcessingTest, Stop) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; bool connectionClosed = false; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .Times(4) .WillRepeatedly([&](auto&&, auto&&) -> std::expected { if (connectionClosed) { return makeError(websocket::error::closed); } return makeRequest(requestMessage, Request::HttpHeaders{}); }); EXPECT_CALL(wsHandlerMock, Call).Times(3).WillRepeatedly([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); size_t numCalls = 0; EXPECT_CALL(*mockWsConnection_, send).Times(3).WillRepeatedly([&](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); ++numCalls; if (numCalls == 3) connectionHandler_.stop(); return std::nullopt; }); EXPECT_CALL(*mockWsConnection_, close).WillOnce([&connectionClosed]() { connectionClosed = true; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } struct ConnectionHandlerParallelProcessingTest : ConnectionHandlerTest { static size_t constexpr maxParallelRequests = 3; ConnectionHandlerParallelProcessingTest() : ConnectionHandlerTest( ProcessingPolicy::Parallel, ConnectionHandlerParallelProcessingTest::maxParallelRequests ) { } static void asyncSleep(boost::asio::yield_context yield, std::chrono::steady_clock::duration duration) { boost::asio::steady_timer timer{yield.get_executor()}; timer.expires_after(duration); timer.async_wait(yield); } }; TEST_F(ConnectionHandlerParallelProcessingTest, ReceiveError) { EXPECT_CALL(*mockHttpConnection_, wasUpgraded).WillOnce(Return(false)); EXPECT_CALL(*mockHttpConnection_, receive).WillOnce(Return(makeError(http::error::end_of_stream))); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockHttpConnection_), yield); }); } TEST_F(ConnectionHandlerParallelProcessingTest, Receive_Handle_Send) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(Return(makeRequest(requestMessage, Request::HttpHeaders{}))) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call).WillOnce([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockWsConnection_, send).WillOnce([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } TEST_F(ConnectionHandlerParallelProcessingTest, Receive_Handle_Send_Loop) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; auto const returnRequest = [&](auto&&, auto&&) { return makeRequest(requestMessage, Request::HttpHeaders{}); }; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call).Times(2).WillRepeatedly([&](Request const& request, auto&&, auto&&, auto&&) { EXPECT_EQ(request.message(), requestMessage); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL(*mockWsConnection_, send) .Times(2) .WillRepeatedly([&responseMessage](Response response, auto&&, auto&&) { EXPECT_EQ(response.message(), responseMessage); return std::nullopt; }); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); } TEST_F(ConnectionHandlerParallelProcessingTest, Receive_Handle_Send_Loop_TooManyRequest) { testing::StrictMock> wsHandlerMock; connectionHandler_.onWs(wsHandlerMock.AsStdFunction()); std::string const requestMessage = "some message"; std::string const responseMessage = "some response"; auto const returnRequest = [&](auto&&, auto&&) { return makeRequest(requestMessage, Request::HttpHeaders{}); }; testing::Sequence const sequence; EXPECT_CALL(*mockWsConnection_, wasUpgraded).WillOnce(Return(true)); EXPECT_CALL(*mockWsConnection_, receive) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(returnRequest) .WillOnce(Return(makeError(websocket::error::closed))); EXPECT_CALL(wsHandlerMock, Call) .Times(3) .WillRepeatedly([&](Request const& request, auto&&, auto&&, boost::asio::yield_context yield) { EXPECT_EQ(request.message(), requestMessage); asyncSleep(yield, std::chrono::milliseconds{3}); return Response(http::status::ok, responseMessage, request); }); EXPECT_CALL( *mockWsConnection_, send( testing::ResultOf([](Response response) { return response.message(); }, responseMessage), testing::_, testing::_ ) ) .Times(3) .WillRepeatedly(Return(std::nullopt)); EXPECT_CALL( *mockWsConnection_, send( testing::ResultOf( [](Response response) { return response.message(); }, "Too many requests for one connection" ), testing::_, testing::_ ) ) .Times(2) .WillRepeatedly(Return(std::nullopt)); runSpawn([this](boost::asio::yield_context yield) { connectionHandler_.processConnection(std::move(mockWsConnection_), yield); }); }