CDRIVER-2390 remove minPoolSize URI option (#1932)

* test `minPoolSize` is unrecognized
* remove `MONGOC_URI_MINPOOLSIZE`
* remove `mongoc_client_pool_min_size`
* skip spec tests expecting `minPoolSize` to be accepted
* update libmongoc-specific test to exclude minPoolSize

Author: kevinAlbs

NEWS

@@ -40,6 +40,7 @@ Unreleased (2.0.0)
 * `mongoc_cursor_is_alive` is removed. Use the equivalent `mongoc_cursor_more` instead.
 * `mongoc_collection_delete` is removed. Use `mongoc_collection_delete_one` or `mongoc_collection_delete_many` instead.
 * `mongoc_delete_flags_t` and `mongoc_reply_flags_t` are removed.
+* Support for the deprecated `minPoolSize` URI option is removed along with associated API: `MONGOC_URI_MINPOOLSIZE` and `mongoc_client_pool_min_size`.
 * Support for LibreSSL (the CMake option `ENABLE_SSL=LIBRESSL`) is removed. Associated API is removed (`MONGOC_ENABLE_SSL_LIBRESSL` and  `mongoc_stream_tls_libressl_new`).
 
 ### Forwarding headers (`#include <bson.h>` and `#include <mongoc.h>`)

src/libmongoc/doc/mongoc_client_pool_min_size.rst

@@ -33,7 +33,6 @@ Example
     mongoc_client_pool_destroy
     mongoc_client_pool_enable_auto_encryption
     mongoc_client_pool_max_size
-    mongoc_client_pool_min_size
     mongoc_client_pool_new
     mongoc_client_pool_new_with_error
     mongoc_client_pool_pop

src/libmongoc/doc/mongoc_client_pool_t.rst

@@ -201,7 +201,6 @@ These options govern the behavior of a :symbol:`mongoc_client_pool_t`. They are
 Constant                                   Key                               Description
 ========================================== ================================= =========================================================================================================================================================================================================================
 MONGOC_URI_MAXPOOLSIZE                     maxpoolsize                       The maximum number of clients created by a :symbol:`mongoc_client_pool_t` total (both in the pool and checked out). The default value is 100. Once it is reached, :symbol:`mongoc_client_pool_pop` blocks until another thread pushes a client.
-MONGOC_URI_MINPOOLSIZE                     minpoolsize                       Deprecated. This option's behavior does not match its name, and its actual behavior will likely hurt performance.
 MONGOC_URI_WAITQUEUETIMEOUTMS              waitqueuetimeoutms                The maximum time to wait for a client to become available from the pool.
 ========================================== ================================= =========================================================================================================================================================================================================================
 

src/libmongoc/doc/mongoc_uri_t.rst

@@ -45,7 +45,6 @@ struct _mongoc_client_pool_t {
    mongoc_queue_t queue;
    mongoc_topology_t *topology;
    mongoc_uri_t *uri;
-   uint32_t min_pool_size;
    uint32_t max_pool_size;
    uint32_t size;
 #ifdef MONGOC_ENABLE_SSL
@@ -166,23 +165,13 @@ mongoc_client_pool_new_with_error (const mongoc_uri_t *uri, bson_error_t *error)
    mongoc_cond_init (&pool->cond);
    _mongoc_queue_init (&pool->queue);
    pool->uri = mongoc_uri_copy (uri);
-   pool->min_pool_size = 0;
    pool->max_pool_size = 100;
    pool->size = 0;
    pool->topology = topology;
    pool->error_api_version = MONGOC_ERROR_API_VERSION_LEGACY;
 
    b = mongoc_uri_get_options (pool->uri);
 
-   if (bson_iter_init_find_case (&iter, b, MONGOC_URI_MINPOOLSIZE)) {
-      MONGOC_WARNING (MONGOC_URI_MINPOOLSIZE " is deprecated; its behavior does not match its name, and its actual"
-                                             " behavior will likely hurt performance.");
-
-      if (BSON_ITER_HOLDS_INT32 (&iter)) {
-         pool->min_pool_size = BSON_MAX (0, bson_iter_int32 (&iter));
-      }
-   }
-
    if (bson_iter_init_find_case (&iter, b, MONGOC_URI_MAXPOOLSIZE)) {
       if (BSON_ITER_HOLDS_INT32 (&iter)) {
          pool->max_pool_size = BSON_MAX (1, bson_iter_int32 (&iter));
@@ -477,15 +466,6 @@ mongoc_client_pool_push (mongoc_client_pool_t *pool, mongoc_client_t *client)
    // Push client back into pool.
    _mongoc_queue_push_head (&pool->queue, client);
 
-   if (pool->min_pool_size && _mongoc_queue_get_length (&pool->queue) > pool->min_pool_size) {
-      mongoc_client_t *old_client;
-      old_client = (mongoc_client_t *) _mongoc_queue_pop_tail (&pool->queue);
-      if (old_client) {
-         mongoc_client_destroy (old_client);
-         pool->size--;
-      }
-   }
-
    mongoc_cond_signal (&pool->cond);
    bson_mutex_unlock (&pool->mutex);
 
@@ -556,22 +536,6 @@ mongoc_client_pool_max_size (mongoc_client_pool_t *pool, uint32_t max_pool_size)
    EXIT;
 }
 
-void
-mongoc_client_pool_min_size (mongoc_client_pool_t *pool, uint32_t min_pool_size)
-{
-   ENTRY;
-   BSON_ASSERT_PARAM (pool);
-
-   MONGOC_WARNING ("mongoc_client_pool_min_size is deprecated; its behavior does not match"
-                   " its name, and its actual behavior will likely hurt performance.");
-
-   bson_mutex_lock (&pool->mutex);
-   pool->min_pool_size = min_pool_size;
-   bson_mutex_unlock (&pool->mutex);
-
-   EXIT;
-}
-
 bool
 mongoc_client_pool_set_apm_callbacks (mongoc_client_pool_t *pool, mongoc_apm_callbacks_t *callbacks, void *context)
 {

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

@@ -59,9 +59,6 @@ mongoc_client_pool_try_pop (mongoc_client_pool_t *pool) BSON_GNUC_WARN_UNUSED_RE
 MONGOC_EXPORT (void)
 mongoc_client_pool_max_size (mongoc_client_pool_t *pool, uint32_t max_pool_size);
 
-BSON_DEPRECATED ("Setting min_pool_size on a client pool is deprecated")
-MONGOC_EXPORT (void) mongoc_client_pool_min_size (mongoc_client_pool_t *pool, uint32_t min_pool_size);
-
 #ifdef MONGOC_ENABLE_SSL
 MONGOC_EXPORT (void)
 mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t *pool, const mongoc_ssl_opt_t *opts);

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

@@ -720,9 +720,8 @@ mongoc_uri_option_is_int32 (const char *key)
           !strcasecmp (key, MONGOC_URI_SERVERSELECTIONTIMEOUTMS) ||
           !strcasecmp (key, MONGOC_URI_SOCKETCHECKINTERVALMS) || !strcasecmp (key, MONGOC_URI_SOCKETTIMEOUTMS) ||
           !strcasecmp (key, MONGOC_URI_LOCALTHRESHOLDMS) || !strcasecmp (key, MONGOC_URI_MAXPOOLSIZE) ||
-          !strcasecmp (key, MONGOC_URI_MAXSTALENESSSECONDS) || !strcasecmp (key, MONGOC_URI_MINPOOLSIZE) ||
-          !strcasecmp (key, MONGOC_URI_WAITQUEUETIMEOUTMS) || !strcasecmp (key, MONGOC_URI_ZLIBCOMPRESSIONLEVEL) ||
-          !strcasecmp (key, MONGOC_URI_SRVMAXHOSTS);
+          !strcasecmp (key, MONGOC_URI_MAXSTALENESSSECONDS) || !strcasecmp (key, MONGOC_URI_WAITQUEUETIMEOUTMS) ||
+          !strcasecmp (key, MONGOC_URI_ZLIBCOMPRESSIONLEVEL) || !strcasecmp (key, MONGOC_URI_SRVMAXHOSTS);
 }
 
 bool

src/libmongoc/src/mongoc/mongoc-uri.c

@@ -48,7 +48,6 @@
 #define MONGOC_URI_LOCALTHRESHOLDMS "localthresholdms"
 #define MONGOC_URI_MAXPOOLSIZE "maxpoolsize"
 #define MONGOC_URI_MAXSTALENESSSECONDS "maxstalenessseconds"
-#define MONGOC_URI_MINPOOLSIZE "minpoolsize"
 #define MONGOC_URI_READCONCERNLEVEL "readconcernlevel"
 #define MONGOC_URI_READPREFERENCE "readpreference"
 #define MONGOC_URI_READPREFERENCETAGS "readpreferencetags"

src/libmongoc/src/mongoc/mongoc-uri.h

@@ -174,16 +174,15 @@
       }
     },
     {
-      "description": "Valid connection pool options are parsed correctly, libmongoc version without maxIdleTimeMS",
-      "uri": "mongodb://example.com/?waitQueueTimeoutMS=50000&maxPoolSize=5&minPoolSize=3",
+      "description": "Valid connection pool options are parsed correctly, libmongoc version without maxIdleTimeMS or minPoolSize",
+      "uri": "mongodb://example.com/?waitQueueTimeoutMS=50000&maxPoolSize=5",
       "valid": true,
       "warning": false,
       "hosts": null,
       "auth": null,
       "options": {
         "waitQueueTimeoutMS": 50000,
-        "maxPoolSize": 5,
-        "minPoolSize": 3
+        "maxPoolSize": 5
       }
     }
   ]

