Merge branch 'JsMqtt-8-311' into JsMqtt-9-5

Author: Bret Ambrose

lib/browser/aws_iot.ts

@@ -14,6 +14,7 @@ import { SocketOptions } from "./io";
 import { MqttClientConnection, MqttConnectionConfig, MqttWill } from "./mqtt";
 import * as platform from "../common/platform";
 import * as iot_shared from "../common/aws_iot_shared"
+import { SDK_NAME } from "../common/mqtt_shared";
 
 /**
  * Builder functions to create a {@link MqttConnectionConfig} which can then be used to create
@@ -328,12 +329,12 @@ export class AwsIotMqttConnectionConfigBuilder {
 
         // Add the metrics string
         if (this.params.username == undefined || this.params.username == null || this.params.username == "") {
-            this.params.username = "?SDK=NodeJSv2&Version="
+            this.params.username = `?SDK=${SDK_NAME}&Version=`
         } else {
             if (this.params.username.indexOf("?") != -1) {
-                this.params.username += "&SDK=NodeJSv2&Version="
+                this.params.username += `&SDK=${SDK_NAME}&Version=`
             } else {
-                this.params.username += "?SDK=NodeJSv2&Version="
+                this.params.username += `?SDK=${SDK_NAME}&Version=`
             }
         }
         this.params.username += platform.crt_version()

lib/browser/mqtt.ts

@@ -30,21 +30,22 @@ import {
     MqttConnectionResumed,
     MqttRequest,
     MqttSubscribeRequest,
-    MqttWill,
     OnConnectionClosedResult,
     OnConnectionFailedResult,
     OnConnectionSuccessResult,
     OnMessageCallback,
     Payload,
     QoS
 } from "../common/mqtt";
-import {normalize_payload, normalize_payload_to_buffer} from "../common/mqtt_shared";
+
+import {normalize_payload, normalize_payload_to_buffer, MqttConnectionConfigBase} from "../common/mqtt_shared";
 import {once} from "events";
 
 export {
     QoS, Payload, MqttRequest, MqttSubscribeRequest, MqttWill, OnMessageCallback, MqttConnectionConnected, MqttConnectionDisconnected,
     MqttConnectionResumed, OnConnectionSuccessResult, OnConnectionFailedResult, OnConnectionClosedResult
 } from "../common/mqtt";
+export { MqttConnectionConfigBase } from "../common/mqtt_shared";
 
 /**
  * Listener signature for event emitted from an {@link MqttClientConnection} when an error occurs
@@ -113,88 +114,14 @@ export type AWSCredentials = auth.AWSCredentials;
 /**
  * Configuration options for an MQTT connection
  *
+ * Extends {@link MqttConnectionConfigBase} with browser-specific options.
+ *
  * @category MQTT
  */
