ConfigDefinition.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 "rpc/common/APIVersion.hpp"
#include "util/Assert.hpp"
#include "util/newconfig/Array.hpp"
#include "util/newconfig/ConfigConstraints.hpp"
#include "util/newconfig/ConfigFileInterface.hpp"
#include "util/newconfig/ConfigValue.hpp"
#include "util/newconfig/Error.hpp"
#include "util/newconfig/ObjectView.hpp"
#include "util/newconfig/Types.hpp"
#include "util/newconfig/ValueView.hpp"
 
#include <algorithm>
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <initializer_list>
#include <optional>
#include <string>
#include <string_view>
#include <thread>
#include <unordered_map>
#include <utility>
#include <variant>
#include <vector>
 
namespace util::config {
 
class ClioConfigDefinition {
public:
    using KeyValuePair = std::pair<std::string_view, std::variant<ConfigValue, Array>>;
 
    ClioConfigDefinition(std::initializer_list<KeyValuePair> pair);
 
    [[nodiscard]] std::optional<std::vector<Error>>
    parse(ConfigFileInterface const& config);
 
    [[nodiscard]] ObjectView
    getObject(std::string_view prefix, std::optional<std::size_t> idx = std::nullopt) const;
 
    [[nodiscard]] ValueView
    getValueView(std::string_view fullKey) const;
 
    template <typename T>
    T
    get(std::string_view fullKey) const
    {
        ASSERT(map_.contains(fullKey), "key {} does not exist in config", fullKey);
        auto const val = map_.at(fullKey);
        if (std::holds_alternative<ConfigValue>(val)) {
            return ValueView{std::get<ConfigValue>(val)}.getValueImpl<T>();
        }
        std::unreachable();
    }
 
    [[nodiscard]] ValueView
    getValueInArray(std::string_view fullKey, std::size_t index) const;
 
    [[nodiscard]] ArrayView
    getArray(std::string_view prefix) const;
 
    [[nodiscard]] bool
    contains(std::string_view key) const;
 
    [[nodiscard]] bool
    hasItemsWithPrefix(std::string_view key) const;
 
    [[nodiscard]] Array const&
    asArray(std::string_view key) const;
 
    [[nodiscard]] std::size_t
    arraySize(std::string_view prefix) const;
 
    static std::chrono::milliseconds
    toMilliseconds(float value);
 
    template <typename T>
    std::optional<T>
    maybeValue(std::string_view fullKey) const
    {
        return getValueView(fullKey).asOptional<T>();
    }
 
    [[nodiscard]] auto
    begin() const
    {
        return map_.begin();
    }
 
    [[nodiscard]] auto
    end() const
    {
        return map_.end();
    }
 
private:
    [[nodiscard]] auto
    getArrayIterator(std::string_view key) const
    {
        auto const fullKey = addBracketsForArrayKey(key);
        auto const it = std::ranges::find_if(map_, [&fullKey](auto pair) { return pair.first == fullKey; });
 
        ASSERT(it != map_.end(), "key {} does not exist in config", fullKey);
        ASSERT(std::holds_alternative<Array>(it->second), "Value of {} is not an array", fullKey);
 
        return it;
    }
 
    [[nodiscard]] static std::string
    addBracketsForArrayKey(std::string_view key)
    {
        std::string fullKey = std::string(key);
        if (!key.contains(".[]"))
            fullKey += ".[]";
        return fullKey;
    }
 
