inspector: support handshake response for websocket inspection

PR-URL: #60225
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>

Author: islandryu

lib/internal/inspector/network_undici.js

@@ -209,23 +209,17 @@ function onClientResponseFinish({ request }) {
 // TODO: Move Network.webSocketCreated to the actual creation time of the WebSocket.
 // undici:websocket:open fires when the connection is established, but this results
 // in an inaccurate stack trace.
-function onWebSocketOpen({ websocket }) {
+function onWebSocketOpen({ websocket, handshakeResponse }) {
   websocket[kInspectorRequestId] = getNextRequestId();
   const url = websocket.url.toString();
   Network.webSocketCreated({
     requestId: websocket[kInspectorRequestId],
     url,
   });
-  // TODO: Use handshake response data from undici diagnostics when available.
-  // https://github.com/nodejs/undici/pull/4396
   Network.webSocketHandshakeResponseReceived({
     requestId: websocket[kInspectorRequestId],
     timestamp: getMonotonicTime(),
-    response: {
-      status: 101,
-      statusText: 'Switching Protocols',
-      headers: {},
-    },
+    response: handshakeResponse,
   });
 }
 

test/common/websocket-server.js

@@ -9,10 +9,12 @@ class WebSocketServer {
   constructor({
     port = 0,
     server,
+    customHandleUpgradeHeaders = [],
   }) {
     this.port = port;
     this.server = server || http.createServer();
     this.clients = new Set();
+    this.customHandleUpgradeHeaders = customHandleUpgradeHeaders;
 
     this.server.on('upgrade', this.handleUpgrade.bind(this));
   }
@@ -36,6 +38,7 @@ class WebSocketServer {
       'Upgrade: websocket',
       'Connection: Upgrade',
       `Sec-WebSocket-Accept: ${acceptKey}`,
+      ...this.customHandleUpgradeHeaders,
     ];
 
     socket.write(responseHeaders.join('\r\n') + '\r\n\r\n');

test/parallel/test-inspector-network-websocket.js

@@ -29,8 +29,15 @@ function findFrameInInitiator(regex, initiator) {
 
 async function test() {
   await session.post('Network.enable');
+
+  const CUSTOM_HEADER_NAME = 'X-Custom-Header';
+  const CUSTOM_HEADER_VALUE = 'CustomHeaderValue';
+
   const server = new WebSocketServer({
     responseError: true,
+    customHandleUpgradeHeaders: [
+      `${CUSTOM_HEADER_NAME}: ${CUSTOM_HEADER_VALUE}`,
+    ]
   });
   await server.start();
   const url = `ws://127.0.0.1:${server.port}/`;
@@ -49,6 +56,11 @@ async function test() {
     assert.strictEqual(message.params.requestId, requestId);
     assert.strictEqual(message.params.response.status, 101);
     assert.strictEqual(message.params.response.statusText, 'Switching Protocols');
+    assert.strictEqual(message.params.response.headers.upgrade, 'websocket');
+    assert.strictEqual(message.params.response.headers.connection, 'Upgrade');
+    assert.ok(message.params.response.headers['sec-websocket-accept']);
+    assert.ok(message.params.response.headers['sec-websocket-accept'].length > 0);
+    assert.strictEqual(message.params.response.headers[CUSTOM_HEADER_NAME.toLowerCase()], CUSTOM_HEADER_VALUE);
     assert.strictEqual(typeof message.params.timestamp, 'number');
     socket.close();
   }));