Merge pull request #366 from puppyofkosh/CDRIVER-1392

ajdavis · ajdavis · commit a840f061fed6 · 2016-08-10T14:23:21.000-04:00
CDRIVER-1392 appname in connection string
diff --git a/src/mongoc/mongoc-client-pool.c b/src/mongoc/mongoc-client-pool.c
@@ -83,6 +83,10 @@ mongoc_client_pool_new (const mongoc_uri_t *uri)
    mongoc_client_pool_t *pool;
    const bson_t *b;
    bson_iter_t iter;
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+   const char *appname;
+#endif
+
 
    ENTRY;
 
@@ -122,6 +126,14 @@ mongoc_client_pool_new (const mongoc_uri_t *uri)
       }
    }
 
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+   appname = mongoc_uri_get_option_as_utf8 (pool->uri, "appname", NULL);
+   if (appname) {
+      /* the appname should have already been validated */
+      BSON_ASSERT (mongoc_client_pool_set_appname (pool, appname));
+   }
+#endif
+
    mongoc_counter_client_pools_active_inc();
 
    RETURN(pool);
diff --git a/src/mongoc/mongoc-client.c b/src/mongoc/mongoc-client.c
@@ -723,6 +723,9 @@ _mongoc_client_new_from_uri (const mongoc_uri_t *uri, mongoc_topology_t *topolog
    const mongoc_read_prefs_t *read_prefs;
    const mongoc_read_concern_t *read_concern;
    const mongoc_write_concern_t *write_concern;
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+   const char *appname;
+#endif
 
    BSON_ASSERT (uri);
 
@@ -750,6 +753,14 @@ _mongoc_client_new_from_uri (const mongoc_uri_t *uri, mongoc_topology_t *topolog
    read_prefs = mongoc_uri_get_read_prefs_t (client->uri);
    client->read_prefs = mongoc_read_prefs_copy (read_prefs);
 
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+   appname = mongoc_uri_get_option_as_utf8 (client->uri, "appname", NULL);
+   if (appname && client->topology->single_threaded) {
+      /* the appname should have already been validated */
+      BSON_ASSERT (mongoc_client_set_appname (client, appname));
+   }
+#endif
+
    mongoc_cluster_init (&client->cluster, client->uri, client);
 
 #ifdef MONGOC_ENABLE_SSL
diff --git a/src/mongoc/mongoc-metadata-private.h b/src/mongoc/mongoc-metadata-private.h
@@ -60,6 +60,7 @@ bool               _mongoc_metadata_build_doc_with_application (bson_t     *doc,
                                                                 const char *application);
 void               _mongoc_metadata_freeze                     (void);
 mongoc_metadata_t *_mongoc_metadata_get                        (void);
+bool               _mongoc_metadata_appname_is_valid           (const char *appname);
 BSON_END_DECLS
 
 #endif
diff --git a/src/mongoc/mongoc-metadata.c b/src/mongoc/mongoc-metadata.c
@@ -314,3 +314,9 @@ _mongoc_metadata_get (void)
 {
    return &gMongocMetadata;
 }
+
+bool
+_mongoc_metadata_appname_is_valid (const char *appname)
+{
+   return strlen (appname) <= MONGOC_METADATA_APPNAME_MAX;
+}
diff --git a/src/mongoc/mongoc-topology-scanner.c b/src/mongoc/mongoc-topology-scanner.c
@@ -763,7 +763,7 @@ bool
 _mongoc_topology_scanner_set_appname (mongoc_topology_scanner_t *ts,
                                       const char                *appname)
 {
-   if (strlen (appname) > MONGOC_METADATA_APPNAME_MAX) {
+   if (!_mongoc_metadata_appname_is_valid (appname)) {
       return false;
    }
 
diff --git a/src/mongoc/mongoc-uri.c b/src/mongoc/mongoc-uri.c
@@ -28,6 +28,7 @@
 #include "mongoc-host-list.h"
 #include "mongoc-host-list-private.h"
 #include "mongoc-log.h"
+#include "mongoc-metadata-private.h"
 #include "mongoc-socket.h"
 #include "mongoc-uri-private.h"
 #include "mongoc-read-concern-private.h"
@@ -634,10 +635,15 @@ mongoc_uri_parse_option (mongoc_uri_t *uri,
       mongoc_read_concern_set_level (uri->read_concern, value);
    } else if (!strcasecmp(key, "authmechanismproperties")) {
       if (!mongoc_uri_parse_auth_mechanism_properties(uri, value)) {
-         bson_free(key);
-         bson_free(value);
-         return false;
+         goto CLEANUP;
+      }
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+   } else if (!strcasecmp (key, "appname")) {
+      if (!mongoc_uri_set_appname (uri, value)) {
+         MONGOC_WARNING ("appname is invalid [appname=%s]", value);
+         goto CLEANUP;
       }
+#endif
    } else {
       bson_append_utf8(&uri->options, key, -1, value, -1);
    }
@@ -1114,6 +1120,37 @@ mongoc_uri_set_auth_source (mongoc_uri_t *uri, const char *value)
    return true;
 }
 
+
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+const char *
+mongoc_uri_get_appname (const mongoc_uri_t *uri)
+{
+   BSON_ASSERT (uri);
+
+   return mongoc_uri_get_option_as_utf8 (uri, "appname", NULL);
+}
+
+
+bool
+mongoc_uri_set_appname (mongoc_uri_t *uri,
+                        const char   *value)
+{
+   BSON_ASSERT (value);
+
+   if (!bson_utf8_validate (value, strlen (value), false)) {
+      return false;
+   }
+
+   if (!_mongoc_metadata_appname_is_valid (value)) {
+      return false;
+   }
+
+   mongoc_uri_bson_append_or_replace_key (&uri->options, "appname", value);
+
+   return true;
+}
+#endif
+
 const bson_t *
 mongoc_uri_get_options (const mongoc_uri_t *uri)
 {
diff --git a/src/mongoc/mongoc-uri.h b/src/mongoc/mongoc-uri.h
@@ -27,6 +27,7 @@
 #include "mongoc-read-prefs.h"
 #include "mongoc-read-concern.h"
 #include "mongoc-write-concern.h"
+#include "mongoc-config.h"
 
 
 #ifndef MONGOC_DEFAULT_PORT
@@ -87,6 +88,11 @@ const bson_t                 *mongoc_uri_get_credentials          (const mongoc_
 const char                   *mongoc_uri_get_auth_source          (const mongoc_uri_t           *uri);
 bool                          mongoc_uri_set_auth_source          (mongoc_uri_t                 *uri,
                                                                    const char                   *value);
+#ifdef MONGOC_EXPERIMENTAL_FEATURES
+const char                   *mongoc_uri_get_appname              (const mongoc_uri_t           *uri);
+bool                          mongoc_uri_set_appname              (mongoc_uri_t                 *uri,
+                                                                   const char                   *value);
+#endif
 const char                   *mongoc_uri_get_auth_mechanism       (const mongoc_uri_t           *uri);
 bool                          mongoc_uri_get_mechanism_properties (const mongoc_uri_t           *uri,
                                                                    bson_t                       *properties);
diff --git a/tests/test-mongoc-client.c b/tests/test-mongoc-client.c
@@ -1981,6 +1981,93 @@ test_client_sends_metadata_pooled (void)
 {
    _test_client_sends_metadata (true);
 }
+
+static void
+test_client_appname (bool pooled,
+                     bool use_uri)
+{
+   mock_server_t *server;
+   request_t *request;
+   mongoc_uri_t *uri;
+   future_t *future;
+   mongoc_client_t *client;
+   mongoc_client_pool_t *pool;
+   const char *const server_reply = "{'ok': 1, 'ismaster': true}";
+   const int heartbeat_ms = 500;
+
+   server = mock_server_new ();
+   mock_server_run (server);
+   uri = mongoc_uri_copy (mock_server_get_uri (server));
+   mongoc_uri_set_option_as_int32 (uri, "heartbeatFrequencyMS", heartbeat_ms);
+
+   if (use_uri) {
+      mongoc_uri_set_option_as_utf8 (uri, "appname", "testapp");
+   }
+
+   if (pooled) {
+      pool = mongoc_client_pool_new (uri);
+      if (!use_uri) {
+         ASSERT (mongoc_client_pool_set_appname (pool, "testapp"));
+      }
+      client = mongoc_client_pool_pop (pool);
+   } else {
+      client = mongoc_client_new_from_uri (uri);
+      if (!use_uri) {
+         ASSERT (mongoc_client_set_appname (client, "testapp"));
+      }
+      future = _force_ismaster_with_ping (client, heartbeat_ms);
+   }
+
+   request = mock_server_receives_command (
+      server, "admin", MONGOC_QUERY_SLAVE_OK,
+      "{'isMaster': 1,"
+      " 'client': {"
+      "    'application': {"
+      "       'name': 'testapp'}}}");
+
+   mock_server_replies_simple (request, server_reply);
+   if (!pooled) {
+      _respond_to_ping (future, server);
+   }
+
+   request_destroy (request);
+
+   /* cleanup */
+   if (pooled) {
+      mongoc_client_pool_push (pool, client);
+      mongoc_client_pool_destroy (pool);
+   } else {
+      mongoc_client_destroy (client);
+   }
+
+   mongoc_uri_destroy (uri);
+   mock_server_destroy (server);
+}
+
+static void
+test_client_appname_single_uri (void)
+{
+   test_client_appname (false, true);
+}
+
+static void
+test_client_appname_single_no_uri (void)
+{
+   test_client_appname (false, false);
+}
+
+static void
+test_client_appname_pooled_uri (void)
+{
+   test_client_appname (true, true);
+}
+
+static void
+test_client_appname_pooled_no_uri (void)
+{
+   test_client_appname (true, false);
+}
+
 #endif
 
 void
@@ -2038,6 +2125,14 @@ test_client_install (TestSuite *suite)
                   test_client_sends_metadata_single);
    TestSuite_Add (suite, "/Client/sends_metadata_pooled",
                   test_client_sends_metadata_pooled);
+   TestSuite_Add (suite, "/Client/appname_single_uri",
+                  test_client_appname_single_uri);
+   TestSuite_Add (suite, "/Client/appname_single_no_uri",
+                  test_client_appname_single_no_uri);
+   TestSuite_Add (suite, "/Client/appname_pooled_uri",
+                  test_client_appname_pooled_uri);
+   TestSuite_Add (suite, "/Client/appname_pooled_no_uri",
+                  test_client_appname_pooled_no_uri);
 #endif
 
 #ifdef TODO_CDRIVER_689
diff --git a/tests/test-mongoc-metadata.c b/tests/test-mongoc-metadata.c
@@ -40,6 +40,73 @@ _reset_metadata (void)
    _mongoc_metadata_init ();
 }
 
+static void
+test_mongoc_metadata_appname_in_uri (void)
+{
+   char long_string[MONGOC_METADATA_APPNAME_MAX + 2];
+   char *uri_str;
+   const char *good_uri = "mongodb://host/?appname=mongodump";
+   mongoc_uri_t *uri;
+   const char *appname = "mongodump";
+
+   memset (long_string, 'a', MONGOC_METADATA_APPNAME_MAX + 1);
+   long_string[MONGOC_METADATA_APPNAME_MAX + 1] = '\0';
+
+   /* Shouldn't be able to set with appname really long */
+   capture_logs (true);
+   uri_str = bson_strdup_printf ("mongodb://a/?appname=%s", long_string);
+   ASSERT (!mongoc_client_new (uri_str));
+   capture_logs (false);
+
+   uri = mongoc_uri_new (good_uri);
+   ASSERT (uri);
+   appname = mongoc_uri_get_appname (uri);
+   ASSERT (appname);
+   ASSERT (!strcmp (appname, appname));
+   mongoc_uri_destroy (uri);
+
+   uri = mongoc_uri_new (NULL);
+   ASSERT (uri);
+   ASSERT (!mongoc_uri_set_appname (uri, long_string));
+   ASSERT (mongoc_uri_set_appname (uri, appname));
+   appname = mongoc_uri_get_appname (uri);
+   ASSERT (appname);
+   ASSERT (!strcmp (appname, appname));
+   mongoc_uri_destroy (uri);
+
+   bson_free (uri_str);
+}
+
+static void
+test_mongoc_metadata_appname_frozen_single (void)
+{
+   mongoc_client_t *client;
+   const char *good_uri = "mongodb://host/?appname=mongodump";
+
+   client = mongoc_client_new (good_uri);
+
+   /* Shouldn't be able to set appname again */
+   ASSERT (!mongoc_client_set_appname (client, "a"));
+
+   mongoc_client_destroy (client);
+}
+
+static void
+test_mongoc_metadata_appname_frozen_pooled (void)
+{
+   mongoc_client_pool_t *pool;
+   const char *good_uri = "mongodb://host/?appname=mongodump";
+   mongoc_uri_t *uri;
+
+   uri = mongoc_uri_new (good_uri);
+
+   pool = mongoc_client_pool_new (uri);
+   ASSERT (!mongoc_client_pool_set_appname (pool, "test"));
+
+   mongoc_client_pool_destroy (pool);
+   mongoc_uri_destroy (uri);
+}
+
 static void
 test_mongoc_metadata_append_success (void)
 {
@@ -71,6 +138,7 @@ test_mongoc_metadata_append_success (void)
    mock_server_run (server);
    uri = mongoc_uri_copy (mock_server_get_uri (server));
    mongoc_uri_set_option_as_int32 (uri, "heartbeatFrequencyMS", 500);
+   mongoc_uri_set_option_as_utf8 (uri, "appname", "testapp");
    pool = mongoc_client_pool_new (uri);
 
    /* Force topology scanner to start */
@@ -86,6 +154,14 @@ test_mongoc_metadata_append_success (void)
    ASSERT (bson_iter_init_find (&iter, request_doc, METADATA_FIELD));
    ASSERT (bson_iter_recurse (&iter, &md_iter));
 
+   ASSERT (bson_iter_find (&md_iter, "application"));
+   ASSERT (BSON_ITER_HOLDS_DOCUMENT (&md_iter));
+   ASSERT (bson_iter_recurse (&md_iter, &inner_iter));
+   ASSERT (bson_iter_find (&inner_iter, "name"));
+   val = bson_iter_utf8 (&inner_iter, NULL);
+   ASSERT (val);
+   ASSERT (!strcmp (val, "testapp"));
+
    /* Make sure driver.name and driver.version and platform are all right */
    ASSERT (bson_iter_find (&md_iter, "driver"));
    ASSERT (BSON_ITER_HOLDS_DOCUMENT (&md_iter));
@@ -321,6 +397,13 @@ test_mongoc_metadata_cannot_send (void)
 void
 test_metadata_install (TestSuite *suite)
 {
+   TestSuite_Add (suite, "/ClientMetadata/appname_in_uri",
+                  test_mongoc_metadata_appname_in_uri);
+   TestSuite_Add (suite, "/ClientMetadata/appname_frozen_single",
+                  test_mongoc_metadata_appname_frozen_single);
+   TestSuite_Add (suite, "/ClientMetadata/appname_frozen_pooled",
+                  test_mongoc_metadata_appname_frozen_pooled);
+
    TestSuite_Add (suite, "/ClientMetadata/success",
                   test_mongoc_metadata_append_success);
    TestSuite_Add (suite, "/ClientMetadata/failure",

Original file line number	Diff line number	Diff line change
`@@ -314,3 +314,9 @@ _mongoc_metadata_get (void)`
`314`	`314`	`{`
`315`	`315`	`return &gMongocMetadata;`
`316`	`316`	`}`
	`317`	`+`
	`318`	`+bool`
	`319`	`+_mongoc_metadata_appname_is_valid (const char *appname)`
	`320`	`+{`
	`321`	`+ return strlen (appname) <= MONGOC_METADATA_APPNAME_MAX;`
	`322`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -763,7 +763,7 @@ bool`
`763`	`763`	`_mongoc_topology_scanner_set_appname (mongoc_topology_scanner_t *ts,`
`764`	`764`	`const char *appname)`
`765`	`765`	`{`
`766`		`- if (strlen (appname) > MONGOC_METADATA_APPNAME_MAX) {`
	`766`	`+ if (!_mongoc_metadata_appname_is_valid (appname)) {`
`767`	`767`	`return false;`
`768`	`768`	`}`
`769`	`769`