Blog

Des websockets dans Laravel sans faire tourner de serveur websocket

· Andrij Tkachenko · 5 min de lecture

Une fenêtre d’éditeur de code reliée par une seule ligne à un nuage, qui envoie des mises à jour en direct à quatre fenêtres de navigateur

Avec Laravel, les mises à jour en direct ont l’air simples. Un événement implémente ShouldBroadcast, routes/channels.php indique qui peut l’écouter, et Laravel Echo le reçoit dans le navigateur. Une commande passe à « expédiée », et le client le voit sans recharger la page.

Ce que la documentation ne mentionne qu’en passant, c’est qu’il faut bien que quelque chose garde la connexion avec chaque navigateur ouvert. Laravel lui-même répond aux requêtes puis s’arrête, si bien que le broadcasting a toujours besoin d’un serveur websocket à côté de votre application. Cet article explique pourquoi, ce qu’il faut pour en faire tourner un en production, et comment garder vos événements et Echo exactement tels quels pendant qu’un cloud temps réel tient les connexions pour vous.

Pourquoi Laravel a besoin d’un serveur websocket

Une requête Laravel est courte. PHP reçoit la requête, Laravel démarre, votre contrôleur répond, et le processus est libre pour la requête suivante. C’est ce qui rend Laravel rapide et facile à héberger, et c’est aussi pour cela qu’une requête ne peut pas rester ouverte pendant des heures pour envoyer des mises à jour à un navigateur. Django et Flask se heurtent à la même limite sur WSGI, comme le montre notre article sur les websockets en Python.

Le broadcasting a donc deux volets :

  • Votre application envoie. Quand vous appelez broadcast( new OrderUpdated( $order ) ), Laravel confie l’événement à un broadcaster, qui le transmet par une courte requête. Avec ShouldBroadcast, cela se passe dans un job en file d’attente, et c’est donc un worker de file d’attente qui l’exécute.
  • Quelque chose d’autre distribue. Un serveur websocket garde une connexion ouverte avec chaque navigateur, vérifie auprès de votre application qui peut rejoindre chaque canal privé, et transmet chaque événement aux navigateurs qui l’écoutent.

Le premier volet, c’est du Laravel ordinaire. Le second est un service à part, qui tourne en continu, et c’est lui qui demande du travail.

Faire tourner votre propre serveur websocket

Laravel a un serveur websocket que vous pouvez faire tourner vous-même, et d’autres projets aussi. En lancer un sur votre ordinateur portable prend une minute. Le faire tourner pour de vrais utilisateurs demande davantage :

  • Un processus qui tourne en continu, maintenu en vie par un gestionnaire de processus, redémarré quand il plante, avec ses propres logs et sa propre surveillance. Les hébergements mutualisés et les plateformes serverless ne peuvent pas en faire tourner du tout.
  • Un port, un certificat et un proxy, pour que les navigateurs puissent se connecter en wss:// sur votre domaine, avec un proxy configuré pour laisser passer les websockets et ne pas couper les connexions longues. Notre test WebSocket montre si le résultat passe.
  • De la place pour beaucoup de connexions. Chaque navigateur ouvert est une connexion ouverte, et le serveur comme le système d’exploitation doivent avoir des limites réglées pour en tenir des milliers à la fois.
  • Plusieurs serveurs, à mesure que vous grandissez. Avec un seul serveur, toutes les connexions peuvent tomber au même endroit. À partir de deux, il faut un canal partagé, en général Redis, pour qu’un événement envoyé à l’un atteigne les navigateurs connectés aux autres.
  • Des déploiements sans tempête. Redémarrer le serveur websocket coupe toutes les connexions, et tous les navigateurs se reconnectent en même temps. Les pages qui étaient absentes manquent aussi ce qui a été envoyé entre-temps, à moins que quelque chose ne le garde pour elles.

Rien de tout cela n’est exotique, et beaucoup d’équipes le font bien. Mais c’est un second système à faire tourner à côté de votre application, tant qu’elle a des fonctions en direct.

