CPP-741 - Allow client ID to be configurable

Author: mikefero

cpp-driver/gtests/src/unit/tests/test_startup_options.cpp

@@ -19,18 +19,28 @@
 #include "driver_info.hpp"
 #include "query_request.hpp"
 #include "session.hpp"
-
+#include "testing.hpp"
 
 #define APPLICATION_NAME "DataStax C/C++ Test Harness"
 #define APPLICATION_VERSION "1.0.0"
 
+inline bool operator==(const CassUuid& rhs, const CassUuid& lhs) {
+  return rhs.clock_seq_and_node == lhs.clock_seq_and_node &&
+    rhs.time_and_version == lhs.time_and_version;
+}
+
+inline bool operator!=(const CassUuid& rhs, const CassUuid& lhs) {
+  return !(rhs == lhs);
+}
+
 class StartupRequestUnitTest : public Unit {
 public:
   void TearDown() {
     ASSERT_TRUE(session_.close()->wait_for(WAIT_FOR_TIME));
     Unit::TearDown();
   }
 
+  cass::Session& session() { return session_; }
   const cass::String& client_id() const { return client_id_; }
   cass::Config& config() { return config_; }
   const mockssandra::RequestHandler* simple_with_client_options() {
@@ -129,3 +139,27 @@ TEST_F(StartupRequestUnitTest, Application) {
   ASSERT_EQ(cass::driver_name(), options["DRIVER_NAME"]);
   ASSERT_EQ(cass::driver_version(), options["DRIVER_VERSION"]);
 }
+
+TEST_F(StartupRequestUnitTest, SetClientId) {
+  mockssandra::SimpleCluster cluster(simple_with_client_options());
+  ASSERT_EQ(cluster.start_all(), 0);
+
+  CassUuid generated_client_id = session().client_id();
+  CassUuid assigned_client_id;
+  ASSERT_EQ(CASS_OK,
+            cass_uuid_from_string("03398c99-c635-4fad-b30a-3b2c49f785c2",
+                                  &assigned_client_id));
+  config().set_client_id(assigned_client_id);
+
+  connect();
+  CassUuid current_client_id = session().client_id();
+  ASSERT_EQ(assigned_client_id, current_client_id);
+  ASSERT_NE(generated_client_id, current_client_id);
+  cass::Map<cass::String, cass::String> options = client_options();
+  ASSERT_EQ(4u, options.size());
+
+  ASSERT_EQ("03398c99-c635-4fad-b30a-3b2c49f785c2", options["CLIENT_ID"]);
+  ASSERT_EQ(CASS_DEFAULT_CQL_VERSION, options["CQL_VERSION"]);
+  ASSERT_EQ(cass::driver_name(), options["DRIVER_NAME"]);
+  ASSERT_EQ(cass::driver_version(), options["DRIVER_VERSION"]);
+}

cpp-driver/src/config.hpp

@@ -68,6 +68,7 @@ class Config {
       , prepare_on_all_hosts_(CASS_DEFAULT_PREPARE_ON_ALL_HOSTS)
       , prepare_on_up_or_add_host_(CASS_DEFAULT_PREPARE_ON_UP_OR_ADD_HOST)
       , no_compact_(CASS_DEFAULT_NO_COMPACT)
+      , is_client_id_set_(false)
       , host_listener_(new DefaultHostListener()) {
     profiles_.set_empty_key(String());
 
@@ -398,8 +399,16 @@ class Config {
     application_version_ = application_version;
   }
 
+  CassUuid client_id() const { return client_id_; }
+  bool is_client_id_set() const { return is_client_id_set_; }
+
+  void set_client_id(CassUuid client_id) {
+    client_id_ = client_id;
+    is_client_id_set_ = true;
+  }
+
   const DefaultHostListener::Ptr& host_listener() const { return host_listener_; }
-  
+
   void set_host_listener(const DefaultHostListener::Ptr& listener) {
     if (listener) {
       host_listener_ = listener;
@@ -451,6 +460,8 @@ class Config {
   bool no_compact_;
   String application_name_;
   String application_version_;
+  bool is_client_id_set_;
+  CassUuid client_id_;
   DefaultHostListener::Ptr host_listener_;
 };
 

cpp-driver/src/session_base.cpp

@@ -80,6 +80,9 @@ Future::Ptr SessionBase::connect(const Config& config,
     }
   }
 
+  if (config.is_client_id_set()) {
+    client_id_ = config.client_id();
+  }
   LOG_INFO("Client id is %s", to_string(client_id_).c_str());
 
   config_ = config.new_instance();

cpp-driver/test/ccm_bridge/src/process.cpp

@@ -94,6 +94,9 @@ Process::Result Process::execute(const Args& command) {
   rc = uv_loop_close(&loop);
   if (rc != 0) {
     uv_print_all_handles(&loop, stderr);
+    if (!result.standard_error.empty()) {
+      std::cerr << result.standard_error << std::endl;
+    }
     assert(false && "Process loop still has pending handles");
   }
 

include/dse.h

@@ -459,8 +459,6 @@ cass_cluster_set_dse_plaintext_authenticator_proxy_n(CassCluster* cluster,
  * that can aid in debugging issues with larger clusters where there are a lot
  * of client (or application) connections.
  *
- * @dse{6.0.0+}
- *
  * @public @memberof CassCluster
  *
  * @param[in] cluster
@@ -474,8 +472,6 @@ cass_cluster_set_application_name(CassCluster* cluster,
  * Same as cass_cluster_set_application_name(), but with lengths for string
  * parameters.
  *
- * @dse{6.0.0+}
- *
  * @public @memberof CassCluster
  *
  * @param[in] cluster
@@ -495,8 +491,6 @@ cass_cluster_set_application_name_n(CassCluster* cluster,
  * a lot of client (or application) connections that may have different
  * versions in use.
  *
- * @dse{6.0.0+}
- *
  * @public @memberof CassCluster
  *
  * @param[in] cluster
@@ -511,8 +505,6 @@ cass_cluster_set_application_version(CassCluster* cluster,
  * Same as cass_cluster_set_application_version(), but with lengths for string
  * parameters.
  *
- * @dse{6.0.0+}
- *
  * @public @memberof CassCluster
  *
  * @param[in] cluster
@@ -524,6 +516,23 @@ cass_cluster_set_application_version_n(CassCluster* cluster,
                                        const char* application_version,
                                        size_t application_version_length);
 
+/**
+ * Set the client id.
+ *
+ * This is optional; however it provides the server with the client ID that can
+ * aid in debugging issues with large clusters where there are a lot of client
+ * connections.
+ *
+ * Default: UUID v4 generated (@see cass_session_get_client_id())
+ *
+ * @public @memberof CassCluster
+ *
+ * @param[in] cluster
+ * @param[in] client_id
+ */
+CASS_EXPORT void
+cass_cluster_set_client_id(CassCluster* cluster, CassUuid client_id);
+
 /***********************************************************************************
  *
  * Session
@@ -548,13 +557,6 @@ cass_session_execute_dse_graph(CassSession* session,
 /**
  * Get the client id.
  *
- * This can help with debugging issues in large clusters where there are a lot
- * of client connections. A session's unique identifier (UUID) is constant for
- * its lifetime and does not change when re-establishing connection to a
- * cluster.
- *
- * @dse{6.0.0+}
- *
  * @public @memberof CassSession
  *
  * @param[in] session

src/cluster_config.cpp

@@ -131,5 +131,8 @@ void cass_cluster_set_application_version_n(CassCluster* cluster,
                                                          application_version_length));
 }
 
+void cass_cluster_set_client_id(CassCluster* cluster, CassUuid client_id) {
+  cluster->config().set_client_id(client_id);
+}
 
 } // extern "C"

tests/src/integration/dse_integration.cpp

@@ -65,7 +65,8 @@ void DseIntegration::connect(dse::Cluster cluster) {
 void DseIntegration::connect() {
   // Create the cluster configuration and establish the session connection
   cluster_ = default_cluster();
-  connect(cluster_);
+  dse_cluster_ = cluster_;
+  connect(dse_cluster_);
 }
 
 Cluster DseIntegration::default_cluster() {

tests/src/integration/dse_integration.hpp

@@ -73,6 +73,10 @@ class DseIntegration : public Integration {
   virtual Cluster default_cluster();
 
 protected:
+  /**
+   * Configured DSE cluster
+   */
+  dse::Cluster dse_cluster_;
   /**
    * Connected database DSE session
    */