CDRIVER-3871 implement public setters and getters for timeoutMS

samantharitter · samantharitter · commit 95ed9344a15c · 2021-02-17T14:22:28.000-05:00
diff --git a/src/libmongoc/doc/errors.rst b/src/libmongoc/doc/errors.rst
@@ -97,6 +97,8 @@ Many C Driver functions report errors by returning ``false`` or -1 and filling o
 +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | ``MONGOC_ERROR_CLIENT_SIDE_ENCRYPTION`` | Error code produced by libmongocrypt.                                                                                           | An error occurred in the library responsible for Client Side Encryption                                                                                                                                                                                                                                                                    |
 +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``MONGOC_ERROR_TIMEOUT``                | ``MONGOC_ERROR_TIMEOUT_INVALID``                                                                                                | You passed an invalid value for a timeout paramenter.                                                                                                                                                                                                                                                                                      |
++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. _error_labels:
 
diff --git a/src/libmongoc/doc/mongoc_client_get_timeout_ms.rst b/src/libmongoc/doc/mongoc_client_get_timeout_ms.rst
@@ -0,0 +1,24 @@
+:man_page: mongoc_client_get_timeout_ms
+
+mongoc_client_get_timeout_ms()
+==============================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  int64_t
+  mongoc_client_get_timeout_ms (const mongoc_client_t *client)
+
+Returns the client-side operation timeout value for this object. If ``client`` does not have a timeout currently set, this method returns -1 for MONGOC_TIMEOUTMS_UNSET.
+
+Parameters
+----------
+
+* ``client``: A :symbol:`mongoc_client_t`.
+
+Returns
+-------
+
+The timeout set on this client or -1 for MONGOC_TIMEOUTMS_UNSET.
diff --git a/src/libmongoc/doc/mongoc_client_t.rst b/src/libmongoc/doc/mongoc_client_t.rst
@@ -68,6 +68,7 @@ Example
     mongoc_client_get_server_description
     mongoc_client_get_server_descriptions
     mongoc_client_get_server_status
+    mongoc_client_get_timeout_ms
     mongoc_client_get_uri
     mongoc_client_get_write_concern
     mongoc_client_new
diff --git a/src/libmongoc/doc/mongoc_collection_get_timeout_ms.rst b/src/libmongoc/doc/mongoc_collection_get_timeout_ms.rst
@@ -0,0 +1,24 @@
+:man_page: mongoc_collection_get_timeout_ms
+
+mongoc_collection_get_timeout_ms()
+==================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  int64_t
+  mongoc_collection_get_timeout_ms (const mongoc_collection_t *collection)
+
+Returns the client-side operation timeout value for this object. If ``collection`` does not have a timeout currently set, this method will return a value inherited from the parent :symbol:`mongoc_database_t` or :symbol:`mongoc_client_t` object. If no timeout is set on any parent object, returns -1 for MONGOC_TIMEOUTMS_UNSET.
+
+Parameters
+----------
+
+* ``collection``: A :symbol:`mongoc_collection_t`.
+
+Returns
+-------
+
+The timeout set on this collection or inherited from a parent object.
diff --git a/src/libmongoc/doc/mongoc_collection_set_timeout_ms.rst b/src/libmongoc/doc/mongoc_collection_set_timeout_ms.rst
@@ -0,0 +1,30 @@
+:man_page: mongoc_collection_set_timeout_ms
+
+mongoc_collection_set_timeout_ms()
+==================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_collection_set_timeout_ms (mongoc_collection_t *collection, int64_t timeout_ms, bson_error_t *error)
+
+Sets the client-side operation timeout value for ``collection`` to the given ``timeout_ms``. If there is an error setting the timeout, this method will return false and ``error`` will be set.
+
+
+This function will set ``error`` and return false in the following cases:
+
+* ``timeout_ms`` is a negative number
+
+Parameters
+----------
+
+* ``collection``: A :symbol:`mongoc_collection_t`.
+* ``timeout_ms``: A value, in milliseconds, for the timeout. Must be non-negative.
+
+Returns
+-------
+
+true if the timeout_ms is set successfully. Otherwise, false.
diff --git a/src/libmongoc/doc/mongoc_collection_t.rst b/src/libmongoc/doc/mongoc_collection_t.rst
@@ -58,6 +58,7 @@ Read preferences and write concerns are inherited from the parent client. They c
     mongoc_collection_get_name
     mongoc_collection_get_read_concern
     mongoc_collection_get_read_prefs
