Merge branch 'main' into RSDK-10366-rust-utils-for-windows

Author: stuqdog

CMakeLists.txt

@@ -44,7 +44,7 @@ else()
   cmake_minimum_required(VERSION 3.25 FATAL_ERROR)
 endif()
 
-set(CMAKE_PROJECT_VERSION 0.9.0)
+set(CMAKE_PROJECT_VERSION 0.10.0)
 
 # Identify the project.
 project(viam-cpp-sdk

src/viam/api/api_proto_tag.lock

@@ -1 +1 @@
-v0.1.431
+v0.1.432

src/viam/api/buf.lock

@@ -8,7 +8,7 @@ deps:
   - remote: buf.build
     owner: viamrobotics
     repository: api
-    commit: 7602eb52384c4ee9bba76965852d8381
+    commit: 1f5b8a47f15e49af89174672bb898b77
   - remote: buf.build
     owner: viamrobotics
     repository: goutils

src/viam/sdk/robot/client.cpp

@@ -129,11 +129,15 @@ RobotClient::~RobotClient() {
 
 void RobotClient::close() {
     should_refresh_.store(false);
-    for (const std::shared_ptr<std::thread>& t : threads_) {
-        t->~thread();
+
+    for (auto& thread : threads_) {
+        thread.join();
     }
+    threads_.clear();
+
     stop_all();
-    viam_channel_->close();
+
+    viam_channel_.close();
 }
 
 bool is_error_response(const grpc::Status& response) {
@@ -211,7 +215,7 @@ void RobotClient::refresh() {
         if (rs) {
             try {
                 const std::shared_ptr<Resource> rpc_client =
-                    rs->create_rpc_client(name.name(), channel_);
+                    rs->create_rpc_client(name.name(), viam_channel_.channel());
                 const Name name_({name.namespace_(), name.type(), name.subtype()}, "", name.name());
                 new_resources.emplace(name_, rpc_client);
             } catch (const std::exception& exc) {
@@ -250,11 +254,10 @@ void RobotClient::refresh_every() {
     }
 };
 
-RobotClient::RobotClient(std::shared_ptr<ViamChannel> channel)
-    : channel_(channel->channel()),
-      viam_channel_(std::move(channel)),
+RobotClient::RobotClient(ViamChannel channel)
+    : viam_channel_(std::move(channel)),
       should_close_channel_(false),
-      impl_(std::make_unique<impl>(RobotService::NewStub(channel_))) {}
+      impl_(std::make_unique<impl>(RobotService::NewStub(viam_channel_.channel()))) {}
 
 std::vector<Name> RobotClient::resource_names() const {
     const std::lock_guard<std::mutex> lock(lock_);
@@ -286,20 +289,14 @@ void RobotClient::log(const std::string& name,
     }
 }
 
-std::shared_ptr<RobotClient> RobotClient::with_channel(std::shared_ptr<ViamChannel> channel,
+std::shared_ptr<RobotClient> RobotClient::with_channel(ViamChannel channel,
                                                        const Options& options) {
-    std::shared_ptr<RobotClient> robot = std::make_shared<RobotClient>(std::move(channel));
+    auto robot = std::make_shared<RobotClient>(std::move(channel));
     robot->refresh_interval_ = options.refresh_interval();
     robot->should_refresh_ = (robot->refresh_interval_ > 0);
     if (robot->should_refresh_) {
-        const std::shared_ptr<std::thread> t =
-            std::make_shared<std::thread>(&RobotClient::refresh_every, robot);
-        // TODO(RSDK-1743): this was leaking, confirm that adding thread catching in
-        // close/destructor lets us shutdown gracefully. See also address sanitizer,
-        // UB sanitizer
-        t->detach();
-        robot->threads_.push_back(t);
-    };
+        robot->threads_.emplace_back(&RobotClient::refresh_every, robot);
+    }
 
     robot->refresh();
     return robot;
@@ -308,8 +305,8 @@ std::shared_ptr<RobotClient> RobotClient::with_channel(std::shared_ptr<ViamChann
 std::shared_ptr<RobotClient> RobotClient::at_address(const std::string& address,
                                                      const Options& options) {
     const char* uri = address.c_str();
-    auto channel = ViamChannel::dial_initial(uri, options.dial_options());
-    std::shared_ptr<RobotClient> robot = RobotClient::with_channel(channel, options);
+    auto robot =
+        RobotClient::with_channel(ViamChannel::dial_initial(uri, options.dial_options()), options);
     robot->should_close_channel_ = true;
 
     return robot;
@@ -318,11 +315,9 @@ std::shared_ptr<RobotClient> RobotClient::at_address(const std::string& address,
 std::shared_ptr<RobotClient> RobotClient::at_local_socket(const std::string& address,
                                                           const Options& options) {
     const std::string addr = "unix:" + address;
-    const char* uri = addr.c_str();
-    const std::shared_ptr<grpc::Channel> channel =
-        sdk::impl::create_viam_channel(uri, grpc::InsecureChannelCredentials());
-    auto viam_channel = std::make_shared<ViamChannel>(channel, address.c_str(), nullptr);
-    std::shared_ptr<RobotClient> robot = RobotClient::with_channel(viam_channel, options);
+    auto robot = RobotClient::with_channel(
+        ViamChannel(sdk::impl::create_viam_channel(addr, grpc::InsecureChannelCredentials())),
+        options);
     robot->should_close_channel_ = true;
 
     return robot;

src/viam/sdk/robot/client.hpp

@@ -64,7 +64,10 @@ class RobotClient {
         friend bool operator==(const operation& lhs, const operation& rhs);
     };
 
+    explicit RobotClient(ViamChannel channel);
+
     ~RobotClient();
+
     void refresh();
     void close();
 
@@ -87,10 +90,7 @@ class RobotClient {
     /// @param options Options for connecting and refreshing.
     /// Connects directly to a pre-existing channel. A robot created this way must be
     /// `close()`d manually.
-    static std::shared_ptr<RobotClient> with_channel(std::shared_ptr<ViamChannel> channel,
-                                                     const Options& options);
-
-    RobotClient(std::shared_ptr<ViamChannel> channel);
+    static std::shared_ptr<RobotClient> with_channel(ViamChannel channel, const Options& options);
 
     std::vector<Name> resource_names() const;
 
@@ -165,13 +165,12 @@ class RobotClient {
 
     void refresh_every();
 
-    std::vector<std::shared_ptr<std::thread>> threads_;
+    std::vector<std::thread> threads_;
 
     std::atomic<bool> should_refresh_;
     unsigned int refresh_interval_;
 
-    std::shared_ptr<GrpcChannel> channel_;
-    std::shared_ptr<ViamChannel> viam_channel_;
+    ViamChannel viam_channel_;
     bool should_close_channel_;
 
     struct impl;

src/viam/sdk/rpc/dial.cpp

@@ -19,19 +19,46 @@
 namespace viam {
 namespace sdk {
 
-const std::shared_ptr<grpc::Channel>& ViamChannel::channel() const {
-    return channel_;
-}
+struct ViamChannel::impl {
+    impl(const char* path, void* runtime) : path(path), rust_runtime(runtime) {}
 
-void ViamChannel::close() {
-    if (closed_) {
-        return;
+    impl(const impl&) = delete;
+
+    impl(impl&& other) noexcept
+        : path(std::exchange(other.path, nullptr)),
+          rust_runtime(std::exchange(other.rust_runtime, nullptr)) {}
+
+    impl& operator=(const impl&) = delete;
+
+    impl& operator=(impl&& other) noexcept {
+        path = std::exchange(other.path, nullptr);
+        rust_runtime = std::exchange(other.rust_runtime, nullptr);
+
+        return *this;
     }
-    closed_ = true;
-    free_string(path_);
-    free_rust_runtime(rust_runtime_);
+
+    ~impl() {
+        free_string(path);
+        free_rust_runtime(rust_runtime);
+    }
+
+    const char* path;
+    void* rust_runtime;
 };
 
+ViamChannel::ViamChannel(std::shared_ptr<grpc::Channel> channel, const char* path, void* runtime)
+    : channel_(std::move(channel)), pimpl_(std::make_unique<ViamChannel::impl>(path, runtime)) {}
+
+ViamChannel::ViamChannel(std::shared_ptr<grpc::Channel> channel) : channel_(std::move(channel)) {}
+
+ViamChannel::ViamChannel(ViamChannel&&) noexcept = default;
+
+ViamChannel& ViamChannel::operator=(ViamChannel&&) noexcept = default;
+
+ViamChannel::~ViamChannel() {
+    close();
+}
+
 const std::string& Credentials::type() const {
     return type_;
 }
@@ -40,9 +67,6 @@ const std::string& Credentials::payload() const {
     return payload_;
 }
 
-ViamChannel::ViamChannel(std::shared_ptr<grpc::Channel> channel, const char* path, void* runtime)
-    : channel_(std::move(channel)), path_(path), closed_(false), rust_runtime_(runtime) {}
-
 DialOptions::DialOptions() = default;
 
 DialOptions& DialOptions::set_credentials(boost::optional<Credentials> creds) {
@@ -106,8 +130,8 @@ bool DialOptions::allows_insecure_downgrade() const {
     return allow_insecure_downgrade_;
 }
 
-std::shared_ptr<ViamChannel> ViamChannel::dial_initial(
-    const char* uri, const boost::optional<DialOptions>& options) {
+ViamChannel ViamChannel::dial_initial(const char* uri,
+                                      const boost::optional<DialOptions>& options) {
     DialOptions opts = options.get_value_or(DialOptions());
     auto timeout = opts.timeout();
     auto attempts_remaining = opts.initial_connection_attempts();
@@ -130,11 +154,10 @@ std::shared_ptr<ViamChannel> ViamChannel::dial_initial(
     }
     // the while loop will run until we either return or throw an error, so we can never reach this
     // point
-    BOOST_UNREACHABLE_RETURN(nullptr)
+    BOOST_UNREACHABLE_RETURN(ViamChannel(nullptr))
 }
 
-std::shared_ptr<ViamChannel> ViamChannel::dial(const char* uri,
-                                               const boost::optional<DialOptions>& options) {
+ViamChannel ViamChannel::dial(const char* uri, const boost::optional<DialOptions>& options) {
     void* ptr = init_rust_runtime();
     const DialOptions opts = options.get_value_or(DialOptions());
     const std::chrono::duration<float> float_timeout = opts.timeout();
@@ -164,12 +187,18 @@ std::shared_ptr<ViamChannel> ViamChannel::dial(const char* uri,
     }
     address += proxy_path;
 
-    const std::shared_ptr<grpc::Channel> channel =
-        impl::create_viam_channel(address, grpc::InsecureChannelCredentials());
-    const std::unique_ptr<viam::robot::v1::RobotService::Stub> st =
-        viam::robot::v1::RobotService::NewStub(channel);
-    return std::make_shared<ViamChannel>(channel, proxy_path, ptr);
-};
+    return ViamChannel(sdk::impl::create_viam_channel(address, grpc::InsecureChannelCredentials()),
+                       proxy_path,
+                       ptr);
+}
+
+const std::shared_ptr<grpc::Channel>& ViamChannel::channel() const {
+    return channel_;
+}
+
+void ViamChannel::close() {
+    pimpl_.reset();
+}
 
 unsigned int Options::refresh_interval() const {
     return refresh_interval_;

src/viam/sdk/rpc/dial.hpp

@@ -13,18 +13,24 @@ namespace sdk {
 
 class DialOptions;
 class ViamChannel {
-   public:
-    void close();
     ViamChannel(std::shared_ptr<GrpcChannel> channel, const char* path, void* runtime);
 
+   public:
+    explicit ViamChannel(std::shared_ptr<GrpcChannel> channel);
+
+    ViamChannel(ViamChannel&&) noexcept;
+
+    ViamChannel& operator=(ViamChannel&&) noexcept;
+
+    ~ViamChannel();
+
     /// @brief Connects to a robot at the given URI address, using the provided dial options (or
     /// default options is none are provided). Ignores initial connection options specifying
     /// how many times to attempt to connect and with what timeout.
     /// In general, use of this method is discouraged. `RobotClient::at_address(...)` is the
     /// preferred method to connect to a robot, and creates the channel itself.
     /// @throws Exception if it is unable to establish a connection to the provided URI
-    static std::shared_ptr<ViamChannel> dial(const char* uri,
-                                             const boost::optional<DialOptions>& options);
+    static ViamChannel dial(const char* uri, const boost::optional<DialOptions>& options);
 
     // @brief Dials to a robot at the given URI address, using the provided dial options (or default
     // options is none are provided). Additionally specifies that this dial is an initial connection
@@ -33,16 +39,18 @@ class ViamChannel {
     /// preferred method to connect to a robot, and creates the channel itself.
     /// @throws Exception if it is unable to establish a connection to the provided URI within
     /// the given number of initial connection attempts
-    static std::shared_ptr<ViamChannel> dial_initial(const char* uri,
-                                                     const boost::optional<DialOptions>& options);
+    static ViamChannel dial_initial(const char* uri, const boost::optional<DialOptions>& options);
 
     const std::shared_ptr<GrpcChannel>& channel() const;
 
+    void close();
+
    private:
+    struct impl;
+
     std::shared_ptr<GrpcChannel> channel_;
-    const char* path_;
-    bool closed_;
-    void* rust_runtime_;
+
+    std::unique_ptr<impl> pimpl_;
 };
 
 class Credentials {

src/viam/sdk/tests/test_robot.cpp

@@ -50,8 +50,7 @@ void robot_client_to_mocks_pipeline(F&& test_case) {
     // in-process gRPC channel.
     auto test_server = TestServer(server);
     auto grpc_channel = test_server.grpc_in_process_channel();
-    auto viam_channel = std::make_shared<ViamChannel>(grpc_channel, "", nullptr);
-    auto client = RobotClient::with_channel(viam_channel, Options(0, boost::none));
+    auto client = RobotClient::with_channel(ViamChannel(grpc_channel), Options(0, boost::none));
 
     // Run the passed-in test case on the created stack and give access to the
     // created RobotClient and MockRobotService.