Registry.hpp

//------------------------------------------------------------------------------
/*
    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.
*/
//==============================================================================
 
#pragma once
 
#include "etl/Models.hpp"
#include "etl/RegistryInterface.hpp"
#include "etl/SystemState.hpp"
 
#include <xrpl/protocol/TxFormats.h>
 
#include <concepts>
#include <cstdint>
#include <functional>
#include <string>
#include <tuple>
#include <type_traits>
#include <utility>
#include <vector>
 
namespace etl::impl {
 
template <typename T>
concept HasLedgerDataHook = requires(T p) {
    { p.onLedgerData(std::declval<model::LedgerData>()) } -> std::same_as<void>;
};
 
template <typename T>
concept HasInitialDataHook = requires(T p) {
    { p.onInitialData(std::declval<model::LedgerData>()) } -> std::same_as<void>;
};
 
template <typename T>
concept HasTransactionHook = requires(T p) {
    { p.onTransaction(uint32_t{}, std::declval<model::Transaction>()) } -> std::same_as<void>;
};
 
template <typename T>
concept HasObjectHook = requires(T p) {
    { p.onObject(uint32_t{}, std::declval<model::Object>()) } -> std::same_as<void>;
};
 
template <typename T>
concept HasInitialTransactionHook = requires(T p) {
    {
        p.onInitialTransaction(uint32_t{}, std::declval<model::Transaction>())
    } -> std::same_as<void>;
};
 
template <typename T>
concept HasInitialObjectsHook = requires(T p) {
    {
        p.onInitialObjects(uint32_t{}, std::declval<std::vector<model::Object>>(), std::string{})
    } -> std::same_as<void>;
};
 
template <typename T>
concept HasInitialObjectHook = requires(T p) {
    { p.onInitialObject(uint32_t{}, std::declval<model::Object>()) } -> std::same_as<void>;
};
 
template <typename T>
concept ContainsSpec = std::decay_t<T>::spec::kSPEC_TAG;
 
template <typename T>
concept ContainsValidHook =
    HasLedgerDataHook<T> or HasInitialDataHook<T> or (HasTransactionHook<T> and ContainsSpec<T>) or
    (HasInitialTransactionHook<T> and ContainsSpec<T>) or HasObjectHook<T> or
    HasInitialObjectsHook<T> or HasInitialObjectHook<T>;
 
template <typename T>
concept NoTwoOfKind = not(HasLedgerDataHook<T> and HasTransactionHook<T>) and
    not(HasInitialDataHook<T> and HasInitialTransactionHook<T>) and
    not(HasInitialObjectsHook<T> and HasInitialObjectHook<T>);
 
template <typename T>
concept SomeExtension = NoTwoOfKind<T> and ContainsValidHook<T>;
 
template <SomeExtension... Ps>
class Registry : public RegistryInterface {
    std::reference_wrapper<SystemState const> state_;
    std::tuple<Ps...> store_;
 
    static_assert(
        (((not HasTransactionHook<std::decay_t<Ps>>) or ContainsSpec<std::decay_t<Ps>>) and ...),
        "Spec must be specified when 'onTransaction' function exists."
    );
 
    static_assert(
        (((not HasInitialTransactionHook<std::decay_t<Ps>>) or ContainsSpec<std::decay_t<Ps>>) and
         ...),
        "Spec must be specified when 'onInitialTransaction' function exists."
    );
 
public:
    explicit constexpr Registry(SystemState const& state, SomeExtension auto&&... exts)
        requires(std::is_same_v<std::decay_t<decltype(exts)>, std::decay_t<Ps>> and ...)
        : state_{state}, store_(std::forward<Ps>(exts)...)
    {
    }
 
    ~Registry() override = default;
    Registry(Registry const&) = delete;
    Registry(Registry&&) = default;
    Registry&
    operator=(Registry const&) = delete;
    Registry&
    operator=(Registry&&) = default;
 
