解决code-server中WebSocket连接关闭问题（状态码1006）

在使用code-server时，开发者可能会遇到WebSocket连接异常关闭的问题，表现为状态码1006。这种情况通常发生在通过反向代理访问code-server时，特别是当代理配置不正确的情况下。

问题背景

code-server是一个基于浏览器的VS Code实现，它依赖于WebSocket协议来实现实时通信功能。当通过Nginx等反向代理访问时，如果代理配置不当，WebSocket连接可能会异常终止，导致用户界面无法正常工作。

关键问题分析

WebSocket连接关闭状态码1006通常表示连接异常终止。在code-server的上下文中，这往往是由于反向代理配置中的主机头(host header)传递不正确导致的。具体表现为：

1. 当使用非标准端口（如9091代替443）时，问题更容易出现
2. 反向代理修改了原始请求的主机头信息
3. code-server无法正确识别原始请求的主机信息

解决方案

通过调整Nginx的反向代理配置可以解决此问题。关键在于正确处理X-Forwarded-Host头：

proxy_set_header X-Forwarded-Host $http_host;

这个配置确保了：

1. 原始请求的主机头信息被正确传递
2. code-server能够识别真实的访问地址
3. WebSocket连接可以正常建立和维持

配置示例

以下是一个完整的Nginx反向代理配置示例：

server {
    listen 443 ssl http2;
    server_name code-server.example.com;
    
    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;
    
    location / {
        proxy_pass http://code-server:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $http_host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

深入理解

1. $host与$http_host的区别：

   • $host不包含端口信息
   • $http_host包含完整的原始请求头，包括端口号

2. WebSocket协议要求：

   • 需要正确的Upgrade头
   • 需要保持持久连接

3. code-server的特殊性：

   • 优先使用X-Forwarded-Host而非Host头
   • 对端口信息敏感，特别是在非标准端口情况下

最佳实践建议

1. 始终在反向代理配置中显式设置X-Forwarded-Host
2. 对于非标准端口访问，确保使用$http_host而非$host
3. 测试时可以使用LOG_LEVEL=debug环境变量获取更多诊断信息
4. 保持反向代理和code-server版本的最新状态

通过以上配置和最佳实践，开发者可以确保code-server在各种网络环境下都能稳定工作，避免WebSocket连接问题。