CDRIVER-2581 improve opmsg cmd error msgs

Author: kevinAlbs

src/mongoc/mongoc-cluster.c

@@ -146,9 +146,8 @@ _bson_error_message_printf (bson_error_t *error, const char *format, ...)
    }
 }
 
-#define RUN_CMD_ERR(_domain, _code, _msg)                          \
+#define RUN_CMD_ERR_DECORATE                                       \
    do {                                                            \
-      bson_set_error (error, _domain, _code, _msg);                \
       _bson_error_message_printf (                                 \
          error,                                                    \
          "Failed to send \"%s\" command with database \"%s\": %s", \
@@ -157,6 +156,11 @@ _bson_error_message_printf (bson_error_t *error, const char *format, ...)
          error->message);                                          \
    } while (0)
 
+#define RUN_CMD_ERR(_domain, _code, ...)                   \
+   do {                                                    \
+      bson_set_error (error, _domain, _code, __VA_ARGS__); \
+      RUN_CMD_ERR_DECORATE;                                \
+   } while (0)
 
 /*
  *--------------------------------------------------------------------------
@@ -259,13 +263,7 @@ mongoc_cluster_run_command_opquery (mongoc_cluster_t *cluster,
       mongoc_cluster_disconnect_node (cluster, server_id, true, error);
 
       /* add info about the command to writev_full's error message */
-      _bson_error_message_printf (
-         error,
-         "Failed to send \"%s\" command with database \"%s\": %s",
-         cmd->command_name,
-         cmd->db_name,
-         error->message);
-
+      RUN_CMD_ERR_DECORATE;
       GOTO (done);
    }
 
@@ -2579,6 +2577,8 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
                                     cluster->sockettimeoutms,
                                     error);
    if (!ok) {
+      /* add info about the command to writev_full's error message */
+      RUN_CMD_ERR_DECORATE;
       mongoc_cluster_disconnect_node (
          cluster, server_stream->sd->id, true, error);
       bson_free (output);
@@ -2590,6 +2590,7 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
    ok = _mongoc_buffer_append_from_stream (
       &buffer, server_stream->stream, 4, cluster->sockettimeoutms, error);
    if (!ok) {
+         RUN_CMD_ERR_DECORATE;
       mongoc_cluster_disconnect_node (
          cluster, server_stream->sd->id, true, error);
       bson_free (output);
@@ -2602,8 +2603,7 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
    memcpy (&msg_len, buffer.data, 4);
    msg_len = BSON_UINT32_FROM_LE (msg_len);
    if ((msg_len < 16) || (msg_len > server_stream->sd->max_msg_size)) {
-      bson_set_error (
-         error,
+         RUN_CMD_ERR (
          MONGOC_ERROR_PROTOCOL,
          MONGOC_ERROR_PROTOCOL_INVALID_REPLY,
          "Message size %d is not within expected range 16-%d bytes",
@@ -2623,6 +2623,7 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
                                            cluster->sockettimeoutms,
                                            error);
    if (!ok) {
+         RUN_CMD_ERR_DECORATE;
       mongoc_cluster_disconnect_node (
          cluster, server_stream->sd->id, true, error);
       bson_free (output);
@@ -2633,8 +2634,7 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
 
    ok = _mongoc_rpc_scatter (&rpc, buffer.data, buffer.len);
    if (!ok) {
-      bson_set_error (error,
-                      MONGOC_ERROR_PROTOCOL,
+         RUN_CMD_ERR (MONGOC_ERROR_PROTOCOL,
                       MONGOC_ERROR_PROTOCOL_INVALID_REPLY,
                       "Malformed message from server");
       bson_free (output);
@@ -2648,8 +2648,7 @@ mongoc_cluster_run_opmsg (mongoc_cluster_t *cluster,
 
       output = bson_realloc (output, len);
       if (!_mongoc_rpc_decompress (&rpc, (uint8_t *) output, len)) {
-         bson_set_error (error,
-                         MONGOC_ERROR_PROTOCOL,
+            RUN_CMD_ERR (MONGOC_ERROR_PROTOCOL,
                          MONGOC_ERROR_PROTOCOL_INVALID_REPLY,
                          "Could not decompress message from server");
          mongoc_cluster_disconnect_node (

tests/test-mongoc-cluster.c

@@ -1378,6 +1378,69 @@ test_cluster_ismaster_hangup (void)
    _test_cluster_ismaster_fails (true);
 }
 
+static void
+_test_cluster_command_error (bool use_op_msg)
+{
+   mock_server_t *server;
+   mongoc_client_t *client;
+   bson_error_t err;
+   request_t *request;
+   future_t *future;
+
+   if (use_op_msg) {
+      server = mock_server_with_autoismaster (WIRE_VERSION_OP_MSG);
+   } else {
+      server = mock_server_with_autoismaster (WIRE_VERSION_OP_MSG - 1);
+   }
+   mock_server_run (server);
+   client = mongoc_client_new_from_uri (mock_server_get_uri (server));
+   future = future_client_command_simple (client,
+                                          "db",
+                                          tmp_bson ("{'ping': 1}"),
+                                          NULL /* opts */,
+                                          NULL /* read prefs */,
+                                          &err);
+   if (use_op_msg) {
+      request = mock_server_receives_msg (
+         server, MONGOC_QUERY_NONE, tmp_bson ("{'ping': 1}"));
+   } else {
+      request = mock_server_receives_command (
+         server, "db", MONGOC_QUERY_SLAVE_OK, "{'ping': 1}");
+   }
+   mock_server_hangs_up (request);
+   BSON_ASSERT (!future_get_bool (future));
+   future_destroy (future);
+   request_destroy (request);
+   if (use_op_msg) {
+      /* _mongoc_buffer_append_from_stream, used by opmsg gives more detail. */
+      ASSERT_ERROR_CONTAINS (err,
+                             MONGOC_ERROR_STREAM,
+                             MONGOC_ERROR_STREAM_SOCKET,
+                             "Failed to send \"ping\" command with database "
+                             "\"db\": Failed to read 4 bytes: socket error or "
+                             "timeout");
+   } else {
+      ASSERT_ERROR_CONTAINS (err,
+                             MONGOC_ERROR_STREAM,
+                             MONGOC_ERROR_STREAM_SOCKET,
+                             "Failed to send \"ping\" command with database "
+                             "\"db\": socket error or timeout");
+   }
+   mock_server_destroy (server);
+   mongoc_client_destroy (client);
+}
+
+static void
+test_cluster_command_error_op_msg ()
+{
+   _test_cluster_command_error (true);
+}
+
+static void
+test_cluster_command_error_op_query ()
+{
+   _test_cluster_command_error (false);
+}
 
 void
 test_cluster_install (TestSuite *suite)
@@ -1503,4 +1566,10 @@ test_cluster_install (TestSuite *suite)
       suite, "/Cluster/ismaster_fails", test_cluster_ismaster_fails);
    TestSuite_AddMockServerTest (
       suite, "/Cluster/ismaster_hangup", test_cluster_ismaster_hangup);
+   TestSuite_AddMockServerTest (suite,
+                                "/Cluster/command_error/op_msg",
+                                test_cluster_command_error_op_msg);
+   TestSuite_AddMockServerTest (suite,
+                                "/Cluster/command_error/op_query",
+                                test_cluster_command_error_op_query);
 }