    constexpr void
    dispatch(model::LedgerData const& data) override
    {
        // send entire batch of data at once
        {
            auto const expand = [&](auto& p) {
                if constexpr (requires { p.onLedgerData(data); })
                    executeIfAllowed(p, [&data](auto& p) { p.onLedgerData(data); });
            };
 
            std::apply([&expand](auto&&... xs) { (expand(xs), ...); }, store_);
        }
 
        // send filtered transactions
        {
            auto const expand = [&]<typename P>(P& p, model::Transaction const& t) {
                if constexpr (requires { p.onTransaction(data.seq, t); }) {
                    if (std::decay_t<P>::spec::wants(t.type))
                        executeIfAllowed(p, [&data, &t](auto& p) { p.onTransaction(data.seq, t); });
                }
            };
 
            for (auto const& t : data.transactions) {
                std::apply([&expand, &t](auto&&... xs) { (expand(xs, t), ...); }, store_);
            }
        }
 
        // send per object path
        {
            auto const expand = [&]<typename P>(P&& p, model::Object const& o) {
                if constexpr (requires { p.onObject(data.seq, o); })
                    executeIfAllowed(p, [&data, &o](auto& p) { p.onObject(data.seq, o); });
            };
 
            for (auto const& obj : data.objects) {
                std::apply([&expand, &obj](auto&&... xs) { (expand(xs, obj), ...); }, store_);
            }
        }
    }
 
    constexpr void
    dispatchInitialObjects(
        uint32_t seq,
        std::vector<model::Object> const& data,
        std::string lastKey
    ) override
    {
        // send entire vector path
        {
            auto const expand = [&](auto&& p) {
                if constexpr (requires { p.onInitialObjects(seq, data, lastKey); })
                    executeIfAllowed(p, [seq, &data, &lastKey](auto& p) {
                        p.onInitialObjects(seq, data, lastKey);
                    });
            };
 
            std::apply([&expand](auto&&... xs) { (expand(xs), ...); }, store_);
        }
 
        // send per object path
        {
            auto const expand = [&]<typename P>(P&& p, model::Object const& o) {
                if constexpr (requires { p.onInitialObject(seq, o); })
                    executeIfAllowed(p, [seq, &o](auto& p) { p.onInitialObject(seq, o); });
            };
 
            for (auto const& obj : data) {
                std::apply([&expand, &obj](auto&&... xs) { (expand(xs, obj), ...); }, store_);
            }
        }
    }
 
    constexpr void
    dispatchInitialData(model::LedgerData const& data) override
    {
        // send entire batch path
        {
            auto const expand = [&](auto&& p) {
                if constexpr (requires { p.onInitialData(data); })
                    executeIfAllowed(p, [&data](auto& p) { p.onInitialData(data); });
            };
 
            std::apply([&expand](auto&&... xs) { (expand(xs), ...); }, store_);
        }
 
        // send per tx path
        {
            auto const expand = [&]<typename P>(P&& p, model::Transaction const& tx) {
                if constexpr (requires { p.onInitialTransaction(data.seq, tx); }) {
                    if (std::decay_t<P>::spec::wants(tx.type))
                        executeIfAllowed(p, [&data, &tx](auto& p) {
                            p.onInitialTransaction(data.seq, tx);
                        });
                }
            };
 
            for (auto const& tx : data.transactions) {
                std::apply([&expand, &tx](auto&&... xs) { (expand(xs, tx), ...); }, store_);
            }
        }
    }
 
private:
    void
    executeIfAllowed(auto& p, auto&& fn)
    {
        if constexpr (requires { p.allowInReadonly(); }) {
            if (state_.get().isWriting or p.allowInReadonly())
                fn(p);
        } else {
            if (state_.get().isWriting)
                fn(p);
        }
    }
};
 
static auto
makeRegistry(SystemState const& state, auto&&... exts)
{
    return std::make_unique<Registry<std::decay_t<decltype(exts)>...>>(
        state, std::forward<decltype(exts)>(exts)...
    );
}
 
}  // namespace etl::impl