/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2011-2020 Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

#include "config.h"
#include "iotests.h"
#include <libcouchbase/couchbase.h>

#include <utility>
#include "internal.h"

#include "n1ql/query_cache.hh"

using std::string;
using std::vector;

// Special function for debugging. This returns the name and encoded form of
// the plan
void lcb_n1qlcache_getplan(lcb_QUERY_CACHE_ *cache, const std::string &key, std::string &out)
{
    const Plan *plan = cache->get_entry(key);
    if (plan != nullptr) {
        Json::Value tmp(Json::objectValue);
        plan->apply_plan(tmp, out);
    }
}

struct N1QLResult {
    vector<string> rows;
    string meta;
    uint16_t htcode{};
    lcb_STATUS rc{};
    bool called{};
    string status;
    vector<std::pair<unsigned int, string>> errors;

    N1QLResult()
    {
        reset();
    }

    void reset()
    {
        called = false;
        rc = LCB_SUCCESS;
        meta.clear();
        rows.clear();
        status.clear();
        errors.clear();
        htcode = 0;
    }
};

#define SKIP_QUERY_TEST()                                                                                              \
    fprintf(stderr, "Requires recent mock with query support\n");                                                      \
    return

#define SKIP_CLUSTER_QUERY_TEST()                                                                                      \
    fprintf(stderr, "Requires recent server with query support\n");                                                    \
    return

extern "C" {
static void rowcb(lcb_INSTANCE *, int, const lcb_RESPQUERY *resp)
{
    N1QLResult *res;
    lcb_respquery_cookie(resp, (void **)&res);

    const char *row;
    size_t nrow;
    lcb_respquery_row(resp, &row, &nrow);

    if (lcb_respquery_is_final(resp)) {
        res->rc = lcb_respquery_status(resp);
        if (row) {
            res->meta.assign(row, nrow);
            Json::Value meta;
            if (Json::Reader().parse(res->meta.data(), res->meta.data() + res->meta.size(), meta)) {
                if (meta.isMember("status") && meta["status"].isString()) {
                    res->status = meta["status"].asString();
                }

                if (meta.isMember("errors") && meta["errors"].isArray()) {
                    for (auto &err : meta["errors"]) {
                        if (err.isObject()) {
                            res->errors.emplace_back(err["code"].asUInt(), err["msg"].asString());
                        }
                    }
                }
            }
        }
        const lcb_RESPHTTP *http = nullptr;
        lcb_respquery_http_response(resp, &http);
        if (http) {
            lcb_resphttp_http_status(http, &res->htcode);
        }
    } else {
        res->rows.emplace_back(row, nrow);
    }
    res->called = true;
}
}

class QueryUnitTest : public MockUnitTest
{
  protected:
    lcb_CMDQUERY *cmd{};
    void SetUp() override
    {
        lcb_cmdquery_create(&cmd);
    }
    void TearDown() override
    {
        lcb_cmdquery_destroy(cmd);
    }
    bool createQueryConnection(HandleWrap &hw, lcb_INSTANCE **instance)
    {
        if (MockEnvironment::getInstance()->isRealCluster()) {
            return false;
        }
        createConnection(hw, instance);
        const lcbvb_CONFIG *vbc;
        lcb_STATUS rc;
        rc = lcb_cntl(*instance, LCB_CNTL_GET, LCB_CNTL_VBCONFIG, &vbc);
        EXPECT_EQ(LCB_SUCCESS, rc);
        int ix = lcbvb_get_randhost(vbc, LCBVB_SVCTYPE_QUERY, LCBVB_SVCMODE_PLAIN);
        return ix > -1;
    }

    bool createClusterQueryConnection(HandleWrap &hw, lcb_INSTANCE **instance)
    {
        if (!MockEnvironment::getInstance()->isRealCluster()) {
            return false;
        }
        createClusterConnection(hw, instance);
        const lcbvb_CONFIG *vbc = nullptr;
        lcb_STATUS rc;
        rc = lcb_cntl(*instance, LCB_CNTL_GET, LCB_CNTL_VBCONFIG, &vbc);
        EXPECT_TRUE(vbc != nullptr);
        EXPECT_EQ(LCB_SUCCESS, rc);
        int ix = lcbvb_get_randhost(vbc, LCBVB_SVCTYPE_QUERY, LCBVB_SVCMODE_PLAIN);
        return ix > -1;
    }

