//------------------------------------------------------------------------------ /* 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/LedgerFetcherInterface.hpp" #include "etlng/LoadBalancerInterface.hpp" #include "util/log/Logger.hpp" #include #include #include #include #include namespace etl::impl { /** * @brief GRPC Ledger data fetcher */ class LedgerFetcher : public LedgerFetcherInterface { private: util::Logger log_{"ETL"}; std::shared_ptr backend_; std::shared_ptr loadBalancer_; public: /** * @brief Create an instance of the fetcher */ LedgerFetcher(std::shared_ptr backend, std::shared_ptr balancer) : backend_(std::move(backend)), loadBalancer_(std::move(balancer)) { } /** * @brief Extract data for a particular ledger from an ETL source * * This function continously tries to extract the specified ledger (using all available ETL sources) until the * extraction succeeds, or the server shuts down. * * @param sequence sequence of the ledger to extract * @return Ledger header and transaction+metadata blobs; Empty optional if the server is shutting down */ [[nodiscard]] OptionalGetLedgerResponseType fetchData(uint32_t sequence) override { LOG(log_.debug()) << "Attempting to fetch ledger with sequence = " << sequence; auto response = loadBalancer_->fetchLedger(sequence, false, false); if (response) LOG(log_.trace()) << "GetLedger reply = " << response->DebugString(); return response; } /** * @brief Extract diff data for a particular ledger from an ETL source. * * This function continously tries to extract the specified ledger (using all available ETL sources) until the * extraction succeeds, or the server shuts down. * * @param sequence sequence of the ledger to extract * @return Ledger data diff between sequance and parent; Empty optional if the server is shutting down */ [[nodiscard]] OptionalGetLedgerResponseType fetchDataAndDiff(uint32_t sequence) override { LOG(log_.debug()) << "Attempting to fetch ledger with sequence = " << sequence; auto const isCacheFull = backend_->cache().isFull(); auto const isLedgerCached = backend_->cache().latestLedgerSequence() >= sequence; if (isLedgerCached) { LOG(log_.info()) << sequence << " is already cached, the current latest seq in cache is " << backend_->cache().latestLedgerSequence() << " and the cache is " << (isCacheFull ? "full" : "not full"); } auto response = loadBalancer_->fetchLedger(sequence, true, !isCacheFull || isLedgerCached); if (response) LOG(log_.trace()) << "GetLedger reply = " << response->DebugString(); return response; } }; } // namespace etl::impl