Add IoT Metrics Support (#371)

Author: xiazhvera

Source/AwsCommonRuntimeKit/mqtt/Mqtt5Options.swift

@@ -201,6 +201,21 @@ public class MqttConnectOptions: CStruct {
   }
 }
 
+/// Configuration for the AWS IoT Metrics, including SDK name, version, and platforms.
+private class AwsIoTSDKMetrics: CStruct {
+  public let libraryName: String = "IoTDeviceSDK/Swift"
+
+  typealias RawType = aws_mqtt_iot_metrics
+  func withCStruct<Result>(_ body: (aws_mqtt_iot_metrics) -> Result) -> Result {
+    var raw_metrics = aws_mqtt_iot_metrics()
+    return libraryName.withByteCursor { libraryNameByteCursor in
+      raw_metrics.library_name = libraryNameByteCursor
+      return body(raw_metrics)
+    }
+  }
+
+}
+
 /// Configuration for the creation of MQTT5 clients
 public class MqttClientOptions: CStructWithUserData {
   /// Host name of the MQTT server to connect to.
@@ -278,6 +293,12 @@ public class MqttClientOptions: CStructWithUserData {
   /// Callback for Lifecycle Event Disconnection.
   public let onLifecycleEventDisconnectionFn: OnLifecycleEventDisconnection?
 
+  /// Enable AWS IoT Metrics, including SDK name, version, and platform. Default to True.
+  public let enableMetrics: Bool
+
+  /// AWS IoT Metrics. This is internally set only.
+  private let metrics: AwsIoTSDKMetrics?
+
   public init(
     hostName: String,
     port: UInt32,
@@ -303,7 +324,8 @@ public class MqttClientOptions: CStructWithUserData {
     onLifecycleEventAttemptingConnectFn: OnLifecycleEventAttemptingConnect? = nil,
     onLifecycleEventConnectionSuccessFn: OnLifecycleEventConnectionSuccess? = nil,
     onLifecycleEventConnectionFailureFn: OnLifecycleEventConnectionFailure? = nil,
-    onLifecycleEventDisconnectionFn: OnLifecycleEventDisconnection? = nil
+    onLifecycleEventDisconnectionFn: OnLifecycleEventDisconnection? = nil,
+    enableMetrics: Bool = true
   ) {
 
     self.hostName = hostName
@@ -347,6 +369,8 @@ public class MqttClientOptions: CStructWithUserData {
     self.onLifecycleEventConnectionSuccessFn = onLifecycleEventConnectionSuccessFn
     self.onLifecycleEventConnectionFailureFn = onLifecycleEventConnectionFailureFn
     self.onLifecycleEventDisconnectionFn = onLifecycleEventDisconnectionFn
+    self.enableMetrics = enableMetrics
+    self.metrics = enableMetrics ? AwsIoTSDKMetrics() : nil
   }
 
   func validateConversionToNative() throws {
@@ -476,19 +500,22 @@ public class MqttClientOptions: CStructWithUserData {
       tls_options,
       self.httpProxyOptions,
       self.topicAliasingOptions,
+      self.metrics,
       connnectOptions
     ) {
       socketOptionsCPointer,
       tlsOptionsCPointer,
       httpProxyOptionsCPointer,
       topicAliasingOptionsCPointer,
+      metricsCPointer,
       connectOptionsCPointer in
 
       raw_options.socket_options = socketOptionsCPointer
       raw_options.tls_options = tlsOptionsCPointer
       raw_options.http_proxy_options = httpProxyOptionsCPointer
       raw_options.topic_aliasing_options = topicAliasingOptionsCPointer
       raw_options.connect_options = connectOptionsCPointer
+      raw_options.metrics = metricsCPointer
 
       guard let userData else {
         // directly return

Test/AwsCommonRuntimeKitTests/mqtt/Mqtt5ClientTests.swift

@@ -207,7 +207,8 @@ class Mqtt5ClientTests: XCBaseTestCase, @unchecked Sendable {
         onLifecycleEventAttemptingConnectFn: testContext.onLifecycleEventAttemptingConnect,
         onLifecycleEventConnectionSuccessFn: testContext.onLifecycleEventConnectionSuccess,
         onLifecycleEventConnectionFailureFn: testContext.onLifecycleEventConnectionFailure,
-        onLifecycleEventDisconnectionFn: testContext.onLifecycleEventDisconnection)
+        onLifecycleEventDisconnectionFn: testContext.onLifecycleEventDisconnection,
+        enableMetrics: clientOptions.enableMetrics)
     } else {
       let elg = try EventLoopGroup()
       let resolver = try HostResolver(
@@ -407,20 +408,67 @@ class Mqtt5ClientTests: XCBaseTestCase, @unchecked Sendable {
     let connectOptions = MqttConnectOptions(
       clientId: createClientId(),
       username: inputUsername,
-      password: inputPassword.data(using: .utf8)
-    )
+      password: inputPassword.data(using: .utf8))
 
     let clientOptions = MqttClientOptions(
       hostName: inputHost,
       port: UInt32(inputPort)!,
-      connectOptions: connectOptions)
+      connectOptions: connectOptions,
+      enableMetrics: false)
 
     let testContext = MqttTestContext()
     let client = try createClient(clientOptions: clientOptions, testContext: testContext)
     try await connectClient(client: client, testContext: testContext)
     try await disconnectClientCleanup(client: client, testContext: testContext)
   }
 
+  /*
+   * [Metrics-UC2-B] Direct Connection with Basic Auth - Metrics Disabled (should succeed)
+   *
+   * When metrics are disabled, the username is not modified and basic authentication
+   * works correctly.
+   */
+  func testMqtt5DirectConnectBasicAuthMetricsEnabled() async throws {
+
+    let inputUsername = try getEnvironmentVarOrSkipTest(
+      environmentVarName: "AWS_TEST_MQTT5_BASIC_AUTH_USERNAME")
+    let inputPassword = try getEnvironmentVarOrSkipTest(
+      environmentVarName: "AWS_TEST_MQTT5_BASIC_AUTH_PASSWORD")
+    let inputHost = try getEnvironmentVarOrSkipTest(
+      environmentVarName: "AWS_TEST_MQTT5_DIRECT_MQTT_BASIC_AUTH_HOST")
+    let inputPort = try getEnvironmentVarOrSkipTest(
+      environmentVarName: "AWS_TEST_MQTT5_DIRECT_MQTT_BASIC_AUTH_PORT")
+
+    let connectOptions = MqttConnectOptions(
+      clientId: createClientId(),
+      username: inputUsername,
+      password: inputPassword.data(using: .utf8))
+
+    // Metrics enabled
+    let clientOptions = MqttClientOptions(
+      hostName: inputHost,
+      port: UInt32(inputPort)!,
+      connectOptions: connectOptions,
+      enableMetrics: true)
+
+    let testContext: Mqtt5ClientTests.MqttTestContext = MqttTestContext()
+    let client = try createClient(clientOptions: clientOptions, testContext: testContext)
+
+    try client.start()
+    // The connection should fail with metrics in username
+    await awaitExpectation([testContext.connectionFailureExpectation], 5)
+
+    if let failureData = testContext.lifecycleConnectionFailureData {
+      XCTAssertEqual(
+        failureData.crtError.code, Int32(AWS_ERROR_MQTT5_CONNACK_CONNECTION_REFUSED.rawValue))
+    } else {
+      XCTFail("lifecycleConnectionFailureData Missing")
+      return
+    }
+
+    try await stopClient(client: client, testContext: testContext)
+  }
+
   /*
    * [ConnDC-UC3] Direct Connection with TLS
    */
@@ -663,7 +711,8 @@ class Mqtt5ClientTests: XCBaseTestCase, @unchecked Sendable {
     let clientOptions = MqttClientOptions(
       hostName: inputHost,
       port: UInt32(inputPort)!,
-      connectOptions: connectOptions)
+      connectOptions: connectOptions,
+      enableMetrics: false)
 
     let testContext = MqttTestContext()
     testContext.withWebsocketTransform(isSuccess: true)