Blog

Websockety w Next.js: czas rzeczywisty na hostingu serverless

· Andrij Tkachenko · 5 min czytania

Trzy krótko działające funkcje serwerowe, każda ze stoperem, połączone z chmurą, która utrzymuje otwarte połączenia na żywo z czterema oknami przeglądarki

Dodawanie aktualizacji na żywo do aplikacji Next.js zwykle zaczyna się dobrze. Otwierasz websocket w client componencie, kierujesz go na mały serwer i z next dev wszystko działa: status zamówienia zmienia się na „wysłane”, pojawia się nowa wiadomość, zmienia się licznik osób online. Potem robisz deploy, a połączenie się zrywa, łączy ponownie, znowu się zrywa albo w ogóle się nie otwiera.

Problem rzadko leży w kodzie. Większość aplikacji Next.js działa na hostingu serverless, a funkcja serverless nie potrafi utrzymać otwartego połączenia. Ten wpis wyjaśnia dlaczego, ile kosztują typowe obejścia i jak dodać do aplikacji Next.js funkcje czasu rzeczywistego bez utrzymywania serwera websocket.

Dlaczego funkcja serverless nie utrzyma websocketu

Route handler, server action i server component działają na hostingu serverless tak samo. Przychodzi żądanie, funkcja startuje albo się wybudza, odpowiada, a wkrótce potem zostaje zamrożona albo zatrzymana. Kolejne żądanie może trafić do zupełnie innej instancji.

Websocket potrzebuje czegoś odwrotnego: jednego procesu, który utrzymuje połączenie z każdą przeglądarką tak długo, jak otwarta jest strona, często godzinami, i może w każdej chwili coś do niej wysłać. Funkcja serverless nie żyje tak długo, nie ma jak dotrzeć do połączenia otwartego przez inną instancję, a każda sekunda jej działania jest rozliczana. Dlatego tyle pierwszych prób działa w środowisku deweloperskim, gdzie wszystko obsługuje jeden stale działający proces, a zawodzi na produkcji.

Typowe obejścia

Polling. Strona co kilka sekund pyta route handler, czy coś się zmieniło. Działa to wszędzie, ale każde pytanie to wywołanie funkcji, większość odpowiedzi nie przynosi nic nowego, a strona jest zawsze kilka sekund w tyle. Gdy na stronie, która odpytuje serwer co 5 sekund, jest 1000 osób, daje to 200 wywołań funkcji na sekundę, przez całą dobę.

Streaming z route handlera. Route handler może trzymać odpowiedź otwartą i strumieniować zdarzenia do strony. To już bliżej działania na żywo, ale każdy otwarty strumień to wciąż działająca funkcja, każda platforma przerywa funkcje po upływie maksymalnego czasu działania, a strumień żyje w jednej instancji, więc zdarzenie wysłane z innej nigdy do niego nie dotrze.

Custom server. Next.js może działać za Twoim własnym serwerem Node.js, z biblioteką websocket obok. Wtedy aplikacja nie działa już na hostingu serverless: utrzymujesz stale działający serwer, dbasz o to, żeby działał w trakcie deployów, a gdy serwerów jest więcej niż jeden, przekazujesz każde zdarzenie między nimi, zwykle przez Redis, i pilnujesz, żeby każda przeglądarka trafiała na serwer, który ją zna. Nasz Test WebSocket sprawdza taki serwer z przeglądarki.

Własny serwer websocket obok aplikacji. Aplikacja zostaje na serverless, a połączenia utrzymuje osobny serwer. To najczystsze z czterech rozwiązań, a mimo to wciąż drugi system, który trzeba utrzymywać: jego certyfikat, skalowanie, monitorowanie i sposób na rozpoznanie użytkownika, bo taki serwer nie odczyta sesji Twojej aplikacji.

Albo niech połączenia utrzymuje chmura czasu rzeczywistego

Hostowana usługa czasu rzeczywistego w całości przejmuje to, co musi działać długo. Przeglądarki utrzymują otwarte połączenia z usługą. Twój kod Next.js, w server action albo w route handlerze, wysyła każde zdarzenie jednym krótkim żądaniem HTTP, a do tego funkcja serverless nadaje się idealnie. Usługa dostarcza je każdej stronie, która powinna je dostać, niezależnie od tego, która instancja je wysłała.

