[fix] Make server.handleUpgrade() work with any duplex stream (#2165)

Author: pimterry

lib/websocket.js

@@ -223,8 +223,13 @@ class WebSocket extends EventEmitter {
     receiver.on('ping', receiverOnPing);
     receiver.on('pong', receiverOnPong);
 
-    socket.setTimeout(0);
-    socket.setNoDelay();
+    // These methods may not be available if `socket` is actually just a stream:
+    if (socket.setTimeout) {
+      socket.setTimeout(0);
+    }
+    if (socket.setNoDelay) {
+      socket.setNoDelay();
+    }
 
     if (head.length > 0) socket.unshift(head);
 

package.json

@@ -58,6 +58,7 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "mocha": "^8.4.0",
+    "native-duplexpair": "^1.0.0",
     "nyc": "^15.0.0",
     "prettier": "^3.0.0",
     "utf-8-validate": "^6.0.0"

test/websocket-server.test.js

@@ -10,6 +10,7 @@ const path = require('path');
 const net = require('net');
 const fs = require('fs');
 const os = require('os');
+const DuplexPair = require('native-duplexpair');
 
 const Sender = require('../lib/sender');
 const WebSocket = require('..');
@@ -514,6 +515,35 @@ describe('WebSocketServer', () => {
         });
       });
     });
+
+    it('can complete a WebSocket upgrade over any duplex stream', (done) => {
+      const server = http.createServer();
+
+      server.listen(0, () => {
+        const wss = new WebSocket.Server({ noServer: true });
+
+        server.on('upgrade', (req, socket, head) => {
+          // Put a stream between the raw socket and our websocket processing:
+          const { socket1: stream1, socket2: stream2 } = new DuplexPair();
+          socket.pipe(stream1);
+          stream1.pipe(socket);
+
+          // Pass the other side of the stream as the socket to upgrade:
+          wss.handleUpgrade(req, stream2, head, (ws) => {
+            ws.send('hello');
+            ws.close();
+          });
+        });
+
+        const ws = new WebSocket(`ws://localhost:${server.address().port}`);
+
+        ws.on('message', (message, isBinary) => {
+          assert.deepStrictEqual(message, Buffer.from('hello'));
+          assert.ok(!isBinary);
+          server.close(done);
+        });
+      });
+    });
   });
 
   describe('#completeUpgrade', () => {