Ou confier les connexions à un cloud temps réel

L’autre voie, c’est un service hébergé comme broadcaster. Votre application envoie chaque événement par une seule courte requête HTTP, comme elle le fait déjà avec un broadcaster, et le service garde les connexions, vérifie vos règles de canaux auprès de votre application et distribue les événements. Votre application Laravel reste une application Laravel normale, sur n’importe quel hébergement, serverless compris.

L’important, c’est que le changement reste à l’intérieur du broadcasting de Laravel, si bien que vos événements, vos canaux et votre code Echo ne changent pas.

Le broadcasting de Laravel sur WordPlus Cloud

Avec WordPlus Cloud, le changement tient en une connexion de broadcasting. Votre .env la désigne :

.env
BROADCAST_CONNECTION=wordplus
WORDPLUS_SITE=s1500000007
WORDPLUS_SECRET=…
WORDPLUS_LOCAL_KEY=…

Vos canaux restent dans routes/channels.php, avec un argument facultatif pour ce que garde chaque salon :

PHP
// The room of an order, orders.1042, for its customer, the last 20 updates kept.
Broadcast::channel( 'orders.{order}', fn ( User $user, Order $order ) => $user->id === $order->customer_id, [ 'history' => 20 ] );

Vos événements restent tels quels, et broadcast( new OrderUpdated( $order ) ) les envoie. Dans le navigateur, Echo reçoit notre connecteur à la place de son connecteur habituel :

JavaScript
import Echo from 'laravel-echo';
import { WordplusConnector } from '@wordplus/realtime/echo';

window.Echo = new Echo( { broadcaster: WordplusConnector, ...window.wordplusRealtimeConfig } );

window.Echo.private( 'orders.1042' ).listen( '.updated', ( data ) => showStatus( data.status ) );

La directive @wordplusRealtime dans votre layout écrit cette configuration, avec l’utilisateur connecté, si bien que la page se connecte sans requête préalable. Ensuite, tout ce que vous connaissez d’Echo fonctionne :

  • Les canaux privés et de présence, avec here(), joining() et leaving() pour savoir qui est dans un salon, whisper() pour les indicateurs de saisie, et notification() pour les notifications Laravel.
  • Livewire reçoit les événements de la même façon, avec #[On( 'echo-private:orders.{order.id},.updated' )].
  • React et Vue utilisent useEcho() des paquets Echo de Laravel lui-même, comme le font les starter kits.
  • toOthers() laisse de côté l’onglet qui a envoyé la requête.

Et ce qu’un serveur websocket seul ne vous donne pas :

  • Aucun serveur websocket à faire tourner. Nos serveurs gardent les connexions, d’autres démarrent à mesure que votre application grandit, et une page passe de l’un à l’autre sans coupure quand l’un d’eux redémarre.
  • Rien de perdu à la reconnexion. Un salon garde ses derniers événements, si bien qu’une page qui revient reçoit ce qu’elle a manqué, dans l’ordre.
  • Scellé en chemin. Ce que votre application envoie voyage chiffré, avec des clés que seuls votre application et vos utilisateurs détiennent.
  • Appels et diffusions en direct sur la même connexion. Appels à deux, appels de groupe et diffusions en direct, avec un écran d’appel et un lecteur prêts à l’emploi, ou les vôtres.

Le guide Laravel détaille toute la mise en place, et la démo en ligne est une petite boutique construite dessus, où une commande passe à « expédiée » dans une autre fenêtre au moment où vous cliquez.

WordPlus Cloud for Apps a un prix selon les connexions simultanées, à partir de 1 000, facturé au mois ou à l’année. Découvrez ce qu’il apporte aux applications, ou consultez les tarifs pour les applications. Notre page sur l’API WebSocket montre les salles, la présence et les événements dans chaque stack. Des questions sur votre intégration ? Écrivez-nous.