    std::unordered_map<std::string_view, std::variant<ConfigValue, Array>> map_;
};
 
static ClioConfigDefinition gClioConfig = ClioConfigDefinition{
    {{"database.type", ConfigValue{ConfigType::String}.defaultValue("cassandra").withConstraint(gValidateCassandraName)
     },
     {"database.cassandra.contact_points", ConfigValue{ConfigType::String}.defaultValue("localhost")},
     {"database.cassandra.secure_connect_bundle", ConfigValue{ConfigType::String}.optional()},
     {"database.cassandra.port", ConfigValue{ConfigType::Integer}.withConstraint(gValidatePort).optional()},
     {"database.cassandra.keyspace", ConfigValue{ConfigType::String}.defaultValue("clio")},
     {"database.cassandra.replication_factor",
      ConfigValue{ConfigType::Integer}.defaultValue(3u).withConstraint(gValidateReplicationFactor)},
     {"database.cassandra.table_prefix", ConfigValue{ConfigType::String}.optional()},
     {"database.cassandra.max_write_requests_outstanding",
      ConfigValue{ConfigType::Integer}.defaultValue(10'000).withConstraint(gValidateUint32)},
     {"database.cassandra.max_read_requests_outstanding",
      ConfigValue{ConfigType::Integer}.defaultValue(100'000).withConstraint(gValidateUint32)},
     {"database.cassandra.threads",
      ConfigValue{ConfigType::Integer}
          .defaultValue(
              static_cast<uint32_t>(std::thread::hardware_concurrency()),
              "The number of available CPU cores."
          )
          .withConstraint(gValidateUint32)},
     {"database.cassandra.core_connections_per_host",
      ConfigValue{ConfigType::Integer}.defaultValue(1).withConstraint(gValidateUint16)},
     {"database.cassandra.queue_size_io", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint16)},
     {"database.cassandra.write_batch_size",
      ConfigValue{ConfigType::Integer}.defaultValue(20).withConstraint(gValidateUint16)},
     {"database.cassandra.connect_timeout", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint32)
     },
     {"database.cassandra.request_timeout", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint32)
     },
     {"database.cassandra.username", ConfigValue{ConfigType::String}.optional()},
     {"database.cassandra.password", ConfigValue{ConfigType::String}.optional()},
     {"database.cassandra.certfile", ConfigValue{ConfigType::String}.optional()},
 
     {"allow_no_etl", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
     {"__ng_etl", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
     {"etl_sources.[].ip", Array{ConfigValue{ConfigType::String}.optional().withConstraint(gValidateIp)}},
     {"etl_sources.[].ws_port", Array{ConfigValue{ConfigType::String}.optional().withConstraint(gValidatePort)}},
     {"etl_sources.[].grpc_port", Array{ConfigValue{ConfigType::String}.optional().withConstraint(gValidatePort)}},
 
     {"forwarding.cache_timeout",
      ConfigValue{ConfigType::Double}.defaultValue(0.0).withConstraint(gValidatePositiveDouble)},
     {"forwarding.request_timeout",
      ConfigValue{ConfigType::Double}.defaultValue(10.0).withConstraint(gValidatePositiveDouble)},
 
     {"rpc.cache_timeout", ConfigValue{ConfigType::Double}.defaultValue(0.0).withConstraint(gValidatePositiveDouble)},
 
     {"num_markers", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateNumMarkers)},
 
     {"dos_guard.whitelist.[]", Array{ConfigValue{ConfigType::String}.optional()}},
     {"dos_guard.max_fetches", ConfigValue{ConfigType::Integer}.defaultValue(1000'000u).withConstraint(gValidateUint32)
     },
     {"dos_guard.max_connections", ConfigValue{ConfigType::Integer}.defaultValue(20u).withConstraint(gValidateUint32)},
     {"dos_guard.max_requests", ConfigValue{ConfigType::Integer}.defaultValue(20u).withConstraint(gValidateUint32)},
     {"dos_guard.sweep_interval",
      ConfigValue{ConfigType::Double}.defaultValue(1.0).withConstraint(gValidatePositiveDouble)},
 
     {"workers",
      ConfigValue{ConfigType::Integer}
          .defaultValue(std::thread::hardware_concurrency(), "The number of available CPU cores.")
          .withConstraint(gValidateUint32)},
     {"server.ip", ConfigValue{ConfigType::String}.withConstraint(gValidateIp)},
     {"server.port", ConfigValue{ConfigType::Integer}.withConstraint(gValidatePort)},
     {"server.max_queue_size", ConfigValue{ConfigType::Integer}.defaultValue(1).withConstraint(gValidateUint32)},
     {"server.local_admin", ConfigValue{ConfigType::Boolean}.optional()},
     {"server.admin_password", ConfigValue{ConfigType::String}.optional()},
     {"server.processing_policy",
      ConfigValue{ConfigType::String}.defaultValue("parallel").withConstraint(gValidateProcessingPolicy)},
     {"server.parallel_requests_limit", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint16)},
     {"server.ws_max_sending_queue_size",
      ConfigValue{ConfigType::Integer}.defaultValue(1500).withConstraint(gValidateUint32)},
     {"server.__ng_web_server", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
 
     {"prometheus.enabled", ConfigValue{ConfigType::Boolean}.defaultValue(true)},
     {"prometheus.compress_reply", ConfigValue{ConfigType::Boolean}.defaultValue(true)},
 
     {"io_threads", ConfigValue{ConfigType::Integer}.defaultValue(2).withConstraint(gValidateUint16)},
 
     {"subscription_workers", ConfigValue{ConfigType::Integer}.defaultValue(1).withConstraint(gValidateUint32)},
 
     {"graceful_period", ConfigValue{ConfigType::Double}.defaultValue(10.0).withConstraint(gValidatePositiveDouble)},
 
     {"cache.num_diffs", ConfigValue{ConfigType::Integer}.defaultValue(32).withConstraint(gValidateUint16)},
     {"cache.num_markers", ConfigValue{ConfigType::Integer}.defaultValue(48).withConstraint(gValidateUint16)},
     {"cache.num_cursors_from_diff",
      ConfigValue{ConfigType::Integer}.defaultValue(0).withConstraint(gValidateNumCursors)},
     {"cache.num_cursors_from_account",
      ConfigValue{ConfigType::Integer}.defaultValue(0).withConstraint(gValidateNumCursors)},
     {"cache.page_fetch_size", ConfigValue{ConfigType::Integer}.defaultValue(512).withConstraint(gValidateUint16)},
     {"cache.load", ConfigValue{ConfigType::String}.defaultValue("async").withConstraint(gValidateLoadMode)},
 
     {"log_channels.[].channel", Array{ConfigValue{ConfigType::String}.optional().withConstraint(gValidateChannelName)}
     },
     {"log_channels.[].log_level",
      Array{ConfigValue{ConfigType::String}.optional().withConstraint(gValidateLogLevelName)}},
 
     {"log_level", ConfigValue{ConfigType::String}.defaultValue("info").withConstraint(gValidateLogLevelName)},
 
     {"log_format",
      ConfigValue{ConfigType::String}.defaultValue(
          R"(%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%)"
      )},
 
     {"log_to_console", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
 
     {"log_directory", ConfigValue{ConfigType::String}.optional()},
 
     {"log_rotation_size", ConfigValue{ConfigType::Integer}.defaultValue(2048).withConstraint(gValidateUint32)},
 
     {"log_directory_max_size", ConfigValue{ConfigType::Integer}.defaultValue(50 * 1024).withConstraint(gValidateUint32)
     },
 
     {"log_rotation_hour_interval", ConfigValue{ConfigType::Integer}.defaultValue(12).withConstraint(gValidateUint32)},
 
     {"log_tag_style", ConfigValue{ConfigType::String}.defaultValue("none").withConstraint(gValidateLogTag)},
 
     {"extractor_threads", ConfigValue{ConfigType::Integer}.defaultValue(1u).withConstraint(gValidateUint32)},
 
     {"read_only", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
 
     {"start_sequence", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint32)},
 
     {"finish_sequence", ConfigValue{ConfigType::Integer}.optional().withConstraint(gValidateUint32)},
 
     {"ssl_cert_file", ConfigValue{ConfigType::String}.optional()},
 
     {"ssl_key_file", ConfigValue{ConfigType::String}.optional()},
 
     {"api_version.default",
      ConfigValue{ConfigType::Integer}.defaultValue(rpc::kAPI_VERSION_DEFAULT).withConstraint(gValidateApiVersion)},
     {"api_version.min",
      ConfigValue{ConfigType::Integer}.defaultValue(rpc::kAPI_VERSION_MIN).withConstraint(gValidateApiVersion)},
     {"api_version.max",
      ConfigValue{ConfigType::Integer}.defaultValue(rpc::kAPI_VERSION_MAX).withConstraint(gValidateApiVersion)},
 
     {"migration.full_scan_threads", ConfigValue{ConfigType::Integer}.defaultValue(2).withConstraint(gValidateUint32)},
     {"migration.full_scan_jobs", ConfigValue{ConfigType::Integer}.defaultValue(4).withConstraint(gValidateUint32)},
     {"migration.cursors_per_job", ConfigValue{ConfigType::Integer}.defaultValue(100).withConstraint(gValidateUint32)}},
};
 
}  // namespace util::config