@stomp/stompjs 5.3.0 → 5.4.4

package/README.md

@@ -41,7 +41,7 @@ The API documentation is hosted as GitHub pages for entire StompJS family of lib
 You may head straight to the https://stomp-js.github.io/api-docs/latest/
 
 This library comes with detailed usage instructions. Please find it at 
-[Usage instructions](https://stomp-js.github.io/guide/stompjs/2018/06/28/using-stompjs-v5.html).
+[Usage instructions](https://stomp-js.github.io/guide/stompjs/2018/06/29/using-stompjs-v5.html).
 Check out other guides at https://stomp-js.github.io/.
 
 There are quite detailed API documentation,
@@ -80,7 +80,8 @@ If you want to understand the code, develop, or contribute. Please visit
  * [Dillon Sellars](https://github.com/dillon-sellars)
  * [Jimi Charalampidis](https://github.com/jimic)
  * [Raul](https://github.com/rulonder)
+ * [Dimitar Georgiev](https://github.com/iMitaka)
 
 ## License
 
-[License](LICENSE.md) - Apache v2 License
+[License](LICENSE.md) - MIT License

package/bundles/stomp.umd.js

@@ -133,10 +133,11 @@ exports.BYTE = {
 "use strict";
 
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
@@ -170,6 +171,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var stomp_handler_1 = __webpack_require__(/*! ./stomp-handler */ "./src/stomp-handler.ts");
 var versions_1 = __webpack_require__(/*! ./versions */ "./src/versions.ts");
+var web_socket_state_1 = __webpack_require__(/*! ./web-socket-state */ "./src/web-socket-state.ts");
 /**
  * STOMP Client Class.
  *
@@ -235,14 +237,11 @@ var Client = /** @class */ (function () {
          * A bug in ReactNative chops a string on occurrence of a NULL.
          * See issue [https://github.com/stomp-js/stompjs/issues/89]{@link https://github.com/stomp-js/stompjs/issues/89}.
          * This makes incoming WebSocket messages invalid STOMP packets.
-         * Seeting this flag attempts to reverse the damage by appending a NULL.
+         * Setting this flag attempts to reverse the damage by appending a NULL.
          * If the broker splits a large message into multiple WebSocket messages,
          * this flag will cause data loss and abnormal termination of connection.
          *
          * This is not an ideal solution, but a stop gap until the underlying issue is fixed at ReactNative library.
-         *
-         * This flag only impacts handling of text frames.
-         * Binary frames are not impacted by the underlying issue.
          */
         this.appendMissingNULLonIncoming = false;
         this._active = false;
@@ -370,6 +369,7 @@ var Client = /** @class */ (function () {
                             maxWebSocketChunkSize: this.maxWebSocketChunkSize,
                             forceBinaryWSFrames: this.forceBinaryWSFrames,
                             logRawCommunication: this.logRawCommunication,
+                            appendMissingNULLonIncoming: this.appendMissingNULLonIncoming,
                             onConnect: function (frame) {
                                 if (!_this._active) {
                                     _this.debug('STOMP got connected while deactivate was issued, will disconnect now');
@@ -454,8 +454,9 @@ var Client = /** @class */ (function () {
      */
     Client.prototype.forceDisconnect = function () {
         if (this._webSocket) {
-            if (this._webSocket.readyState === WebSocket.CONNECTING || this._webSocket.readyState === WebSocket.OPEN) {
-                this._webSocket.close();
+            if (this._webSocket.readyState === web_socket_state_1.WebSocketState.CONNECTING
+                || this._webSocket.readyState === web_socket_state_1.WebSocketState.OPEN) {
+                this._stompHandler._closeWebsocket();
             }
         }
     };
@@ -1091,7 +1092,15 @@ var Stomp = /** @class */ (function () {
      * using [Client#webSocketFactory]{@link Client#webSocketFactory}.
      */
     Stomp.over = function (ws) {
-        var wsFn = typeof (ws) === 'function' ? ws : function () { return ws; };
+        var wsFn;
+        if (typeof (ws) === 'function') {
+            wsFn = ws;
+        }
+        else {
+            console.warn('Stomp.over did not receive a factory, auto reconnect will not work. ' +
+                'Please see https://stomp-js.github.io/api-docs/latest/classes/Stomp.html#over');
+            wsFn = function () { return ws; };
+        }
         return new compat_client_1.CompatClient(wsFn);
     };
     /**
@@ -1322,6 +1331,7 @@ __export(__webpack_require__(/*! ./stomp-config */ "./src/stomp-config.ts"));
 __export(__webpack_require__(/*! ./stomp-headers */ "./src/stomp-headers.ts"));
 __export(__webpack_require__(/*! ./stomp-subscription */ "./src/stomp-subscription.ts"));
 __export(__webpack_require__(/*! ./versions */ "./src/versions.ts"));
+__export(__webpack_require__(/*! ./web-socket-state */ "./src/web-socket-state.ts"));
 // Compatibility code
 __export(__webpack_require__(/*! ./compatibility/compat-client */ "./src/compatibility/compat-client.ts"));
 __export(__webpack_require__(/*! ./compatibility/stomp */ "./src/compatibility/stomp.ts"));
@@ -1406,7 +1416,8 @@ var Parser = /** @class */ (function () {
         this._token = [];
         this._initState();
     }
-    Parser.prototype.parseChunk = function (segment) {
+    Parser.prototype.parseChunk = function (segment, appendMissingNULLonIncoming) {
+        if (appendMissingNULLonIncoming === void 0) { appendMissingNULLonIncoming = false; }
         var chunk;
         if ((segment instanceof ArrayBuffer)) {
             chunk = new Uint8Array(segment);
@@ -1414,6 +1425,16 @@ var Parser = /** @class */ (function () {
         else {
             chunk = this._encoder.encode(segment);
         }
+        // See https://github.com/stomp-js/stompjs/issues/89
+        // Remove when underlying issue is fixed.
+        //
+        // Send a NULL byte, if the last byte of a Text frame was not NULL.F
+        if (appendMissingNULLonIncoming && chunk[chunk.length - 1] !== 0) {
+            var chunkWithNull = new Uint8Array(chunk.length + 1);
+            chunkWithNull.set(chunk, 0);
+            chunkWithNull[chunk.length] = 0;
+            chunk = chunkWithNull;
+        }
         // tslint:disable-next-line:prefer-for-of
         for (var i = 0; i < chunk.length; i++) {
             var byte = chunk[i];
@@ -1583,6 +1604,7 @@ var byte_1 = __webpack_require__(/*! ./byte */ "./src/byte.ts");
 var frame_impl_1 = __webpack_require__(/*! ./frame-impl */ "./src/frame-impl.ts");
 var parser_1 = __webpack_require__(/*! ./parser */ "./src/parser.ts");
 var versions_1 = __webpack_require__(/*! ./versions */ "./src/versions.ts");
+var web_socket_state_1 = __webpack_require__(/*! ./web-socket-state */ "./src/web-socket-state.ts");
 /**
  * The STOMP protocol handler
  *
@@ -1592,8 +1614,8 @@ var versions_1 = __webpack_require__(/*! ./versions */ "./src/versions.ts");
  */
 var StompHandler = /** @class */ (function () {
     function StompHandler(_client, _webSocket, config) {
-        if (config === void 0) { config = {}; }
         var _this = this;
+        if (config === void 0) { config = {}; }
         this._client = _client;
         this._webSocket = _webSocket;
         this._serverFrameHandlers = {
@@ -1706,17 +1728,7 @@ var StompHandler = /** @class */ (function () {
                 var rawChunkAsString = (evt.data instanceof ArrayBuffer) ? new TextDecoder().decode(evt.data) : evt.data;
                 _this.debug("<<< " + rawChunkAsString);
             }
-            parser.parseChunk(evt.data);
-            // See https://github.com/stomp-js/stompjs/issues/89
-            // Remove when underlying issue is fixed.
-            //
-            // Send a NULL byte, if the last byte of a Text frame was not NULL.
-            if (_this.appendMissingNULLonIncoming && !(evt.data instanceof ArrayBuffer)) {
-                if (evt.data[evt.data.length - 1] !== 0) {
-                    var bufferWithNull = (new Uint8Array([0])).buffer;
-                    parser.parseChunk(bufferWithNull);
-                }
-            }
+            parser.parseChunk(evt.data, _this.appendMissingNULLonIncoming);
         };
         this._webSocket.onclose = function (closeEvent) {
             _this.debug("Connection closed to " + _this._webSocket.url);
@@ -1740,6 +1752,11 @@ var StompHandler = /** @class */ (function () {
         if ((headers.version !== versions_1.Versions.V1_1 && headers.version !== versions_1.Versions.V1_2)) {
             return;
         }
+        // It is valid for the server to not send this header
+        // https://stomp.github.io/stomp-specification-1.2.html#Heart-beating
+        if (!headers['heart-beat']) {
+            return;
+        }
         // heart-beat header received from the server looks like:
         //
         //     heart-beat: sx, sy
@@ -1748,7 +1765,7 @@ var StompHandler = /** @class */ (function () {
             var ttl = Math.max(this.heartbeatOutgoing, serverIncoming);
             this.debug("send PING every " + ttl + "ms");
             this._pinger = setInterval(function () {
-                if (_this._webSocket.readyState === WebSocket.OPEN) {
+                if (_this._webSocket.readyState === web_socket_state_1.WebSocketState.OPEN) {
                     _this._webSocket.send(byte_1.BYTE.LF);
                     _this.debug('>>> PING');
                 }
@@ -1762,11 +1779,15 @@ var StompHandler = /** @class */ (function () {
                 // We wait twice the TTL to be flexible on window's setInterval calls
                 if (delta > (ttl_1 * 2)) {
                     _this.debug("did not receive server activity for the last " + delta + "ms");
-                    _this._webSocket.close();
+                    _this._closeWebsocket();
                 }
             }, ttl_1);
         }
     };
+    StompHandler.prototype._closeWebsocket = function () {
+        this._webSocket.onmessage = function () { }; // ignore messages
+        this._webSocket.close();
+    };
     StompHandler.prototype._transmit = function (params) {
         var command = params.command, headers = params.headers, body = params.body, binaryBody = params.binaryBody, skipContentLengthHeader = params.skipContentLengthHeader;
         var frame = new frame_impl_1.FrameImpl({
@@ -1810,7 +1831,7 @@ var StompHandler = /** @class */ (function () {
                     disconnectHeaders.receipt = "close-" + this._counter++;
                 }
                 this.watchForReceipt(disconnectHeaders.receipt, function (frame) {
-                    _this._webSocket.close();
+                    _this._closeWebsocket();
                     _this._cleanUp();
                     _this.onDisconnect(frame);
                 });
@@ -1821,8 +1842,9 @@ var StompHandler = /** @class */ (function () {
             }
         }
         else {
-            if (this._webSocket.readyState === WebSocket.CONNECTING || this._webSocket.readyState === WebSocket.OPEN) {
-                this._webSocket.close();
+            if (this._webSocket.readyState === web_socket_state_1.WebSocketState.CONNECTING
+                || this._webSocket.readyState === web_socket_state_1.WebSocketState.OPEN) {
+                this._closeWebsocket();
             }
         }
     };
@@ -2048,6 +2070,34 @@ var Versions = /** @class */ (function () {
 exports.Versions = Versions;
 
 
+/***/ }),
+
+/***/ "./src/web-socket-state.ts":
+/*!*********************************!*\
+  !*** ./src/web-socket-state.ts ***!
+  \*********************************/
+/*! no static exports found */
+/***/ (function(module, exports, __webpack_require__) {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Possible states for the WebSocket, copied here to avoid dependency on WebSocket class
+ *
+ * Part of `@stomp/rx-stomp`
+ *
+ * @internal
+ */
+var WebSocketState;
+(function (WebSocketState) {
+    WebSocketState[WebSocketState["CONNECTING"] = 0] = "CONNECTING";
+    WebSocketState[WebSocketState["OPEN"] = 1] = "OPEN";
+    WebSocketState[WebSocketState["CLOSING"] = 2] = "CLOSING";
+    WebSocketState[WebSocketState["CLOSED"] = 3] = "CLOSED";
+})(WebSocketState = exports.WebSocketState || (exports.WebSocketState = {}));
+
+
 /***/ }),
 
 /***/ 0: