Połączenie WebSocket nie powiodło się: jak je przetestować i co znaczy błąd 1006

Gdy przeglądarka mówi, że połączenie WebSocket nie powiodło się, przyczyna to niemal zawsze jedna z kilku: proxy, które nie przepuszcza WebSocketów, handshake odrzucony przez serwer, problem z certyfikatem albo połączenie ucięte dlatego, że wyglądało na bezczynne. Żeby sprawdzić, która, połącz się z tym samym adresem naszym Testem WebSocket, odczytaj kod zamknięcia, a potem sprawdź handshake.
Ten wpis omawia te kroki oraz naprawę dla każdej przyczyny.
Dlaczego przeglądarka mówi tak mało
Twój kod dostaje zdarzenie error bez szczegółów, a po nim zamknięcie z kodem 1006. Tego kodu serwer nigdy nie wysyła. RFC 6455 rezerwuje go dla końca połączenia, który zgłasza, że połączenie zakończyło się bez komunikatu zamknięcia, więc mówi tylko tyle, że coś poszło nie tak.
Ta ogólnikowość jest celowa. Gdyby strona mogła odróżnić odrzucony handshake od zamkniętego portu, skrypt mógłby tego użyć do skanowania sieci odwiedzającego. Szczegóły są więc ukryte przed Twoim kodem i trzeba szukać gdzie indziej:
- Narzędzia deweloperskie przeglądarki. W panelu Network przefiltruj po WS i wybierz połączenie. Pokazuje status handshake'u i każdą wiadomość.
- Konsola. Przeglądarka zapisuje tam powód, którego Twój kod nie może odczytać.
- Logi serwera i proxy, które widzą to, co przeglądarka ukrywa.
Krok 1: przetestuj adres
Otwórz Test WebSocket, wpisz adres wss:// i połącz się. Zapisuje, ile trwało połączenie, każdą wiadomość w obu kierunkach oraz kod zamknięcia z jego znaczeniem.
Jeśli łączy się tutaj, a w Twojej aplikacji nie, porównaj oba przypadki. Ten test ma własny origin i żadnych tokenów Twojej aplikacji, więc różnica to zwykle uwierzytelnianie albo sprawdzanie originu. Jeśli zawodzi także tutaj, spróbuj z innej sieci, na przykład z hotspotu w telefonie, żeby wykluczyć VPN albo firmowe proxy.
Krok 2: sprawdź handshake
WebSocket zaczyna się jako żądanie HTTP, a curl pokazuje odpowiedź, którą przeglądarka ukrywa:
curl -i -N --http1.1 \
-H "Connection: Upgrade" \
-H "Upgrade: websocket" \
-H "Sec-WebSocket-Version: 13" \
-H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \
https://example.com/socketDodaj -H "Origin: https://your-site.example", jeśli Twój serwer sprawdza, skąd przychodzi połączenie. Pierwszy wiersz odpowiedzi mówi większość:
101 Switching Protocols. Handshake działa, więc przyjrzyj się temu, co dzieje się po nim.200. Żądanie trafiło na zwykłą stronę, więc proxy nie przekazuje go dalej jako WebSocket albo ścieżka jest zła.400. Serwer nie przyjął handshake'u. Niektóre serwery oczekują też od żądania więcej, niż to ma.401lub403. Uwierzytelnianie zawiodło albo origin nie jest dozwolony.404. Pod tą ścieżką nic nie nasłuchuje.502,503lub504. Proxy nie może dotrzeć do serwera za nim.
Jeśli curl zgłasza błąd certyfikatu, znalazłeś przyczynę: przeglądarka odrzuca połączenie w ten sam sposób i pokazuje Twojemu kodowi to samo 1006.
Zwykłe przyczyny i ich naprawy
Proxy nie przepuszcza WebSocketów. To najczęstsza przyczyna. Proxy musi celowo przekazywać nagłówki upgrade, a w nginx wygląda to tak:
location /socket {
proxy_pass http://127.0.0.1:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_read_timeout 3600s;
}Zrywa się po mniej więcej minucie. Proxy i load balancery zamykają połączenia, które wyglądają na bezczynne, a proxy_read_timeout w nginx wynosi 60 sekund, dopóki go nie zmienisz. Podniesienie go pomaga, ale wysyłaj małą wiadomość albo ping częściej niż najkrótszy limit na drodze, bo nie kontrolujesz każdego proxy między sobą a użytkownikami.
ws:// ze strony HTTPS. Przeglądarki blokują to jako mieszaną zawartość, poza ws:// do localhost. Na stronie serwowanej przez HTTPS używaj wss://.
Origin jest odrzucony. Serwery często pozwalają na połączenia tylko ze swoich stron, a resztę odrzucają w czasie handshake'u. Dodaj adres swojej strony do listy.
Nie ma jak wysłać nagłówków. Żadna przeglądarka nie potrafi ustawić nagłówków w WebSocket, więc token w nagłówku Authorization nigdy nie dociera. Wyślij go w zapytaniu, jako podprotokół albo w pierwszej wiadomości.
Zawodzi przy każdym wdrożeniu. Restart zrywa wszystkie połączenia. Łącz się ponownie z rosnącym, losowym opóźnieniem, żeby nie wracały wszystkie naraz, i nie zakładaj, że nic nie umknęło podczas nieobecności.
Co mówią kody zamknięcia
Gdy połączenie zostało otwarte, warto odczytać kod, z którym się zamyka:
- 1000: normalne zamknięcie, celowe.
- 1001: odejście, na przykład wyłączenie serwera albo opuszczenie strony.
- 1006: brak komunikatu zamknięcia, jak wyżej.
- 1008: serwer odmówił zgodnie ze swoimi zasadami, często z powodu uwierzytelniania albo originu.
- 1011: po stronie serwera coś poszło nie tak.
- 1012 i 1013: restart albo prośba, żeby spróbować później.
Test WebSocket wymienia wszystkie z ich znaczeniem. Kody od 4000 w górę należą do serwera lub jego biblioteki.
Jeśli wolisz nie prowadzić serwera
Większość tego wynika z samodzielnego prowadzenia websocketów: proxy, limitów czasu, restartów. Websockety w Pythonie i w Laravelu omawiają, co to wymaga w każdym frameworku, a dlaczego hosty WordPressa nie utrzymają websocketu dotyczy hostingu współdzielonego.
Z WordPlus Cloud Twoja aplikacja łączy się z naszymi serwerami czasu rzeczywistego przez nasze SDK, z pokojami, obecnością i ponownymi połączeniami, a Ty nie prowadzisz żadnego serwera WebSocket. Cena zależy od liczby połączeń, od 1000, a dokumentacja ma przewodnik dla każdej platformy. Jeśli połączenie z nim zawodzi, test połączenia pokazuje, czy ta sieć dociera do naszych serwerów.