Add option to set X-User header value for forwarded requests (#1425)

Fixes #1422.

tests/common/util/MockLoadBalancer.hpp

@@ -40,7 +40,7 @@ struct MockLoadBalancer {
     MOCK_METHOD(
         std::optional<boost::json::object>,
         forwardToRippled,
-        (boost::json::object const&, std::optional<std::string> const&, boost::asio::yield_context),
+        (boost::json::object const&, std::optional<std::string> const&, bool, boost::asio::yield_context),
         (const)
     );
 };

tests/common/util/MockSource.hpp

@@ -19,7 +19,7 @@
 #pragma once
 
 #include "data/BackendInterface.hpp"
-#include "etl/ETLHelpers.hpp"
+#include "etl/NetworkValidatedLedgersInterface.hpp"
 #include "etl/Source.hpp"
 #include "feed/SubscriptionManagerInterface.hpp"
 #include "util/config/Config.hpp"
@@ -39,7 +39,7 @@
 #include <memory>
 #include <optional>
 #include <string>
-#include <unordered_map>
+#include <string_view>
 #include <utility>
 #include <vector>
 
@@ -60,7 +60,7 @@ struct MockSource : etl::SourceBase {
     MOCK_METHOD(
         std::optional<boost::json::object>,
         forwardToRippled,
-        (boost::json::object const&, std::optional<std::string> const&, boost::asio::yield_context),
+        (boost::json::object const&, std::optional<std::string> const&, std::string_view, boost::asio::yield_context),
         (const, override)
     );
 };
@@ -129,10 +129,11 @@ public:
     forwardToRippled(
         boost::json::object const& request,
         std::optional<std::string> const& forwardToRippledClientIp,
+        std::string_view xUserValue,
         boost::asio::yield_context yield
     ) const override
     {
-        return mock_->forwardToRippled(request, forwardToRippledClientIp, yield);
+        return mock_->forwardToRippled(request, forwardToRippledClientIp, xUserValue, yield);
     }
 };
 

tests/common/util/TestWsServer.cpp

@@ -32,20 +32,30 @@
 #include <boost/beast/core/flat_buffer.hpp>
 #include <boost/beast/core/role.hpp>
 #include <boost/beast/core/tcp_stream.hpp>
+#include <boost/beast/http/field.hpp>
+#include <boost/beast/http/message.hpp>
+#include <boost/beast/http/string_body.hpp>
 #include <boost/beast/websocket/error.hpp>
 #include <boost/beast/websocket/rfc6455.hpp>
 #include <boost/beast/websocket/stream_base.hpp>
 #include <gtest/gtest.h>
 
+#include <algorithm>
 #include <expected>
+#include <iterator>
 #include <optional>
 #include <string>
 #include <utility>
+#include <vector>
 
 namespace asio = boost::asio;
 namespace websocket = boost::beast::websocket;
 
-TestWsConnection::TestWsConnection(websocket::stream<boost::beast::tcp_stream> wsStream) : ws_(std::move(wsStream))
+TestWsConnection::TestWsConnection(
+    websocket::stream<boost::beast::tcp_stream> wsStream,
+    std::vector<util::requests::HttpHeader> headers
+)
+    : ws_(std::move(wsStream)), headers_(std::move(headers))
 {
 }
 
@@ -83,6 +93,12 @@ TestWsConnection::close(boost::asio::yield_context yield)
     return std::nullopt;
 }
 
+std::vector<util::requests::HttpHeader> const&
+TestWsConnection::headers() const
+{
+    return headers_;
+}
+
 TestWsServer::TestWsServer(asio::io_context& context, std::string const& host, int port) : acceptor_(context)
 {
     auto endpoint = asio::ip::tcp::endpoint(boost::asio::ip::make_address(host), port);
@@ -102,13 +118,28 @@ TestWsServer::acceptConnection(asio::yield_context yield)
     if (errorCode)
         return std::unexpected{util::requests::RequestError{"Accept error", errorCode}};
 
+    boost::beast::flat_buffer buffer;
+    boost::beast::http::request<boost::beast::http::string_body> request;
+    boost::beast::http::async_read(socket, buffer, request, yield[errorCode]);
+    if (errorCode)
+        return std::unexpected{util::requests::RequestError{"Read error", errorCode}};
+    std::vector<util::requests::HttpHeader> headers;
+    std::transform(request.begin(), request.end(), std::back_inserter(headers), [](auto const& header) {
+        if (header.name() == boost::beast::http::field::unknown)
+            return util::requests::HttpHeader{header.name_string(), header.value()};
+
+        return util::requests::HttpHeader{header.name(), header.value()};
+    });
+    if (not boost::beast::websocket::is_upgrade(request))
+        return std::unexpected{util::requests::RequestError{"Not a websocket request"}};
+
     boost::beast::websocket::stream<boost::beast::tcp_stream> ws(std::move(socket));
     ws.set_option(websocket::stream_base::timeout::suggested(boost::beast::role_type::server));
-    ws.async_accept(yield[errorCode]);
+    ws.async_accept(request, yield[errorCode]);
     if (errorCode)
         return std::unexpected{util::requests::RequestError{"Handshake error", errorCode}};
 
-    return TestWsConnection(std::move(ws));
+    return TestWsConnection(std::move(ws), std::move(headers));
 }
 
 void

tests/common/util/TestWsServer.hpp

@@ -31,15 +31,20 @@
 #include <functional>
 #include <optional>
 #include <string>
+#include <vector>
 
 class TestWsConnection {
     boost::beast::websocket::stream<boost::beast::tcp_stream> ws_;
+    std::vector<util::requests::HttpHeader> headers_;
 
 public:
     using SendCallback = std::function<void()>;
     using ReceiveCallback = std::function<void(std::string)>;
 
-    TestWsConnection(boost::beast::websocket::stream<boost::beast::tcp_stream> wsStream);
+    TestWsConnection(
+        boost::beast::websocket::stream<boost::beast::tcp_stream> wsStream,
+        std::vector<util::requests::HttpHeader> headers
+    );
 
     // returns error message if error occurs
     std::optional<std::string>
@@ -51,6 +56,9 @@ public:
 
     std::optional<std::string>
     close(boost::asio::yield_context yield);
+
+    std::vector<util::requests::HttpHeader> const&
+    headers() const;
 };
 
 class TestWsServer {