src/libmongoc/tests/json/connection_uri/additional-nonspec-tests.json

@@ -100,68 +100,6 @@ test_mongoc_client_pool_min_size_zero (void)
    mongoc_uri_destroy (uri);
 }
 
-static void
-test_mongoc_client_pool_min_size_dispose (void)
-{
-   mongoc_client_pool_t *pool;
-   mongoc_client_t *client;
-   mongoc_uri_t *uri;
-   mongoc_client_t *c0, *c1, *c2, *c3;
-
-   capture_logs (true);
-   uri = mongoc_uri_new ("mongodb://127.0.0.1/?minpoolsize=2");
-   pool = test_framework_client_pool_new_from_uri (uri, NULL);
-
-   c0 = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (c0);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 1);
-
-   c1 = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (c1);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 2);
-
-   c2 = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (c2);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 3);
-
-   c3 = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (c3);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 4);
-
-   mongoc_client_pool_push (pool, c0); /* queue is [c0] */
-   ASSERT_CMPSIZE_T (mongoc_client_pool_num_pushed (pool), ==, (size_t) 1);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 4);
-
-   mongoc_client_pool_push (pool, c1); /* queue is [c1, c0] */
-   ASSERT_CMPSIZE_T (mongoc_client_pool_num_pushed (pool), ==, (size_t) 2);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 4);
-
-   mongoc_client_pool_push (pool, c2); /* queue is [c2, c1] */
-   ASSERT_CMPSIZE_T (mongoc_client_pool_num_pushed (pool), ==, (size_t) 2);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 3);
-
-   mongoc_client_pool_push (pool, c3); /* queue is [c3, c2] */
-   ASSERT_CMPSIZE_T (mongoc_client_pool_num_pushed (pool), ==, (size_t) 2);
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 2);
-
-   /* BSON_ASSERT oldest client was destroyed, newest were stored */
-   client = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (client);
-   BSON_ASSERT (client == c3);
-
-   client = mongoc_client_pool_pop (pool);
-   BSON_ASSERT (client);
-   BSON_ASSERT (client == c2);
-
-   ASSERT_CMPSIZE_T (mongoc_client_pool_get_size (pool), ==, (size_t) 2);
-
-   /* clean up */
-   mongoc_client_pool_push (pool, c2);
-   mongoc_client_pool_push (pool, c3);
-   mongoc_client_pool_destroy (pool);
-   mongoc_uri_destroy (uri);
-}
-
 static void
 test_mongoc_client_pool_set_max_size (void)
 {
@@ -199,50 +137,6 @@ test_mongoc_client_pool_set_max_size (void)
    mongoc_client_pool_destroy (pool);
 }
 