    void makeCommand(const char *query, bool prepared = false)
    {
        lcb_cmdquery_reset(cmd);
        lcb_cmdquery_statement(cmd, query, strlen(query));
        lcb_cmdquery_callback(cmd, rowcb);
        lcb_cmdquery_adhoc(cmd, !prepared);
    }
};

TEST_F(QueryUnitTest, testSimple)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }

    N1QLResult res;
    makeCommand("SELECT mockrow");
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    ASSERT_EQ(1, res.rows.size());
}

TEST_F(QueryUnitTest, testQueryError)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT blahblah FROM blahblah");
    lcb_cmdquery_timeout(cmd, LCB_MS2US(200));
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_TRUE(res.rows.empty());
}

TEST_F(QueryUnitTest, testInvalidJson)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    createConnection(hw, &instance);
    lcb_CMDQUERY *cmd;
    lcb_cmdquery_create(&cmd);

    const char *bad_query = "blahblah";
    ASSERT_NE(LCB_SUCCESS, lcb_cmdquery_payload(cmd, bad_query, strlen(bad_query)));
    lcb_cmdquery_destroy(cmd);
}

TEST_F(QueryUnitTest, testPrepareOk)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT mockrow", true);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_EQ(res.rc, LCB_SUCCESS);
    ASSERT_EQ(1, res.rows.size());

    // Get the plan contents
    string query("SELECT mockrow");
    string plan;
    lcb_n1qlcache_getplan(instance->n1ql_cache, query, plan);
    // We have the plan!
    ASSERT_FALSE(plan.empty());

    // Issue it again..
    makeCommand("SELECT mockrow", true);
    res.reset();
    rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    string plan2;
    lcb_n1qlcache_getplan(instance->n1ql_cache, query, plan2);
    ASSERT_FALSE(plan2.empty());
    ASSERT_EQ(plan, plan2) << "Reused the same query (cache works!)";

    lcb_n1qlcache_clear(instance->n1ql_cache);
    plan.clear();
    lcb_n1qlcache_getplan(instance->n1ql_cache, query, plan);
    ASSERT_TRUE(plan.empty());

    // Issue it again!
    makeCommand("SELECT mockrow", true);
    res.reset();
    rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);

    ASSERT_EQ(1, res.rows.size());
    lcb_n1qlcache_getplan(instance->n1ql_cache, query, plan);
    ASSERT_FALSE(plan.empty());
}

TEST_F(QueryUnitTest, testPrepareStale)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT mockrow", true);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_EQ(1, res.rows.size());

    // Reset the index "state"
    MockCommand mcmd(MockCommand::RESET_QUERYSTATE);
    doMockTxn(mcmd);

    // Ensure the previous plan fails
    string query("SELECT mockrow");

    string raw;
    lcb_n1qlcache_getplan(instance->n1ql_cache, query, raw);
    ASSERT_FALSE(raw.empty());

    lcb_cmdquery_reset(cmd);
    lcb_cmdquery_callback(cmd, rowcb);
    ASSERT_STATUS_EQ(LCB_SUCCESS, lcb_cmdquery_payload(cmd, raw.c_str(), raw.size()));

    res.reset();
    lcb_cmdquery_timeout(cmd, LCB_MS2US(200));
    rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_TRUE(res.called);
    ASSERT_TRUE(res.rows.empty());
    ASSERT_FALSE(res.meta.empty());
    ASSERT_NE(string::npos, res.meta.find("indexNotFound"));

    // Now that we've verified our current plan isn't working, let's try to
    // issue the cached plan again. lcb should get us a new plan
    makeCommand("SELECT mockrow", true);
    res.reset();
    rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_EQ(1, res.rows.size());
}

TEST_F(QueryUnitTest, testPrepareFailure)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT blahblah", true);
    lcb_cmdquery_timeout(cmd, LCB_MS2US(200));
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_TRUE(res.called);
    ASSERT_NE(LCB_SUCCESS, res.rc);
    ASSERT_TRUE(res.rows.empty());
}

TEST_F(QueryUnitTest, testCancellation)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createQueryConnection(hw, &instance)) {
        SKIP_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT mockrow");
    lcb_QUERY_HANDLE *handle = nullptr;
    lcb_cmdquery_handle(cmd, &handle);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    ASSERT_TRUE(handle != nullptr);
    lcb_query_cancel(instance, handle);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_FALSE(res.called);
}

