bring in mqtt5 metrics

Author: xiazhvera

include/aws/mqtt/v5/mqtt5_types.h

@@ -11,6 +11,8 @@
 #include <aws/common/array_list.h>
 #include <aws/common/byte_buf.h>
 
+struct aws_mqtt_iot_sdk_metrics;
+
 AWS_PUSH_SANE_WARNING_LEVEL
 
 /**
@@ -394,6 +396,9 @@ struct aws_mqtt5_packet_connect_view {
     /* Do not bind these.  We don't support AUTH packets yet.  For decode/encade testing purposes only. */
     const struct aws_byte_cursor *authentication_method;
     const struct aws_byte_cursor *authentication_data;
+
+    /* IoT SDK metrics configuration */
+    const struct aws_mqtt_iot_sdk_metrics *metrics;
 };
 
 /**

source/v5/mqtt5_options_storage.c

@@ -11,6 +11,7 @@
 #include <aws/common/uuid.h>
 #include <aws/io/channel_bootstrap.h>
 #include <aws/io/event_loop.h>
+#include <aws/mqtt/private/client_impl_shared.h>
 #include <aws/mqtt/private/v5/mqtt5_client_impl.h>
 #include <aws/mqtt/private/v5/mqtt5_utils.h>
 #include <aws/mqtt/v5/mqtt5_client.h>
@@ -377,6 +378,16 @@ int aws_mqtt5_packet_connect_view_validate(const struct aws_mqtt5_packet_connect
         }
     }
 
+    if (connect_options->metrics != NULL) {
+        if (aws_mqtt_validate_iot_sdk_metrics_utf8(connect_options->metrics)) {
+            AWS_LOGF_ERROR(
+                AWS_LS_MQTT5_GENERAL,
+                "id=%p: aws_mqtt5_packet_connect_view - metrics not valid UTF-8",
+                (void *)connect_options);
+            return aws_raise_error(AWS_ERROR_MQTT5_CONNECT_OPTIONS_VALIDATION);
+        }
+    }
+
     if (connect_options->receive_maximum != NULL) {
         if (*connect_options->receive_maximum == 0) {
             AWS_LOGF_ERROR(
@@ -643,7 +654,11 @@ static size_t s_aws_mqtt5_packet_connect_compute_storage_size(const struct aws_m
 
     storage_size += view->client_id.len;
     if (view->username != NULL) {
-        storage_size += view->username->len;
+        if (view->metrics) {
+            storage_size += aws_mqtt_append_sdk_metrics_to_username_size(view->username, *view->metrics);
+        } else {
+            storage_size += view->username->len;
+        }
     }
     if (view->password != NULL) {
         storage_size += view->password->len;
@@ -652,6 +667,8 @@ static size_t s_aws_mqtt5_packet_connect_compute_storage_size(const struct aws_m
     storage_size +=
         s_aws_mqtt5_user_property_set_compute_storage_size(view->user_properties, view->user_property_count);
 
+    storage_size += aws_mqtt_iot_sdk_metrics_compute_storage_size(view->metrics);
+
     if (view->authentication_method != NULL) {
         storage_size += view->authentication_method->len;
     }
@@ -686,9 +703,24 @@ int aws_mqtt5_packet_connect_storage_init(
 
     if (view->username != NULL) {
         storage->username = *view->username;
+        struct aws_byte_buf metrics_username_buf;
+        AWS_ZERO_STRUCT(metrics_username_buf);
+
+        /* Apply metrics to username if configured */
+        if (view->metrics) {
+            struct aws_byte_cursor username_cur = storage->username;
+            if (aws_mqtt_append_sdk_metrics_to_username(
+                    allocator, &username_cur, *view->metrics, &metrics_username_buf)) {
+                return AWS_OP_ERR;
+            }
+            storage->username = aws_byte_cursor_from_buf(&metrics_username_buf);
+        }
+
         if (aws_byte_buf_append_and_update(&storage->storage, &storage->username)) {
+            aws_byte_buf_clean_up(&metrics_username_buf);
             return AWS_OP_ERR;
         }
