Merge branch 'master' into breaking-changes

Author: mikuso

README.md

@@ -249,8 +249,8 @@ await cli.connect();
 - `options` {Object}
   - `protocols` {Array<String>} - Array of subprotocols supported by this server. Can be overridden in an [auth](#serverauthcallback) callback. Defaults to `[]`.
   - `callTimeoutMs` {Number} - Milliseconds to wait before unanswered outbound calls are rejected automatically. Defaults to `30000`.
-  - `pingIntervalMs` {Number} - Milliseconds between WebSocket pings to connected clients. Defaults to `30000`.
-  - `deferPingsOnActivity` {Boolean} - Should connected clients skip sending pings if activity received? Defaults to `false`.
+  - `pingIntervalMs` {Number} - Milliseconds between WebSocket pings to connected clients. Used for keep-alive timeouts. Defaults to `30000`.
+  - `deferPingsOnActivity` {Boolean} - Should connected clients skip sending keep-alive pings if activity received? Defaults to `false`.
   - `respondWithDetailedErrors` {Boolean} - Specifies whether to send detailed errors (including stack trace) to remote party upon an error being thrown by a handler. Defaults to `false`.
   - `callConcurrency` {Number} - The number of concurrent in-flight outbound calls permitted at any one time. Additional calls are queued. (There is no limit on inbound calls.) Defaults to `1`.
   - `strictMode` {Boolean} - Enable strict validation of calls & responses. Defaults to `false`. (See [Strict Validation](#strict-validation) to understand how this works.)
@@ -388,8 +388,8 @@ Returns a `Promise` which resolves when the server has completed closing.
   - `headers` {Object} - Additional HTTP headers to send along with the websocket upgrade request. Defaults to `{}`.
   - `query` {Object|String} - An optional query string or object to append as the query string of the connection URL. Defaults to `''`.
   - `callTimeoutMs` {Number} - Milliseconds to wait before unanswered outbound calls are rejected automatically. Defaults to `60000`.
-  - `pingIntervalMs` {Number} - Milliseconds between WebSocket pings. Defaults to `30000`.
-  - `deferPingsOnActivity` {Boolean} - Should the client skip sending pings if activity received? Defaults to `false`.
+  - `pingIntervalMs` {Number} - Milliseconds between WebSocket pings. Used for keep-alive timeouts. Defaults to `30000`.
+  - `deferPingsOnActivity` {Boolean} - Should the client skip sending keep-alive pings if activity received? Defaults to `false`.
   - `strictMode` {Boolean} - Enable strict validation of calls & responses. Defaults to `false`. (See [Strict Validation](#strict-validation) to understand how this works.)
   - `strictModeValidators` {Array<Validator>} - Optional additional validators to be used in conjunction with `strictMode`. (See [Strict Validation](#adding-additional-validation-schemas) to understand how this works.)
   - `respondWithDetailedErrors` {Boolean} - Specifies whether to send detailed errors (including stack trace) to remote party upon an error being thrown by a handler. Defaults to `false`.

lib/server.js

@@ -110,13 +110,21 @@ class RPCServer extends EventEmitter {
                 }
             };
 
+            socket.on('error', (err) => {
+                abortUpgrade(err);
+            });
+
             try {
                 if (this._state !== OPEN) {
                     throw new WebsocketUpgradeError(500, "Server not open");
                 }
 
-                const headers = request.headers;
+                if (socket.readyState !== 'open') {
+                    throw new WebsocketUpgradeError(400, `Client readyState = '${socket.readyState}'`);
+                }
 
+                const headers = request.headers;
+
                 if (headers.upgrade.toLowerCase() !== 'websocket') {
                     throw new WebsocketUpgradeError(400, "Can only upgrade websocket upgrade requests");
                 }
@@ -163,25 +171,32 @@ class RPCServer extends EventEmitter {
                 const accept = (session, protocol) => {
                     if (resolved) return;
                     resolved = true;
+                    
+                    try {
+                        if (socket.readyState !== 'open') {
+                            throw new WebsocketUpgradeError(400, `Client readyState = '${socket.readyState}'`);
+                        }
 
-                    if (protocol === undefined) {
-                        // pick first subprotocol (preferred by server) that is also supported by the client
-                        protocol = (this._options.protocols ?? []).find(p => protocols.has(p));
-                    } else if (protocol !== false && !protocols.has(protocol)) {
-                        abortUpgrade(new WebsocketUpgradeError(400, `Client doesn't support expected subprotocol`));
-                        return;
-                    }
+                        if (protocol === undefined) {
+                            // pick first subprotocol (preferred by server) that is also supported by the client
+                            protocol = (this._options.protocols ?? []).find(p => protocols.has(p));
+                        } else if (protocol !== false && !protocols.has(protocol)) {
+                            throw new WebsocketUpgradeError(400, `Client doesn't support expected subprotocol`);
+                        }
 
-                    // cache auth results for connection creation
-                    this._pendingUpgrades.set(request, {
-                        session: session ?? {},
-                        protocol,
-                        handshake
-                    });
+                        // cache auth results for connection creation
+                        this._pendingUpgrades.set(request, {
+                            session: session ?? {},
+                            protocol,
+                            handshake
+                        });
 
-                    this._wss.handleUpgrade(request, socket, head, ws => {
-                        this._wss.emit('connection', ws, request);
-                    });
+                        this._wss.handleUpgrade(request, socket, head, ws => {
+                            this._wss.emit('connection', ws, request);
+                        });
+                    } catch (err) {
+                        abortUpgrade(err);
+                    }
                 };
 
                 const reject = (code = 404, message = 'Not found') => {
@@ -198,10 +213,6 @@ class RPCServer extends EventEmitter {
                     reject(400, `Client connection closed before upgrade complete`);
                 });
 
-                socket.on('error', (err) => {
-                    abortUpgrade(err);
-                });
-
                 if (this.authCallback) {
                     await this.authCallback(
                         accept,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ocpp-rpc",
-  "version": "1.10.1",
+  "version": "1.10.2",
   "description": "A client & server implementation of the WAMP-like RPC-over-websocket system defined in the OCPP protcols (e.g. OCPP1.6-J and OCPP2.0.1).",
   "main": "index.js",
   "scripts": {