TEST_F(QueryUnitTest, testClusterwide)
{
    SKIP_IF_CLUSTER_VERSION_IS_LOWER_THAN(MockEnvironment::VERSION_65)
    lcb_INSTANCE *instance;
    HandleWrap hw;
    if (!createClusterQueryConnection(hw, &instance)) {
        SKIP_CLUSTER_QUERY_TEST();
    }
    N1QLResult res;
    makeCommand("SELECT 1");
    lcb_QUERY_HANDLE *handle = nullptr;
    lcb_cmdquery_handle(cmd, &handle);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    ASSERT_TRUE(handle != nullptr);
    lcb_query_cancel(instance, handle);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_FALSE(res.called);
}

struct upsert_result {
    bool invoked{false};
    lcb_STATUS rc{LCB_ERR_GENERIC};
    std::string id{};
    std::uint64_t cas{0};
};

extern "C" {
static void setCallback(lcb_INSTANCE *, lcb_CALLBACK_TYPE, const lcb_RESPSTORE *resp)
{
    upsert_result *res = nullptr;
    lcb_respstore_cookie(resp, (void **)&res);
    res->invoked = true;
    lcb_STORE_OPERATION op;
    lcb_respstore_operation(resp, &op);
    ASSERT_EQ(LCB_STORE_UPSERT, op);
    res->rc = lcb_respstore_status(resp);
    lcb_respstore_cas(resp, &res->cas);
    const char *ptr = nullptr;
    std::size_t len = 0;
    lcb_respstore_key(resp, &ptr, &len);
    res->id.assign(ptr, len);
}
}

upsert_result upsert_doc(lcb_INSTANCE *instance, const string &scope, const string &collection)
{
    (void)lcb_install_callback(instance, LCB_CALLBACK_STORE, (lcb_RESPCALLBACK)setCallback);

    string key = unique_name("id");
    string val = R"({"key":")" + key + "\"}";

    lcb_CMDSTORE *cmd;
    lcb_cmdstore_create(&cmd, LCB_STORE_UPSERT);
    lcb_cmdstore_collection(cmd, scope.c_str(), scope.size(), collection.c_str(), collection.size());
    lcb_cmdstore_key(cmd, key.c_str(), key.size());
    lcb_cmdstore_value(cmd, val.c_str(), val.size());
    upsert_result res{};
    EXPECT_EQ(LCB_SUCCESS, lcb_store(instance, &res, cmd));
    lcb_cmdstore_destroy(cmd);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    EXPECT_TRUE(res.invoked);
    EXPECT_STATUS_EQ(LCB_SUCCESS, res.rc);
    return res;
}

struct query_index {
    std::string id{};
    std::string name{};
    bool is_primary{false};
    std::string keyspace_id{};
    std::string namespace_id{};
    std::string bucket_id{};
    std::string state{};
};

struct query_index_list {
    bool invoked{false};
    lcb_STATUS rc{LCB_ERR_GENERIC};
    std::uint16_t http_code{0};
    std::string meta{};
    std::string status{};
    vector<std::pair<unsigned int, string>> errors{};
    std::vector<query_index> indexes{};
};

extern "C" {
static void list_indexes_callback(lcb_INSTANCE *, int, const lcb_RESPQUERY *resp)
{
    query_index_list *res;
    lcb_respquery_cookie(resp, (void **)&res);

    const char *row;
    size_t nrow;
    lcb_respquery_row(resp, &row, &nrow);

    if (lcb_respquery_is_final(resp)) {
        res->rc = lcb_respquery_status(resp);
        if (row) {
            res->meta.assign(row, nrow);
            Json::Value meta;
            if (Json::Reader().parse(res->meta, meta)) {
                if (meta.isMember("status") && meta["status"].isString()) {
                    res->status = meta["status"].asString();
                }

                if (meta.isMember("errors") && meta["errors"].isArray()) {
                    for (auto &err : meta["errors"]) {
                        if (err.isObject()) {
                            res->errors.emplace_back(err["code"].asUInt(), err["msg"].asString());
                        }
                    }
                }
            }
        }
        const lcb_RESPHTTP *http = nullptr;
        lcb_respquery_http_response(resp, &http);
        if (http) {
            lcb_resphttp_http_status(http, &res->http_code);
        }
    } else {
        Json::Value index_json;
        if (Json::Reader().parse(row, row + nrow, index_json)) {
            query_index index{};
            if (index_json.isMember("is_primary") && index_json["is_primary"].isBool()) {
                index.is_primary = index_json["is_primary"].asBool();
            }
            if (index_json.isMember("id") && index_json["id"].isString()) {
                index.id = index_json["id"].asString();
            }
            if (index_json.isMember("state") && index_json["state"].isString()) {
                index.state = index_json["state"].asString();
            }
            if (index_json.isMember("name") && index_json["name"].isString()) {
                index.name = index_json["name"].asString();
            }
            if (index_json.isMember("bucket_id") && index_json["bucket_id"].isString()) {
                index.bucket_id = index_json["bucket_id"].asString();
            }
            if (index_json.isMember("keyspace_id") && index_json["keyspace_id"].isString()) {
                index.keyspace_id = index_json["keyspace_id"].asString();
            }
            if (index_json.isMember("namespace_id") && index_json["namespace_id"].isString()) {
                index.namespace_id = index_json["namespace_id"].asString();
            }
            res->indexes.emplace_back(index);
        }
    }
    res->invoked = true;
}
}

