WIP moving metrics to client options.

xiazhvera · xiazhvera · commit 9aa40cb46d15 · 2025-12-19T09:40:07.000-08:00
diff --git a/include/aws/mqtt/private/v5/mqtt5_options_storage.h b/include/aws/mqtt/private/v5/mqtt5_options_storage.h
@@ -139,6 +139,7 @@ struct aws_mqtt5_operation_pingreq {
 
 struct aws_mqtt5_client_options_storage {
     struct aws_allocator *allocator;
+    struct aws_mqtt5_client_options options;
 
     struct aws_string *host_name;
     uint32_t port;
@@ -182,6 +183,8 @@ struct aws_mqtt5_client_options_storage {
     void *client_termination_handler_user_data;
 
     struct aws_host_resolution_config host_resolution_override;
+
+    const struct aws_mqtt_iot_sdk_metrics *metrics;
 };
 
 AWS_EXTERN_C_BEGIN
@@ -217,7 +220,8 @@ AWS_MQTT_API uint32_t aws_mqtt5_operation_get_ack_timeout_override(const struct
 
 AWS_MQTT_API struct aws_mqtt5_operation_connect *aws_mqtt5_operation_connect_new(
     struct aws_allocator *allocator,
-    const struct aws_mqtt5_packet_connect_view *connect_options);
+    const struct aws_mqtt5_packet_connect_view *connect_options,
+    const struct aws_mqtt5_client_options *client_config);
 
 AWS_MQTT_API int aws_mqtt5_packet_connect_view_validate(const struct aws_mqtt5_packet_connect_view *connect_view);
 
diff --git a/include/aws/mqtt/v5/mqtt5_client.h b/include/aws/mqtt/v5/mqtt5_client.h
@@ -657,6 +657,11 @@ struct aws_mqtt5_client_options {
      * configuration but changes the refresh frequency to a value that prevents DNS pinging.
      */
     struct aws_host_resolution_config *host_resolution_override;
+
+    /**
+     * IoT SDK metrics configuration
+     */
+    const struct aws_mqtt_iot_sdk_metrics *metrics;
 };
 
 AWS_EXTERN_C_BEGIN
diff --git a/include/aws/mqtt/v5/mqtt5_packet_storage.h b/include/aws/mqtt/v5/mqtt5_packet_storage.h
@@ -209,7 +209,8 @@ AWS_MQTT_API size_t aws_mqtt5_user_property_set_size(const struct aws_mqtt5_user
 AWS_MQTT_API int aws_mqtt5_packet_connect_storage_init(
     struct aws_mqtt5_packet_connect_storage *connect_storage,
     struct aws_allocator *allocator,
-    const struct aws_mqtt5_packet_connect_view *connect_options);
+    const struct aws_mqtt5_packet_connect_view *connect_options,
+    const struct aws_mqtt5_client_options *client_options);
 
 AWS_MQTT_API int aws_mqtt5_packet_connect_storage_init_from_external_storage(
     struct aws_mqtt5_packet_connect_storage *connect_storage,
diff --git a/include/aws/mqtt/v5/mqtt5_types.h b/include/aws/mqtt/v5/mqtt5_types.h
@@ -396,9 +396,6 @@ 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;
 };
 
 /**
diff --git a/source/v5/mqtt5_client.c b/source/v5/mqtt5_client.c
@@ -1174,7 +1174,8 @@ static void s_change_current_state_to_mqtt_connect(struct aws_mqtt5_client *clie
     aws_mqtt5_negotiated_settings_reset(&client->negotiated_settings, &connect_view);
     connect_view.client_id = aws_byte_cursor_from_buf(&client->negotiated_settings.client_id_storage);
 
-    struct aws_mqtt5_operation_connect *connect_op = aws_mqtt5_operation_connect_new(client->allocator, &connect_view);
+    struct aws_mqtt5_operation_connect *connect_op =
+        aws_mqtt5_operation_connect_new(client->allocator, &connect_view, &client->config->options);
     if (connect_op == NULL) {
         int error_code = aws_last_error();
         AWS_LOGF_ERROR(
diff --git a/source/v5/mqtt5_options_storage.c b/source/v5/mqtt5_options_storage.c
@@ -378,16 +378,6 @@ 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(
@@ -645,7 +635,9 @@ void aws_mqtt5_packet_connect_storage_clean_up(struct aws_mqtt5_packet_connect_s
     aws_byte_buf_clean_up_secure(&storage->storage);
 }
 
-static size_t s_aws_mqtt5_packet_connect_compute_storage_size(const struct aws_mqtt5_packet_connect_view *view) {
+static size_t s_aws_mqtt5_packet_connect_compute_storage_size(
+    const struct aws_mqtt5_packet_connect_view *view,
+    const struct aws_mqtt5_client_options *options) {
     if (view == NULL) {
         return 0;
     }
@@ -654,10 +646,10 @@ 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) {
-        if (view->metrics) {
+        if (options && options->metrics) {
             size_t username_size = 0;
             aws_mqtt_append_sdk_metrics_to_username(
-                aws_default_allocator(), view->username, *view->metrics, NULL, &username_size);
+                aws_default_allocator(), view->username, *options->metrics, NULL, &username_size);
             storage_size += username_size;
         } else {
             storage_size += view->username->len;
@@ -670,8 +662,6 @@ 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,12 +676,13 @@ static size_t s_aws_mqtt5_packet_connect_compute_storage_size(const struct aws_m
 int aws_mqtt5_packet_connect_storage_init(
     struct aws_mqtt5_packet_connect_storage *storage,
     struct aws_allocator *allocator,
-    const struct aws_mqtt5_packet_connect_view *view) {
+    const struct aws_mqtt5_packet_connect_view *view,
+    const struct aws_mqtt5_client_options *client_config) {
     AWS_ZERO_STRUCT(*storage);
 
     struct aws_mqtt5_packet_connect_view *storage_view = &storage->storage_view;
 
-    size_t storage_capacity = s_aws_mqtt5_packet_connect_compute_storage_size(view);
+    size_t storage_capacity = s_aws_mqtt5_packet_connect_compute_storage_size(view, client_config);
     if (aws_byte_buf_init(&storage->storage, allocator, storage_capacity)) {
         return AWS_OP_ERR;
     }
@@ -710,10 +701,10 @@ int aws_mqtt5_packet_connect_storage_init(
         AWS_ZERO_STRUCT(metrics_username_buf);
 
         /* Apply metrics to username if configured */
-        if (view->metrics) {
+        if (client_config->metrics != NULL) {
             struct aws_byte_cursor username_cur = storage->username;
             if (aws_mqtt_append_sdk_metrics_to_username(
-                    allocator, &username_cur, *view->metrics, &metrics_username_buf, NULL)) {
+                    allocator, &username_cur, *client_config->metrics, &metrics_username_buf, NULL)) {
                 return AWS_OP_ERR;
             }
             storage->username = aws_byte_cursor_from_buf(&metrics_username_buf);
@@ -846,7 +837,8 @@ static void s_destroy_operation_connect(void *object) {
 
 struct aws_mqtt5_operation_connect *aws_mqtt5_operation_connect_new(
     struct aws_allocator *allocator,
-    const struct aws_mqtt5_packet_connect_view *connect_options) {
+    const struct aws_mqtt5_packet_connect_view *connect_options,
+    const struct aws_mqtt5_client_options *client_config) {
     AWS_PRECONDITION(allocator != NULL);
     AWS_PRECONDITION(connect_options != NULL);
 
@@ -867,7 +859,8 @@ struct aws_mqtt5_operation_connect *aws_mqtt5_operation_connect_new(
     aws_priority_queue_node_init(&connect_op->base.priority_queue_node);
     connect_op->base.impl = connect_op;
 
-    if (aws_mqtt5_packet_connect_storage_init(&connect_op->options_storage, allocator, connect_options)) {
+    if (aws_mqtt5_packet_connect_storage_init(
+            &connect_op->options_storage, allocator, connect_options, client_config)) {
         goto error;
     }
 
@@ -3420,6 +3413,13 @@ int aws_mqtt5_client_options_validate(const struct aws_mqtt5_client_options *opt
         }
     }
 
+    if (options->metrics != NULL) {
+        if (aws_mqtt_validate_iot_sdk_metrics_utf8(options->metrics)) {
+            AWS_LOGF_ERROR(AWS_LS_MQTT5_GENERAL, "invalid metrics in mqtt5 client configuration");
+            return aws_raise_error(AWS_ERROR_MQTT5_CONNECT_OPTIONS_VALIDATION);
+        }
+    }
+
     return AWS_OP_SUCCESS;
 }
 
@@ -3835,21 +3835,28 @@ struct aws_mqtt5_client_options_storage *aws_mqtt5_client_options_storage_new(
         return NULL;
     }
 
+    struct aws_mqtt5_client_options *options_view = &options_storage->options;
+
     options_storage->allocator = allocator;
     options_storage->host_name = aws_string_new_from_cursor(allocator, &options->host_name);
+    options_view->host_name = aws_byte_cursor_from_string(options_storage->host_name);
     if (options_storage->host_name == NULL) {
         goto error;
     }
 
     options_storage->port = options->port;
+    options_view->port = options_storage->port;
+
     options_storage->bootstrap = aws_client_bootstrap_acquire(options->bootstrap);
+    options_view->bootstrap = options_storage->bootstrap;
 
     if (options->socket_options != NULL) {
         options_storage->socket_options = *options->socket_options;
     } else {
         options_storage->socket_options.type = AWS_SOCKET_STREAM;
         options_storage->socket_options.connect_timeout_ms = AWS_MQTT5_DEFAULT_SOCKET_CONNECT_TIMEOUT_MS;
     }
+    options_view->socket_options = &options_storage->socket_options;
 
     if (options->tls_options != NULL) {
         if (aws_tls_connection_options_copy(&options_storage->tls_options, options->tls_options)) {
@@ -3866,6 +3873,7 @@ struct aws_mqtt5_client_options_storage *aws_mqtt5_client_options_storage_new(
             }
         }
     }
+    options_view->tls_options = options_storage->tls_options_ptr;
 
     if (options->http_proxy_options != NULL) {
         /* Ignore a specified proxy connection type and use TUNNEL unconditionally as only this proxy type works. */
@@ -3878,32 +3886,50 @@ struct aws_mqtt5_client_options_storage *aws_mqtt5_client_options_storage_new(
         aws_http_proxy_options_init_from_config(
             &options_storage->http_proxy_options, options_storage->http_proxy_config);
     }
+    options_view->http_proxy_options = options->http_proxy_options;
 
     options_storage->websocket_handshake_transform = options->websocket_handshake_transform;
+    options_view->websocket_handshake_transform = options_storage->websocket_handshake_transform;
     options_storage->websocket_handshake_transform_user_data = options->websocket_handshake_transform_user_data;
+    options_view->websocket_handshake_transform_user_data = options_storage->websocket_handshake_transform_user_data;
 
     options_storage->publish_received_handler = options->publish_received_handler;
+    options_view->publish_received_handler = options_storage->publish_received_handler;
     options_storage->publish_received_handler_user_data = options->publish_received_handler_user_data;
+    options_view->publish_received_handler_user_data = options_storage->publish_received_handler_user_data;
 
     options_storage->session_behavior = options->session_behavior;
+    options_view->session_behavior = options_storage->session_behavior;
     options_storage->extended_validation_and_flow_control_options =
         options->extended_validation_and_flow_control_options;
+    options_view->extended_validation_and_flow_control_options =
+        options_storage->extended_validation_and_flow_control_options;
     options_storage->offline_queue_behavior = options->offline_queue_behavior;
+    options_view->offline_queue_behavior = options_storage->offline_queue_behavior;
 
     options_storage->retry_jitter_mode = options->retry_jitter_mode;
+    options_view->retry_jitter_mode = options_storage->retry_jitter_mode;
     options_storage->min_reconnect_delay_ms = options->min_reconnect_delay_ms;
+    options_view->min_reconnect_delay_ms = options_storage->min_reconnect_delay_ms;
     options_storage->max_reconnect_delay_ms = options->max_reconnect_delay_ms;
+    options_view->max_reconnect_delay_ms = options_storage->max_reconnect_delay_ms;
     options_storage->min_connected_time_to_reset_reconnect_delay_ms =
         options->min_connected_time_to_reset_reconnect_delay_ms;
+    options_view->min_connected_time_to_reset_reconnect_delay_ms =
+        options_storage->min_connected_time_to_reset_reconnect_delay_ms;
 
     options_storage->ping_timeout_ms = options->ping_timeout_ms;
+    options_view->ping_timeout_ms = options_storage->ping_timeout_ms;
     options_storage->connack_timeout_ms = options->connack_timeout_ms;
+    options_view->connack_timeout_ms = options_storage->connack_timeout_ms;
 
     options_storage->ack_timeout_seconds = options->ack_timeout_seconds;
+    options_view->ack_timeout_seconds = options_storage->ack_timeout_seconds;
 
     if (options->topic_aliasing_options != NULL) {
         options_storage->topic_aliasing_options = *options->topic_aliasing_options;
     }
+    options_view->topic_aliasing_options = &options_storage->topic_aliasing_options;
 
     struct aws_byte_buf auto_assign_id_buf;
     AWS_ZERO_STRUCT(auto_assign_id_buf);
@@ -3965,18 +3991,23 @@ struct aws_mqtt5_client_options_storage *aws_mqtt5_client_options_storage_new(
 
     options_storage->connect = aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt5_packet_connect_storage));
     int connect_storage_result =
-        aws_mqtt5_packet_connect_storage_init(options_storage->connect, allocator, &connect_options);
+        aws_mqtt5_packet_connect_storage_init(options_storage->connect, allocator, &connect_options, options);
 
     aws_byte_buf_clean_up(&auto_assign_id_buf);
     if (connect_storage_result != AWS_OP_SUCCESS) {
         goto error;
     }
+    options_view->connect_options = &options_storage->connect->storage_view;
 
     options_storage->lifecycle_event_handler = options->lifecycle_event_handler;
+    options_view->lifecycle_event_handler = options_storage->lifecycle_event_handler;
     options_storage->lifecycle_event_handler_user_data = options->lifecycle_event_handler_user_data;
+    options_view->lifecycle_event_handler_user_data = options_storage->lifecycle_event_handler_user_data;
 
     options_storage->client_termination_handler = options->client_termination_handler;
+    options_view->client_termination_handler = options_storage->client_termination_handler;
     options_storage->client_termination_handler_user_data = options->client_termination_handler_user_data;
+    options_view->client_termination_handler_user_data = options_storage->client_termination_handler_user_data;
 
     s_apply_zero_valued_defaults_to_client_options_storage(options_storage);
 
@@ -3988,6 +4019,11 @@ struct aws_mqtt5_client_options_storage *aws_mqtt5_client_options_storage_new(
         options_storage->host_resolution_override.resolve_frequency_ns = aws_timestamp_convert(
             options_storage->max_reconnect_delay_ms, AWS_TIMESTAMP_MILLIS, AWS_TIMESTAMP_NANOS, NULL);
     }
+    options_view->host_resolution_override = &options_storage->host_resolution_override;
+
+    // TODO: Placehold for metrics storage implemnetation.
+    // options_storage->metrics = options->metrics;
+    // options_view->metrics = options_storage->metrics;
 
     return options_storage;
 
diff --git a/source/v5/mqtt5_to_mqtt3_adapter.c b/source/v5/mqtt5_to_mqtt3_adapter.c
@@ -1639,7 +1639,8 @@ static void s_set_login_task_fn(struct aws_task *task, void *arg, enum aws_task_
 
     struct aws_mqtt5_packet_connect_storage *new_connect =
         aws_mem_calloc(adapter->allocator, 1, sizeof(struct aws_mqtt5_packet_connect_storage));
-    aws_mqtt5_packet_connect_storage_init(new_connect, adapter->allocator, &new_connect_view);
+    aws_mqtt5_packet_connect_storage_init(
+        new_connect, adapter->allocator, &new_connect_view, &adapter->client->config->options);
 
     adapter->client->config->connect = new_connect;
     aws_mqtt5_packet_connect_storage_clean_up(old_connect);
diff --git a/tests/v5/mqtt5_client_tests.c b/tests/v5/mqtt5_client_tests.c
@@ -154,7 +154,7 @@ static int s_aws_mqtt5_client_test_init_default_connect_storage(
         .clean_start = true,
     };
 
-    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view);
+    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view, NULL);
 }
 
 static int s_aws_mqtt5_client_test_init_default_disconnect_storage(
@@ -1052,7 +1052,7 @@ static int s_aws_mqtt5_client_test_init_ping_test_connect_storage(
         .clean_start = true,
     };
 
-    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view);
+    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view, NULL);
 }
 
 /*
@@ -2970,7 +2970,7 @@ static int s_aws_mqtt5_client_test_init_resume_session_connect_storage(
         .clean_start = false,
     };
 
-    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view);
+    return aws_mqtt5_packet_connect_storage_init(storage, allocator, &connect_view, NULL);
 }
 
 #define SESSION_RESUMPTION_CONNECT_COUNT 5
@@ -6667,6 +6667,7 @@ static int s_mqtt5_client_metrics_in_username_fn(
 
     struct mqtt5_client_test_options test_options;
     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");
@@ -6675,7 +6676,6 @@ static int s_mqtt5_client_metrics_in_username_fn(
         .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;
@@ -6739,7 +6739,8 @@ static int s_mqtt5_client_metrics_in_username_fn(
 
     struct aws_mqtt5_packet_connect_storage expected_connect_storage;
 
-    aws_mqtt5_packet_connect_storage_init(&expected_connect_storage, allocator, &connect_view);
+    aws_mqtt5_packet_connect_storage_init(
+        &expected_connect_storage, allocator, &connect_view, &test_options.client_options);
 
     struct aws_mqtt5_packet_disconnect_storage expected_disconnect_storage;
     ASSERT_SUCCESS(s_aws_mqtt5_client_test_init_default_disconnect_storage(&expected_disconnect_storage, allocator));
diff --git a/tests/v5/mqtt5_operation_and_storage_tests.c b/tests/v5/mqtt5_operation_and_storage_tests.c
diff --git a/tests/v5/mqtt5_operation_validation_failure_tests.c b/tests/v5/mqtt5_operation_validation_failure_tests.c
diff --git a/tests/v5/mqtt5_testing_utils.c b/tests/v5/mqtt5_testing_utils.c
diff --git a/tests/v5/mqtt5_to_mqtt3_adapter_tests.c b/tests/v5/mqtt5_to_mqtt3_adapter_tests.c
