Add support for Browsers & Web Sockets

.gitignore

@@ -56,8 +56,11 @@ obj/*
 .env
 typings/
 dist/
+dist-esm/
+browser/
 output/
 client/examples/js/lib/
 processor/examples/js/lib/
 typedoc
-out/
+out/
+

.vscode/settings.json

@@ -1,27 +1,29 @@
 {
-    "files.exclude": {
-      "**/.git": true,
-      "**/.svn": true,
-      "**/.DS_Store": true
-    },
-    "[typescript]": {
-      "editor.formatOnSave": true,
-      "editor.formatOnPaste": true,
-      "editor.tabSize": 2,
-      "editor.detectIndentation": false
-    },
-    "[json]": {
-      "editor.formatOnSave": true,
-      "editor.formatOnPaste": true,
-      "editor.tabSize": 2,
-      "editor.detectIndentation": false
-    },
-    "[yaml]": {
-      "editor.formatOnSave": true,
-      "editor.formatOnPaste": true,
-      "editor.tabSize": 2,
-      "editor.detectIndentation": false
-    },
-    "editor.rulers": [100],
-    "typescript.tsdk": "./client/node_modules/typescript/lib"
-  }
+  "files.exclude": {
+    "**/.git": true,
+    "**/.svn": true,
+    "**/.DS_Store": true
+  },
+  "[typescript]": {
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.tabSize": 2,
+    "editor.detectIndentation": false
+  },
+  "[json]": {
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.tabSize": 2,
+    "editor.detectIndentation": false
+  },
+  "[yaml]": {
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.tabSize": 2,
+    "editor.detectIndentation": false
+  },
+  "editor.rulers": [
+    100
+  ],
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}

karma.conf.js

@@ -0,0 +1,75 @@
+// Karma configuration
+// Generated on Fri Mar 08 2019 11:00:13 GMT-0800 (Pacific Standard Time)
+
+module.exports = function (config) {
+  config.set({
+
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: '',
+
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha'],
+
+
+    // list of files / patterns to load in the browser
+    files: [
+      './test-browser/index.js'
+    ],
+
+
+    // list of files / patterns to exclude
+    exclude: [
+    ],
+
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+    },
+
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ['progress'],
+
+
+    // web server port
+    port: 9876,
+
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: ['Chrome'],
+
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: true,
+
+    // Concurrency level
+    // how many browser should be started simultaneous
+    concurrency: Infinity,
+
+    client: {
+      mocha: {
+        timeout: 50000
+      }
+    }
+  })
+}

lib/ConnectionContextBase.ts

@@ -7,6 +7,8 @@ import { DataTransformer, DefaultDataTransformer } from "./dataTransformer";
 import { TokenProvider } from "./auth/token";
 import { ConnectionConfig } from "./connectionConfig";
 import { SasTokenProvider } from "./auth/sas";
+import rhea from "rhea";
+
 import * as Constants from "./util/constants";
 import * as os from "os";
 
