fix metrics with null username

Author: xiazhvera

source/v5/mqtt5_options_storage.c

@@ -645,7 +645,9 @@ static size_t s_aws_mqtt5_packet_connect_compute_storage_size(
     size_t storage_size = 0;
 
     storage_size += view->client_id.len;
-    if (view->username != NULL) {
+
+    if (view->username != NULL || (options && options->metrics_storage != NULL)) {
+
         if (options) {
             size_t username_size = 0;
             aws_mqtt_append_sdk_metrics_to_username(
@@ -699,17 +701,18 @@ int aws_mqtt5_packet_connect_storage_init(
         return AWS_OP_ERR;
     }
 
-    if (view->username != NULL) {
-        storage->username = *view->username;
+    if (view->username != NULL || (client_options_storage && client_options_storage->metrics_storage != NULL)) {
+        if (view->username) {
+            storage->username = *view->username;
+        }
         struct aws_byte_buf metrics_username_buf;
         AWS_ZERO_STRUCT(metrics_username_buf);
 
         /* Apply metrics to username if configured */
         if (client_options_storage) {
-            struct aws_byte_cursor username_cur = storage->username;
             if (aws_mqtt_append_sdk_metrics_to_username(
                     allocator,
-                    &username_cur,
+                    &storage->username,
                     client_options_storage->metrics_storage ? &client_options_storage->metrics_storage->storage_view
                                                             : NULL,
                     &metrics_username_buf,

tests/CMakeLists.txt

@@ -115,6 +115,7 @@ add_test_case(mqtt_websocket_failed_transform)
 # Connection state tests
 add_test_case(mqtt_connection_set_metrics_valid)
 add_test_case(mqtt_connection_set_metrics_null)
+add_test_case(mqtt_connection_set_metrics_with_null_username)
 add_test_case(mqtt_connection_set_metrics_invalid_utf8_library)
 add_test_case(mqtt_connection_set_metrics_modify_on_reconnect)
 
@@ -414,6 +415,7 @@ add_test_case(mqtt5_client_manual_puback_disconnect_cancellation)
 # Mqtt5 Metrics tests
 add_test_case(mqtt5_client_set_metrics_valid)
 add_test_case(mqtt5_client_set_metrics_null)
+add_test_case(mqtt5_client_set_metrics_with_null_username)
 
 add_test_case(rate_limiter_token_bucket_init_invalid)
 add_test_case(rate_limiter_token_bucket_regeneration_integral)

tests/v3/connection_state_test.c

@@ -4115,10 +4115,15 @@ AWS_TEST_CASE_FIXTURE(
 
 /**
  * helper function to test client with different metrics by checking the received username field
+ * @param allocator The allocator to use
+ * @param metrics The metrics to set (can be NULL to disable metrics)
+ * @param username The username to set (can be NULL to skip setting username)
+ * @param ctx The test context
  */
 static int s_create_mqtt_connection_and_set_metrics(
     struct aws_allocator *allocator,
     struct aws_mqtt_iot_metrics *metrics,
+    struct aws_byte_cursor *username,
     void *ctx) {
     struct mqtt_connection_state_test *state_test_data = ctx;
 
@@ -4131,8 +4136,9 @@ static int s_create_mqtt_connection_and_set_metrics(
         .on_connection_complete = aws_test311_on_connection_complete_fn,
     };
 
-    struct aws_byte_cursor username = aws_byte_cursor_from_c_str("testuser");
-    ASSERT_SUCCESS(aws_mqtt_client_connection_set_login(state_test_data->mqtt_connection, &username, NULL));
+    if (username != NULL) {
+        ASSERT_SUCCESS(aws_mqtt_client_connection_set_login(state_test_data->mqtt_connection, username, NULL));
+    }
 
     ASSERT_SUCCESS(aws_mqtt_client_connection_set_metrics(state_test_data->mqtt_connection, metrics));
 
@@ -4154,9 +4160,9 @@ static int s_create_mqtt_connection_and_set_metrics(
     struct aws_byte_buf expected_buf;
     AWS_ZERO_STRUCT(expected_buf);
     if (metrics) {
-        aws_test_mqtt_build_expected_metrics(allocator, &username, metrics->library_name, NULL, &expected_buf);
-    } else {
-        aws_byte_buf_init_copy_from_cursor(&expected_buf, allocator, username);
+        aws_test_mqtt_build_expected_metrics(allocator, username, metrics->library_name, NULL, &expected_buf);
+    } else if (username != NULL) {
+        aws_byte_buf_init_copy_from_cursor(&expected_buf, allocator, *username);
     }
 
     ASSERT_TRUE(aws_byte_cursor_eq_byte_buf(&received_packet->username, &expected_buf));
@@ -4179,7 +4185,8 @@ static int s_test_mqtt_connection_set_metrics_valid_fn(struct aws_allocator *all
         // .metadata_count = 0,
     };
 
-    ASSERT_SUCCESS(s_create_mqtt_connection_and_set_metrics(allocator, &metrics, ctx));
+    struct aws_byte_cursor username = aws_byte_cursor_from_c_str("testuser");
+    ASSERT_SUCCESS(s_create_mqtt_connection_and_set_metrics(allocator, &metrics, &username, ctx));
 
     return AWS_OP_SUCCESS;
 }
@@ -4196,7 +4203,8 @@ AWS_TEST_CASE_FIXTURE(
  */
 static int s_test_mqtt_connection_set_metrics_null_fn(struct aws_allocator *allocator, void *ctx) {
 
-    ASSERT_SUCCESS(s_create_mqtt_connection_and_set_metrics(allocator, NULL, ctx));
+    struct aws_byte_cursor username = aws_byte_cursor_from_c_str("testuser");
+    ASSERT_SUCCESS(s_create_mqtt_connection_and_set_metrics(allocator, NULL, &username, ctx));
 
     return AWS_OP_SUCCESS;
 }
@@ -4208,6 +4216,27 @@ AWS_TEST_CASE_FIXTURE(
     s_clean_up_mqtt_server_fn,
     &test_data)
 
+static int s_test_mqtt_connection_set_metrics_with_null_username_fn(struct aws_allocator *allocator, void *ctx) {
+
+    struct aws_mqtt_iot_metrics metrics = {
+        .library_name = aws_byte_cursor_from_c_str("TestSDK/1.0"),
+        // TODO: enable metadata testing when metadata support is added
+        // .metadata_entries = NULL,
+        // .metadata_count = 0,
+    };
+
+    ASSERT_SUCCESS(s_create_mqtt_connection_and_set_metrics(allocator, &metrics, NULL, ctx));
+
+    return AWS_OP_SUCCESS;
+}
+
+AWS_TEST_CASE_FIXTURE(
+    mqtt_connection_set_metrics_with_null_username,
+    s_setup_mqtt_server_fn,
+    s_test_mqtt_connection_set_metrics_with_null_username_fn,
+    s_clean_up_mqtt_server_fn,
+    &test_data)
+
 /**
  * Test that aws_mqtt_client_connection_set_metrics rejects invalid UTF-8 in library name
  */

tests/v5/mqtt5_client_tests.c

@@ -6659,6 +6659,7 @@ AWS_TEST_CASE(mqtt5_client_auto_assigned_client_id_iot_core, s_mqtt5_client_auto
 static int s_mqtt5_client_metrics_in_username_fn(
     struct aws_allocator *allocator,
     struct aws_mqtt_iot_metrics *metrics,
+    struct aws_byte_cursor *original_username,
     void *ctx) {
     (void)ctx;
 
@@ -6668,14 +6669,11 @@ static int s_mqtt5_client_metrics_in_username_fn(
     aws_mqtt5_client_test_init_default_options(&test_options);
     test_options.client_options.metrics = metrics;
 
-    /* Set up username and metrics */
-    struct aws_byte_cursor original_username = aws_byte_cursor_from_c_str("test_user");
-
     struct aws_mqtt5_packet_connect_view connect_view = {
         .keep_alive_interval_seconds = 30,
         .client_id = aws_byte_cursor_from_string(g_default_client_id),
         .clean_start = true,
-        .username = &original_username};
+        .username = original_username};
 
     test_options.connect_options = connect_view;
 
@@ -6776,14 +6774,31 @@ static int s_test_mqtt5_client_set_metrics_valid(struct aws_allocator *allocator
         // .metadata_count = 0,
     };
 
-    return s_mqtt5_client_metrics_in_username_fn(allocator, &metrics, ctx);
+    struct aws_byte_cursor username = aws_byte_cursor_from_c_str("test_user");
+
+    return s_mqtt5_client_metrics_in_username_fn(allocator, &metrics, &username, ctx);
 }
 
 AWS_TEST_CASE(mqtt5_client_set_metrics_valid, s_test_mqtt5_client_set_metrics_valid)
 
+static int s_test_mqtt5_client_set_metrics_with_null_username(struct aws_allocator *allocator, void *ctx) {
+
+    struct aws_mqtt_iot_metrics metrics = {
+        .library_name = aws_byte_cursor_from_c_str("TestSDK/1.0")
+        // TODO: enable when metadata is supported
+        // .metadata_entries = NULL,
+        // .metadata_count = 0,
+    };
+
+    return s_mqtt5_client_metrics_in_username_fn(allocator, &metrics, NULL, ctx);
+}
+
+AWS_TEST_CASE(mqtt5_client_set_metrics_with_null_username, s_test_mqtt5_client_set_metrics_with_null_username)
+
 static int s_test_mqtt5_client_set_metrics_null(struct aws_allocator *allocator, void *ctx) {
 
-    return s_mqtt5_client_metrics_in_username_fn(allocator, NULL, ctx);
+    struct aws_byte_cursor username = aws_byte_cursor_from_c_str("test_user");
+    return s_mqtt5_client_metrics_in_username_fn(allocator, NULL, &username, ctx);
 }
 
 AWS_TEST_CASE(mqtt5_client_set_metrics_null, s_test_mqtt5_client_set_metrics_null)