Append topology type to error

Author: adriandole

src/libbson/tests/test-bcon-basic.c

@@ -293,7 +293,7 @@ test_int32 (void)
    bson_init (&bcon);
    bson_init (&expected);
 
-   bson_append_int32 (&expected, "foobar", 3, 100);
+   bson_append_int32 (&expected, "foo", -1, 100);
 
    BCON_APPEND (&bcon, "foo", BCON_INT32 (100));
 

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

@@ -97,4 +97,8 @@ _mongoc_error_is_server (const bson_error_t *error);
 bool
 _mongoc_error_is_auth (const bson_error_t *error);
 
+/* Try to append `s` to `error`. Truncates `s` if `error` is out of space. */
+void
+_mongoc_error_append (bson_error_t *error, const char *s);
+
 BSON_END_DECLS

src/libmongoc/src/mongoc/mongoc-error.c

@@ -327,3 +327,12 @@ _mongoc_error_is_auth (const bson_error_t *error)
    return error->domain == MONGOC_ERROR_CLIENT &&
           error->code == MONGOC_ERROR_CLIENT_AUTHENTICATE;
 }
+
+void
+_mongoc_error_append (bson_error_t *error, const char *s)
+{
+   BSON_ASSERT (error);
+   const size_t error_len = strlen (error->message);
+   const size_t remaining = sizeof (error->message) - error_len;
+   bson_strncpy (error->message + error_len, s, remaining);
+}

src/libmongoc/src/mongoc/mongoc-server-description-private.h

@@ -241,8 +241,4 @@ bool
 mongoc_server_description_has_service_id (
    const mongoc_server_description_t *description);
 
-/* Generate human-readable description of the server */
-bson_string_t *
-mongoc_server_description_info (const mongoc_server_description_t *sd);
-
 #endif

src/libmongoc/src/mongoc/mongoc-server-description.c

@@ -1281,15 +1281,3 @@ mongoc_server_description_has_service_id (
    }
    return true;
 }
-
-bson_string_t *
-mongoc_server_description_info (const mongoc_server_description_t *sd)
-{
-   bson_string_t *info = bson_string_new (NULL);
-   bson_string_append_printf (info,
-                              "%s server_type: %s, rtt: %ld",
-                              sd->host.host_and_port,
-                              mongoc_server_description_type (sd),
-                              sd->round_trip_time_msec);
-   return info;
-}

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