@@ -132,12 +134,15 @@ export module ConnectionContextBase {
     if (!parameters || typeof parameters !== "object") {
       throw new Error("'parameters' is a required parameter and must be of type 'object'.");
     }
-    ConnectionConfig.validate(parameters.config,
-      { isEntityPathRequired: parameters.isEntityPathRequired || false });
+    ConnectionConfig.validate(parameters.config, {
+      isEntityPathRequired: parameters.isEntityPathRequired || false
+    });
     const userAgent = parameters.connectionProperties.userAgent;
     if (userAgent.length > Constants.maxUserAgentLength) {
-      throw new Error(`The user-agent string cannot be more than 128 characters in length.` +
-        `The given user-agent string is: ${userAgent} with length: ${userAgent.length}`);
+      throw new Error(
+        `The user-agent string cannot be more than 128 characters in length.` +
+        `The given user-agent string is: ${userAgent} with length: ${userAgent.length}`
+      );
     }
 
     const connectionOptions: ConnectionOptions = {
@@ -157,6 +162,19 @@ export module ConnectionContextBase {
       operationTimeoutInSeconds: parameters.operationTimeoutInSeconds
     };
 
+    if (parameters.config.webSocket || (typeof window !== "undefined" && (window as any).WebSocket)) {
+      const socket = parameters.config.webSocket || (window as any).WebSocket;
+      // TODO: expose websocket_connect via rhea-promise
+      const ws = rhea.websocket_connect(socket);
+      const host = parameters.config.host;
+      const endpoint = parameters.config.webSocketEndpointPath || '';
+
+      // connectionOptions is cast to any to work around type errors.
+      // The errors seem spurious and so are ignored.
+      (connectionOptions.connection_details as any) =
+        ws(`wss://${host}:443/${endpoint}`, ["AMQPWSB10"], {});
+    }
+
     const connection = new Connection(connectionOptions);
     const connectionLock = `${Constants.establishConnection}-${generate_uuid()}`;
     const connectionContextBase: ConnectionContextBase = {
@@ -167,9 +185,13 @@ export module ConnectionContextBase {
       connectionId: connection.id,
       cbsSession: new CbsClient(connection, connectionLock),
       config: parameters.config,
-      tokenProvider: parameters.tokenProvider ||
-        new SasTokenProvider(parameters.config.endpoint, parameters.config.sharedAccessKeyName,
-          parameters.config.sharedAccessKey),
+      tokenProvider:
+        parameters.tokenProvider ||
+        new SasTokenProvider(
+          parameters.config.endpoint,
+          parameters.config.sharedAccessKeyName,
+          parameters.config.sharedAccessKey
+        ),
       dataTransformer: parameters.dataTransformer || new DefaultDataTransformer()
     };
 

lib/auth/aad.ts

@@ -3,7 +3,7 @@
 
 import {
   ApplicationTokenCredentials, DeviceTokenCredentials, UserTokenCredentials, MSITokenCredentials
-} from "ms-rest-azure";
+} from "@azure/ms-rest-nodeauth";
 import { TokenInfo, TokenType, TokenProvider } from "./token";
 import * as Constants from "../util/constants";
 
@@ -50,26 +50,21 @@ export class AadTokenProvider implements TokenProvider {
    * @param {string} [audience] - The audience for which the token is desired. If not
    * provided then the Endpoint from the connection string will be applied.
    */
-  getToken(audience?: string): Promise<TokenInfo> {
+  async getToken(audience?: string): Promise<TokenInfo> {
     const self = this;
-    return new Promise<TokenInfo>((resolve, reject) => {
-      self.credentials.getToken((err, result) => {
-        if (err) {
-          reject(err);
-        }
-        let expiresOn = Date.now();
-        if (result.expiresOn && result.expiresOn instanceof Date) {
-          expiresOn = result.expiresOn.getTime();
-        }
-        const expiry = Math.floor(expiresOn / 1000) +
-          self.tokenValidTimeInSeconds - Constants.aadTokenValidityMarginSeconds;
-        const tokenObj: TokenInfo = {
-          expiry: expiry,
-          tokenType: TokenType.CbsTokenTypeJwt,
-          token: result.accessToken
-        };
-        resolve(tokenObj);
-      });
-    });
+    const result = await self.credentials.getToken();
+    let expiresOn = Date.now();
+    if (result.expiresOn && result.expiresOn instanceof Date) {
+      expiresOn = result.expiresOn.getTime();
+    }
+    const expiry = Math.floor(expiresOn / 1000) +
+      self.tokenValidTimeInSeconds - Constants.aadTokenValidityMarginSeconds;
+    const tokenObj: TokenInfo = {
+      expiry: expiry,
+      tokenType: TokenType.CbsTokenTypeJwt,
+      token: result.accessToken
+    };
+
+    return tokenObj;
   }
 }

lib/auth/iotSas.ts

@@ -3,6 +3,7 @@
 
 import { SasTokenProvider } from "./sas";
 import { TokenInfo } from "./token";
+import { Buffer } from "buffer";
 
 /**
  * @class IotSasTokenProvider

lib/auth/sas.ts

@@ -3,8 +3,9 @@
 
 import { parseConnectionString, ServiceBusConnectionStringModel } from "../util/utils";
 import { TokenInfo, TokenProvider, TokenType } from "./token";
-const isBuffer = require("is-buffer");
-const jssha = require("jssha");
+import { Buffer } from "buffer";
+import isBuffer from "is-buffer";
+import jssha from "jssha";
 
 /**
  * @class SasTokenProvider
@@ -37,7 +38,7 @@ export class SasTokenProvider implements TokenProvider {
   tokenValidTimeInSeconds: number;
 
   /**
-   * Initializes a new isntance of SasTokenProvider
+   * Initializes a new instance of SasTokenProvider
    * @constructor
    * @param {string} namespace - The namespace of the EventHub/ServiceBus instance.
    * @param {string} keyName - The name of the EventHub/ServiceBus key.

lib/connectionConfig/connectionConfig.ts

@@ -3,6 +3,26 @@
 
 import { parseConnectionString, ServiceBusConnectionStringModel } from "../util/utils";
 
+/**
+ * Describes the required shape of WebSocket instances.
+ * @interface WebSocketInstance
+ */
+export interface WebSocketInstance {
+  send: Function;
+  onmessage: Function | null;
+  onopen: Function | null;
+  onclose: Function | null;
+  onerror: Function | null;
+}
+
+/**
+ * Describes the required shape of WebSocket constructors.
+ * @interface WebSocketImpl
+ */
+export interface WebSocketImpl {
+  new(url: string, protocols?: string | string[]): WebSocketInstance;
+}
+
 /**
  * Describes the options that can be provided while creating a connection config.
  * @interface ConnectionConfigOptions
@@ -47,6 +67,19 @@ export interface ConnectionConfig {
    * @property {string} sharedAccessKey - The secret value of the access key.
    */
   sharedAccessKey: string;
+
+  /**
+   * @property {WebSocketImpl} [webSocket] - The WebSocket constructor used to create an AMQP connection
+   * over a WebSocket. In browsers, the built-in WebSocket will be  used by default. In Node, a
+   * TCP socket will be used if a WebSocket constructor is not provided.
+   */
+  webSocket?: WebSocketImpl;
+
+  /**
+   * @property {string} [webSocketEndpointPath] - The path for the endpoint that accepts an AMQP
+   * connection over WebSockets.
+   */
+  webSocketEndpointPath?: string;
 }
 
 /**
@@ -73,13 +106,15 @@ export namespace ConnectionConfig {
     }
 
     if (!parsedCS.Endpoint.endsWith("/")) parsedCS.Endpoint += "/";
+
     const result: ConnectionConfig = {
       connectionString: connectionString,
       endpoint: parsedCS.Endpoint,
       host: (parsedCS && parsedCS.Endpoint) ? (parsedCS.Endpoint.match('sb://([^/]*)') || [])[1] : "",
       sharedAccessKeyName: parsedCS.SharedAccessKeyName,
       sharedAccessKey: parsedCS.SharedAccessKey
     };
+
     if (path || parsedCS.EntityPath) result.entityPath = path || parsedCS.EntityPath;
     return result;
   }

lib/dataTransformer.ts

@@ -3,8 +3,8 @@
 
 import { message } from "rhea-promise";
 import * as log from "./log";
-
-const isBuffer = require("is-buffer");
+import isBuffer from "is-buffer";
+import { Buffer } from "buffer";
 
 /**
  * Describes the transformations that can be performed to encode/decode the data before sending it

lib/index.browser.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+// This file is a stub export filling in missing capabilities in the browser.
+// The AadTokenProvider is only supported in Node.
+export const AadTokenProvider = undefined;

lib/index.node.ts

@@ -0,0 +1 @@
+export { AadTokenProvider } from "./auth/aad";

lib/index.ts

@@ -1,13 +1,16 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+/// <reference lib="es2015" />
+
 export { RequestResponseLink, SendRequestOptions } from "./requestResponseLink";
 export { retry, RetryConfig, RetryOperationType } from "./retry";
 export { DataTransformer, DefaultDataTransformer } from "./dataTransformer";
 export { TokenType, TokenProvider, TokenInfo } from "./auth/token";
 export { SasTokenProvider } from "./auth/sas";
 export { IotSasTokenProvider } from "./auth/iotSas";
-export { AadTokenProvider } from "./auth/aad";
+export * from './index.node';
+
 export {
   ConnectionConfig, ConnectionConfigOptions, EventHubConnectionConfig, IotHubConnectionConfig
 } from "./connectionConfig";