ServerInfo.hpp

#pragma once
 
#include "data/BackendInterface.hpp"
#include "data/DBHelpers.hpp"
#include "etl/ETLServiceInterface.hpp"
#include "etl/LoadBalancerInterface.hpp"
#include "feed/SubscriptionManagerInterface.hpp"
#include "rpc/Errors.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "util/Assert.hpp"
#include "util/build/Build.hpp"
 
#include <boost/json/conversion.hpp>
#include <boost/json/object.hpp>
#include <boost/json/value.hpp>
#include <fmt/format.h>
#include <xrpl/basics/chrono.h>
#include <xrpl/basics/strHex.h>
#include <xrpl/protocol/BuildInfo.h>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/Fees.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/jss.h>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>
#include <string>
 
namespace rpc {
class Counters;
}  // namespace rpc
 
namespace rpc {

template <typename CountersType>
class BaseServerInfoHandler {
    static constexpr auto kBackendCountersKey = "backend_counters";
 
    std::shared_ptr<BackendInterface> backend_;
    std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions_;
    std::shared_ptr<etl::LoadBalancerInterface> balancer_;
    std::shared_ptr<etl::ETLServiceInterface const> etl_;
    std::reference_wrapper<CountersType const> counters_;
 
public:
    struct Input {
        bool backendCounters = false;
    };

    struct AdminSection {
        boost::json::object counters;
        std::optional<boost::json::object> backendCounters;
        boost::json::object subscriptions;
        boost::json::object etl;
    };

    struct ValidatedLedgerSection {
        uint32_t age = 0;
        std::string hash;
        ripple::LedgerIndex seq = {};
        std::optional<ripple::Fees> fees = std::nullopt;
    };

    struct CacheSection {
        std::size_t size = 0;
        bool isEnabled = false;
        bool isFull = false;
        ripple::LedgerIndex latestLedgerSeq = {};
        float objectHitRate = 1.0;
        float successorHitRate = 1.0;
    };

    struct InfoSection {
        std::optional<AdminSection> adminSection = std::nullopt;
        std::string completeLedgers;
        uint32_t loadFactor = 1u;
        std::chrono::time_point<std::chrono::system_clock> time = std::chrono::system_clock::now();
        std::chrono::seconds uptime = {};
        std::string clioVersion = util::build::getClioVersionString();
        std::string xrplVersion = ripple::BuildInfo::getVersionString();
        std::optional<boost::json::object> rippledInfo = std::nullopt;
        ValidatedLedgerSection validatedLedger = {};
        CacheSection cache = {};
        bool isAmendmentBlocked = false;
        bool isCorruptionDetected = false;
    };

    struct Output {
        InfoSection info = {};
 
        // validated should be sent via framework
        bool validated = true;
    };
 
    using Result = HandlerReturnType<Output>;

    BaseServerInfoHandler(
        std::shared_ptr<BackendInterface> backend,
        std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions,
        std::shared_ptr<etl::LoadBalancerInterface> balancer,
        std::shared_ptr<etl::ETLServiceInterface const> etl,
        CountersType const& counters
    )
        : backend_(std::move(backend))
        , subscriptions_(std::move(subscriptions))
        , balancer_(std::move(balancer))
        , etl_(std::move(etl))
        , counters_(std::cref(counters))
    {
    }

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        static RpcSpec const kRpcSpec = {};
        return kRpcSpec;
    }

