CDRIVER-3929 Include apiVersion in handshake commands

Author: alcaeus

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

@@ -529,5 +529,6 @@ mongoc_client_pool_set_server_api (mongoc_client_pool_t *pool,
    }
 
    pool->api = mongoc_server_api_copy (api);
+   _mongoc_topology_scanner_set_server_api (pool->topology->scanner, api);
    return true;
 }

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

@@ -3114,5 +3114,6 @@ mongoc_client_set_server_api (mongoc_client_t *client,
    }
 
    client->api = mongoc_server_api_copy (api);
+   _mongoc_topology_scanner_set_server_api (client->topology->scanner, api);
    return true;
 }

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

@@ -146,6 +146,10 @@ _is_retryable_read (const mongoc_cmd_parts_t *parts,
 void
 _mongoc_cmd_append_payload_as_array (const mongoc_cmd_t *cmd, bson_t *out);
 
+void
+_mongoc_cmd_append_server_api (bson_t *command_body,
+                               const mongoc_server_api_t *api);
+
 BSON_END_DECLS
 
 

src/libmongoc/src/mongoc/mongoc-cmd.c

@@ -827,14 +827,12 @@ mongoc_cmd_parts_assemble (mongoc_cmd_parts_t *parts,
                            bson_error_t *error)
 {
    mongoc_server_description_type_t server_type;
-   mongoc_server_api_t *api;
    mongoc_client_session_t *cs;
    const bson_t *cluster_time = NULL;
    mongoc_read_prefs_t *prefs = NULL;
    const char *cmd_name;
    bool is_get_more;
    const mongoc_read_prefs_t *prefs_ptr;
-   const char *string_version;
    bool ret = false;
 
    ENTRY;
@@ -994,23 +992,8 @@ mongoc_cmd_parts_assemble (mongoc_cmd_parts_t *parts,
          sending a getmore, or if we are in a transaction. */
       if (parts->client->api) {
          if (!is_get_more && !_txn_in_progress (parts)) {
-            api = parts->client->api;
-            string_version = mongoc_server_api_version_to_string (api->version);
-
-            bson_append_utf8 (
-               &parts->assembled_body, "apiVersion", -1, string_version, -1);
-
-            if (api->strict_set) {
-               bson_append_bool (
-                  &parts->assembled_body, "apiStrict", -1, api->strict);
-            }
-
-            if (api->deprecation_errors_set) {
-               bson_append_bool (&parts->assembled_body,
-                                 "apiDeprecationErrors",
-                                 -1,
-                                 api->deprecation_errors);
-            }
+            _mongoc_cmd_append_server_api (&parts->assembled_body,
+                                           parts->client->api);
          }
       }
 
@@ -1155,3 +1138,39 @@ _mongoc_cmd_append_payload_as_array (const mongoc_cmd_t *cmd, bson_t *out)
 
    bson_append_array_end (out, &bson);
 }
+
+/*--------------------------------------------------------------------------
+ *
+ * _mongoc_cmd_append_server_api --
+ *    Append versioned API fields to a mongoc_cmd_t
+ *
+ * Arguments:
+ *    cmd The mongoc_cmd_t, which will have versioned API fields added
+ *    api A mongoc_server_api_t holding server API information
+ *
+ * Pre-conditions:
+ *    - @api is initialized.
+ *
+ *--------------------------------------------------------------------------
+ */
+void
+_mongoc_cmd_append_server_api (bson_t *command_body,
+                               const mongoc_server_api_t *api)
+{
+   const char *string_version;
+
+   BSON_ASSERT (api);
+
+   string_version = mongoc_server_api_version_to_string (api->version);
+
+   bson_append_utf8 (command_body, "apiVersion", -1, string_version, -1);
+
+   if (api->strict_set) {
+      bson_append_bool (command_body, "apiStrict", -1, api->strict);
+   }
+
+   if (api->deprecation_errors_set) {
+      bson_append_bool (
+         command_body, "apiDeprecationErrors", -1, api->deprecation_errors);
+   }
+}

src/libmongoc/src/mongoc/mongoc-topology-scanner-private.h

@@ -109,6 +109,8 @@ typedef struct mongoc_topology_scanner {
    bool negotiate_sasl_supported_mechs;
    bool bypass_cooldown;
    bool speculative_authentication;
+
+   mongoc_server_api_t *api;
 } mongoc_topology_scanner_t;
 
 mongoc_topology_scanner_t *
@@ -223,6 +225,10 @@ bool
 mongoc_topology_scanner_node_in_cooldown (mongoc_topology_scanner_node_t *node,
                                           int64_t when);
 
+void
+_mongoc_topology_scanner_set_server_api (mongoc_topology_scanner_t *ts,
+                                         const mongoc_server_api_t *api);
+
 /* for testing. */
 mongoc_stream_t *
 _mongoc_topology_scanner_tcp_initiate (mongoc_async_cmd_t *acmd);

src/libmongoc/src/mongoc/mongoc-topology-scanner.c

@@ -104,9 +104,22 @@ _jumpstart_other_acmds (mongoc_topology_scanner_node_t *node,
                         mongoc_async_cmd_t *acmd);
 
 static void
-_add_ismaster (bson_t *cmd)
+_add_ismaster (bson_t *cmd, const mongoc_server_api_t *api)
 {
    BSON_APPEND_INT32 (cmd, "isMaster", 1);
+
+   if (api) {
+      _mongoc_cmd_append_server_api (cmd, api);
+   }
+}
+
+static void
+_reset_ismaster (mongoc_topology_scanner_t *ts)
+{
+   bson_init (&ts->ismaster_cmd);
+   _add_ismaster (&ts->ismaster_cmd, ts->api);
+   bson_init (&ts->ismaster_cmd_with_handshake);
+   bson_init (&ts->cluster_time);
 }
 
 const char *
@@ -226,7 +239,7 @@ _build_ismaster_with_handshake (mongoc_topology_scanner_t *ts)
    int count = 0;
    char buf[16];
 
-   _add_ismaster (doc);
+   _add_ismaster (doc, ts->api);
 
    BSON_APPEND_DOCUMENT_BEGIN (doc, HANDSHAKE_FIELD, &subdoc);
    res = _mongoc_handshake_build_doc_with_application (&subdoc, ts->appname);
@@ -346,21 +359,19 @@ mongoc_topology_scanner_new (
 
    ts->async = mongoc_async_new ();
 
-   bson_init (&ts->ismaster_cmd);
-   _add_ismaster (&ts->ismaster_cmd);
-   bson_init (&ts->ismaster_cmd_with_handshake);
-   bson_init (&ts->cluster_time);
-
    ts->setup_err_cb = setup_err_cb;
    ts->cb = cb;
    ts->cb_data = data;
    ts->uri = uri;
    ts->appname = NULL;
+   ts->api = NULL;
    ts->handshake_ok_to_send = false;
    ts->connect_timeout_msec = connect_timeout_msec;
    /* may be overridden for testing. */
    ts->dns_cache_timeout_ms = DNS_CACHE_TIMEOUT_MS;
 
+   _reset_ismaster (ts);
+
    return ts;
 }
 
@@ -399,6 +410,10 @@ mongoc_topology_scanner_destroy (mongoc_topology_scanner_t *ts)
    bson_destroy (&ts->ismaster_cmd_with_handshake);
    bson_destroy (&ts->cluster_time);
 
+   if (ts->api) {
+      mongoc_server_api_destroy (ts->api);
+   }
+
    /* This field can be set by a mongoc_client */
    bson_free ((char *) ts->appname);
 
@@ -1324,3 +1339,20 @@ _jumpstart_other_acmds (mongoc_topology_scanner_node_t *node,
       }
    }
 }
