Node.js中http-proxy通过HTTPS代理无法升级WebSocket问题排查

问题描述 #

使用http-proxy搭建HTTPS代理服务，/login接口代理正常，但/socket.io的WebSocket连接无法建立，控制台无任何错误输出，怀疑连接未完成协议升级。后端服务器监听3000端口，同时处理HTTP请求与WebSocket连接。

用户代码 #

var app = require('express')();
const https = require('https');
const fs = require('fs');
var httpProxy = require('http-proxy');

var proxy = httpProxy.createProxyServer({ws:true});
var server=https.createServer(credentials, app).listen(8082)

app.use('/login', function (req, res) {
   console.log("Request Url "+req.url)
   proxy.web(req, res,{target:'example.com:3000'})
})

app.use('/socket.io',function(req,socket,head){
    console.log("Request Url "+req.url)
    server.on('upgrade', function(req, socket, head) {
        socket.on('error', (error) => {
             console.error(error);
         });
        proxy.ws(req, socket, head, {target:'example.com:3000'})
      });
})

问题分析与修复方案 #

1. 错误的Express中间件回调参数 #

app.use('/socket.io')的回调函数参数错误，Express中间件的标准参数是(req, res, next)，而非(req, socket, head)——后者是WebSocket升级事件的回调参数，不能直接用于Express中间件中。

2. 重复绑定upgrade事件 #

每次有/socket.io请求时就执行server.on('upgrade')，会导致该事件被重复绑定，后续请求会触发多次代理逻辑，引发异常。正确的做法是只绑定一次upgrade事件，放在Express中间件外部。

3. Target地址不完整 #

target需要指定完整的协议（https://），否则http-proxy会默认使用HTTP协议，与后端的HTTPS服务不兼容。

4. 错误监听缺失 #

需要给proxy实例添加错误监听，才能捕获代理过程中的错误，而不是只给单个socket加监听。

修复后的代码 #

var app = require('express')();
const https = require('https');
const fs = require('fs');
var httpProxy = require('http-proxy');

// 配置证书（需确保credentials已正确定义）
const credentials = {
  key: fs.readFileSync('path/to/private-key.pem'),
  cert: fs.readFileSync('path/to/certificate.pem')
};

// 创建代理实例，开启WebSocket支持
var proxy = httpProxy.createProxyServer({ ws: true });

// 监听代理错误，排查问题
proxy.on('error', function(err, req, res) {
  console.error('Proxy error:', err);
  if (res) {
    res.writeHead(500, { 'Content-Type': 'text/plain' });
    res.end('Proxy error occurred');
  }
});

// 创建HTTPS服务器
var server = https.createServer(credentials, app).listen(8082);

// 代理/login接口
app.use('/login', function (req, res) {
  console.log("Request Url " + req.url);
  proxy.web(req, res, { target: 'https://example.com:3000' });
});

// 监听服务器的upgrade事件，处理WebSocket请求
server.on('upgrade', function(req, socket, head) {
  // 只处理/socket.io路径的WebSocket请求
  if (req.url.startsWith('/socket.io')) {
    console.log("WebSocket Upgrade Url " + req.url);
    socket.on('error', (error) => {
      console.error('Socket error:', error);
    });
    proxy.ws(req, socket, head, { target: 'https://example.com:3000' });
  } else {
    // 非socket.io的upgrade请求关闭连接
    socket.destroy();
  }
});

额外排查建议 #

• 确保后端3000端口的服务已正确配置HTTPS，并且支持WebSocket升级
• 检查客户端连接socket.io时使用的是wss://协议（对应HTTPS代理），而非ws://
• 可以在后端服务器的upgrade事件中添加日志，确认是否收到代理过来的升级请求

内容的提问来源于stack exchange，提问作者Areej Fatimah