CDRIVER-5548 Enable setting socket timeout per client (#1556)

* this allows use of a single mongoc_client_pool_t even when different timeout values are desired

* note: timeout is restored on mongoc_client_pool_push()

---------

Co-authored-by: Kevin Albertson <[email protected]>

Author: scotthunt

src/libmongoc/doc/mongoc_client_set_sockettimeoutms.rst

@@ -0,0 +1,26 @@
+:man_page: mongoc_client_set_sockettimeoutms
+
+mongoc_client_set_sockettimeoutms()
+===================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  void
+  mongoc_client_set_sockettimeoutms (mongoc_client_t *client, int32_t timeoutms);
+
+Change the ``sockettimeoutms`` of the :symbol:`mongoc_client_t`.
+
+If ``client`` was obtained from a :symbol:`mongoc_client_pool_t`, the socket timeout is restored to the previous value when calling :symbol:`mongoc_client_pool_push`.
+
+Parameters
+----------
+
+* ``client``: A :symbol:`mongoc_client_t`.
+* ``timeoutms``: The requested timeout value in milliseconds.
+
+.. seealso::
+
+  | :ref:`URI Connection Options <connection_options>`

src/libmongoc/doc/mongoc_client_t.rst

@@ -87,6 +87,7 @@ Example
     mongoc_client_set_read_concern
     mongoc_client_set_read_prefs
     mongoc_client_set_server_api
+    mongoc_client_set_sockettimeoutms
     mongoc_client_set_ssl_opts
     mongoc_client_set_stream_initiator
     mongoc_client_set_write_concern

src/libmongoc/doc/mongoc_uri_t.rst

@@ -84,6 +84,8 @@ IPv4 and IPv6
 
 .. include:: includes/ipv4-and-ipv6.txt
 
+.. _connection_options:
+
 Connection Options
 ------------------
 

src/libmongoc/src/mongoc/mongoc-client-pool.c

@@ -366,6 +366,9 @@ mongoc_client_pool_push (mongoc_client_pool_t *pool, mongoc_client_t *client)
    BSON_ASSERT_PARAM (pool);
    BSON_ASSERT_PARAM (client);
 
+   /* reset sockettimeoutms to the default in case it was changed with mongoc_client_set_sockettimeoutms() */
+   mongoc_cluster_reset_sockettimeoutms (&client->cluster);
+
    bson_mutex_lock (&pool->mutex);
    _mongoc_queue_push_head (&pool->queue, client);
 

src/libmongoc/src/mongoc/mongoc-client.c

@@ -1125,6 +1125,13 @@ mongoc_client_destroy (mongoc_client_t *client)
 }
 
 
+void
+mongoc_client_set_sockettimeoutms (mongoc_client_t *client, int32_t timeoutms)
+{
+   BSON_ASSERT_PARAM (client);
+   mongoc_cluster_set_sockettimeoutms (&client->cluster, timeoutms);
+}
+
 /*
  *--------------------------------------------------------------------------
  *

src/libmongoc/src/mongoc/mongoc-client.h

@@ -107,6 +107,8 @@ MONGOC_EXPORT (mongoc_client_t *)
 mongoc_client_new_from_uri (const mongoc_uri_t *uri) BSON_GNUC_WARN_UNUSED_RESULT;
 MONGOC_EXPORT (mongoc_client_t *)
 mongoc_client_new_from_uri_with_error (const mongoc_uri_t *uri, bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT;
+MONGOC_EXPORT (void)
+mongoc_client_set_sockettimeoutms (mongoc_client_t *client, int32_t timeoutms);
 MONGOC_EXPORT (const mongoc_uri_t *)
 mongoc_client_get_uri (const mongoc_client_t *client);
 MONGOC_EXPORT (void)

src/libmongoc/src/mongoc/mongoc-cluster-private.h

@@ -72,6 +72,12 @@ mongoc_cluster_init (mongoc_cluster_t *cluster, const mongoc_uri_t *uri, void *c
 void
 mongoc_cluster_destroy (mongoc_cluster_t *cluster);
 
+void
+mongoc_cluster_set_sockettimeoutms (mongoc_cluster_t *cluster, int32_t sockettimeoutms);
+
+void
+mongoc_cluster_reset_sockettimeoutms (mongoc_cluster_t *cluster);
+
 void
 mongoc_cluster_disconnect_node (mongoc_cluster_t *cluster, uint32_t id);
 

src/libmongoc/src/mongoc/mongoc-cluster.c

@@ -2513,8 +2513,7 @@ mongoc_cluster_init (mongoc_cluster_t *cluster, const mongoc_uri_t *uri, void *c
    cluster->client = (mongoc_client_t *) client;
    cluster->requires_auth = (mongoc_uri_get_username (uri) || mongoc_uri_get_auth_mechanism (uri));
 
-   cluster->sockettimeoutms =
-      mongoc_uri_get_option_as_int32 (uri, MONGOC_URI_SOCKETTIMEOUTMS, MONGOC_DEFAULT_SOCKETTIMEOUTMS);
+   mongoc_cluster_reset_sockettimeoutms (cluster);
 
    cluster->socketcheckintervalms =
       mongoc_uri_get_option_as_int32 (uri, MONGOC_URI_SOCKETCHECKINTERVALMS, MONGOC_TOPOLOGY_SOCKET_CHECK_INTERVAL_MS);
@@ -2562,6 +2561,21 @@ mongoc_cluster_destroy (mongoc_cluster_t *cluster) /* INOUT */
    EXIT;
 }
 
