Refactor protocol mode and refactor mqtt metrics tests

Author: Bret Ambrose

lib/browser/mqtt.spec.ts

@@ -5,9 +5,12 @@
 
 import * as test_env from "@test/test_env";
 import * as retry from "@test/retry";
+import * as mqtt_server from "@test/mqtt_server";
+import * as test_metrics from "@test/metrics";
 import { ClientBootstrap, SocketOptions } from './io';
-import { MqttClient, MqttConnectionConfig } from './mqtt';
+import { MqttClient, MqttConnectionConfig, MqttClientConnection } from './mqtt';
 import { v4 as uuid } from 'uuid';
+import * as mqtt_shared from "../common/mqtt_shared";
 
 jest.setTimeout(30000);
 
@@ -61,3 +64,38 @@ test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_ws_auth_mqtt())(
         await test_connection(config, new MqttClient(new ClientBootstrap()));
     })
 });
+
+async function doMetricsTestConnect311(server: mqtt_server.MqttServer, disableMetrics: boolean, username?: string) {
+    let clientConfig : MqttConnectionConfig = {
+        client_id: "irrelevant",
+        host_name: "localhost",
+        port: server.getPort(),
+        socket_options: new SocketOptions(),
+        disable_metrics: disableMetrics,
+    };
+
+    if (username !== undefined) {
+        clientConfig.username = username;
+    }
+
+    let client = new MqttClient();
+    let connection = new MqttClientConnection(client, clientConfig);
+
+    await connection.connect();
+}
+
+test('mqtt311 metrics - enabled, undefined username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt311, doMetricsTestConnect311, false);
+});
+
+test('mqtt311 metrics - disabled, undefined username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt311, doMetricsTestConnect311, true);
+});
+
+test('mqtt311 metrics - enabled, non-empty username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt311, doMetricsTestConnect311, false, "squidward");
+});
+
+test('mqtt311 metrics - disabled, non-empty username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt311, doMetricsTestConnect311, true, "krustykrab");
+});

lib/browser/mqtt.ts

@@ -295,7 +295,7 @@ export class MqttClientConnection extends BufferedEventEmitter {
         }
 
         let internalConfig : internal_mqtt_client.ClientConfig = {
-            protocolVersion: internal_mqtt_client.ProtocolMode.Mqtt311,
+            protocolVersion: mqtt_shared.ProtocolMode.Mqtt311,
             offlineQueuePolicy: internal_mqtt_client.OfflineQueuePolicy.PreserveQos1PlusPublishes,
             connectOptions: internalConnectOptions,
             pingTimeoutMillis: this.config.ping_timeout ? this.config.ping_timeout : 30 * 1000,

lib/browser/mqtt5.spec.ts

@@ -11,8 +11,8 @@ import url from "url";
 import {HttpsProxyAgent} from "https-proxy-agent";
 import * as auth from "./auth";
 import {once} from "events";
-import * as model from "./mqtt_internal/model";
 import * as mqtt_server from "@test/mqtt_server";
+import * as test_metrics from "@test/metrics";
 import * as promise from "../common/promise";
 import * as mqtt_shared from "../common/mqtt_shared";
 import * as mqtt5_packet from "../common/mqtt5_packet";
@@ -595,7 +595,7 @@ function buildDefaultClientConfig(fixture : ClientTestFixture) : mqtt5.Mqtt5Clie
 
 test('Manual Puback - Acquire', async () => {
     let config: mqtt_server.MqttServerConfig = {
-        protocolVersion: model.ProtocolMode.Mqtt5
+        protocolVersion: mqtt_shared.ProtocolMode.Mqtt5
     };
 
     let fixture = new ClientTestFixture(config);
@@ -656,7 +656,7 @@ test('Manual Puback - Acquire', async () => {
 
 test('Manual Puback - No Acquire', async () => {
     let config: mqtt_server.MqttServerConfig = {
-        protocolVersion: model.ProtocolMode.Mqtt5
+        protocolVersion: mqtt_shared.ProtocolMode.Mqtt5
     };
 
     let fixture = new ClientTestFixture(config);
@@ -692,4 +692,47 @@ test('Manual Puback - No Acquire', async () => {
     await stopped;
 
     fixture.getServer().stop();
+});
+
+async function doMetricsTestConnect5(server: mqtt_server.MqttServer, disableMetrics: boolean, username?: string) {
+    let clientConfig : mqtt5.Mqtt5ClientConfig = {
+        hostName: "localhost",
+        port: server.getPort(),
+        disableMetrics: disableMetrics,
+        websocketOptions: {
+            urlFactoryOptions: {
+                urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Ws
+            }
+        }
+    };
+
+    if (username !== undefined) {
+        clientConfig.connectProperties = {
+            keepAliveIntervalSeconds: 1200,
+            username: username
+        };
+    }
+
+    let client = new mqtt5.Mqtt5Client(clientConfig);
+
+    let connectionSuccess = once(client, 'connectionSuccess');
+    client.start();
+
+    await connectionSuccess;
+}
+
+test('mqtt5 metrics - enabled, undefined username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, false);
+});
+
+test('mqtt5 metrics - disabled, undefined username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, true);
+});
+
+test('mqtt5 metrics - enabled, non-empty username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, false, "hello");
+});
+
+test('mqtt5 metrics - disabled, non-empty username', async () => {
+    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, true, "world");
 });

lib/browser/mqtt5.ts

@@ -278,7 +278,7 @@ export class Mqtt5Client extends BufferedEventEmitter implements mqtt5.IMqtt5Cli
         };
 
         let internalConfig : internal_mqtt_client.ClientConfig = {
-            protocolVersion: internal_mqtt_client.ProtocolMode.Mqtt5,
+            protocolVersion: mqtt_shared.ProtocolMode.Mqtt5,
             offlineQueuePolicy: internal_mqtt_client.OfflineQueuePolicy.PreserveQos1PlusPublishes,
             connectOptions: internalConnectOptions,
             pingTimeoutMillis: DEFAULT_MQTT_PING_TIMEOUT_MS,
@@ -341,7 +341,7 @@ export class Mqtt5Client extends BufferedEventEmitter implements mqtt5.IMqtt5Cli
         // trump the stop request
         if (disconnectPacket) {
             disconnectPacket.type = mqtt5_packet.PacketType.Disconnect;
-            validate.validateInitialOutboundPacket(disconnectPacket, internal_mqtt_client.ProtocolMode.Mqtt5);
+            validate.validateInitialOutboundPacket(disconnectPacket, mqtt_shared.ProtocolMode.Mqtt5);
         }
 
         this.internalClient.stop(disconnectPacket);