ETLService.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2023, 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.
*/
//==============================================================================
 
#pragma once
 
#include "data/BackendInterface.hpp"
#include "etl/CacheLoader.hpp"
#include "etl/ETLState.hpp"
#include "etl/LoadBalancer.hpp"
#include "etl/NetworkValidatedLedgersInterface.hpp"
#include "etl/SystemState.hpp"
#include "etl/impl/AmendmentBlockHandler.hpp"
#include "etl/impl/ExtractionDataPipe.hpp"
#include "etl/impl/Extractor.hpp"
#include "etl/impl/LedgerFetcher.hpp"
#include "etl/impl/LedgerLoader.hpp"
#include "etl/impl/LedgerPublisher.hpp"
#include "etl/impl/Transformer.hpp"
#include "etlng/ETLService.hpp"
#include "etlng/ETLServiceInterface.hpp"
#include "etlng/LoadBalancer.hpp"
#include "etlng/LoadBalancerInterface.hpp"
#include "feed/SubscriptionManagerInterface.hpp"
#include "util/Assert.hpp"
#include "util/log/Logger.hpp"
 
#include <boost/asio/io_context.hpp>
#include <boost/json/object.hpp>
#include <grpcpp/grpcpp.h>
#include <org/xrpl/rpc/v1/get_ledger.pb.h>
#include <xrpl/proto/org/xrpl/rpc/v1/xrp_ledger.grpc.pb.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <thread>
 
struct AccountTransactionsData;
struct NFTTransactionsData;
struct NFTsData;
 
namespace etl {
 
struct ETLServiceTag {
    virtual ~ETLServiceTag() = default;
};
 
template <typename T>
concept SomeETLService = std::derived_from<T, ETLServiceTag>;
 
class ETLService : public etlng::ETLServiceInterface, ETLServiceTag {
    // TODO: make these template parameters in ETLService
    using DataPipeType = etl::impl::ExtractionDataPipe<org::xrpl::rpc::v1::GetLedgerResponse>;
    using CacheLoaderType = etl::CacheLoader<>;
    using LedgerFetcherType = etl::impl::LedgerFetcher;
    using ExtractorType = etl::impl::Extractor<DataPipeType, LedgerFetcherType>;
    using LedgerLoaderType = etl::impl::LedgerLoader<LedgerFetcherType>;
    using LedgerPublisherType = etl::impl::LedgerPublisher;
    using AmendmentBlockHandlerType = etl::impl::AmendmentBlockHandler;
    using TransformerType =
        etl::impl::Transformer<DataPipeType, LedgerLoaderType, LedgerPublisherType, AmendmentBlockHandlerType>;
 
    util::Logger log_{"ETL"};
 
    std::shared_ptr<BackendInterface> backend_;
    std::shared_ptr<etlng::LoadBalancerInterface> loadBalancer_;
    std::shared_ptr<NetworkValidatedLedgersInterface> networkValidatedLedgers_;
 
    std::uint32_t extractorThreads_ = 1;
    std::thread worker_;
 
    CacheLoaderType cacheLoader_;
    LedgerFetcherType ledgerFetcher_;
    LedgerLoaderType ledgerLoader_;
    LedgerPublisherType ledgerPublisher_;
    AmendmentBlockHandlerType amendmentBlockHandler_;
 
    SystemState state_;
 
    size_t numMarkers_ = 2;
    std::optional<uint32_t> startSequence_;
    std::optional<uint32_t> finishSequence_;
 
public:
    ETLService(
        util::config::ClioConfigDefinition const& config,
        boost::asio::io_context& ioc,
        std::shared_ptr<BackendInterface> backend,
        std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions,
        std::shared_ptr<etlng::LoadBalancerInterface> balancer,
        std::shared_ptr<NetworkValidatedLedgersInterface> ledgers
    );
 
    ETLService(ETLService&&) = delete;
 
    static std::shared_ptr<etlng::ETLServiceInterface>
    makeETLService(
        util::config::ClioConfigDefinition const& config,
        boost::asio::io_context& ioc,
        std::shared_ptr<BackendInterface> backend,
        std::shared_ptr<feed::SubscriptionManagerInterface> subscriptions,
        std::shared_ptr<etlng::LoadBalancerInterface> balancer,
        std::shared_ptr<NetworkValidatedLedgersInterface> ledgers
    )
    {
        std::shared_ptr<etlng::ETLServiceInterface> ret;
 
        if (config.get<bool>("__ng_etl")) {
            ASSERT(
                std::dynamic_pointer_cast<etlng::LoadBalancer>(balancer),
                "LoadBalancer type must be etlng::LoadBalancer"
            );
            ret = std::make_shared<etlng::ETLService>(config, backend, subscriptions, balancer, ledgers);
        } else {
            ASSERT(
                std::dynamic_pointer_cast<etl::LoadBalancer>(balancer), "LoadBalancer type must be etl::LoadBalancer"
            );
            ret = std::make_shared<etl::ETLService>(config, ioc, backend, subscriptions, balancer, ledgers);
        }
 
        ret->run();
        return ret;
    }
 
    ~ETLService() override
    {
        if (not state_.isStopping)
            stop();
    }
 
    void
    stop() override
    {
        LOG(log_.info()) << "Stop called";
 
        state_.isStopping = true;
        cacheLoader_.stop();
 
        if (worker_.joinable())
            worker_.join();
 
        LOG(log_.debug()) << "Joined ETLService worker thread";
    }
 
    std::uint32_t
    lastCloseAgeSeconds() const override
    {
        return ledgerPublisher_.lastCloseAgeSeconds();
    }
 
    bool
    isAmendmentBlocked() const override
    {
        return state_.isAmendmentBlocked;
    }
 
    bool
    isCorruptionDetected() const override
    {
        return state_.isCorruptionDetected;
    }
 
    boost::json::object
    getInfo() const override
    {
        boost::json::object result;
 
        result["etl_sources"] = loadBalancer_->toJson();
        result["is_writer"] = static_cast<int>(state_.isWriting);
        result["read_only"] = static_cast<int>(state_.isReadOnly);
        auto last = ledgerPublisher_.getLastPublish();
        if (last.time_since_epoch().count() != 0)
            result["last_publish_age_seconds"] = std::to_string(ledgerPublisher_.lastPublishAgeSeconds());
        return result;
    }
 
    std::optional<etl::ETLState>
    getETLState() const noexcept override
    {
        return loadBalancer_->getETLState();
    }
 
    void
    run() override;
 
private:
    std::optional<uint32_t>
    runETLPipeline(uint32_t startSequence, uint32_t numExtractors);
 
    void
    monitor();
 
    uint32_t
    publishNextSequence(uint32_t nextSequence);
 
    void
    monitorReadOnly();
 
    bool
    isStopping() const
    {
        return state_.isStopping;
    }
 
    std::uint32_t
    getNumMarkers() const
    {
        return numMarkers_;
    }
 
    void
    doWork();
};
}  // namespace etl