scylladb/test/boost/storage_proxy_test.cc

/*
 * Copyright (C) 2015-present ScyllaDB
 */

/*
 * SPDX-License-Identifier: LicenseRef-ScyllaDB-Source-Available-1.1
 */


#include <fmt/ranges.h>
#include <seastar/core/thread.hh>
#undef SEASTAR_TESTING_MAIN
#include <seastar/testing/test_case.hh>
#include <seastar/testing/thread_test_case.hh>

#include "test/lib/cql_test_env.hh"
#include "test/lib/cql_assertions.hh"
#include "test/lib/eventually.hh"
#include "transport/messages/result_message.hh"
#include "types/types.hh"
#include "service/storage_proxy.hh"
#include "query_ranges_to_vnodes.hh"
#include "schema/schema_builder.hh"
#include "utils/error_injection.hh"

BOOST_AUTO_TEST_SUITE(storage_proxy_test)

// Returns random keys sorted in ring order.
// The schema must have a single bytes_type partition key column.
static std::vector<dht::ring_position> make_ring(schema_ptr s, int n_keys) {
    std::vector<dht::ring_position> ring;
    for (int i = 0; i < 10; ++i) {
        auto pk = partition_key::from_single_value(*s, to_bytes(format("key{:d}", i)));
        ring.emplace_back(dht::decorate_key(*s, pk));
    }
    std::sort(ring.begin(), ring.end(), dht::ring_position_less_comparator(*s));
    return ring;
}

SEASTAR_TEST_CASE(test_get_restricted_ranges) {
    return do_with_cql_env_thread([](cql_test_env& e) {
        auto s = schema_builder("ks", "cf")
                .with_column("pk", bytes_type, column_kind::partition_key)
                .with_column("v", bytes_type, column_kind::regular_column)
                .build();

        std::vector<dht::ring_position> ring = make_ring(s, 10);

        auto check = [&s](locator::token_metadata_ptr tmptr, dht::partition_range input,
                          dht::partition_range_vector expected) {
            query_ranges_to_vnodes_generator ranges_to_vnodes(locator::make_splitter(tmptr), s, {input});
            auto actual = ranges_to_vnodes(1000);
            if (!std::equal(actual.begin(), actual.end(), expected.begin(), [&s](auto&& r1, auto&& r2) {
                return r1.equal(r2, dht::ring_position_comparator(*s));
            })) {
                BOOST_FAIL(fmt::format("Ranges differ, expected {} but got {}", expected, actual));
            }
        };

        auto& stm = e.shared_token_metadata().local();

        {
            // Ring with minimum token
            auto tmptr = stm.make_token_metadata_ptr();
            const auto host_id = locator::host_id{utils::UUID(0, 1)};
            tmptr->update_topology(host_id, locator::endpoint_dc_rack{"dc1", "rack1"}, locator::node::state::normal);
            tmptr->update_normal_tokens(std::unordered_set<dht::token>({dht::minimum_token()}), host_id).get();

            check(tmptr, dht::partition_range::make_singular(ring[0]), {
                    dht::partition_range::make_singular(ring[0])
            });

            check(tmptr, dht::partition_range({ring[2]}, {ring[3]}), {
                    dht::partition_range({ring[2]}, {ring[3]})
            });
        }

        {
            auto tmptr = stm.make_token_metadata_ptr();
            const auto id1 = locator::host_id{utils::UUID(0, 1)};
            const auto id2 = locator::host_id{utils::UUID(0, 2)};
            tmptr->update_topology(id1, locator::endpoint_dc_rack{"dc1", "rack1"}, locator::node::state::normal);
            tmptr->update_normal_tokens(std::unordered_set<dht::token>({ring[2].token()}), id1).get();
            tmptr->update_topology(id2, locator::endpoint_dc_rack{"dc1", "rack1"}, locator::node::state::normal);
            tmptr->update_normal_tokens(std::unordered_set<dht::token>({ring[5].token()}), id2).get();

            check(tmptr, dht::partition_range::make_singular(ring[0]), {
                    dht::partition_range::make_singular(ring[0])
            });

            check(tmptr, dht::partition_range::make_singular(ring[2]), {
                    dht::partition_range::make_singular(ring[2])
            });

            check(tmptr, dht::partition_range({{dht::ring_position::ending_at(ring[2].token()), false}}, {ring[3]}), {
                    dht::partition_range({{dht::ring_position::ending_at(ring[2].token()), false}}, {ring[3]})
            });

            check(tmptr, dht::partition_range({ring[3]}, {ring[4]}), {
                dht::partition_range({ring[3]}, {ring[4]})
            });

            check(tmptr, dht::partition_range({ring[2]}, {ring[3]}), {
                dht::partition_range({ring[2]}, {dht::ring_position::ending_at(ring[2].token())}),
                dht::partition_range({{dht::ring_position::ending_at(ring[2].token()), false}}, {ring[3]})
            });

            check(tmptr, dht::partition_range({{ring[2], false}}, {ring[3]}), {
                dht::partition_range({{ring[2], false}}, {dht::ring_position::ending_at(ring[2].token())}),
                dht::partition_range({{dht::ring_position::ending_at(ring[2].token()), false}}, {ring[3]})
            });
        }
    });
}

