set metrics for mqtt3to5 adapter

xiazhvera · xiazhvera · commit 38e45e43d74d · 2025-11-20T17:57:43.000-08:00
diff --git a/include/aws/mqtt/private/client_impl_shared.h b/include/aws/mqtt/private/client_impl_shared.h
@@ -147,8 +147,6 @@ struct aws_mqtt_iot_sdk_metrics_storage {
 };
 
 /* IoT SDK Metrics */
-
-// TODO: the function will zero out metrics_storage, properly deallocate the storage before pass in
 AWS_MQTT_API int aws_mqtt_iot_sdk_metrics_storage_init(
     struct aws_mqtt_iot_sdk_metrics_storage *metrics_storage,
     struct aws_allocator *allocator,
diff --git a/source/client_impl_shared.c b/source/client_impl_shared.c
@@ -258,8 +258,6 @@ int aws_mqtt_iot_sdk_metrics_storage_init(
         return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
     }
 
-    AWS_ZERO_STRUCT(*metrics_storage);
-
     if (metrics_options == NULL) {
         return AWS_OP_SUCCESS;
     }
diff --git a/source/v5/mqtt5_to_mqtt3_adapter.c b/source/v5/mqtt5_to_mqtt3_adapter.c
@@ -2779,13 +2779,123 @@ static int s_aws_mqtt_client_connection_5_get_stats(
     return AWS_OP_SUCCESS;
 }
 
+struct aws_mqtt_set_metrics_task {
+    struct aws_task task;
+    struct aws_allocator *allocator;
+    struct aws_mqtt_client_connection_5_impl *adapter;
+
+    struct aws_mqtt_iot_sdk_metrics_storage *metrics_storage;
+};
+
+static void s_aws_mqtt_set_metrics_task_destroy(struct aws_mqtt_set_metrics_task *task) {
+    if (task == NULL) {
+        return;
+    }
+
+    aws_mqtt_iot_sdk_metrics_storage_clean_up(task->metrics_storage);
+
+    aws_mem_release(task->allocator, task);
+}
+
+static void s_set_metrics_task_fn(struct aws_task *task, void *arg, enum aws_task_status status) {
+    (void)task;
+
+    struct aws_mqtt_set_metrics_task *set_task = arg;
+    struct aws_mqtt_client_connection_5_impl *adapter = set_task->adapter;
+    if (status != AWS_TASK_STATUS_RUN_READY) {
+        goto done;
+    }
+
+    /* we're in the mqtt5 client's event loop; it's safe to access internal state */
+    struct aws_mqtt5_packet_connect_storage *old_connect = adapter->client->config->connect;
+
+    /*
+     * Packet storage stores binary data in a single buffer.  The safest way to replace some binary data is
+     * to make a new storage from the old storage, deleting the old storage after construction is complete.
+     */
+    struct aws_mqtt5_packet_connect_view new_connect_view = old_connect->storage_view;
+
+    if (set_task->metrics_storage) {
+        new_connect_view.metrics = &set_task->metrics_storage->storage_view;
+    } else {
+        new_connect_view.metrics = NULL;
+    }
+
+    if (aws_mqtt5_packet_connect_view_validate(&new_connect_view)) {
+        AWS_LOGF_ERROR(
+            AWS_LS_MQTT5_TO_MQTT3_ADAPTER, "id=%p: mqtt3-to-5-adapter - invalid CONNECT metrics", (void *)adapter);
+        goto done;
+    }
+
+    struct aws_mqtt5_packet_connect_storage *new_connect =
+        aws_mem_calloc(adapter->allocator, 1, sizeof(struct aws_mqtt5_packet_connect_storage));
+
+    if (aws_mqtt5_packet_connect_storage_init(new_connect, adapter->allocator, &new_connect_view)) {
+        aws_mem_release(adapter->allocator, new_connect);
+        goto done;
+    }
+
+    adapter->client->config->connect = new_connect;
+    aws_mqtt5_packet_connect_storage_clean_up(old_connect);
+    aws_mem_release(old_connect->allocator, old_connect);
+
+done:
+
+    aws_ref_count_release(&adapter->internal_refs);
+
+    s_aws_mqtt_set_metrics_task_destroy(set_task);
+}
+
+static struct aws_mqtt_set_metrics_task *s_aws_mqtt_set_metrics_task_new(
+    struct aws_allocator *allocator,
+    struct aws_mqtt_client_connection_5_impl *adapter,
+    const struct aws_mqtt_iot_sdk_metrics *metrics) {
+
+    struct aws_mqtt_set_metrics_task *set_task = aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_set_metrics_task));
+    if (set_task == NULL) {
+        return NULL;
+    }
+
+    aws_task_init(&set_task->task, s_set_metrics_task_fn, (void *)set_task, "SetMetricsTask");
+    set_task->allocator = allocator;
+    set_task->adapter = (struct aws_mqtt_client_connection_5_impl *)aws_ref_count_acquire(&adapter->internal_refs);
+
+    if (metrics != NULL) {
+        set_task->metrics_storage = aws_mem_calloc(allocator, 1, sizeof(struct aws_mqtt_iot_sdk_metrics_storage));
+        if (aws_mqtt_iot_sdk_metrics_storage_init(set_task->metrics_storage, allocator, metrics)) {
+            aws_ref_count_release(&adapter->internal_refs);
+            aws_mem_release(allocator, set_task);
+            return NULL;
+        }
+    }
+
+    return set_task;
+}
+
 static int s_aws_mqtt_client_connection_5_set_metrics(void *impl, const struct aws_mqtt_iot_sdk_metrics *metrics) {
-    (void)impl;
-    (void)metrics;
+    struct aws_mqtt_client_connection_5_impl *adapter = impl;
 
-    /* MQTT5 adapter does not support metrics configuration */
-    AWS_LOGF_WARN(AWS_LS_MQTT5_TO_MQTT3_ADAPTER, "MQTT5 adapter does not support metrics configuration");
-    return aws_raise_error(AWS_ERROR_UNSUPPORTED_OPERATION);
+    if (aws_mqtt_validate_iot_sdk_metrics_utf8(metrics)) {
+        AWS_LOGF_DEBUG(
+            AWS_LS_MQTT5_TO_MQTT3_ADAPTER, "id=%p: Invalid utf8 or forbidden codepoints in metrics.", (void *)adapter);
+        return aws_raise_error(AWS_ERROR_INVALID_UTF8);
+    }
+
+    struct aws_mqtt_set_metrics_task *task = s_aws_mqtt_set_metrics_task_new(adapter->allocator, adapter, metrics);
+    if (task == NULL) {
+        int error_code = aws_last_error();
+        AWS_LOGF_ERROR(
+            AWS_LS_MQTT5_TO_MQTT3_ADAPTER,
+            "id=%p: failed to create set metrics task, error code %d(%s)",
+            (void *)adapter,
+            error_code,
+            aws_error_debug_str(error_code));
+        return AWS_OP_ERR;
+    }
+
+    aws_event_loop_schedule_task_now(adapter->loop, &task->task);
+
+    return AWS_OP_SUCCESS;
 }
 
 static uint16_t s_aws_mqtt_5_resubscribe_existing_topics(
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -458,6 +458,9 @@ add_test_case(mqtt5to3_adapter_resubscribe_something)
 add_test_case(mqtt5to3_adapter_subscribe_single_null_suback)
 add_test_case(mqtt5to3_adapter_subscribe_multi_null_suback)
 add_test_case(mqtt5to3_adapter_operation_callbacks_after_shutdown)
+add_test_case(mqtt5to3_adapter_set_metrics_valid)
+add_test_case(mqtt5to3_adapter_set_metrics_null)
+add_test_case(mqtt5to3_adapter_set_metrics_invalid_utf8_library)
 
 add_test_case(mqtt_subscription_set_add_empty_not_subbed)
 add_test_case(mqtt_subscription_set_add_single_path)
diff --git a/tests/v5/mqtt5_to_mqtt3_adapter_tests.c b/tests/v5/mqtt5_to_mqtt3_adapter_tests.c
@@ -4406,3 +4406,116 @@ static int s_mqtt5to3_adapter_operation_callbacks_after_shutdown_fn(struct aws_a
 AWS_TEST_CASE(
     mqtt5to3_adapter_operation_callbacks_after_shutdown,
     s_mqtt5to3_adapter_operation_callbacks_after_shutdown_fn)
+
+/**
+ * Test that aws_mqtt_client_connection_set_metrics works correctly with valid metrics
+ */
+static int s_mqtt5to3_adapter_connection_set_metrics_valid_fn(struct aws_allocator *allocator, 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);
+
+    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_to_mqtt3_adapter_test_fixture fixture;
+    ASSERT_SUCCESS(aws_mqtt5_to_mqtt3_adapter_test_fixture_init(&fixture, allocator, &test_fixture_options));
+
+    struct aws_mqtt_client_connection *connection = fixture.connection;
+
+    struct aws_mqtt_iot_sdk_metrics metrics = {
+        .library_name = aws_byte_cursor_from_c_str("TestSDK/1.0"),
+        .metadata_entries = NULL,
+        .metadata_count = 0,
+    };
+
+    ASSERT_SUCCESS(aws_mqtt_client_connection_set_metrics(connection, &metrics));
+
+    aws_mqtt5_to_mqtt3_adapter_test_fixture_clean_up(&fixture);
+    aws_mqtt_library_clean_up();
+
+    return AWS_OP_SUCCESS;
+}
+
+AWS_TEST_CASE(mqtt5to3_adapter_set_metrics_valid, s_mqtt5to3_adapter_connection_set_metrics_valid_fn)
+
+/**
+ * Test that aws_mqtt_client_connection_set_metrics works correctly with NULL metrics (disables metrics)
+ */
+static int s_mqtt5to3_adapter_connection_set_metrics_null_fn(struct aws_allocator *allocator, 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);
+
+    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_to_mqtt3_adapter_test_fixture fixture;
+    ASSERT_SUCCESS(aws_mqtt5_to_mqtt3_adapter_test_fixture_init(&fixture, allocator, &test_fixture_options));
+
+    struct aws_mqtt_client_connection *connection = fixture.connection;
+
+    ASSERT_SUCCESS(aws_mqtt_client_connection_set_metrics(connection, NULL));
+
+    aws_mqtt5_to_mqtt3_adapter_test_fixture_clean_up(&fixture);
+    aws_mqtt_library_clean_up();
+
+    return AWS_OP_SUCCESS;
+}
+
+AWS_TEST_CASE(mqtt5to3_adapter_set_metrics_null, s_mqtt5to3_adapter_connection_set_metrics_null_fn)
+
+/**
+ * Test that aws_mqtt_client_connection_set_metrics rejects invalid UTF-8 in library name
+ */
+static int s_mqtt5to3_adapter_connection_set_metrics_invalid_utf8_library_fn(
+    struct aws_allocator *allocator,
+    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);
+
+    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_to_mqtt3_adapter_test_fixture fixture;
+    ASSERT_SUCCESS(aws_mqtt5_to_mqtt3_adapter_test_fixture_init(&fixture, allocator, &test_fixture_options));
+
+    struct aws_mqtt_client_connection *connection = fixture.connection;
+
+    /* Invalid UTF-8 sequence */
+    struct aws_byte_cursor invalid_utf8_library = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("TestSDK\xFF\xFE");
+
+    struct aws_mqtt_iot_sdk_metrics metrics = {
+        .library_name = invalid_utf8_library,
+        .metadata_entries = NULL,
+        .metadata_count = 0,
+    };
+
+    ASSERT_FAILS(aws_mqtt_client_connection_set_metrics(connection, &metrics));
+    ASSERT_INT_EQUALS(aws_last_error(), AWS_ERROR_INVALID_UTF8);
+
+    aws_mqtt5_to_mqtt3_adapter_test_fixture_clean_up(&fixture);
+    aws_mqtt_library_clean_up();
+
+    return AWS_OP_SUCCESS;
+}
+
+AWS_TEST_CASE(
+    mqtt5to3_adapter_set_metrics_invalid_utf8_library,
+    s_mqtt5to3_adapter_connection_set_metrics_invalid_utf8_library_fn)

Original file line number	Diff line number	Diff line change
`@@ -258,8 +258,6 @@ int aws_mqtt_iot_sdk_metrics_storage_init(`
`258`	`258`	`return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);`
`259`	`259`	`}`
`260`	`260`
`261`		`- AWS_ZERO_STRUCT(*metrics_storage);`
`262`		`-`
`263`	`261`	`if (metrics_options == NULL) {`
`264`	`262`	`return AWS_OP_SUCCESS;`
`265`	`263`	`}`