@@ -55,7 +55,6 @@ struct _mongoc_topology_description_t {
     * see Driver Sessions Spec. */
    bson_t cluster_time;
 
-
    /* smallest seen logicalSessionTimeoutMinutes, or -1 if any server has no
     * logicalSessionTimeoutMinutes. see Server Discovery and Monitoring Spec */
    int64_t session_timeout_minutes;
@@ -195,9 +194,4 @@ _mongoc_topology_description_clear_connection_pool (
    uint32_t server_id,
    const bson_oid_t *service_id);
 
-
-/* Generate human-readable description of the topology */
-bson_string_t *
-_mongoc_topology_description_info (const mongoc_topology_description_t *td);
-
 #endif /* MONGOC_TOPOLOGY_DESCRIPTION_PRIVATE_H */

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

@@ -2602,32 +2602,3 @@ _mongoc_topology_description_clear_connection_pool (
 
    mc_tpl_sd_increment_generation (sd, service_id);
 }
-
-bool
-_append_server_info (void *sd, void *info)
-{
-   bson_string_t *server_info =
-      mongoc_server_description_info ((mongoc_server_description_t *) sd);
-   bson_string_append_printf (
-      (bson_string_t *) info, "<%s>, ", server_info->str);
-   bson_string_free (server_info, true);
-   return true;
-}
-
-bson_string_t *
-_mongoc_topology_description_info (const mongoc_topology_description_t *td)
-{
-   bson_string_t *info = bson_string_new (NULL);
-   if (!td->_servers_ || td->_servers_->items_len == 0) {
-      bson_string_append (info, "No available servers.");
-      return info;
-   }
-
-   bson_string_append_printf (info,
-                              "Topology type: %s, servers: [",
-                              mongoc_topology_description_type (td));
-   mongoc_set_for_each (td->_servers_, _append_server_info, (void *) info);
-   bson_string_append_c (info, ']');
-
-   return info;
-}

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

@@ -1168,6 +1168,9 @@ mongoc_topology_select_server_id (mongoc_topology_t *topology,
                                   bool *must_use_primary,
                                   bson_error_t *error)
 {
+   static const char *timeout_msg =
+      "No suitable servers found: `serverSelectionTimeoutMS` expired";
+
    mongoc_topology_scanner_t *ts;
    int r;
    int64_t local_threshold_ms;
@@ -1179,8 +1182,10 @@ mongoc_topology_select_server_id (mongoc_topology_t *topology,
    int64_t heartbeat_msec;
    uint32_t server_id;
    mc_shared_tpld td = mc_tpld_take_ref (topology);
-   const char *timeout_msg =
-      "No suitable servers found: `serverSelectionTimeoutMS` expired.";
+
+   bson_string_t *topology_type = bson_string_new (". Topology type: ");
+   bson_string_append (topology_type,
+                       mongoc_topology_description_type (td.ptr));
 
    /* These names come from the Server Selection Spec pseudocode */
    int64_t loop_start;  /* when we entered this function */
@@ -1241,15 +1246,10 @@ mongoc_topology_select_server_id (mongoc_topology_t *topology,
 
             if (scan_ready > expire_at && !try_once) {
                /* selection timeout will expire before min heartbeat passes */
-               bson_string_t *topology_info =
-                  _mongoc_topology_description_info (td.ptr);
-               bson_string_t *msg = bson_string_new_printf (
-                  "%s %s", timeout_msg, topology_info->str);
-               _mongoc_server_selection_error (msg->str, &scanner_error, error);
+               _mongoc_server_selection_error (
+                  timeout_msg, &scanner_error, error);
 
                server_id = 0;
-               bson_string_free (topology_info, true);
-               bson_string_free (msg, true);
                goto done;
             }
 
@@ -1402,6 +1402,10 @@ mongoc_topology_select_server_id (mongoc_topology_t *topology,
    }
 
 done:
+   if (error) {
+      _mongoc_error_append (error, topology_type->str);
+   }
+   bson_string_free (topology_type, true);
    mc_tpld_drop_ref (&td);
    return server_id;
 }
@@ -1977,7 +1981,6 @@ static void
 _topology_collect_errors (const mongoc_topology_description_t *td,
                           bson_error_t *error_out)
 {
-   // zz
    const mongoc_server_description_t *server_description;
    bson_string_t *error_message;
 
@@ -1993,9 +1996,8 @@ _topology_collect_errors (const mongoc_topology_description_t *td,
          if (error_message->len > 0) {
             bson_string_append_c (error_message, ' ');
          }
-         bson_string_append_printf (error_message,
-                                    "[%s (SERVER TYPE)]",
-                                    server_description->error.message);
+         bson_string_append_printf (
+            error_message, "[%s]", server_description->error.message);
          /* The last error's code and domain wins. */
          error_out->code = error->code;
          error_out->domain = error->domain;

src/libmongoc/tests/test-mongoc-server-selection-errors.c

@@ -93,7 +93,8 @@ test_server_selection_error_dns_direct_single (void)
    server_selection_error_dns (
       "mongodb://example-localhost.invalid:27017/",
       "No suitable servers found (`serverSelectionTryOnce` set): "
-      "[Fake error for 'example-localhost.invalid']",
+      "[Fake error for 'example-localhost.invalid']"
+      ". Topology type: Single",
       false,
       false);
 }
@@ -106,7 +107,8 @@ test_server_selection_error_dns_direct_pooled (void *ctx)
    server_selection_error_dns (
       "mongodb://example-localhost.invalid:27017/",
       "No suitable servers found: `serverSelectionTimeoutMS` expired: "
-      "[Fake error for 'example-localhost.invalid']",
+      "[Fake error for 'example-localhost.invalid']"
+      ". Topology type: Single",
       false,
       true);
 }
@@ -119,7 +121,8 @@ test_server_selection_error_dns_multi_fail_single (void)
       "example-localhost.invalid:27017,other-example-localhost.invalid:27017/",
       "No suitable servers found (`serverSelectionTryOnce` set):"
       " [Fake error for 'example-localhost.invalid']"
-      " [Fake error for 'other-example-localhost.invalid']",
+      " [Fake error for 'other-example-localhost.invalid']"
+      ". Topology type: Unknown",
       false,
       false);
 }
@@ -134,7 +137,8 @@ test_server_selection_error_dns_multi_fail_pooled (void *ctx)
       "example-localhost.invalid:27017,other-example-localhost.invalid:27017/",
       "No suitable servers found: `serverSelectionTimeoutMS` expired:"
       " [Fake error for 'example-localhost.invalid']"
-      " [Fake error for 'other-example-localhost.invalid']",
+      " [Fake error for 'other-example-localhost.invalid']"
+      ". Topology type: Unknown",
       false,
       true);
 }