query_index_list list_indexes(lcb_INSTANCE *instance, const std::string &bucket_name = "default")
{
    const std::string param = "bucket_name";
    const std::string encoded_bucket_name = Json::FastWriter().write(Json::Value(bucket_name));
    std::string statement = R"(
SELECT idx.* FROM system:indexes AS idx
WHERE
    (
        (keyspace_id = $bucket_name AND bucket_id IS MISSING)
    OR
        (bucket_id = $bucket_name)
    )
AND `using`="gsi"
 ORDER BY is_primary DESC, name ASC)";
    lcb_CMDQUERY *cmd;
    lcb_cmdquery_create(&cmd);
    lcb_cmdquery_statement(cmd, statement.c_str(), statement.size());
    lcb_cmdquery_callback(cmd, list_indexes_callback);
    EXPECT_STATUS_EQ(LCB_SUCCESS, lcb_cmdquery_named_param(cmd, param.data(), param.size(), encoded_bucket_name.data(),
                                                           encoded_bucket_name.size()));
    query_index_list indexes{};
    lcb_STATUS rc = lcb_query(instance, &indexes, cmd);
    lcb_cmdquery_destroy(cmd);
    EXPECT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    return indexes;
}

struct index_status_result {
    bool invoked{false};
    lcb_STATUS rc{LCB_ERR_GENERIC};
    std::uint16_t status{};
    std::string body{};
};

extern "C" {
static void index_status_callback(lcb_INSTANCE *, lcb_CALLBACK_TYPE, const lcb_RESPHTTP *resp)
{
    index_status_result *res = nullptr;
    lcb_resphttp_cookie(resp, (void **)&res);
    res->invoked = true;
    res->rc = lcb_resphttp_status(resp);
    const char *ptr = nullptr;
    std::size_t len = 0;
    lcb_resphttp_body(resp, &ptr, &len);
    res->body.assign(ptr, len);
    lcb_resphttp_http_status(resp, &res->status);
}
}

struct index_stats_point {
    std::uint32_t timestamp{0};
    std::uint32_t index_items_count{0};
};

std::vector<index_stats_point> index_status(lcb_INSTANCE *instance, const std::string &scope,
                                            const std::string &collection, const std::string &index)
{
    const std::string path{"/pools/default/stats/range"};
    auto old_callback = lcb_install_callback(instance, LCB_CALLBACK_HTTP, (lcb_RESPCALLBACK)index_status_callback);

    std::string payload =
        R"(
[
    {
        "step": 3,
        "start": -3,
        "metric": [
            {"label": "name", "value": "index_items_count"},
            {"label": "bucket", "value": "default"},
            {"label": "scope", "value": ")" +
        scope + R"("},
            {"label": "collection", "value": ")" +
        collection + R"("},
            {"label": "index", "value": ")" +
        index + R"("}
        ],
        "nodesAggregation": "sum"
    }
]
)";

    lcb_CMDHTTP *cmd;
    lcb_cmdhttp_create(&cmd, LCB_HTTP_TYPE_MANAGEMENT);
    lcb_cmdhttp_method(cmd, LCB_HTTP_METHOD_POST);
    lcb_cmdhttp_path(cmd, path.data(), path.size());
    lcb_cmdhttp_body(cmd, payload.data(), payload.size());

    index_status_result res{};
    lcb_STATUS rc = lcb_http(instance, &res, cmd);
    lcb_cmdhttp_destroy(cmd);
    EXPECT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);

    EXPECT_TRUE(res.invoked);
    EXPECT_STATUS_EQ(LCB_SUCCESS, res.rc) << "http=" << res.status;

    std::vector<index_stats_point> stats{};
    Json::Value stats_json;
    if (Json::Reader().parse(res.body, stats_json)) {
        if (stats_json.isArray() && !stats_json.empty()) {
            const auto &entry_json = stats_json[0];
            if (entry_json.isObject() && entry_json.isMember("data") && entry_json["data"].isArray() &&
                !entry_json["data"].empty()) {
                const auto &metric_json = entry_json["data"][0];
                if (metric_json.isObject() && metric_json.isMember("values") && metric_json["values"].isArray()) {
                    for (const auto &value : metric_json["values"]) {
                        if (value.isArray() && value.size() == 2) {
                            index_stats_point point{};
                            point.timestamp = value[0].asUInt();
                            point.index_items_count = std::stoul(value[1].asString());
                            stats.emplace_back(point);
                        }
                    }
                }
            }
        }
    }

    std::sort(stats.begin(), stats.end(),
              [](const index_stats_point &a, const index_stats_point &b) { return a.timestamp < b.timestamp; });

    lcb_install_callback(instance, LCB_CALLBACK_HTTP, old_callback);
    return stats;
}