SEASTAR_THREAD_TEST_CASE(test_split_stats) {
    auto ep1 = locator::host_id{};
    auto sg1 = create_scheduling_group("apa1", 100).get();
    auto sg2 = create_scheduling_group("apa2", 100).get();

    std::optional<service::storage_proxy_stats::split_stats> stats1, stats2;

    // pretending to be abstract_write_response_handler type. 
    // created in various scheduling groups, in which they 
    // instantiate group-local split_stats.
    with_scheduling_group(sg1, [&] {
        stats1.emplace("tuta", "nils", "en nils", "nilsa", true);
    }).get();

    with_scheduling_group(sg2, [&] {
        stats2.emplace("tuta", "nils", "en nils", "nilsa", true);
    }).get();

    // simulating the calling of storage_proxy::on_down, from gossip
    // on node dropping out. If inside a write operation, we'll pick up
    // write handlers and to "timeout_cb" on them, which in turn might
    // call get_ep_stat, which eventually calls register_metrics for 
    // the DC written to.
    // Point being is that either the above should not happen, or 
    // split_stats should be resilient to being called from different
    // scheduling group.
    stats1->register_metrics_for("DC1", ep1);
    stats2->register_metrics_for("DC1", ep1);
}

SEASTAR_TEST_CASE(test_drop_table_during_range_scan) {
#ifdef SCYLLA_ENABLE_ERROR_INJECTION
    return do_with_cql_env_thread([] (cql_test_env& e) {
        e.execute_cql("CREATE TABLE tbl (a int PRIMARY KEY, b int)").get();
        for (int i = 0; i < 100; i++) {
            e.execute_cql(format("INSERT INTO tbl (a, b) VALUES ({}, {})", i, i * 10)).get();
        }

        utils::get_local_injector().enable("query_partition_key_range_concurrent_scan_pause");

        // Start scan in background
        auto scan_fut = e.execute_cql("SELECT * FROM tbl");

        // Wait until the scan hits the pause point
        REQUIRE_EVENTUALLY_EQUAL(std::function<size_t()>([] {
            return utils::get_local_injector().waiters("query_partition_key_range_concurrent_scan_pause");
        }), size_t(1));

        // Get current schema version before drop
        auto get_schema_version = [&e] {
            auto msg = e.execute_cql("SELECT schema_version FROM system.local WHERE key='local'").get();
            auto rows = dynamic_pointer_cast<cql_transport::messages::result_message::rows>(msg);
            auto& rs = rows->rs().result_set();
            return value_cast<utils::UUID>(uuid_type->deserialize(*rs.rows()[0][0]));
        };
        auto schema_version_before_drop = get_schema_version();

        // Drop the table while scan is paused (run in background since drop
        // may wait for in-flight reads to complete)
        auto drop_fut = e.execute_cql("DROP TABLE tbl");

        // Wait for schema version to change in system.local (indicates drop is fully applied)
        REQUIRE_EVENTUALLY_EQUAL(std::function<bool()>([&] {
            return get_schema_version() != schema_version_before_drop;
        }), true);

        // Resume the scan after table is gone
        utils::get_local_injector().receive_message("query_partition_key_range_concurrent_scan_pause");
        utils::get_local_injector().disable("query_partition_key_range_concurrent_scan_pause");

        // Wait for drop future
        drop_fut.get();

        // The scan should either complete or throw, but not crash
        try {
            scan_fut.get();
        } catch (...) {
            // Expected - table was dropped mid-scan
        }
    });
#else
    std::cerr << "Skipping test as it depends on error injection. Please run in mode where it's enabled (debug,dev).\n";
    return make_ready_future<>();
#endif
}

BOOST_AUTO_TEST_SUITE_END()