Синхронный клиент для простых кейсов с простой обработкой ошибок

[Gazizonoki]

Допустим, мы хотим выполнить запрос BeginTransaction(). Сейчас чтобы это сделать пользователю надо написать вот такой код:

NYdb::NTable::TTransaction BeginTransaction(NYdb::NTable::TSession& session) {
    auto result = session.BeginTransaction().GetValueSync();
    if (!status.IsSuccess()) {
        throw yexception() << status;
    }
    return result.GetTransaction();
}

Это простой сценарий, но он требует от пользователя много усилий. Нужен более простой вариант, чтобы скрыть это все от пользователя.

Можно разбить требуемые улучшения на 2 пункта:

1. Избавиться от GetValueSync(), в простых кейсах пользователю не нужно асинхронное исполнение
2. Убрать TStatus для обработки ошибок, это лишняя абстракция, которую пользователю нужно держать в уме, пусть SDK по умолчанию кидает исключения.

Тогда запрос будет выглядеть так:

auto tran = session.BeginTransaction();

Предложение:

Чтобы не трогать уже существующий код, можно сделать новый синхронный клиент TSimpleTableClient (название требует доработок). У него будут TSyncSession, у которых будет синхронный API. На ошибках такой клиент будет кидать TYdbRequestError. Также можно добавить возможность делать кастомную логику обработку ошибок: в настройках TSimpleTableClient будет функция OnError, которая по умолчанию будет бросать исключения, но ее можно будет переопределить на клиентской стороне.

Также, чтобы уменьшить порог входа и необходимость знания о клиентах, как их подключать, можно поддержать возможность создания TTableClient напрямую из драйвера. Тогда код пользователя может выглядеть как-то так:

int main() {
    NYdb::TDriver driver{"grpc://localhost:2136/local"};
    try {
        auto resultSet = driver.Table().ExecuteDataQuery("SELECT a, b, c from `example_table`");
        // parse result
    } catch (NYdb::TYdbRequestError& e) {
        std::cerr << e;
        return 1;
    }
    return 0;
}

Оставшийся вопрос: как сделать ретраер и как прокинуть в него ошибку

[Gazizonoki]

Вариант 1

Основные идеи такие:

1. Уберем TSession от глаз пользователя. Это ydb specific абстракция, она скорее про то, как запрос будет исполнятся на сервере. В простых кейсах ничего специфичного с ними клиенту делать и не надо. Пользователь скорее хочет думать о базе с точки зрения транзакций, это более привычное представление.
2. Сейчас чтобы исполнить несколько запросов в транзакции, нужно передать TTxControl с txId, полученным на вызов BeginTransaction() в каждый ExecuteDataQuery. Это низкоуровневное API, которое совершенно неинтуитивно. В данном варианте TTxControl вообще не показывается пользователю, а транзакция выполняется в лямбде, переданной в ExecuteInTx().
3. Ретраер остался примерно тем же, в него передается лямбда с запросом, который нужно поретраить. Только лямбда теперь не должна возращать TStatus ретраеру, он будет перехватывать исключения TRequestError, которые кидаются при серверных ошибках и содержит TStatus внутри. На основании его значения и будет происходить ретрай.
4. Под капотом сессия создается на одиночный запрос через TSimpleTableClient, в ретраере на весь вызов Retry(), при необходимости пересоздавая ее, если для конкретного случая это требует политика ретраев, и транзакции на весь ее период, если ее исполняют не в ретраере.

Возможный вариант API:

namespace NYdb::NTable {

struct TClientSettings : public TCommonClientSettingsBase<TClientSettings> {}; // COMMON???
struct TExecDataQuerySettings : public TOperationRequestSettings<TExecDataQuerySettings> {};  // COMMON???
class TTxSettings; // COMMON???

struct TDataQueryResult {
    std::vector<TResultSet> ResultSets;
    std::optional<TQueryStats> QueryStats;
};


class TTxHandle {
public:
    TDataQueryResult ExecuteDataQuery(const std::string& query, const TExecDataQuerySettings& settings = {});
    void Commit();
    void Rollback();
};

class TRetryHandle {
public:
    void ExecuteInTx(std::function<void(TTxHandle handle)>, const TTxSettings& settings = {});