+    mongoc_collection_get_timeout_ms
     mongoc_collection_get_write_concern
     mongoc_collection_insert
     mongoc_collection_insert_bulk
@@ -73,6 +74,7 @@ Read preferences and write concerns are inherited from the parent client. They c
     mongoc_collection_save
     mongoc_collection_set_read_concern
     mongoc_collection_set_read_prefs
+    mongoc_collection_set_timeout_ms
     mongoc_collection_set_write_concern
     mongoc_collection_stats
     mongoc_collection_update
diff --git a/src/libmongoc/doc/mongoc_database_get_timeout_ms.rst b/src/libmongoc/doc/mongoc_database_get_timeout_ms.rst
@@ -0,0 +1,24 @@
+:man_page: mongoc_database_get_timeout_ms
+
+mongoc_database_get_timeout_ms()
+================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  int64_t
+  mongoc_database_get_timeout_ms (const mongoc_database_t *database)
+
+Returns the client-side operation timeout value for this object. If ``database`` does not have a timeout currently set, this method will return a value inherited from the parent :symbol:`mongoc_client_t` object. If no timeout is set on the parent object, returns -1, or MONGOC_TIMEOUTMS_UNSET.
+
+Parameters
+----------
+
+* ``database``: A :symbol:`mongoc_database_t`.
+
+Returns
+-------
+
+The timeout set on this database or inherited from a parent object.
diff --git a/src/libmongoc/doc/mongoc_database_set_timeout_ms.rst b/src/libmongoc/doc/mongoc_database_set_timeout_ms.rst
@@ -0,0 +1,30 @@
+:man_page: mongoc_database_set_timeout_ms
+
+mongoc_database_set_timeout_ms()
+================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_database_set_timeout_ms (mongoc_database_t *database, int64_t timeout_ms, bson_error_t *error)
+
+Sets the client-side operation timeout value for ``database`` to the given ``timeout_ms``. If there is an error setting the timeout, this method will return false and ``error`` will be set.
+
+
+This function will set ``error`` and return false in the following cases:
+
+* ``timeout_ms`` is a negative number
+
+Parameters
+----------
+
+* ``database``: A :symbol:`mongoc_database_t`.
+* ``timeout_ms``: A value, in milliseconds, for the timeout. Must be non-negative.
+
+Returns
+-------
+
+true if the timeout_ms is set successfully. Otherwise, false.
diff --git a/src/libmongoc/doc/mongoc_database_t.rst b/src/libmongoc/doc/mongoc_database_t.rst
@@ -43,6 +43,7 @@ Read preferences and write concerns are inherited from the parent client. They c
     mongoc_database_get_name
     mongoc_database_get_read_concern
     mongoc_database_get_read_prefs
+    mongoc_database_get_timeout_ms
     mongoc_database_get_write_concern
     mongoc_database_has_collection
     mongoc_database_read_command_with_opts
@@ -51,6 +52,7 @@ Read preferences and write concerns are inherited from the parent client. They c
     mongoc_database_remove_user
     mongoc_database_set_read_concern
     mongoc_database_set_read_prefs
+    mongoc_database_set_timeout_ms
     mongoc_database_set_write_concern
     mongoc_database_watch
     mongoc_database_write_command_with_opts
diff --git a/src/libmongoc/src/mongoc/mongoc-client-private.h b/src/libmongoc/src/mongoc/mongoc-client-private.h
@@ -122,6 +122,8 @@ struct _mongoc_client_t {
    mongoc_set_t *client_sessions;
    unsigned int csid_rand_seed;
 
+   int64_t timeout_ms;
+
    uint32_t generation;
 };
 
diff --git a/src/libmongoc/src/mongoc/mongoc-client.c b/src/libmongoc/src/mongoc/mongoc-client.c
@@ -1156,6 +1156,9 @@ _mongoc_client_new_from_uri (mongoc_topology_t *topology)
       BSON_ASSERT (mongoc_client_set_appname (client, appname));
    }
 
+   /* TODO CDRIVER-3850 pull initial timeoutMS value from the URI */
+   client->timeout_ms = MONGOC_TIMEOUTMS_UNSET;
+
    mongoc_cluster_init (&client->cluster, client->uri, client);
 
 #ifdef MONGOC_ENABLE_SSL