/**
 * Sergey(2021-08-11): For some reason scoped indexes are really slow on Jenkins, this function, checks number of
 * indexed documents and return when it is greater or equals to requested. See CCBC-1443.
 */
void wait_for_num_items_in_index(lcb_INSTANCE *instance, const string &scope, const string &collection,
                                 const string &index, std::uint32_t expected)
{
    std::uint32_t current = 0;
    while (current < expected) {
        auto stats = index_status(instance, scope, collection, index);
        if (!stats.empty()) {
            current = stats[stats.size() - 1].index_items_count;
            if (current >= expected) {
                return;
            }
        }
        sleep(1);
    };
}

void create_index(lcb_INSTANCE *instance, const string &index, const string &scope, const string &collection,
                  bool wait_for_index = true)
{
    string keyspace = "`default`:`default`.`" + scope + "`.`" + collection + "`";
    string statement = "CREATE PRIMARY INDEX ";
    statement += "`" + index + "`" + " ON " + keyspace + " USING GSI";

    N1QLResult res;
    lcb_CMDQUERY *cmd;
    lcb_cmdquery_create(&cmd);
    lcb_cmdquery_statement(cmd, statement.c_str(), statement.size());
    lcb_cmdquery_callback(cmd, rowcb);

    lcb_QUERY_HANDLE *handle = nullptr;
    lcb_cmdquery_handle(cmd, &handle);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    lcb_cmdquery_destroy(cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    ASSERT_TRUE(handle != nullptr);
    lcb_wait(instance, LCB_WAIT_DEFAULT);

    while (wait_for_index) {
        auto query_indexes = list_indexes(instance);
        ASSERT_STATUS_EQ(LCB_SUCCESS, query_indexes.rc) << "meta = " << query_indexes.meta;
        if (std::any_of(query_indexes.indexes.begin(), query_indexes.indexes.end(), [&index](const query_index &entry) {
                return entry.name == index && entry.state == "online";
            })) {
            return;
        }
        usleep(100000);
    }
}

/**
 * @test
 * End-to-End query test on a collection
 *
 * @pre
 * 1. Create scope and collection
 * 2. Add primary index to collection
 * 3. Upsert doc to collection
 * 4. Query on the collection
 *
 * @post
 *
 * Query on collection is successful
 */
TEST_F(QueryUnitTest, testCollectionQuery)
{
    SKIP_IF_MOCK()
    SKIP_IF_CLUSTER_VERSION_IS_LOWER_THAN(MockEnvironment::VERSION_70)
    HandleWrap hw;
    lcb_INSTANCE *instance;
    createConnection(hw, &instance);

    // to ensure timeout comes from the query engine, and not generate by SDK
    lcb_cntl_string(instance, "query_grace_period", "3" /* seconds */);

    string scope = unique_name("scope");
    string collection = unique_name("collection");
    string index = unique_name("index");

    // Create a scope and collection
    create_scope(instance, scope);
    create_collection(instance, scope, collection);

    // Create an index on the collection
    create_index(instance, index, scope, collection);

    // Insert a doc
    auto upsert_res = upsert_doc(instance, scope, collection);
    wait_for_num_items_in_index(instance, scope, collection, index, 1);

    N1QLResult res;
    lcb_CMDQUERY *cmd;
    lcb_cmdquery_create(&cmd);
    string query = "SELECT * FROM `" + collection + "` WHERE meta().id=\"" + upsert_res.id + "\"";
    lcb_cmdquery_statement(cmd, query.c_str(), query.size());
    lcb_cmdquery_consistency(cmd, LCB_QUERY_CONSISTENCY_REQUEST);
    lcb_cmdquery_metrics(cmd, true);
    lcb_cmdquery_callback(cmd, rowcb);
    lcb_cmdquery_scope_name(cmd, scope.c_str(), scope.size());

    lcb_QUERY_HANDLE *handle = nullptr;
    lcb_cmdquery_handle(cmd, &handle);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    lcb_cmdquery_destroy(cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    ASSERT_TRUE(handle != nullptr);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_TRUE(res.called);
    ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc) << "http=" << res.htcode << ", meta=" << res.meta;
    ASSERT_EQ(1, res.rows.size()) << "http=" << res.htcode << ", meta=" << res.meta;
    drop_scope(instance, scope);
}

TEST_F(QueryUnitTest, testQueryWithUnknownCollection)
{
    SKIP_IF_MOCK()
    SKIP_IF_CLUSTER_VERSION_IS_LOWER_THAN(MockEnvironment::VERSION_70)
    HandleWrap hw;
    lcb_INSTANCE *instance;
    createConnection(hw, &instance);

    string scope = unique_name("scope1");
    string collection = unique_name("collection1");
    string unknown_scope = unique_name("scope2");
    string unknown_collection = unique_name("collection2");
    string index = unique_name("index");

    // Create a scope and collection
    create_scope(instance, scope);
    create_collection(instance, scope, collection);

    // Create an index on the collection
    create_index(instance, index, scope, collection);

    // Insert a doc
    auto upsert_res = upsert_doc(instance, scope, collection);
    wait_for_num_items_in_index(instance, scope, collection, index, 1);

    {
        // Query with unknown scope
        N1QLResult res;
        lcb_CMDQUERY *cmd;
        lcb_cmdquery_create(&cmd);
        string query = "SELECT * FROM `" + collection + "` where meta().id=\"" + upsert_res.id + "\"";
        lcb_cmdquery_statement(cmd, query.c_str(), query.size());
        lcb_cmdquery_callback(cmd, rowcb);
        lcb_cmdquery_scope_name(cmd, unknown_scope.c_str(), unknown_scope.size());
        lcb_cmdquery_consistency(cmd, LCB_QUERY_CONSISTENCY_REQUEST);

        lcb_QUERY_HANDLE *handle = nullptr;
        lcb_cmdquery_handle(cmd, &handle);
        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        lcb_cmdquery_destroy(cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        ASSERT_TRUE(handle != nullptr);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_EQ(0, res.rows.size());
        ASSERT_STATUS_EQ(LCB_ERR_SCOPE_NOT_FOUND, res.rc) << lcb_strerror_short(res.rc);
    }

    {
        // Query with unknown collection
        N1QLResult res;
        lcb_CMDQUERY *cmd;
        lcb_cmdquery_create(&cmd);
        string query = "SELECT * FROM `" + unknown_collection + "` where meta().id=\"" + upsert_res.id + "\"";
        lcb_cmdquery_statement(cmd, query.c_str(), query.size());
        lcb_cmdquery_callback(cmd, rowcb);
        lcb_cmdquery_scope_name(cmd, scope.c_str(), scope.size());

        lcb_QUERY_HANDLE *handle = nullptr;
        lcb_cmdquery_handle(cmd, &handle);
        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        lcb_cmdquery_destroy(cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        ASSERT_TRUE(handle != nullptr);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_EQ(0, res.rows.size());
        ASSERT_STATUS_EQ(LCB_ERR_KEYSPACE_NOT_FOUND, res.rc) << lcb_strerror_short(res.rc);
    }

    drop_scope(instance, scope);
}

TEST_F(QueryUnitTest, testCollectionPreparedQuery)
{
    SKIP_IF_MOCK()
    SKIP_IF_CLUSTER_VERSION_IS_LOWER_THAN(MockEnvironment::VERSION_70)
    HandleWrap hw;
    lcb_INSTANCE *instance;
    createConnection(hw, &instance);
    lcb_cntl_string(instance, "query_grace_period", "3" /* seconds */);

    string scope = unique_name("scope");
    string collection = unique_name("collection");
    string index = unique_name("index");

    // Create a scope and collection
    create_scope(instance, scope);
    create_collection(instance, scope, collection);

    // Create an index on the collection
    create_index(instance, index, scope, collection);

    // Insert a doc
    auto upsert_res = upsert_doc(instance, scope, collection);
    wait_for_num_items_in_index(instance, scope, collection, index, 1);

    N1QLResult res;
    lcb_CMDQUERY *cmd;
    lcb_cmdquery_create(&cmd);
    string query = "SELECT * FROM `" + collection + "` where meta().id=\"" + upsert_res.id + "\"";
    lcb_cmdquery_statement(cmd, query.c_str(), query.size());
    lcb_cmdquery_callback(cmd, rowcb);
    lcb_cmdquery_scope_name(cmd, scope.c_str(), scope.size());
    lcb_cmdquery_adhoc(cmd, false);
    lcb_cmdquery_consistency(cmd, LCB_QUERY_CONSISTENCY_REQUEST);

    lcb_QUERY_HANDLE *handle = nullptr;
    lcb_cmdquery_handle(cmd, &handle);
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    lcb_cmdquery_destroy(cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    ASSERT_TRUE(handle != nullptr);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_TRUE(res.called);
    ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc) << "http=" << res.htcode << ", meta=" << res.meta;
    ASSERT_EQ(1, res.rows.size()) << "http=" << res.htcode << ", meta=" << res.meta;

    drop_scope(instance, scope);
}

using credentials = std::pair<string, string>;

struct cycled_auth {
  private:
    vector<credentials> store_{};
    size_t cur_{0};
    credentials fallback_;
    string port_;

  public:
    cycled_auth(string port, credentials fallback) : fallback_(std::move(fallback)), port_(std::move(port)) {}

    void add(const string &username, const string &password)
    {
        store_.emplace_back(username, password);
    }

    void clear()
    {
        cur_ = 0;
        store_.clear();
    }

    const credentials &get(const string &port)
    {
        if (port == port_) {
            return store_[cur_];
        }
        return fallback_;
    }

    void advance(const string &port)
    {
        if (port == port_ && cur_ < store_.size() - 1) {
            ++cur_;
        }
    }
};

extern "C" {
static void get_credentials(lcbauth_CREDENTIALS *credentials)
{
    cycled_auth *auth = nullptr;
    lcbauth_credentials_cookie(credentials, reinterpret_cast<void **>(&auth));

    const char *port = nullptr;
    size_t port_len = 0;
    lcbauth_credentials_port(credentials, &port, &port_len);
    std::string port_str(port, port_len);
    const auto &creds = auth->get(port_str);
    lcbauth_credentials_username(credentials, creds.first.c_str(), creds.first.size());
    lcbauth_credentials_password(credentials, creds.second.c_str(), creds.second.size());
    lcbauth_credentials_result(credentials, LCBAUTH_RESULT_OK);
    auth->advance(port_str);
}
}

string get_n1ql_port(lcb_INSTANCE *instance)
{

    lcbvb_CONFIG *vbc;
    lcb_STATUS rc;
    rc = lcb_cntl(instance, LCB_CNTL_GET, LCB_CNTL_VBCONFIG, &vbc);
    EXPECT_EQ(LCB_SUCCESS, rc);
    for (int i = 0; i < LCBVB_NSERVERS(vbc); ++i) {
        unsigned int port = lcbvb_get_port(vbc, i, LCBVB_SVCTYPE_QUERY, LCBVB_SVCMODE_PLAIN);
        if (port != 0) {
            return std::to_string(port);
        }
    }
    return "";
}

TEST_F(QueryUnitTest, testRetryOnAuthenticationFailure)
{
    lcb_INSTANCE *instance;
    HandleWrap hw;
    SKIP_IF_MOCK()
    SKIP_IF_CLUSTER_VERSION_IS_LOWER_THAN(MockEnvironment::VERSION_50)
    if (!getenv("LCB_TEST_ALLOW_CHANGING_PASSWORD")) {
        MockEnvironment::printSkipMessage(__FILE__, __LINE__,
                                          "define LCB_TEST_ALLOW_CHANGING_PASSWORD env variable to re-enable it");
        return;
    }

    createConnection(hw, &instance);
    lcb_cntl_setu32(instance, LCB_CNTL_QUERY_TIMEOUT, LCB_MS2US(500)); // 500ms before timeout

    string valid_username = MockEnvironment::getInstance()->getUsername();
    string valid_password = MockEnvironment::getInstance()->getPassword();
    string invalid_password = valid_password + "_garbage";

    credentials fallback_credentials(valid_username, valid_password);
    std::string query_service_port = get_n1ql_port(instance);
    ASSERT_FALSE(query_service_port.empty());
    cycled_auth ca(query_service_port, fallback_credentials);

    lcb_AUTHENTICATOR *auth = lcbauth_new();
    lcbauth_set_callback(auth, &ca, get_credentials);
    lcbauth_set_mode(auth, LCBAUTH_MODE_DYNAMIC);
    lcb_set_auth(instance, auth);

    N1QLResult res;
    string query;

    query = string("CREATE PRIMARY INDEX ON `") + MockEnvironment::getInstance()->getBucket() + "`";
    makeCommand(query.c_str(), false);

    // make sure the index exists
    {
        res.reset();
        ca.clear();
        ca.add(valid_username, valid_password);

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
    }

    // send query with valid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "valid_password" LIMIT 1)";
        makeCommand(query.c_str(), false);

        res.reset();
        ca.clear();
        ca.add(valid_username, valid_password);

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_TRUE(res.errors.empty()) << res.errors[0].first << ": " << res.errors[0].second;
        ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    }

    // send query with invalid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "invalid_password" LIMIT 1)";
        makeCommand(query.c_str(), false);

        res.reset();
        ca.clear();
        ca.add(valid_username, invalid_password);

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_STATUS_EQ(LCB_ERR_TIMEOUT, res.rc); // timeout because of retrying
    }

    // send query with valid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "invalid_password -> valid_password" LIMIT 1)";
        makeCommand(query.c_str(), false);

        res.reset();
        ca.clear();
        ca.add(valid_username, invalid_password); // first request
        ca.add(valid_username, valid_password);   // other requests

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_TRUE(res.errors.empty()) << res.errors[0].first << ": " << res.errors[0].second;
        ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    }

    // the same as above, but for prepared statement

    // send query with valid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "prepared: valid_password" LIMIT 1)";
        makeCommand(query.c_str(), true);

        res.reset();
        ca.clear();
        ca.add(valid_username, valid_password);

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_TRUE(res.errors.empty()) << res.errors[0].first << ": " << res.errors[0].second;
        ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    }

    // send query with invalid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "prepared: invalid_password" LIMIT 1)";
        makeCommand(query.c_str(), true);

        res.reset();
        ca.clear();
        ca.add(valid_username, invalid_password);

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_STATUS_EQ(LCB_ERR_TIMEOUT, res.rc) << lcb_strerror_short(res.rc); // timeout because of retrying
    }

    // send query with valid password
    {
        query = string("SELECT * FROM `") + MockEnvironment::getInstance()->getBucket() +
                R"(` ORDER BY "prepared: invalid_password -> valid_password" LIMIT 1)";
        makeCommand(query.c_str(), true);

        res.reset();
        ca.clear();
        ca.add(valid_username, invalid_password); // first request
        ca.add(valid_username, valid_password);   // other requests

        lcb_STATUS rc = lcb_query(instance, &res, cmd);
        ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
        lcb_wait(instance, LCB_WAIT_DEFAULT);
        ASSERT_TRUE(res.called);
        ASSERT_TRUE(res.errors.empty()) << res.errors[0].first << ": " << res.errors[0].second;
        ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    }
}

