Blog

Websocketi u PHP-u bez vlastitog procesa

· Andrij Tkachenko · 10 min čitanja

Pet kratkih kartica zahtjeva, svaka zatvorena kvačicom, pokraj jednog poslužitelja čija se jedina linija grana prema tri prozora preglednika

PHP može posluživati websockete, ali ne iz zahtjeva koji odgovaraju na vaše stranice: PHP-FPM svakom zahtjevu daje workera dok se njegov odgovor ne pošalje, a websocket je veza koja ostaje otvorena satima. Zato websocket u PHP-u radi u zasebnoj skripti, pokrenutoj iz naredbenog retka i ostavljenoj da stalno radi, s event loopom koji prati sve veze odjednom, a vaša web-stranica toj skripti mora predati svaki događaj koji treba poslati.

Ovaj članak pokazuje takav poslužitelj s Ratchetom, zašto ne može živjeti unutar vaše web-stranice, što traži njegov rad sa stvarnim korisnicima i kako iz običnog PHP-a slati događaje uživo bez ikakvog websocket procesa.

Zašto PHP zahtjev ne može držati websocket

Websocket je dvosmjerna veza između preglednika i poslužitelja koja ostaje otvorena, pa svaka strana može slati u bilo kojem trenutku. Počinje kao HTTP zahtjev koji traži nadogradnju, a od tada više nije zahtjev s odgovorom, nego linija koja ostaje otvorena dok god je otvorena i stranica.

PHP je napravljen obrnuto. Pod PHP-FPM-om web-poslužitelj svaki zahtjev predaje jednom workeru iz poola. Worker izvrši vašu skriptu, pošalje odgovor i preuzme sljedeći zahtjev. Pool ima stalnu veličinu, a priručnik za PHP kaže da pm.max_children određuje koliko se zahtjeva najviše poslužuje istodobno. Websocket koji se drži u zahtjevu zauzimao bi svog workera dok god je njegova stranica otvorena. Uz 20 workera, 20 otvorenih stranica zauzelo bi ih sve, a web-stranica bi prestala odgovarati svima ostalima.

Poslužitelji ispred PHP-a vide to na isti način. nginx prema zadanim postavkama zatvara vezu s PHP-FPM-om kad PHP 60 sekundi ništa ne pošalje, a pružatelji hostinga postavljaju i vlastita ograničenja koliko dugo zahtjev smije trajati.

Long polling i server-sent events izgledaju kao zaobilazno rješenje, a u PHP-u nailaze na isti zid: svaki zahtjev koji čeka drži jednog workera. Upravo na to nailazi WordPress, kako objašnjava naš članak o WordPressu i websocketima, a nailazi i svaka PHP aplikacija, s frameworkom ili bez njega.

Websocket poslužitelj u PHP-u

Odgovor je u PHP-u drugi program: skripta koju pokrećete s php iz naredbenog retka i koja nikad ne završava. Sluša na portu i pokreće event loop, koji čeka na svim otvorenim vezama odjednom i budi se za onu koja ima nešto reći. Rukovanje (handshake) i uokvirivanje poruka protokola WebSocket umjesto vas obavlja biblioteka. Najpoznatija je Ratchet, izgrađena na event loopu ReactPHP-a:

Shell
composer require cboden/ratchet
PHP
<?php
// chat.php
require __DIR__ . '/vendor/autoload.php';

use Ratchet\ConnectionInterface;
use Ratchet\MessageComponentInterface;

class Chat implements MessageComponentInterface {
    private SplObjectStorage $clients;

    public function __construct() {
        $this->clients = new SplObjectStorage();
    }

    public function onOpen( ConnectionInterface $conn ) {
        $this->clients->attach( $conn );
    }

    // Pass each message to everyone else connected.
    public function onMessage( ConnectionInterface $from, $msg ) {
        foreach ( $this->clients as $client ) {
            if ( $client !== $from ) {
                $client->send( $msg );
            }
        }
    }

    public function onClose( ConnectionInterface $conn ) {
        $this->clients->detach( $conn );
    }

    public function onError( ConnectionInterface $conn, \Exception $e ) {
        $conn->close();
    }
}

