Merge branch 'master' into breaking-changes

Author: mikuso

.github/workflows/test.yaml

@@ -9,8 +9,9 @@ jobs:
     strategy:
       matrix:
         nodeVer:
-          - 17.2.0
+          - 17.3.0
           - 18
+          - 19
     steps:
 
       - uses: actions/checkout@master

README.md

@@ -9,9 +9,9 @@
 
 ![OCPP-RPC](/docs/logo.png)
 
-A client & server implementation of the WAMP-like RPC-over-websocket system defined in the [OCPP-J protcols](https://www.openchargealliance.org/protocols/) (e.g. [OCPP1.6J](https://www.openchargealliance.org/protocols/ocpp-16/) and [OCPP2.0.1J](https://www.openchargealliance.org/protocols/ocpp-201/)).
+A client & server implementation of the WAMP-like RPC-over-websocket system defined in the [OCPP-J protocols](https://www.openchargealliance.org/protocols/) (e.g. [OCPP1.6J](https://www.openchargealliance.org/protocols/ocpp-16/) and [OCPP2.0.1J](https://www.openchargealliance.org/protocols/ocpp-201/)).
 
-Requires Node.js >= 17.2.0
+Requires Node.js >= 17.3.0
 
 This module is built for Node.js and does not currently work in browsers.
 

lib/client.js

@@ -11,6 +11,7 @@ const { getErrorPlainObject, createRPCError, getPackageIdent } = require('./util
 const Queue = require('./queue');
 const EventBuffer = require('./event-buffer');
 const standardValidators = require('./standard-validators');
+const {isValidStatusCode} = require('./ws-util');
 
 const MSG_CALL = 2;
 const MSG_CALLRESULT = 3;
@@ -212,7 +213,10 @@ class RPCClient extends EventEmitter {
                 } else {
                     // await pending calls & responses
                     await this._awaitUntilPendingSettled();
-                    this._ws.close(code ?? 1000, reason);
+                    if (!code || !isValidStatusCode(code)) {
+                        code = 1000;
+                    }
+                    this._ws.close(code, reason);
                 }
 
                 let [codeRes, reasonRes] = await once(this._ws, 'close');

lib/ws-util.js

@@ -108,7 +108,26 @@ function parseSubprotocols(header) {
     return protocols;
 }
 
+/**
+ * Checks if a status code is allowed in a close frame.
+ *
+ * @param {Number} code The status code
+ * @return {Boolean} `true` if the status code is valid, else `false`
+ * @public
+ */
+ function isValidStatusCode(code) {
+    return (
+      (code >= 1000 &&
+        code <= 1014 &&
+        code !== 1004 &&
+        code !== 1005 &&
+        code !== 1006) ||
+      (code >= 3000 && code <= 4999)
+    );
+  }
+
 module.exports = {
     abortHandshake,
     parseSubprotocols,
+    isValidStatusCode,
 };

package-lock.json

@@ -1,14 +1,14 @@
 {
   "name": "ocpp-rpc",
-  "version": "1.10.3",
-  "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).",
+  "version": "1.10.4",
+  "description": "A client & server implementation of the WAMP-like RPC-over-websocket system defined in the OCPP protocols (e.g. OCPP1.6-J and OCPP2.0.1).",
   "main": "index.js",
   "scripts": {
     "test": "mocha",
     "coverage": "nyc --reporter=lcov --reporter=text mocha"
   },
   "engines": {
-    "node": ">=17.2.0"
+    "node": ">=17.3.0"
   },
   "keywords": [
     "ocpp",

package.json

@@ -888,6 +888,30 @@ describe('RPCClient', function(){
 
         });
 
+        it('should treat invalid/reserved close codes as 1000', async () => {
+
+            const {server, endpoint, close} = await createServer();
+            const cli = new RPCClient({endpoint, identity: 'X'});
+
+            try {
+                const testCodes = [-1000,0,1,1005,10000];
+
+                for (const testCode of testCodes) {
+                    const serverClientPromise = once(server, 'client');
+                    await cli.connect();
+                    const [serverClient] = await serverClientPromise;
+                    const serverClosePromise = once(serverClient, 'close');
+                    await cli.close({code: testCode});
+                    const [serverClose] = await serverClosePromise;
+                    assert.equal(serverClose.code, 1000);
+                }
+
+            } finally {
+                close();
+            }
+
+        });
+
         it('should return the close code of the first close() call', async () => {
 
             const {endpoint, close} = await createServer();