Liczy się to, żeby usługa pasowała do sposobu, w jaki Next.js już działa: Twój serwer decyduje, kto może dołączyć do czego, Twoje strony subskrybują z client componentów, a w Twoim hostingu nic się nie zmienia.

Next.js w WordPlus Cloud

Z WordPlus Cloud Twój serwer raz deklaruje swoje pokoje, każdy z regułą określającą, kto może do niego dołączyć:

lib/realtime.ts
import { createRealtime } from '@wordplus/realtime/server';
import { currentUserId, profileOf } from '@/lib/auth';

export const realtime = createRealtime( {
    site: process.env.WORDPLUS_SITE!,
    secret: process.env.WORDPLUS_SECRET!,
    localKey: process.env.WORDPLUS_LOCAL_KEY!,
    user: () => currentUserId(),
    profile: ( user ) => profileOf( user ),
} );

// The room of an order, order:1042: its customer may join, and the last 20 updates are kept.
realtime.room( 'order:{id}', { history: 20 }, async ( user, { id } ) => user !== null && ( await ownerOf( id ) ) === user );

Jeden catch-all route handler odpowiada stronom, gdy proszą o dołączenie, i serwuje pliki SDK dla przeglądarki:

app/api/realtime/[...path]/route.ts
import { realtime } from '@/lib/realtime';

export const GET = realtime.route;
export const POST = realtime.route;

Layout Twoich stron dla zalogowanych użytkowników renderuje RealtimeProvider z realtime.config() dla danego użytkownika, więc każda strona pod nim korzysta z jednego wspólnego połączenia, które przetrwa nawigację po stronie klienta. Następnie client component dołącza do pokoju za pomocą hooka:

app/(app)/orders/[id]/status.tsx
'use client';

import { useState } from 'react';
import { useRoom } from '@wordplus/realtime/react';

export function Status( { id, initial }: { id: string; initial: string } ) {
    const [ status, setStatus ] = useState( initial );
    useRoom( `order:${ id }`, { updated: ( data: { status: string } ) => setStatus( data.status ) } );
    return <p>{ status }</p>;
}

A server action wysyła zdarzenie po zapisaniu zmiany:

app/(app)/orders/[id]/actions.ts
'use server';

import { realtime } from '@/lib/realtime';

export async function markShipped( id: string ) {
    await saveStatus( id, 'shipped' );
    await realtime.to( `order:${ id }` ).emit( 'updated', { status: 'shipped' } );
}

To cały obieg i w tej postaci działa na hostingu serverless. A do tego:

  • Logowanie zostaje po Twojej stronie. Użytkownikiem jest ten identyfikator, pod którym zna go Twoja aplikacja, odczytany wewnątrz route handlera, więc działają tam Twoja sesja i pliki cookie.
  • Nic nie ginie przy ponownym połączeniu. Pokój przechowuje swoje ostatnie zdarzenia, więc strona, która wraca, dostaje to, co ją ominęło, w odpowiedniej kolejności.
  • Jedno połączenie dla wszystkich kart. Karty jednej przeglądarki dzielą jedno połączenie, więc osoba z trzema otwartymi kartami jest liczona tylko raz.
  • Zapieczętowane w drodze. To, co wysyła Twoja aplikacja, podróżuje zaszyfrowane kluczami, które mają tylko Twój serwer i Twoi użytkownicy.
  • Więcej niż zdarzenia. Informacja, kto jest online, rozmowy, które dzwonią w każdej karcie, rozmowy grupowe i transmisje na żywo działają przez to samo połączenie, z gotowym ekranem rozmowy, czatem i odtwarzaczem z Better Messages albo z Twoimi własnymi komponentami na tym samym API.

Przewodnik dla Next.js zawiera całą konfigurację, a demo na żywo to mały sklep zbudowany na niej, w którym status zamówienia zmienia się na „wysłane” w drugim oknie w chwili, gdy klikasz.

Rozmowy wideo w aplikacji Next.js krok po kroku: Jak wdrożyć rozmowy wideo w Next.js.

WordPlus Cloud for Apps ma cenę według jednoczesnych połączeń, od 1000 wzwyż, rozliczaną miesięcznie lub rocznie. Zobacz, co daje aplikacjom albo cennik dla aplikacji. Nasza strona o API WebSocket pokazuje pokoje, obecność i zdarzenia w każdym stacku. Chcesz zapytać o swoją integrację? Napisz do nas.