TEST_F(QueryUnitTest, testInvalidQueryError)
{
    LCB_TEST_REQUIRE_CLUSTER_VERSION(MockEnvironment::VERSION_70)
    lcb_INSTANCE *instance;
    HandleWrap hw;
    createConnection(hw, &instance);
    N1QLResult res;
    makeCommand("I'm not n1ql");
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_STATUS_EQ(LCB_ERR_PARSING_FAILURE, res.rc);
    ASSERT_TRUE(res.rows.empty());
}

TEST_F(QueryUnitTest, testRawQuery)
{
    LCB_TEST_REQUIRE_CLUSTER_VERSION(MockEnvironment::VERSION_70)
    lcb_INSTANCE *instance;
    HandleWrap hw;
    createConnection(hw, &instance);
    N1QLResult res;
    makeCommand(
        R"(SELECT RAW data.val FROM [{"val": true}, {"val": null}, {"val": 42}, {"val": "foo"}, {"val": false}] AS data)");
    lcb_STATUS rc = lcb_query(instance, &res, cmd);
    ASSERT_STATUS_EQ(LCB_SUCCESS, rc);
    lcb_wait(instance, LCB_WAIT_DEFAULT);
    ASSERT_STATUS_EQ(LCB_SUCCESS, res.rc);
    ASSERT_EQ(5, res.rows.size());
    ASSERT_EQ("true", res.rows[0]);
    ASSERT_EQ("null", res.rows[1]);
    ASSERT_EQ("42", res.rows[2]);
    ASSERT_EQ("\"foo\"", res.rows[3]);
    ASSERT_EQ("false", res.rows[4]);
}