    TDataQueryResult ExecuteDataQuery(const std::string& query, const TExecDataQuerySettings& settings = {});
    // ...
};

class TSimpleTableClient {
public:
    TSimpleTableClient(const TDriver& driver, const TClientSettings& settings = TClientSettings());

    void ExecuteInTx(std::function<void(TTxHandle handle)>, const TTxSettings& settings = {});
    void Retry(std::function<void(TRetryHandle handle)>, TDuration timeout);

    TDataQueryResult ExecuteDataQuery(const std::string& query,
                                      const TTxSettings& settings = {},
                                      const TExecDataQuerySettings& settings = {});
    // ...

    void Stop();

private:
    class TImpl;
    std::shared_ptr<TImpl> Impl_;
};

}

Код клиента выполнения одного запроса:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    auto result = driver.Table().ExecuteDataQuery("SELECT 1;");
    // parse result
} catch (NYdb::TYdbRequestError& e) {
    std::cerr << e;
}

Код клиента выполнения транзакции с ретраями:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    driver.Table().Retry([](TRetryHandle retryHandle) {
        retryHandle.ExecuteInTx([](TTxHandle txHandle) {
            auto result = txHandle.ExecuteDataQuery("SELECT 1;");
            // parse result
        });
    });
} catch (NYdb::TRequestError& e) {
    std::cerr << e;
}

[Gazizonoki]

Вариант 2

В отличии от варианта 1, транзакция тут выполнена с помощью RAII (по аналогии с libpqxx). TTransaction - это отдельный объект, на котором можно исполнить запрос, сделать Commit() или Rollback(). При создании объекта через вызов BeginTx() создается транзакция вызовом grpc метода BeginTransaction. По окончании лайфтайма объекта транзакции, вызывается Commit() (возможно имеет смысл по желанию пользователя отключать такое поведение).

Возможный вариант API:

namespace NYdb::NTable {
struct TClientSettings : public TCommonClientSettingsBase<TClientSettings> {}; // COMMON???
struct TExecDataQuerySettings : public TOperationRequestSettings<TExecDataQuerySettings> {}; // COMMON???
struct TTxSettings; // COMMON???


struct TDataQueryResult {
    std::vector<TResultSet> ResultSets;
    std::optional<TQueryStats> QueryStats;
};

class TTransaction {
public:
    TDataQueryResult ExecuteDataQuery(const std::string& query, const TExecDataQuerySettings& settings = {});
    void Commit();
    void Rollback();

    ~TTransaction() {
        if (IsNeedToCommit_) {
            Commit();
        }
    }
};

class TRetryHandle {
public:
    TTransaction BeginTx(const TTxSettings& settings = {});

    TDataQueryResult ExecuteDataQuery(const std::string& query,
                                      const TTxSettings& settings = {},
                                      const TExecDataQuerySettings& settings = {});
    // ...
};

class TSimpleTableClient {
public:
    TSimpleTableClient(const TDriver& driver, const TClientSettings& settings = TClientSettings());

    TTransaction BeginTx(const TTxSettings& settings = {});
    void Retry(std::function<void(TRetryHandle handle)>, const NRetry::TRetryOperationSettings& settings = {});

    TDataQueryResult ExecuteDataQuery(const std::string& query,
                                      const TTxSettings& settings = {},
                                      const TExecDataQuerySettings& settings = {});
    // ...

    void Stop();

private:
    class TImpl;
    std::shared_ptr<TImpl> Impl_;
};

}

Код клиента выполнения одного запроса:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    auto result = driver.Table().ExecuteDataQuery("SELECT 1;");
    // parse result
} catch (NYdb::TYdbRequestError& e) {
    std::cerr << e;
}

Код клиента выполнения транзакции с ретраями:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    driver.Table().Retry([](TRetryHandle retryHandle) {
        auto tx = retryHandle.BeginTx();
        auto result = tx.ExecuteDataQuery("SELECT 1;");
        // parse result
    });
} catch (NYdb::TYdbRequestError& e) {
    std::cerr << e;
}