+        aws_byte_buf_clean_up(&metrics_username_buf);
 
         storage_view->username = &storage->username;
     }

tests/CMakeLists.txt

@@ -265,6 +265,7 @@ add_test_case(mqtt5_client_options_validation_failure_no_bootstrap)
 add_test_case(mqtt5_client_options_validation_failure_no_publish_received)
 add_test_case(mqtt5_client_options_validation_failure_invalid_socket_options)
 add_test_case(mqtt5_client_options_validation_failure_invalid_connect)
+add_test_case(mqtt5_client_options_validation_failure_invalid_metrics_string)
 add_test_case(mqtt5_client_options_validation_failure_invalid_port)
 add_test_case(mqtt5_operation_subscribe_connection_settings_validation_failure_exceeds_maximum_packet_size)
 add_test_case(mqtt5_operation_unsubscribe_connection_settings_validation_failure_exceeds_maximum_packet_size)
@@ -397,6 +398,10 @@ add_test_case(mqtt5_client_outbound_alias_manual_failure_empty_topic)
 add_test_case(mqtt5_client_outbound_alias_manual_success_a_b_ar_br)
 add_test_case(mqtt5_client_outbound_alias_lru_success_a_b_c_br_cr_a)
 
+# Mqtt5 Metrics tests
+add_test_case(mqtt5_client_set_metrics_valid)
+add_test_case(mqtt5_client_set_metrics_null)
+
 add_test_case(rate_limiter_token_bucket_init_invalid)
 add_test_case(rate_limiter_token_bucket_regeneration_integral)
 add_test_case(rate_limiter_token_bucket_regeneration_fractional)

tests/v5/mqtt5_client_tests.c

@@ -11,6 +11,7 @@
 #include <aws/io/channel_bootstrap.h>
 #include <aws/io/event_loop.h>
 #include <aws/mqtt/mqtt.h>
+#include <aws/mqtt/private/client_impl_shared.h>
 #include <aws/mqtt/private/v5/mqtt5_utils.h>
 #include <aws/mqtt/v5/mqtt5_client.h>
 #include <aws/mqtt/v5/mqtt5_listener.h>
@@ -6652,3 +6653,135 @@ static int s_mqtt5_client_auto_assigned_client_id_iot_core_fn(struct aws_allocat
 }
 
 AWS_TEST_CASE(mqtt5_client_auto_assigned_client_id_iot_core, s_mqtt5_client_auto_assigned_client_id_iot_core_fn)