@@ -1327,7 +1330,8 @@ mongoc_client_get_database (mongoc_client_t *client, const char *name)
                                 name,
                                 client->read_prefs,
                                 client->read_concern,
-                                client->write_concern);
+                                client->write_concern,
+                                client->timeout_ms);
 }
 
 
@@ -1406,7 +1410,8 @@ mongoc_client_get_collection (mongoc_client_t *client,
                                   collection,
                                   client->read_prefs,
                                   client->read_concern,
-                                  client->write_concern);
+                                  client->write_concern,
+                                  client->timeout_ms);
 }
 
 
@@ -3070,6 +3075,8 @@ mongoc_client_enable_auto_encryption (mongoc_client_t *client,
                                       mongoc_auto_encryption_opts_t *opts,
                                       bson_error_t *error)
 {
+   BSON_ASSERT_PARAM (client);
+
    if (!client->topology->single_threaded) {
       bson_set_error (error,
                       MONGOC_ERROR_CLIENT,
@@ -3080,3 +3087,11 @@ mongoc_client_enable_auto_encryption (mongoc_client_t *client,
    }
    return _mongoc_cse_client_enable_auto_encryption (client, opts, error);
 }
+
+int64_t
+mongoc_client_get_timeout_ms (const mongoc_client_t *client)
+{
+   BSON_ASSERT_PARAM (client);
+
+   return client->timeout_ms;
+}
diff --git a/src/libmongoc/src/mongoc/mongoc-client.h b/src/libmongoc/src/mongoc/mongoc-client.h
@@ -268,6 +268,9 @@ mongoc_client_enable_auto_encryption (mongoc_client_t *client,
                                       mongoc_auto_encryption_opts_t *opts,
                                       bson_error_t *error);
 
+MONGOC_EXPORT (int64_t)
+mongoc_client_get_timeout_ms (const mongoc_client_t *client);
+
 BSON_END_DECLS
 
 
diff --git a/src/libmongoc/src/mongoc/mongoc-collection-private.h b/src/libmongoc/src/mongoc/mongoc-collection-private.h
@@ -37,6 +37,7 @@ struct _mongoc_collection_t {
    mongoc_read_concern_t *read_concern;
    mongoc_write_concern_t *write_concern;
    bson_t *gle;
+   int64_t timeout_ms;
 };
 
 
@@ -46,7 +47,8 @@ _mongoc_collection_new (mongoc_client_t *client,
                         const char *collection,
                         const mongoc_read_prefs_t *read_prefs,
                         const mongoc_read_concern_t *read_concern,
-                        const mongoc_write_concern_t *write_concern);
+                        const mongoc_write_concern_t *write_concern,
+                        int64_t timeout_ms);
 
 bool
 _mongoc_collection_create_index_if_not_exists (mongoc_collection_t *collection,
diff --git a/src/libmongoc/src/mongoc/mongoc-collection.c b/src/libmongoc/src/mongoc/mongoc-collection.c
@@ -22,23 +22,25 @@
 #include "mongoc-bulk-operation-private.h"
 #include "mongoc-change-stream-private.h"
 #include "mongoc-client-private.h"
-#include "mongoc-find-and-modify-private.h"
-#include "mongoc-find-and-modify.h"
 #include "mongoc-collection.h"
 #include "mongoc-collection-private.h"
 #include "mongoc-cursor-private.h"
+#include "mongoc-database-private.h"
 #include "mongoc-error.h"
+#include "mongoc-error-private.h"
+#include "mongoc-find-and-modify-private.h"
+#include "mongoc-find-and-modify.h"
 #include "mongoc-index.h"
 #include "mongoc-log.h"
-#include "mongoc-trace-private.h"
+#include "mongoc-opts-private.h"
 #include "mongoc-read-concern-private.h"
-#include "mongoc-write-concern-private.h"
 #include "mongoc-read-prefs-private.h"
+#include "mongoc-trace-private.h"
+#include "mongoc-uri.h"
 #include "mongoc-util-private.h"
 #include "mongoc-write-command-private.h"
-#include "mongoc-opts-private.h"
 #include "mongoc-write-command-private.h"
-#include "mongoc-error-private.h"
+#include "mongoc-write-concern-private.h"
 
 #undef MONGOC_LOG_DOMAIN
 #define MONGOC_LOG_DOMAIN "collection"
@@ -166,7 +168,8 @@ _mongoc_collection_new (mongoc_client_t *client,
                         const char *collection,
                         const mongoc_read_prefs_t *read_prefs,
                         const mongoc_read_concern_t *read_concern,
-                        const mongoc_write_concern_t *write_concern)
+                        const mongoc_write_concern_t *write_concern,
+                        int64_t timeout_ms)
 {
    mongoc_collection_t *col;
 
@@ -195,6 +198,8 @@ _mongoc_collection_new (mongoc_client_t *client,
 
    col->gle = NULL;
 
+   col->timeout_ms = timeout_ms;
+
    RETURN (col);
 }
 
@@ -280,7 +285,8 @@ mongoc_collection_copy (mongoc_collection_t *collection) /* IN */
                                    collection->collection,
                                    collection->read_prefs,
                                    collection->read_concern,
-                                   collection->write_concern));
+                                   collection->write_concern,
+                                   collection->timeout_ms));
 }
 
 