// ws://localhost:8080/chat, for pages served from localhost.
$app = new Ratchet\App( 'localhost', 8080 );
$app->route( '/chat', new Chat(), [ 'localhost' ] );
$app->run();

Pokrenite je s php chat.php, a stranica se spaja pomoću WebSocket API-ja koji ima svaki preglednik:

JavaScript
const socket = new WebSocket( 'ws://localhost:8080/chat' );
socket.onopen = () => socket.send( 'hello' );
socket.onmessage = ( event ) => console.log( event.data );

Otvorite tu stranicu u dvije kartice, posluženu s localhosta, i svaka će ispisati ono što pošalje druga. Treći argument metode route() navodi hostove čije se stranice smiju spojiti, jer websocket prema vašem poslužitelju može otvoriti stranica s bilo koje druge web-stranice, a standard odbijanje prepušta vama. [ '*' ] pušta svaku web-stranicu.

Na PHP-u 8.5 to radi takvo kakvo jest, nakon cijelog ekrana obavijesti o zastarjelosti: zadnje izdanje Ratcheta, 0.4.4, izašlo je u prosincu 2021., a njegov README kaže da projekt ponovno oživljava. AMPHP ima vlastiti websocket poslužitelj za PHP 8.1 i novije, a proširenje Swoole dodaje poslužitelj samom PHP-u. Svaki od njih je proces koji držite u radu, a upravo je to ono što je važno u nastavku.

Kad poslužitelj radi na javnoj adresi, naš WebSocket test povezuje se na njega iz preglednika i objašnjava svaki kod zatvaranja. Ako preglednik javlja samo da veza nije uspjela, naš članak o WebSocket pogrešci 1006 pokazuje kako pronaći uzrok.

Što mijenja PHP proces koji dugo radi

Dvije stvari u tom poslužitelju određuju sve što slijedi. $clients živi u memoriji tog jednog procesa, a proces radi tjednima. Većina PHP koda nije pisana ni za jedno ni za drugo.

  • Jedan spori poziv zaustavlja sve. Event loop izvršava vaš kod dio po dio. Dok onMessage() čeka PDO upit, file_get_contents() neke adrese ili sleep(), nijedna druga veza nije poslužena. ReactPHP, na kojem radi Ratchet, prema zadanim je postavkama neblokirajući, a blokirajući posao prepušta workerima. Zato pozivi bazi podataka koje vaša web-stranica posvuda radi ovdje trebaju klijente napravljene za loop ili red čekanja.
  • Memorija se nikad ne vraća. Pod PHP-FPM-om sve što je zahtjev izgradio nestaje kad on završi, pa statička predmemorija ili niz koji samo raste ne čine štetu. U procesu koji radi tjednima to raste dok ga nešto ne pokrene ponovno.
  • Novi kod traži ponovno pokretanje. Skripta je vaše datoteke učitala jednom, kad se pokrenula, pa deploy u njoj ne mijenja ništa dok se ponovno ne pokrene.
  • Vaša web-stranica i poslužitelj dva su programa. Zahtjev koji je spremio narudžbu radi u PHP-FPM-u, a preglednici su spojeni na websocket skriptu, do čije memorije taj zahtjev ne može doći. Ratchetov vlastiti vodič za slanje ažuriranja s postojeće web-stranice svako ažuriranje prenosi preko ZeroMQ-a, za koji su potrebni biblioteka libzmq i PECL proširenje. Isti posao obavlja i Redis kanal ili mala HTTP ruta u websocket skripti.
  • Znati tko se spaja. Kad je websocket na vašoj vlastitoj domeni, preglednik uz nadogradnju šalje i vaš kolačić sesije, ali skripta tu sesiju mora pročitati sama, a PHP sesije prema zadanim postavkama čuva u datotekama na jednom poslužitelju. WebSocket u pregledniku ne može postaviti zaglavlje, pa je drugi način kratkotrajni token u adresi, koji potpisuje vaša web-stranica i koji se provjerava prije nego što se veza otvori.

Što traži rad sa stvarnim korisnicima