+void
+mongoc_cluster_set_sockettimeoutms (mongoc_cluster_t *cluster, int32_t timeoutms)
+{
+   BSON_ASSERT_PARAM (cluster);
+   cluster->sockettimeoutms = timeoutms;
+}
+
+void
+mongoc_cluster_reset_sockettimeoutms (mongoc_cluster_t *cluster)
+{
+   BSON_ASSERT_PARAM (cluster);
+   cluster->sockettimeoutms =
+      mongoc_uri_get_option_as_int32 (cluster->uri, MONGOC_URI_SOCKETTIMEOUTMS, MONGOC_DEFAULT_SOCKETTIMEOUTMS);
+}
+
 static uint32_t
 _mongoc_cluster_select_server_id (mongoc_client_session_t *cs,
                                   mongoc_topology_t *topology,

src/libmongoc/tests/test-mongoc-client-pool.c

@@ -1,5 +1,6 @@
 #include <mongoc/mongoc.h>
 #include "mongoc/mongoc-client-pool-private.h"
+#include <mongoc/mongoc-client-private.h>
 #include "mongoc/mongoc-util-private.h"
 
 
@@ -454,6 +455,32 @@ test_client_pool_max_pool_size_exceeded (void)
    bson_free (args);
 }
 
+static void
+test_client_pool_can_override_sockettimeoutms (void)
+{
+   mongoc_uri_t *uri = mongoc_uri_new ("mongodb://localhost:27017/?socketTimeoutMS=1000");
+   mongoc_client_pool_t *pool = mongoc_client_pool_new (uri);
+
+   // Override the client's socketTimeoutMS.
+   {
+      mongoc_client_t *client = mongoc_client_pool_pop (pool);
+      ASSERT_CMPINT32 (client->cluster.sockettimeoutms, ==, 1000);
+      mongoc_client_set_sockettimeoutms (client, 2000);
+      ASSERT_CMPINT32 (client->cluster.sockettimeoutms, ==, 2000);
+      mongoc_client_pool_push (pool, client);
+   }
+
+   // Pop again. Expect the newly popped client to have the socketTimeoutMS from the URI.
+   {
+      mongoc_client_t *client = mongoc_client_pool_pop (pool);
+      ASSERT_CMPINT32 (client->cluster.sockettimeoutms, ==, 1000);
+      mongoc_client_pool_push (pool, client);
+   }
+
+   mongoc_client_pool_destroy (pool);
+   mongoc_uri_destroy (uri);
+}
+
 void
 test_client_pool_install (TestSuite *suite)
 {
@@ -478,4 +505,5 @@ test_client_pool_install (TestSuite *suite)
 #endif
    TestSuite_AddLive (suite, "/ClientPool/destroy_without_push", test_client_pool_destroy_without_pushing);
    TestSuite_AddLive (suite, "/ClientPool/max_pool_size_exceeded", test_client_pool_max_pool_size_exceeded);
+   TestSuite_Add (suite, "/ClientPool/can_override_sockettimeoutms", test_client_pool_can_override_sockettimeoutms);
 }