+
+void
+_mongoc_topology_scanner_set_server_api (mongoc_topology_scanner_t *ts,
+                                         const mongoc_server_api_t *api)
+{
+   mongoc_server_api_t *prev_api;
+
+   BSON_ASSERT (api);
+
+   prev_api = ts->api;
+   ts->api = mongoc_server_api_copy (api);
+   _reset_ismaster (ts);
+
+   if (prev_api) {
+      mongoc_server_api_destroy (prev_api);
+   }
+}

src/libmongoc/tests/test-mongoc-topology.c

@@ -3,6 +3,7 @@
 #include <mongoc/mongoc-client-pool-private.h>
 
 #include "mongoc/mongoc-client-private.h"
+#include "mongoc/mongoc-server-api-private.h"
 #include "mongoc/mongoc-util-private.h"
 #include "mongoc/mongoc-topology-background-monitoring-private.h"
 #include "TestSuite.h"
@@ -2202,6 +2203,94 @@ test_slow_server_pooled (void)
    mock_server_destroy (primary);
    checks_cleanup (&checks);
 }
+
+static void
+_test_ismaster_versioned_api (bool pooled)
+{
+   mock_server_t *server;
+   mongoc_uri_t *uri;
+   mongoc_client_pool_t *pool;
+   mongoc_client_t *client;
+   char *ismaster;
+   future_t *future;
+   request_t *request;
+   bson_error_t error;
+   mongoc_server_api_version_t version;
+   mongoc_server_api_t *api;
+
+   server = mock_server_new ();
+   mock_server_run (server);
+   uri = mongoc_uri_copy (mock_server_get_uri (server));
+
+   mongoc_server_api_version_from_string ("1", &version);
+   api = mongoc_server_api_new (version);
+
+   if (pooled) {
+      pool = mongoc_client_pool_new (uri);
+      ASSERT_OR_PRINT (mongoc_client_pool_set_server_api (pool, api, &error),
+                       error);
+
+      client = mongoc_client_pool_pop (pool);
+   } else {
+      client = mongoc_client_new_from_uri (uri);
+      ASSERT_OR_PRINT (mongoc_client_set_server_api (client, api, &error),
+                       error);
+   }
+
+   ismaster = bson_strdup_printf ("{'ok': 1,"
+                                  " 'ismaster': true,"
+                                  " 'setName': 'rs',"
+                                  "  'minWireVersion': 2,"
+                                  "  'maxWireVersion': 5,"
+                                  " 'hosts': ['%s']}",
+                                  mock_server_get_host_and_port (server));
+
+   /* For client pools, the first handshake happens when the client is popped.
+    * For non-pooled clients, send a ping command to trigger a handshake. */
+   if (!pooled) {
+      future = future_client_command_simple (
+         client, "admin", tmp_bson ("{'ping': 1}"), NULL, NULL, &error);
+   }
+
+   request = mock_server_receives_ismaster (server);
+   BSON_ASSERT (request);
+   BSON_ASSERT (bson_has_field (request_get_doc (request, 0), "apiVersion"));
+   mock_server_replies_simple (request, ismaster);
+   request_destroy (request);
+
+   if (!pooled) {
+      request = mock_server_receives_command (
+         server, "admin", MONGOC_QUERY_SLAVE_OK, "{'ping': 1}");
+      mock_server_replies_ok_and_destroys (request);
+      BSON_ASSERT (future_get_bool (future));
+      future_destroy (future);
+   }
+
+   if (pooled) {
+      mongoc_client_pool_push (pool, client);
+      mongoc_client_pool_destroy (pool);
+   } else {
+      mongoc_client_destroy (client);
+   }
+
+   mongoc_server_api_destroy (api);
+   mongoc_uri_destroy (uri);
+   mock_server_destroy (server);
+   bson_free (ismaster);
+}
+
+static void
+test_ismaster_versioned_api_single ()
+{
+   _test_ismaster_versioned_api (false);
+}
+
+static void
+test_ismaster_versioned_api_pooled ()
+{
+   _test_ismaster_versioned_api (true);
+}
+
 void
 test_topology_install (TestSuite *suite)
 {
@@ -2356,4 +2445,11 @@ test_topology_install (TestSuite *suite)
                                 test_last_server_removed_warning);
    TestSuite_AddMockServerTest (
       suite, "/Topology/slow_server/pooled", test_slow_server_pooled);
+
+   TestSuite_AddMockServerTest (suite,
+                                "/Topology/ismaster/versioned_api/single",
+                                test_ismaster_versioned_api_single);
+   TestSuite_AddMockServerTest (suite,
+                                "/Topology/ismaster/versioned_api/pooled",
+                                test_ismaster_versioned_api_pooled);
 }