Merge pull request #27 from stas-ut21/develop

4.2.2
stas-ut21 · May 5, 2021 · ca9570e · ca9570e
2 parents 5c6308d + 5dd59b7
commit ca9570e
Show file tree

Hide file tree

Showing 10 changed files with 4,345 additions and 1,222 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,12 +1,11 @@
 language: node_js
 sudo: false
 node_js:
+  - "15"
   - "14"
   - "13"
   - "12"
   - "11"
   - "10"
-  - "9"
-  - "8"
 after_success:
   - "npm install coveralls@3 && nyc report --reporter=text-lcov | coveralls"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+**May 5, 2021 —** [**Docs**](https://github.com/stas-ut21/ws-await/blob/v4.2.2/README.md)
+
+- Add Typescript definitions!
+- Upgrade ws to 7.4.5
+- Upgrade eslint to 7.25.0
+- Upgrade mocha to 8.3.2
+- Default `generateAwaitId` option now use `crypto` module
+- Change `package-lock.json` to 2 version
+- Fix some JSDOC bugs in `websocket.js`
+- Update `.travis.yml` add NodeJS 15
+- Update `.travis.yml`: drop NodeJS 8,9
+
 **February 15, 2021 —** [**Docs**](https://github.com/stas-ut21/ws-await/blob/v4.2.1/README.md)
 
 - Upgrade ws to 7.4.3

diff --git a/README.md b/README.md
@@ -11,6 +11,8 @@ specific message.
 [here](https://github.com/websockets/ws/blob/master/README.md). This module only adds new methods and properties 
 and does not affect the old ones(except Send method - it became asynchronous).
 
+> This module has Typescript definitions!
+
 ## Table of Contents
 
 * [Installing](#installing)

diff --git a/doc/wsAwait.md b/doc/wsAwait.md
@@ -11,7 +11,7 @@ only adds new methods and properties and does not affect the old ones(except `se
 This class represents a WebSocket server. It extends the `WebSocket` class. The following describes the add-ons! 
 Full support for the old api!
 
-### new WebSocket(address[, protocols][, options])
+### new WebSocketAwait(address[, protocols][, options])
 
 - `options` {Object}
     - `awaitTimeout` {Number} The timeout waiting for a response.

diff --git a/index.d.ts b/index.d.ts
diff --git a/lib/default-options.js b/lib/default-options.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const crypto = require('crypto');
+
 /**
  * Default options
  */
@@ -31,9 +33,7 @@ module.exports = {
      *
      * @return {String} is random string
      */
-    generateAwaitId: () => `_${Math.random()
-        .toString(36)
-        .substr(2, 10)}`,
+    generateAwaitId: () => `_${crypto.randomBytes(16).toString('hex')}`,
     /**
      * The function to installation identification parameter to sending messages
      *

diff --git a/lib/websocket.js b/lib/websocket.js
@@ -61,7 +61,7 @@ class WebSocketAwait extends WebSocket {
      * @param {Function} options.attachAwaitId The function to installation identification parameter to sending messages
      * @param {Function} options.extractAwaitId The function to extract identification parameter from incoming messages
      * @param {Function|Null} options.deleteAwaitId The function to delete identification parameter from incoming messages
-     * @throws {WebSocketAwaitValidationError} if validation error
+     * @throws {WebSocketAwait.WebSocketAwaitValidationError} if validation error
      */
     static validateOptions(options) {
         const schema = {
@@ -87,7 +87,7 @@ class WebSocketAwait extends WebSocket {
                 }
 
                 if (schemaArray.indexOf(typeof options[option])) {
-                    throw new WebSocketAwaitValidationError(
+                    throw new WebSocketAwait.WebSocketAwaitValidationError(
                         `The "${option}" argument must be of type ${schema[option]}. ` +
                         `Received type ${typeof options[option]}`,
                     );
@@ -129,28 +129,24 @@ class WebSocketAwait extends WebSocket {
                 const awaitId = this._options.extractAwaitId(parsedData);
 
                 if (awaitId) {
+                    if (!this._options.leaveAwaitId) {
+                        this._options.deleteAwaitId(parsedData);
+                    }
+
                     if (this._checkAwaitId(awaitId)) {
                         const {resolve} = this._getAwaitId(awaitId);
 
                         this._deleteAwaitId(awaitId);
 
-                        if (!this._options.leaveAwaitId) {
-                            delete parsedData.awaitId;
-                        }
-
                         resolve(parsedData);
                     } else {
-                        if (!this._options.leaveAwaitId) {
-                            this._options.deleteAwaitId(parsedData);
-                        }
-
                         this.emit('messageAwait', parsedData, awaitId);
                     }
                 } else {
                     this.emit('message', parsedData);
                 }
             } catch (error) {
-                this.emit('error', new WebSocketAwaitProcessedError(
+                this.emit('error', new WebSocketAwait.WebSocketAwaitProcessedError(
                     'The message received but not processed: ' +
                     `${error.message}, ${data}`,
                 ));
@@ -161,7 +157,7 @@ class WebSocketAwait extends WebSocket {
             for (const item of this._awaitList) {
                 const {reject} = this._getAwaitId(item[0]);
 
-                reject(new WebSocketAwaitConnectionCloseError(
+                reject(new WebSocketAwait.WebSocketAwaitConnectionCloseError(
                     'The message is not sent or not response is received: Connection close',
                 ));
                 this._deleteAwaitId(item[0]);
@@ -205,7 +201,7 @@ class WebSocketAwait extends WebSocket {
     _setAwaitId(awaitId, resolve, reject) {
         const timeout = setTimeout(() => {
             this._deleteAwaitId(awaitId);
-            reject(new WebSocketAwaitTimeoutAwaitError(
+            reject(new WebSocketAwait.WebSocketAwaitTimeoutAwaitError(
                 'No response is received: Response timeout expired',
             ));
         }, this._options.awaitTimeout);
@@ -281,7 +277,7 @@ class WebSocketAwait extends WebSocket {
                     this._deleteAwaitId(awaitId);
                 }
 
-                reject(new WebSocketAwaitSendError(`The message is not sent: ${error.message}`));
+                reject(new WebSocketAwait.WebSocketAwaitSendError(`The message is not sent: ${error.message}`));
             }
         });
     }
@@ -306,10 +302,16 @@ class WebSocketAwait extends WebSocket {
                 await this.send(this._options.attachAwaitId(data, awaitId), options);
                 resolve(awaitId);
             } catch (error) {
-                reject(new WebSocketAwaitSendError(`The message is not sent: ${error.message}`));
+                reject(new WebSocketAwait.WebSocketAwaitSendError(`The message is not sent: ${error.message}`));
             }
         });
     }
 }
 
+WebSocketAwait.WebSocketAwaitValidationError = WebSocketAwaitValidationError;
+WebSocketAwait.WebSocketAwaitConnectionCloseError = WebSocketAwaitConnectionCloseError;
+WebSocketAwait.WebSocketAwaitTimeoutAwaitError = WebSocketAwaitTimeoutAwaitError;
+WebSocketAwait.WebSocketAwaitSendError = WebSocketAwaitSendError;
+WebSocketAwait.WebSocketAwaitProcessedError = WebSocketAwaitProcessedError;
+
 module.exports = WebSocketAwait;