Skip to content

fix: DH-23437: Create the C++ client console lazily #8398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmao-denver wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: DH-23437: Create the C++ client console lazily #8398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions ...ient/deephaven/dhclient/include/private/deephaven/client/impl/table_handle_manager_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ class TableHandleManagerImpl final : public std::enable_shared_from_this<TableHa

public:
[[nodiscard]]
static std::shared_ptr<TableHandleManagerImpl> Create(std::optional<Ticket> console_id,
static std::shared_ptr<TableHandleManagerImpl> Create(std::string session_type,
std::shared_ptr<ServerType> server, std::shared_ptr<ExecutorType> executor,
std::shared_ptr<ExecutorType> flight_executor);

TableHandleManagerImpl(Private, std::optional<Ticket> &&console_id,
TableHandleManagerImpl(Private, std::string &&session_type,
std::shared_ptr<ServerType> &&server, std::shared_ptr<ExecutorType> &&executor,
std::shared_ptr<ExecutorType> &&flight_executor);
TableHandleManagerImpl(const TableHandleManagerImpl &other) = delete;
Expand Down Expand Up @@ -68,8 +68,9 @@ class TableHandleManagerImpl final : public std::enable_shared_from_this<TableHa
void AddSubscriptionHandle(std::shared_ptr<SubscriptionHandle> handle);
void RemoveSubscriptionHandle(const std::shared_ptr<SubscriptionHandle> &handle);

/** Returns the console Ticket, starting the console on first call. Throws if there is no script language. */
[[nodiscard]]
const std::optional<Ticket> &ConsoleId() const { return consoleId_; }
const Ticket &EnsureConsoleId();
[[nodiscard]]
const std::shared_ptr<ServerType> &Server() const { return server_; }
[[nodiscard]]
Expand All @@ -79,10 +80,15 @@ class TableHandleManagerImpl final : public std::enable_shared_from_this<TableHa

private:
const std::string me_; // useful printable object name for logging
std::optional<Ticket> consoleId_;
// Scripting language for this session; empty means console operations throw.
const std::string sessionType_;
std::shared_ptr<ServerType> server_;
std::shared_ptr<ExecutorType> executor_;
std::shared_ptr<ExecutorType> flightExecutor_;
// Guards consoleId_. Not mutex_: starting the console makes an RPC under this lock.
std::mutex consoleMutex_;
// Lazily set by EnsureConsoleId(); never reset.
std::optional<Ticket> consoleId_;
// Protects the below for concurrent access.
std::mutex mutex_;
// The SubscriptionHandles for the tables we have subscribed to. We keep these at the TableHandleManagerImpl level
Expand Down
21 changes: 3 additions & 18 deletions cpp-client/deephaven/dhclient/src/impl/client_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,9 @@

#include <memory>
#include <mutex>
#include <optional>
#include <stdexcept>
#include "deephaven/client/impl/table_handle_manager_impl.h"

using io::deephaven::proto::backplane::grpc::Ticket;
using io::deephaven::proto::backplane::script::grpc::StartConsoleRequest;
using io::deephaven::proto::backplane::script::grpc::StartConsoleResponse;

using deephaven::client::impl::TableHandleManagerImpl;
using deephaven::client::server::Server;
using deephaven::client::utility::Executor;
Expand All @@ -24,20 +19,10 @@ std::shared_ptr<ClientImpl> ClientImpl::Create(
std::shared_ptr<Executor> executor,
std::shared_ptr<Executor> flight_executor,
std::string session_type) {
std::optional<Ticket> console_ticket;
if (!session_type.empty()) {
StartConsoleRequest req;
*req.mutable_result_id() = server->NewTicket();
*req.mutable_session_type() = std::move(session_type);
StartConsoleResponse resp;
server->SendRpc([&](grpc::ClientContext *ctx) {
return server->ConsoleStub()->StartConsole(ctx, req, &resp);
});
console_ticket = std::move(*resp.mutable_result_id());
}

// No console here: TableHandleManagerImpl starts one on first use, keeping
// Client::Connect free of the ConsoleService.StartConsole RPC.
auto thmi = TableHandleManagerImpl::Create(
std::move(console_ticket),
std::move(session_type),
std::move(server),
std::move(executor),
std::move(flight_executor));
Expand Down
8 changes: 1 addition & 7 deletions cpp-client/deephaven/dhclient/src/impl/table_handle_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,14 +605,8 @@ void TableHandleImpl::Unsubscribe(const std::shared_ptr<SubscriptionHandle> &han
}

void TableHandleImpl::BindToVariable(std::string variable) {
const auto &console_id = managerImpl_->ConsoleId();
if (!console_id.has_value()) {
auto message = DEEPHAVEN_LOCATION_STR(
"Client was created without specifying a script language");
throw std::runtime_error(message);
}
BindTableToVariableRequest req;
*req.mutable_console_id() = *console_id;
*req.mutable_console_id() = managerImpl_->EnsureConsoleId();
req.set_variable_name(std::move(variable));
*req.mutable_table_id() = ticket_;

Expand Down
31 changes: 24 additions & 7 deletions cpp-client/deephaven/dhclient/src/impl/table_handle_manager_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,26 @@ using io::deephaven::proto::backplane::grpc::TimeTableRequest;
using io::deephaven::proto::backplane::grpc::Ticket;
using io::deephaven::proto::backplane::script::grpc::ExecuteCommandRequest;
using io::deephaven::proto::backplane::script::grpc::ExecuteCommandResponse;
using io::deephaven::proto::backplane::script::grpc::StartConsoleRequest;
using io::deephaven::proto::backplane::script::grpc::StartConsoleResponse;

namespace deephaven::client::impl {
namespace {
Ticket MakeScopeReference(std::string_view table_name);
} // namespace

std::shared_ptr<TableHandleManagerImpl> TableHandleManagerImpl::Create(std::optional<Ticket> console_id,
std::shared_ptr<TableHandleManagerImpl> TableHandleManagerImpl::Create(std::string session_type,
std::shared_ptr<ServerType> server, std::shared_ptr<ExecutorType> executor,
std::shared_ptr<ExecutorType> flight_executor) {
return std::make_shared<TableHandleManagerImpl>(Private(), std::move(console_id),
return std::make_shared<TableHandleManagerImpl>(Private(), std::move(session_type),
std::move(server), std::move(executor), std::move(flight_executor));
}

TableHandleManagerImpl::TableHandleManagerImpl(Private, std::optional<Ticket> &&console_id,
TableHandleManagerImpl::TableHandleManagerImpl(Private, std::string &&session_type,
std::shared_ptr<ServerType> &&server, std::shared_ptr<ExecutorType> &&executor,
std::shared_ptr<ExecutorType> &&flight_executor) :
me_(deephaven::dhcore::utility::ObjectId("TableHandleManagerImpl", this)),
consoleId_(std::move(console_id)),
sessionType_(std::move(session_type)),
server_(std::move(server)),
executor_(std::move(executor)),
flightExecutor_(std::move(flight_executor)) {
Expand Down Expand Up @@ -140,13 +142,28 @@ std::shared_ptr<TableHandleImpl> TableHandleManagerImpl::InputTable(
return TableHandleImpl::Create(shared_from_this(), std::move(resp));
}

void TableHandleManagerImpl::RunScript(std::string code) {
if (!consoleId_.has_value()) {
const Ticket &TableHandleManagerImpl::EnsureConsoleId() {
if (sessionType_.empty()) {
auto message = DEEPHAVEN_LOCATION_STR("Client was created without specifying a script language");
throw std::runtime_error(message);
}
std::unique_lock guard(consoleMutex_);
if (!consoleId_.has_value()) {
StartConsoleRequest req;
*req.mutable_result_id() = server_->NewTicket();
*req.mutable_session_type() = sessionType_;
StartConsoleResponse resp;
server_->SendRpc([&](grpc::ClientContext *ctx) {
return server_->ConsoleStub()->StartConsole(ctx, req, &resp);
});
consoleId_ = std::move(*resp.mutable_result_id());
}
return *consoleId_;
}

void TableHandleManagerImpl::RunScript(std::string code) {
ExecuteCommandRequest req;
*req.mutable_console_id() = *consoleId_;
*req.mutable_console_id() = EnsureConsoleId();
*req.mutable_code() = std::move(code);
ExecuteCommandResponse resp;
server_->SendRpc([&](grpc::ClientContext *ctx) {
Expand Down
23 changes: 23 additions & 0 deletions cpp-client/deephaven/tests/src/script_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,27 @@ mytable = empty_table(16).update(["intData = (int)(ii - 8)", "longData = (long)(
expected.AddColumn("longData", long_data);
TableComparerForTests::Compare(expected, t);
}

TEST_CASE("Table operations do not need a console", "[script]") {
// Never runs a script, so no console should be needed.
auto client = TableMakerForTests::CreateClient();
auto thm = client.GetManager();

auto t = thm.EmptyTable(10);
CHECK(t.NumRows() == 10);
}

TEST_CASE("Console is reused across scripts", "[script]") {
auto client = TableMakerForTests::CreateClient();
auto thm = client.GetManager();

thm.RunScript("from deephaven import empty_table\nt1 = empty_table(3)");
auto t1 = thm.FetchTable("t1");
CHECK(t1.NumRows() == 3);

// t1 is only in scope if both scripts hit the same console.
thm.RunScript("t2 = t1.update([\"x = ii\"])");
auto t2 = thm.FetchTable("t2");
CHECK(t2.NumRows() == 3);
}
} // namespace deephaven::client::tests
Loading