+/*
+ * Test that verifies metrics are properly appended to username in CONNECT packet
+ * Based on s_mqtt5_client_direct_connect_success_fn
+ */
+static int s_mqtt5_client_metrics_in_username_fn(
+    struct aws_allocator *allocator,
+    struct aws_mqtt_iot_sdk_metrics *metrics,
+    void *ctx) {
+    (void)ctx;
+
+    aws_mqtt_library_init(allocator);
+
+    struct mqtt5_client_test_options test_options;
+    aws_mqtt5_client_test_init_default_options(&test_options);
+
+    /* 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,
+        .metrics = metrics,
+        .username = &original_username};
+
+    test_options.connect_options = connect_view;
+
+    struct aws_mqtt5_client_mqtt5_mock_test_fixture_options test_fixture_options = {
+        .client_options = &test_options.client_options,
+        .server_function_table = &test_options.server_function_table,
+    };
+
+    struct aws_mqtt5_client_mock_test_fixture test_context;
+    ASSERT_SUCCESS(aws_mqtt5_client_mock_test_fixture_init(&test_context, allocator, &test_fixture_options));
+
+    struct aws_mqtt5_client *client = test_context.client;
+    ASSERT_SUCCESS(aws_mqtt5_client_start(client));
+
+    aws_wait_for_connected_lifecycle_event(&test_context);
+
+    struct aws_mqtt5_packet_disconnect_view disconnect_options = {
+        .reason_code = AWS_MQTT5_DRC_NORMAL_DISCONNECTION,
+    };
+
+    struct aws_mqtt5_disconnect_completion_options completion_options = {
+        .completion_callback = s_on_disconnect_completion,
+        .completion_user_data = &test_context,
+    };
+
+    ASSERT_SUCCESS(aws_mqtt5_client_stop(client, &disconnect_options, &completion_options));
+
+    aws_wait_for_stopped_lifecycle_event(&test_context);
+    s_wait_for_disconnect_completion(&test_context);
+    s_wait_for_mock_server_to_receive_disconnect_packet(&test_context);
+
+    struct aws_mqtt5_client_lifecycle_event expected_events[] = {
+        {
+            .event_type = AWS_MQTT5_CLET_ATTEMPTING_CONNECT,
+        },
+        {
+            .event_type = AWS_MQTT5_CLET_CONNECTION_SUCCESS,
+        },
+        {
+            .event_type = AWS_MQTT5_CLET_DISCONNECTION,
+            .error_code = AWS_ERROR_MQTT5_USER_REQUESTED_STOP,
+        },
+        {
+            .event_type = AWS_MQTT5_CLET_STOPPED,
+        },
+    };
+    ASSERT_SUCCESS(
+        s_verify_simple_lifecycle_event_sequence(&test_context, expected_events, AWS_ARRAY_SIZE(expected_events)));
+
+    enum aws_mqtt5_client_state expected_states[] = {
+        AWS_MCS_CONNECTING,
+        AWS_MCS_MQTT_CONNECT,
+        AWS_MCS_CONNECTED,
+        AWS_MCS_CLEAN_DISCONNECT,
+        AWS_MCS_CHANNEL_SHUTDOWN,
+        AWS_MCS_STOPPED,
+    };
+
+    ASSERT_SUCCESS(aws_verify_client_state_sequence(&test_context, expected_states, AWS_ARRAY_SIZE(expected_states)));
+
+    struct aws_mqtt5_packet_connect_storage expected_connect_storage;
+
+    aws_mqtt5_packet_connect_storage_init(&expected_connect_storage, allocator, &connect_view);
+
+    struct aws_mqtt5_packet_disconnect_storage expected_disconnect_storage;
+    ASSERT_SUCCESS(s_aws_mqtt5_client_test_init_default_disconnect_storage(&expected_disconnect_storage, allocator));
+    expected_disconnect_storage.storage_view.reason_code = AWS_MQTT5_DRC_NORMAL_DISCONNECTION;
+
+    struct aws_mqtt5_mock_server_packet_record expected_packets[] = {
+        {
+            .packet_type = AWS_MQTT5_PT_CONNECT,
+            .packet_storage = &expected_connect_storage,
+        },
+        {
+            .packet_type = AWS_MQTT5_PT_DISCONNECT,
+            .packet_storage = &expected_disconnect_storage,
+        },
+    };
+    ASSERT_SUCCESS(
+        aws_verify_received_packet_sequence(&test_context, expected_packets, AWS_ARRAY_SIZE(expected_packets)));
+
+    aws_mqtt5_packet_connect_storage_clean_up(&expected_connect_storage);
+
+    aws_mqtt5_client_mock_test_fixture_clean_up(&test_context);
+    aws_mqtt_library_clean_up();
+
+    return AWS_OP_SUCCESS;
+}
+
+static int s_test_mqtt5_client_set_metrics_valid(struct aws_allocator *allocator, void *ctx) {
+    struct aws_mqtt_iot_sdk_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, ctx);
+}
+
+AWS_TEST_CASE(mqtt5_client_set_metrics_valid, s_test_mqtt5_client_set_metrics_valid)
+
+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);
+}
+
+AWS_TEST_CASE(mqtt5_client_set_metrics_null, s_test_mqtt5_client_set_metrics_null)

tests/v5/mqtt5_operation_and_storage_tests.c

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0.
  */
 
+#include "../v3/mqtt311_testing_utils.h"
+
 #include <aws/common/string.h>
 
 #include "mqtt5_testing_utils.h"
@@ -672,6 +674,13 @@ static int s_mqtt5_connect_storage_new_set_all_fn(struct aws_allocator *allocato
         .topic = aws_byte_cursor_from_c_str(PUBLISH_TOPIC),
     };
 
+    struct aws_mqtt_iot_sdk_metrics metrics = {
+        .library_name = aws_byte_cursor_from_c_str("TestSDK/1.0"),
+        // TODO: add more metrics fields as needed
+        // .metadata_entries = NULL,
+        // .metadata_count = 0,
+    };
+
     struct aws_mqtt5_packet_connect_view connect_options = {
         .keep_alive_interval_seconds = 50,
         .client_id = aws_byte_cursor_from_string(s_client_id),
@@ -690,7 +699,7 @@ static int s_mqtt5_connect_storage_new_set_all_fn(struct aws_allocator *allocato
         .user_properties = s_user_properties,
         .authentication_method = &s_authentication_method_cursor,
         .authentication_data = &s_authentication_data_cursor,
-    };
+        .metrics = &metrics};
 
     struct aws_mqtt5_packet_connect_storage connect_storage;
     AWS_ZERO_STRUCT(connect_storage);
@@ -701,7 +710,15 @@ static int s_mqtt5_connect_storage_new_set_all_fn(struct aws_allocator *allocato
 
     struct aws_mqtt5_packet_connect_view *stored_view = &connect_storage.storage_view;
 
-    AWS_VERIFY_VIEW_STORAGE_RELATIONSHIP_NULLABLE_CURSOR(&connect_storage, &connect_options, username);
+    /* Build expected username with metrics */
+    struct aws_byte_buf expected_username;
+    AWS_ZERO_STRUCT(expected_username);
+    aws_test_mqtt_build_expected_metrics(
+        allocator, connect_options.username, metrics.library_name, NULL, &expected_username);
+    ASSERT_BIN_ARRAYS_EQUALS(
+        expected_username.buffer, expected_username.len, connect_storage.username.ptr, connect_storage.username.len);
+    aws_byte_buf_clean_up(&expected_username);
+
     AWS_VERIFY_VIEW_STORAGE_RELATIONSHIP_NULLABLE_CURSOR(&connect_storage, &connect_options, password);
     AWS_VERIFY_VIEW_STORAGE_RELATIONSHIP_NULLABLE_UINT(
         &connect_storage, &connect_options, session_expiry_interval_seconds);

tests/v5/mqtt5_operation_validation_failure_tests.c

@@ -1170,6 +1170,16 @@ static void s_make_invalid_connect_client_options(struct aws_mqtt5_client_option
 
 AWS_CLIENT_CREATION_VALIDATION_FAILURE(invalid_connect, s_good_client_options, s_make_invalid_connect_client_options)
 
+static struct aws_mqtt_iot_sdk_metrics invalid_utf8_metrics = {
+    .library_name = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("TestSDK\xFF\xFE")};
+
+static struct aws_mqtt5_packet_connect_view s_invalid_utf8_metrics_connect_view = {.metrics = &invalid_utf8_metrics};
+static void s_make_invalid_utf8_metrics(struct aws_mqtt5_client_options *options) {
+    options->connect_options = &s_invalid_utf8_metrics_connect_view;
+}
+
+AWS_CLIENT_CREATION_VALIDATION_FAILURE(invalid_metrics_string, s_good_client_options, s_make_invalid_utf8_metrics)
+
 static void s_make_invalid_port_client_options(struct aws_mqtt5_client_options *options) {
     options->port = 0xFFFFFFFF;
 }