-static void
-test_mongoc_client_pool_set_min_size (void)
-{
-   mongoc_client_pool_t *pool;
-   mongoc_client_t *client;
-   mongoc_uri_t *uri;
-   mongoc_array_t conns;
-   int i;
-
-   _mongoc_array_init (&conns, sizeof client);
-
-   uri = mongoc_uri_new ("mongodb://127.0.0.1/?maxpoolsize=10&minpoolsize=3");
-   capture_logs (true);
-   pool = test_framework_client_pool_new_from_uri (uri, NULL);
-   ASSERT_CAPTURED_LOG ("minpoolsize URI option", MONGOC_LOG_LEVEL_WARNING, "is deprecated");
-
-   for (i = 0; i < 10; i++) {
-      client = mongoc_client_pool_pop (pool);
-      BSON_ASSERT (client);
-      _mongoc_array_append_val (&conns, client);
-      BSON_ASSERT (mlib_cmp (mongoc_client_pool_get_size (pool), ==, i + 1));
-   }
-
-   capture_logs (true);
-   BEGIN_IGNORE_DEPRECATIONS
-   mongoc_client_pool_min_size (pool, 7);
-   END_IGNORE_DEPRECATIONS
-   ASSERT_CAPTURED_LOG (
-      "mongoc_client_pool_min_size", MONGOC_LOG_LEVEL_WARNING, "mongoc_client_pool_min_size is deprecated");
-
-   for (i = 0; i < 10; i++) {
-      client = _mongoc_array_index (&conns, mongoc_client_t *, i);
-      BSON_ASSERT (client);
-      mongoc_client_pool_push (pool, client);
-   }
-
-   BSON_ASSERT (mongoc_client_pool_get_size (pool) == 7);
-
-   _mongoc_array_clear (&conns);
-   _mongoc_array_destroy (&conns);
-   mongoc_uri_destroy (uri);
-   mongoc_client_pool_destroy (pool);
-}
-
 #ifndef MONGOC_ENABLE_SSL
 static void
 test_mongoc_client_pool_ssl_disabled (void)
@@ -661,9 +555,7 @@ test_client_pool_install (TestSuite *suite)
    TestSuite_Add (suite, "/ClientPool/try_pop", test_mongoc_client_pool_try_pop);
    TestSuite_Add (suite, "/ClientPool/pop_timeout", test_mongoc_client_pool_pop_timeout);
    TestSuite_Add (suite, "/ClientPool/min_size_zero", test_mongoc_client_pool_min_size_zero);
-   TestSuite_Add (suite, "/ClientPool/min_size_dispose", test_mongoc_client_pool_min_size_dispose);
    TestSuite_Add (suite, "/ClientPool/set_max_size", test_mongoc_client_pool_set_max_size);
-   TestSuite_Add (suite, "/ClientPool/set_min_size", test_mongoc_client_pool_set_min_size);
 
    TestSuite_Add (suite, "/ClientPool/handshake", test_mongoc_client_pool_handshake);