Ostatak popisa stiže s prvim stvarnim korisnicima:

  • Pristup shellu i upravitelj procesa. Skriptu treba pokrenuti i održavati živom, što README Ratcheta navodi kao uvjet. Dijeljeni hosting to rijetko dopušta. Na vlastitom poslužitelju systemd ili Supervisor ponovno je pokreće kad se sruši.
  • Port, certifikat i proxy. Preglednici se spajaju preko wss:// na vašoj domeni, obično kroz nginx ili Apache ispred skripte. Dokumentacija za nginx objašnjava da proxy zaglavlja Upgrade i Connection prosljeđuje samo kad mu se to kaže, te da vezu preko proxyja kroz koju 60 sekundi nema podataka prema zadanim postavkama zatvara.
  • Heartbeat. Zato poslužitelj svakoj vezi u pravilnim razmacima šalje ping. Tako proxyji ne zatvaraju vezu koja šuti, a otkrivaju se i veze koje su nestale bez javljanja, koje bi inače ostale u $clients.
  • Više od jednog procesa. Jedan event loop koristi jednu jezgru procesora. Kod dva procesa ili dva poslužitelja svaki zna samo za svoje veze, pa svaki događaj mora proći kroz kanal koji dijele, obično Redis. Redis pub/sub isporučuje najviše jednom, pa proces koji se u tom trenutku ponovno spajao taj događaj nikad ne dobije.
  • Deploy. Ponovno pokretanje prekida sve veze. WebSocket u pregledniku ne spaja se ponovno sam, pa to radi kod vaše stranice, nakon odgode koja raste i za svaki je preglednik drukčija. Ono što je poslano dok stranica nije bila spojena izgubljeno je, osim ako ne čuvate nedavne događaje i ne ponovite ih od zadnjeg koji je stranica vidjela.

Ništa od toga nije neobično i mnogi timovi to dobro rade. Ipak, to je drugi sustav uz vašu PHP aplikaciju, pisan u stilu koji ostatku vašeg koda nikad ne treba.

Ili uopće nemojte imati websocket proces

Hostana usluga za rad u stvarnom vremenu preuzima veze od vaših poslužitelja. Preglednici se spajaju na uslugu. Vaš PHP kod svaki događaj šalje jednim kratkim HTTPS zahtjevom, iz upravo onog zahtjeva koji je spremio promjenu, a usluga ga isporučuje svakoj stranici koja ga treba dobiti. Ništa u vašoj aplikaciji ne radi dulje od jednog zahtjeva, pa PHP-FPM ostaje kakav jest.

Postava Gdje žive veze Što pokrećete
Samo PHP-FPM Nigdje, svaki zahtjev završi Polling, worker za svako čekanje
Websocket skripta U njezinoj memoriji Proces, proxy i kanal s web-stranice
Hostana usluga Na njezinim poslužiteljima Jedan zahtjev za svaki događaj

PHP na WordPlus Cloudu

S WordPlus Cloudom jedan je Composer paket vaša poslužiteljska strana, a sadrži i datoteke za preglednik, pa nema instaliranja Nodea:

Shell
composer require wordplus/realtime-php      # PHP 8.1 or later, with sodium

Vaša aplikacija jednom definira svoje sobe, svaku s pravilom o tome tko joj se smije pridružiti. Ovo je soba jedne narudžbe, za njezina kupca:

PHP
// src/realtime.php, required by every request that needs it
use WordPlus\Realtime\Realtime;

$realtime = Realtime::fromEnvironment();   // WORDPLUS_SITE, WORDPLUS_SECRET, WORDPLUS_LOCAL_KEY

// The room of an order, order:1042: its customer may join, and the last 20 updates are kept.
$realtime->room( 'order:{id}', function ( $user, array $p ) {
    if ( null === $user ) {
        return false;
    }

    return order_owner( $p['id'] ) === $user;
}, [ 'history' => 20 ] );

Dvije kratke rute poslužuju datoteke za preglednik i odgovaraju stranicama koje traže da se pridruže sobi, za korisnika iz sesije:

PHP
// public/index.php, or your router
if ( $realtime->respondFile() ) {
    exit;
}

if ( preg_match( '#^/api/realtime/(auth|calls|keys|webhook)$#', parse_url( $_SERVER['REQUEST_URI'], PHP_URL_PATH ), $route ) ) {
    session_start( [ 'read_and_close' => true ] );
    $realtime->respond( $route[1], $_SESSION['user_id'] ?? null );
    exit;
}

Kad je vaš posao spremljen, javite to svima u sobi:

PHP
set_status( $id, 'shipped' );
$realtime->to( "order:$id" )->emit( 'updated', [ 'status' => 'shipped' ] );

Stranica svoje postavke dobiva od <?= $realtime->head( $userId ) ?> u svom <head>, uz import map za klijent, pa ova datoteka radi takva kakva jest, bez bundlera:

public/order.js
import { connect } from '@wordplus/realtime';

const rt = await connect( window.wordplusRealtimeConfig );

const order = rt.join( 'order:1042' );
order.on( 'updated', ( data ) => showStatus( data.status ) );

Taj emit je jedan HTTPS zahtjev, pa radi jednako u PHP-FPM zahtjevu, cron jobu ili queue workeru. Osim toga:

  • Ništa ne treba držati u radu. Nema websocket skripte, pravila na proxyju ni kanala između vaše web-stranice i poslužitelja. Bilo koji od vaših poslužitelja odgovara na bilo koji zahtjev i šalje u bilo koju sobu.
  • Ništa se ne gubi pri ponovnom spajanju. Soba čuva svoje zadnje događaje, pa stranica koja se vrati dobiva ono što je propustila, redom.
  • Sve stranice jednog korisnika. $realtime->toUser( 42 )->emit( 'notice', [ 'text' => 'Your order shipped' ] ) stiže do svake kartice i svakog uređaja koje korisnik ima otvorene. Korisnik koji nema ništa otvoreno ne dobiva ništa, pa ono što do njega mora stići pošaljite e-poštom.
  • Jedna veza za sve kartice. Kartice jednog preglednika dijele jednu vezu, pa se osoba s tri otvorene kartice broji jednom.
  • Zapečaćeno na putu. Ono što vaš poslužitelj šalje u sobu s pravilom putuje šifrirano ključevima koje drže samo vaš poslužitelj i vaši korisnici.
  • Ono što stranice šalju stiže do vas. Webhook to donosi vašem PHP-u, potpisano, a paket potpis provjerava prije nego što to vidi vaš handler. Ako vaš poslužitelj ne odgovori, isporuka se ponavlja 24 sata.
  • Više od događaja. Tko je na mreži, pozivi koji zvone u svakoj kartici, grupni pozivi i prijenosi uživo dolaze na istoj vezi, s gotovim chatom, zaslonom poziva i playerom ili s vašim vlastitim sučeljem na istom API-ju.

U Symfonyju, Slimu ili vlastitom routeru answerRequest() umjesto respond() daje status i tijelo odgovora koje vraćate. Laravel ima svoj broadcasting, a naš članak o websocketima u Laravelu pokazuje isti oblak iza Echa.

Kad vam bolje odgovara vlastiti poslužitelj

Hostana usluga nije prikladna za svaki posao. Vaš PHP kod ono što stranice šalju čuje preko webhooka, HTTP zahtjeva koji može stići više puta, a ne u petlji uz svaku vezu. Igra ili sustav upravljanja u kojem poslužitelj na svaku poruku mora odgovoriti u roku od nekoliko milisekundi pripada na vlastiti poslužitelj. Isto vrijedi i za vaš vlastiti protokol kojim drugi programi govore preko običnog websocketa. A alatu za nekoliko desetaka ljudi, na poslužitelju koji već imate, možda nikad neće trebati više od Ratchet skripte s početka ovog članka.

Počnite s vodičem

Vodič za PHP sadrži cijelo podešavanje, a PHP demo je mala trgovina u običnom PHP-u izgrađena na njemu, u kojoj se narudžba, čim kliknete, u drugom prozoru označi kao poslana. Isto pitanje ima drukčije odgovore u Node.js-u, gdje jedan proces dobro drži veze, te u Djangu i Flasku.

WordPlus Cloud for Apps ima cijenu prema istodobnim vezama, od 1.000 naviše, uz mjesečnu ili godišnju naplatu, a naš članak o cijenama usluga u stvarnom vremenu objašnjava kako funkcionira brojanje po vezi. Pogledajte što nudi aplikacijama, naša stranica o WebSocket API-ju prikazuje sobe, prisutnost i događaje u svakom stacku, a cijene za aplikacije sadrže brojke. Pitanja o vašoj integraciji? Pišite nam.