clio/src/util/requests/RequestBuilder.cpp

//------------------------------------------------------------------------------
/*
    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/requests/RequestBuilder.hpp"

#include "util/log/Logger.hpp"
#include "util/requests/Types.hpp"
#include "util/requests/impl/StreamData.hpp"

#include <boost/asio/associated_executor.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/asio/ssl/error.hpp>
#include <boost/asio/ssl/stream_base.hpp>
#include <boost/beast/core/error.hpp>
#include <boost/beast/core/flat_buffer.hpp>
#include <boost/beast/http/field.hpp>
#include <boost/beast/http/message.hpp>
#include <boost/beast/http/status.hpp>
#include <boost/beast/http/string_body.hpp>
#include <boost/beast/http/verb.hpp>
#include <openssl/err.h>
#include <openssl/tls1.h>

#include <chrono>
#include <expected>
#include <string>
#include <string_view>
#include <utility>
#include <variant>
#include <vector>

namespace util::requests {

namespace beast = boost::beast;
namespace http = beast::http;
namespace asio = boost::asio;
using tcp = asio::ip::tcp;

RequestBuilder::RequestBuilder(std::string host, std::string port)
    : host_(std::move(host)), port_(std::move(port))
{
    request_.set(http::field::host, host_);
    request_.target("/");
}

RequestBuilder&
RequestBuilder::addHeader(HttpHeader const& header)
{
    std::visit([&](auto const& name) { request_.set(name, header.value); }, header.name);
    return *this;
}

RequestBuilder&
RequestBuilder::addHeaders(std::vector<HttpHeader> const& headers)
{
    for (auto const& header : headers)
        addHeader(header);
    return *this;
}

RequestBuilder&
RequestBuilder::addData(std::string data)
{
    request_.body() = data;
    request_.prepare_payload();
    return *this;
}

RequestBuilder&
RequestBuilder::setTimeout(std::chrono::milliseconds const timeout)
{
    timeout_ = timeout;
    return *this;
}

RequestBuilder&
RequestBuilder::setTarget(std::string_view target)
{
    request_.target(target);
    return *this;
}

std::expected<std::string, RequestError>
RequestBuilder::getSsl(boost::asio::yield_context yield)
{
    return doSslRequest(yield, http::verb::get);
}

std::expected<std::string, RequestError>
RequestBuilder::getPlain(boost::asio::yield_context yield)
{
    return doPlainRequest(yield, http::verb::get);
}

std::expected<std::string, RequestError>
RequestBuilder::get(asio::yield_context yield)
{
    return doRequest(yield, http::verb::get);
}

std::expected<std::string, RequestError>
RequestBuilder::postSsl(boost::asio::yield_context yield)
{
    return doSslRequest(yield, http::verb::post);
}

std::expected<std::string, RequestError>
RequestBuilder::postPlain(boost::asio::yield_context yield)
{
    return doPlainRequest(yield, http::verb::post);
}

std::expected<std::string, RequestError>
RequestBuilder::post(asio::yield_context yield)
{
    return doRequest(yield, http::verb::post);
}

std::expected<std::string, RequestError>
RequestBuilder::doSslRequest(asio::yield_context yield, beast::http::verb method)
{
    auto streamData = impl::SslTcpStreamData::create(yield);
    if (not streamData.has_value())
        return std::unexpected{std::move(streamData).error()};

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wold-style-cast"
    if (!SSL_set_tlsext_host_name(streamData->stream.native_handle(), host_.c_str())) {
#pragma GCC diagnostic pop
        beast::error_code errorCode;
        errorCode.assign(static_cast<int>(::ERR_get_error()), asio::error::get_ssl_category());
        return std::unexpected{RequestError{"SSL setup failed", errorCode}};
    }
    return doRequestImpl(std::move(streamData).value(), yield, method);
}

std::expected<std::string, RequestError>
RequestBuilder::doPlainRequest(asio::yield_context yield, beast::http::verb method)
{
    auto streamData = impl::TcpStreamData{yield};
    return doRequestImpl(std::move(streamData), yield, method);
}

std::expected<std::string, RequestError>
RequestBuilder::doRequest(asio::yield_context yield, beast::http::verb method)
{
    auto result = doSslRequest(yield, method);
    if (result.has_value())
        return result;

    LOG(log_.debug()) << "SSL request failed: " << result.error().message()
                      << ". Falling back to plain request.";
    return doPlainRequest(yield, method);
}

/**
 * @brief Perform a request asynchronously
 *
 * @tparam StreamDataType The type of the stream data
 * @param streamData The stream data
 * @param yield The coroutine context
 * @param method The HTTP method to use
 * @return Response or error
 */
template <typename StreamDataType>
std::expected<std::string, RequestError>
RequestBuilder::doRequestImpl(
    StreamDataType&& streamData,
    asio::yield_context yield,
    http::verb const method
)
{
    auto executor = asio::get_associated_executor(yield);

    beast::error_code errorCode;
    tcp::resolver resolver(executor);
    auto const resolverResult = resolver.async_resolve(host_, port_, yield[errorCode]);
    if (errorCode)
        return std::unexpected{RequestError{"Resolve error", errorCode}};

    auto& stream = streamData.stream;

    beast::get_lowest_layer(stream).expires_after(timeout_);
    beast::get_lowest_layer(stream).async_connect(resolverResult, yield[errorCode]);
    if (errorCode)
        return std::unexpected{RequestError{"Connection error", errorCode}};

    request_.method(method);

    if constexpr (StreamDataType::kSSL_ENABLED) {
        beast::get_lowest_layer(stream).expires_after(timeout_);
        stream.async_handshake(asio::ssl::stream_base::client, yield[errorCode]);
        if (errorCode)
            return std::unexpected{RequestError{"Handshake error", errorCode}};
    }

    beast::get_lowest_layer(stream).expires_after(timeout_);
    http::async_write(stream, request_, yield[errorCode]);
    if (errorCode)
        return std::unexpected{RequestError{"Write error", errorCode}};

    beast::flat_buffer buffer;
    http::response<http::string_body> response;

    http::async_read(stream, buffer, response, yield[errorCode]);
    if (errorCode)
        return std::unexpected{RequestError{"Read error", errorCode}};

    if (response.result() != http::status::ok)
        return std::unexpected{RequestError{"Response status is not OK"}};

    beast::get_lowest_layer(stream).socket().shutdown(tcp::socket::shutdown_both, errorCode);

    if (errorCode && errorCode != beast::errc::not_connected)
        return std::unexpected{RequestError{"Shutdown socket error", errorCode}};

    return std::move(response).body();
}

}  // namespace util::requests