-export interface MqttConnectionConfig {
-    /**
-    * ID to place in CONNECT packet. Must be unique across all devices/clients.
-    * If an ID is already in use, the other client will be disconnected.
-    */
-    client_id: string;
-
-    /** Server name to connect to */
-    host_name: string;
-
-    /** Server port to connect to */
-    port: number;
-
+export interface MqttConnectionConfig extends MqttConnectionConfigBase {
     /** Socket options, ignored in browser */
     socket_options: SocketOptions;
 
-    /**
-     * Whether or not to start a clean session with each reconnect.
-     * If True, the server will forget all subscriptions with each reconnect.
-     * Set False to request that the server resume an existing session
-     * or start a new session that may be resumed after a connection loss.
-     * The `session_present` bool in the connection callback informs
-     * whether an existing session was successfully resumed.
-     * If an existing session is resumed, the server remembers previous subscriptions
-     * and sends messages (with QoS1 or higher) that were published while the client was offline.
-     */
-    clean_session?: boolean;
-
-    /**
-     * The keep alive value, in seconds, to send in CONNECT packet.
-     * A PING will automatically be sent at this interval.
-     * The server will assume the connection is lost if no PING is received after 1.5X this value.
-     * This duration must be longer than {@link ping_timeout}.
-     */
-    keep_alive?: number;
-
-    /**
-     * Milliseconds to wait for ping response before client assumes
-     * the connection is invalid and attempts to reconnect.
-     * This duration must be shorter than keep_alive_secs.
-     * Alternatively, TCP keep-alive via :attr:`SocketOptions.keep_alive`
-     * may accomplish this in a more efficient (low-power) scenario,
-     * but keep-alive options may not work the same way on every platform and OS version.
-     */
-    ping_timeout?: number;
-
-    /**
-     * Milliseconds to wait for the response to the operation requires response by protocol.
-     * Set to zero to disable timeout. Otherwise, the operation will fail if no response is
-     * received within this amount of time after the packet is written to the socket.
-     * It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now.
-     */
-    protocol_operation_timeout?: number;
-
-    /**
-     * Minimum seconds to wait between reconnect attempts.
-     * Must be <= {@link reconnect_max_sec}.
-     * Wait starts at min and doubles with each attempt until max is reached.
-     */
-    reconnect_min_sec?: number;
-
-    /**
-     * Maximum seconds to wait between reconnect attempts.
-     * Must be >= {@link reconnect_min_sec}.
-     * Wait starts at min and doubles with each attempt until max is reached.
-     */
-    reconnect_max_sec?: number;
-
-    /**
-     * Will to send with CONNECT packet. The will is
-     * published by the server when its connection to the client is unexpectedly lost.
-     */
-    will?: MqttWill;
-
-    /** Username to connect with */
-    username?: string;
-
-    /** Password to connect with */
-    password?: string;
-
     /** Options for the underlying websocket connection */
     websocket?: WebsocketOptions;
 

lib/browser/mqtt5.ts

@@ -25,6 +25,7 @@ import * as validate from "./mqtt_internal/validate";
 
 export * from "../common/mqtt5";
 export * from '../common/mqtt5_packet';
+export { Mqtt5ClientConfigBase } from "../common/mqtt_shared";
 
 /**
  * Factory function that allows the user to completely control the url used to form the websocket handshake
@@ -124,66 +125,16 @@ export interface Mqtt5WebsocketConfig {
 /**
  * Configuration options for mqtt5 client creation.
  */
-export interface Mqtt5ClientConfig {
-
-    /**
-     * Host name of the MQTT server to connect to.
-     */
-    hostName: string;
-
-    /**
-     * Network port of the MQTT server to connect to.
-     */
-    port: number;
-
-    /**
-     * Controls how the MQTT5 client should behave with respect to MQTT sessions.
-     */
-    sessionBehavior? : mqtt5.ClientSessionBehavior;
-
-    /**
-     * Controls how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt
-     * timepoints for a large set of reconnecting clients.
-     */
-    retryJitterMode? : mqtt5.RetryJitterType;
-
-    /**
-     * Minimum amount of time to wait to reconnect after a disconnect.  Exponential backoff is performed with jitter
-     * after each connection failure.
-     */
-    minReconnectDelayMs? : number;
-
-    /**
-     * Maximum amount of time to wait to reconnect after a disconnect.  Exponential backoff is performed with jitter
-     * after each connection failure.
-     */
-    maxReconnectDelayMs? : number;
-
-    /**
-     * Amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum.
-     * This helps alleviate bandwidth-waste in fast reconnect cycles due to permission failures on operations.
-     */
-    minConnectedTimeToResetReconnectDelayMs? : number;
-
-    /**
-     * All configurable options with respect to the CONNECT packet sent by the client, including the will.  These
-     * connect properties will be used for every connection attempt made by the client.
-     */
-    connectProperties?: mqtt5_packet.ConnectPacket;
+export interface Mqtt5ClientConfig extends mqtt_shared.Mqtt5ClientConfigBase {
 
     /**
      * Overall time interval to wait to establish an MQTT connection.  If a complete MQTT connection (from socket
      * establishment all the way up to CONNACK receipt) has not been established before this timeout expires,
      * the connection attempt will be considered a failure.
-     */
-    connectTimeoutMs? : number;
-
-    /**
-     * Additional controls for client behavior with respect to topic alias usage.
      *
-     * If this setting is left undefined, then topic aliasing behavior will be disabled.
+     * @group Browser-only
      */
-    topicAliasingOptions? : mqtt5.TopicAliasingOptions
+    connectTimeoutMs? : number;
 
     /**
      * Options for the underlying websocket connection

lib/common/aws_iot_shared.spec.ts

@@ -4,36 +4,36 @@
  */
 
 import * as iot_shared from "./aws_iot_shared";
+import { SDK_NAME } from "./mqtt_shared";
 
 jest.setTimeout(10000);
 
 test('Aws IoT Mqtt5 Username Construction - No Custom Auth', async () => {
     let finalUsername : string = iot_shared.buildMqtt5FinalUsername(undefined);
 
-    expect(finalUsername).toEqual(expect.stringContaining("?SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`?SDK=${SDK_NAME}&Version=`));
 });
 
 test('Aws IoT Mqtt5 Username Construction - Empty custom auth', async () => {
     let finalUsername : string = iot_shared.buildMqtt5FinalUsername({});
 
-    expect(finalUsername).toEqual(expect.stringContaining("?SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`?SDK=${SDK_NAME}&Version=`));
 });
 
-
 test('Aws IoT Mqtt5 Username Construction - Simple username', async () => {
     let finalUsername : string = iot_shared.buildMqtt5FinalUsername({
         username: "Derp"
     });
 
-    expect(finalUsername).toEqual(expect.stringContaining("Derp?SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`Derp?SDK=${SDK_NAME}&Version=`));
 });
 
 test('Aws IoT Mqtt5 Username Construction - Query param username', async () => {
     let finalUsername : string = iot_shared.buildMqtt5FinalUsername({
         username: "Derp?Param1=Value1"
     });
 
-    expect(finalUsername).toEqual(expect.stringContaining("Derp?Param1=Value1&SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`Derp?Param1=Value1&SDK=${SDK_NAME}&Version=`));
 });
 
 test('Aws IoT Mqtt5 Username Construction - Authorizer Name', async () => {
@@ -42,7 +42,7 @@ test('Aws IoT Mqtt5 Username Construction - Authorizer Name', async () => {
         authorizerName: "MyAuthorizer"
     });
 
-    expect(finalUsername).toEqual(expect.stringContaining("Hello?x-amz-customauthorizer-name=MyAuthorizer&SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`Hello?x-amz-customauthorizer-name=MyAuthorizer&SDK=${SDK_NAME}&Version=`));
 });
 
 test('Aws IoT Mqtt5 Username Construction - Token Signing', async () => {
@@ -54,7 +54,7 @@ test('Aws IoT Mqtt5 Username Construction - Token Signing', async () => {
         tokenSignature: "SignedToken"
     });
 
-    expect(finalUsername).toEqual(expect.stringContaining("Hello?x-amz-customauthorizer-name=MyAuthorizer&MyToken=TheToken&x-amz-customauthorizer-signature=SignedToken&SDK=NodeJSv2&Version="));
+    expect(finalUsername).toEqual(expect.stringContaining(`Hello?x-amz-customauthorizer-name=MyAuthorizer&MyToken=TheToken&x-amz-customauthorizer-signature=SignedToken&SDK=${SDK_NAME}&Version=`));
 });
 
 test('Aws IoT Mqtt5 Username Construction Failure - Missing token key name', async () => {

lib/common/aws_iot_shared.ts

@@ -15,6 +15,7 @@
 import * as platform from "./platform";
 import * as mqtt5_packet from "./mqtt5_packet";
 import * as utils from "./utils";
+import { SDK_NAME } from "./mqtt_shared";
 
 /**
  * A helper function to add parameters to the username in with_custom_authorizer function
@@ -204,7 +205,7 @@ function addParam(paramName: string, paramValue: string | undefined, paramSet: [
  *
  * @internal
  */
-export function buildMqtt5FinalUsername(customAuthConfig?: MqttConnectCustomAuthConfig) : string {
+export function buildMqtt5FinalUsername(customAuthConfig?: MqttConnectCustomAuthConfig): string {
 
     let path : string = "";
     let paramList : [string, string][] = [];
@@ -241,7 +242,7 @@ export function buildMqtt5FinalUsername(customAuthConfig?: MqttConnectCustomAuth
         }
     }
 
-    paramList.push(["SDK", "NodeJSv2"]);
+    paramList.push(["SDK", SDK_NAME]);
     paramList.push(["Version", platform.crt_version()]);
 
     return (path ?? "") + "?" + paramList.map((value : [string, string]) => `${value[0]}=${value[1]}`).join("&");

lib/common/mqtt.ts

@@ -197,4 +197,4 @@ export const DEFAULT_RECONNECT_MAX_SEC = 128;
  *
  * @category MQTT
  */
- export const DEFAULT_RECONNECT_MIN_SEC = 1;
+export const DEFAULT_RECONNECT_MIN_SEC = 1;