@@ -3507,3 +3513,31 @@ mongoc_collection_watch (const mongoc_collection_t *coll,
 {
    return _mongoc_change_stream_new_from_collection (coll, pipeline, opts);
 }
+
+bool
+mongoc_collection_set_timeout_ms (mongoc_collection_t *coll,
+                                  int64_t timeout_ms,
+                                  bson_error_t *error)
+{
+   BSON_ASSERT_PARAM (coll);
+
+   if (timeout_ms < 0) {
+      bson_set_error (error,
+                      MONGOC_ERROR_TIMEOUT,
+                      MONGOC_ERROR_TIMEOUT_INVALID,
+                      "timeoutMS must be a non-negative integer");
+      return false;
+   }
+
+   coll->timeout_ms = timeout_ms;
+
+   return true;
+}
+
+int64_t
+mongoc_collection_get_timeout_ms (const mongoc_collection_t *coll)
+{
+   BSON_ASSERT_PARAM (coll);
+
+   return coll->timeout_ms;
+}
diff --git a/src/libmongoc/src/mongoc/mongoc-collection.h b/src/libmongoc/src/mongoc/mongoc-collection.h
@@ -351,6 +351,14 @@ mongoc_collection_estimated_document_count (
    bson_t *reply,
    bson_error_t *error);
 
+MONGOC_EXPORT (bool)
+mongoc_collection_set_timeout_ms (mongoc_collection_t *coll,
+                                  int64_t timeout_ms,
+                                  bson_error_t *error);
+
+MONGOC_EXPORT (int64_t)
+mongoc_collection_get_timeout_ms (const mongoc_collection_t *coll);
+
 BSON_END_DECLS
 
 
diff --git a/src/libmongoc/src/mongoc/mongoc-database-private.h b/src/libmongoc/src/mongoc/mongoc-database-private.h
@@ -35,6 +35,7 @@ struct _mongoc_database_t {
    mongoc_read_prefs_t *read_prefs;
    mongoc_read_concern_t *read_concern;
    mongoc_write_concern_t *write_concern;
+   int64_t timeout_ms;
 };
 
 
@@ -43,7 +44,8 @@ _mongoc_database_new (mongoc_client_t *client,
                       const char *name,
                       const mongoc_read_prefs_t *read_prefs,
                       const mongoc_read_concern_t *read_concern,
-                      const mongoc_write_concern_t *write_concern);
+                      const mongoc_write_concern_t *write_concern,
+                      int64_t timeout_ms);
 
 BSON_END_DECLS
 
diff --git a/src/libmongoc/src/mongoc/mongoc-database.c b/src/libmongoc/src/mongoc/mongoc-database.c
diff --git a/src/libmongoc/src/mongoc/mongoc-database.h b/src/libmongoc/src/mongoc/mongoc-database.h
diff --git a/src/libmongoc/src/mongoc/mongoc-error.h b/src/libmongoc/src/mongoc/mongoc-error.h
diff --git a/src/libmongoc/src/mongoc/mongoc-uri.h b/src/libmongoc/src/mongoc/mongoc-uri.h
diff --git a/src/libmongoc/tests/test-mongoc-client.c b/src/libmongoc/tests/test-mongoc-client.c
diff --git a/src/libmongoc/tests/test-mongoc-collection.c b/src/libmongoc/tests/test-mongoc-collection.c
diff --git a/src/libmongoc/tests/test-mongoc-database.c b/src/libmongoc/tests/test-mongoc-database.c