    [[nodiscard]] Result
    process(Input const& input, Context const& ctx) const
    {
        using namespace rpc;
        using namespace std::chrono;
 
        auto const range = backend_->fetchLedgerRange();
        ASSERT(range.has_value(), "ServerInfo's ledger range must be available");
 
        auto const lgrInfo = backend_->fetchLedgerBySequence(
            // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
            range->maxSequence,
            ctx.yield
        );
        if (not lgrInfo.has_value())
            return Error{Status{RippledError::rpcINTERNAL}};
 
        auto const fees = backend_->fetchFees(lgrInfo->seq, ctx.yield);
        if (not fees.has_value())
            return Error{Status{RippledError::rpcINTERNAL}};
 
        auto output = Output{};
        auto const sinceEpoch =
            duration_cast<seconds>(system_clock::now().time_since_epoch()).count();
        auto const age = static_cast<int32_t>(sinceEpoch) -
            static_cast<int32_t>(lgrInfo->closeTime.time_since_epoch().count()) -
            static_cast<int32_t>(kRippleEpochStart);
 
        // NOLINTBEGIN(bugprone-unchecked-optional-access)
        output.info.completeLedgers = fmt::format("{}-{}", range->minSequence, range->maxSequence);
        // NOLINTEND(bugprone-unchecked-optional-access)
 
        if (ctx.isAdmin) {
            output.info.adminSection = {
                .counters = counters_.get().report(),
                .backendCounters =
                    input.backendCounters ? std::make_optional(backend_->stats()) : std::nullopt,
                .subscriptions = subscriptions_->report(),
                .etl = etl_->getInfo()
            };
        }
 
        auto const serverInfoRippled = balancer_->forwardToRippled(
            {{"command", "server_info"}}, ctx.clientIp, ctx.isAdmin, ctx.yield
        );
 
        if (serverInfoRippled && !serverInfoRippled->contains(JS(error))) {
            if (serverInfoRippled->contains(JS(result)) &&
                serverInfoRippled->at(JS(result)).as_object().contains(JS(info))) {
                output.info.rippledInfo =
                    serverInfoRippled->at(JS(result)).as_object().at(JS(info)).as_object();
            }
        }
 
        output.info.validatedLedger.age = age < 0 ? 0 : age;
        output.info.validatedLedger.hash = ripple::strHex(lgrInfo->hash);
        output.info.validatedLedger.seq = lgrInfo->seq;
        output.info.validatedLedger.fees = fees;
        output.info.cache.size = backend_->cache().size();
        output.info.cache.isFull = backend_->cache().isFull();
        output.info.cache.latestLedgerSeq = backend_->cache().latestLedgerSequence();
        output.info.cache.objectHitRate = backend_->cache().getObjectHitRate();
        output.info.cache.successorHitRate = backend_->cache().getSuccessorHitRate();
        output.info.cache.isEnabled = not backend_->cache().isDisabled();
        output.info.uptime = counters_.get().uptime();
        output.info.isAmendmentBlocked = etl_->isAmendmentBlocked();
        output.info.isCorruptionDetected = etl_->isCorruptionDetected();
 
        return output;
    }
 
private:
    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output)
    {
        using boost::json::value_from;
 
        jv = {
            {JS(info), value_from(output.info)},
            {JS(validated), output.validated},
        };
    }
 
    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, InfoSection const& info)
    {
        using boost::json::value_from;
        using ripple::to_string;
 
        jv = {
            {JS(complete_ledgers), info.completeLedgers},
            {JS(load_factor), info.loadFactor},
            {JS(time), to_string(std::chrono::floor<std::chrono::microseconds>(info.time))},
            {JS(uptime), info.uptime.count()},
            {"clio_version", info.clioVersion},
            {"libxrpl_version", info.xrplVersion},
            {JS(validated_ledger), value_from(info.validatedLedger)},
            {"cache", value_from(info.cache)},
        };
 
        if (info.isAmendmentBlocked)
            jv.as_object()[JS(amendment_blocked)] = true;
 
        if (info.isCorruptionDetected)
            jv.as_object()["corruption_detected"] = true;
 
        if (info.rippledInfo) {
            auto const& rippledInfo = *info.rippledInfo;
 
            if (rippledInfo.contains(JS(load_factor)))
                jv.as_object()[JS(load_factor)] = rippledInfo.at(JS(load_factor));
            if (rippledInfo.contains(JS(validation_quorum)))
                jv.as_object()[JS(validation_quorum)] = rippledInfo.at(JS(validation_quorum));
            if (rippledInfo.contains(JS(build_version)))
                jv.as_object()["rippled_version"] = rippledInfo.at(JS(build_version));
            if (rippledInfo.contains(JS(network_id)))
                jv.as_object()[JS(network_id)] = rippledInfo.at(JS(network_id));
        }
 
        if (info.adminSection) {
            jv.as_object()["etl"] = info.adminSection->etl;
            jv.as_object()[JS(counters)] = info.adminSection->counters;
            jv.as_object()[JS(counters)].as_object()["subscriptions"] =
                info.adminSection->subscriptions;
            if (info.adminSection->backendCounters.has_value()) {
                jv.as_object()[kBackendCountersKey] = *info.adminSection->backendCounters;
            }
        }
    }
 
    friend void
    tag_invoke(
        boost::json::value_from_tag,
        boost::json::value& jv,
        ValidatedLedgerSection const& validated
    )
    {
        // NOLINTBEGIN(bugprone-unchecked-optional-access)
        jv = {
            {JS(age), validated.age},
            {JS(hash), validated.hash},
            {JS(seq), validated.seq},
            {JS(base_fee_xrp), validated.fees->base.decimalXRP()},
            {JS(reserve_base_xrp), validated.fees->reserve.decimalXRP()},
            {JS(reserve_inc_xrp), validated.fees->increment.decimalXRP()},
        };
        // NOLINTEND(bugprone-unchecked-optional-access)
    }
 
    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, CacheSection const& cache)
    {
        jv = {
            {"size", cache.size},
            {"is_enabled", cache.isEnabled},
            {"is_full", cache.isFull},
            {"latest_ledger_seq", cache.latestLedgerSeq},
            {"object_hit_rate", cache.objectHitRate},
            {"successor_hit_rate", cache.successorHitRate},
        };
    }
 
    friend Input
    tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv)
    {
        auto input = BaseServerInfoHandler::Input{};
        auto const jsonObject = jv.as_object();
        if (jsonObject.contains(kBackendCountersKey) &&
            jsonObject.at(kBackendCountersKey).is_bool())
            input.backendCounters = jv.at(kBackendCountersKey).as_bool();
        return input;
    }
};

using ServerInfoHandler = BaseServerInfoHandler<Counters>;
 
}  // namespace rpc