Broadcasting

Daravel berbicara dengan protokol Pusher, seperti Laravel Reverb, di port yang sama dengan HTTP-nya. Laravel Echo terhubung ke sana tanpa perubahan, Laravel bisa mem-broadcast lewat Daravel, dan Daravel bisa mem-broadcast lewat Reverb (atau Pusher Channels). Satu .env dipakai kedua framework: key-nya sama dengan Laravel.

Melayani Echo#

REVERB_APP_ID=my-app
REVERB_APP_KEY=my-key            # publik: Echo terhubung dengannya
REVERB_APP_SECRET=my-secret      # menandatangani otorisasi channel dan request API

Application.configure(basePath: '.')
    .withBroadcasting(
      channels: (channels) {
        channels.channel('App.Models.User.{id}',
            (user, p) => '${user.authIdentifier}' == p['id']);
        channels.channel('orders.{orderId}', (user, p) async =>
            (await Order.find(int.parse(p['orderId']!)))?['user_id'] ==
            user.authIdentifier);
        channels.channel('chat.{room}',
            (user, p) => {'id': user.authIdentifier, 'name': (user as User).name});
      },
    )

channels adalah routes/channels.php milik Laravel: pola tanpa prefix private- atau presence-, {placeholder} yang cocok sampai titik berikutnya, dan callback yang mengembalikan false untuk menolak, true untuk channel private, atau data publik user untuk channel presence. Route-nya:

Front end-nya sama dengan Laravel:

import Echo from 'laravel-echo';
import Pusher from 'pusher-js';

window.Echo = new Echo({
  broadcaster: 'reverb',
  key: import.meta.env.VITE_REVERB_APP_KEY,
  wsHost: 'api.example.com',
  wsPort: 443,
  forceTLS: true,
  enabledTransports: ['ws', 'wss'],
  authEndpoint: 'https://api.example.com/broadcasting/auth',
  auth: { headers: { Authorization: `Bearer ${token}` } },
  Pusher,
});

Echo.private(`orders.${orderId}`).listen('OrderShipped', (e) => { /* ... */ });
Echo.join(`chat.${room}`).here(users).joining(user).leaving(user);
Echo.private(`App.Models.User.${userId}`).notification((n) => { /* ... */ });

Koneksi, langganan, dan anggota presence dibagi oleh semua worker isolate melalui coordinator, sehingga APP_ISOLATES=4 berperilaku seperti satu server. Beberapa server (mesin, atau proses di belakang load balancer) berbagi semua itu melalui database, seperti Reverb berbagi melalui Redis; lihat Beberapa server.

Mem-broadcast event#

final class OrderShipped with ShouldBroadcast {
  OrderShipped(this.order);
  final Order order;

  @override
  List<String> broadcastOn() => ['private-orders.${order.id}'];

  @override
  Map<String, Object?> broadcastWith() => {'id': order.id, 'status': 'shipped'};
}

await Event.dispatch(OrderShipped(order));            // listener, lalu broadcast
await Broadcast.event(OrderShipped(order).toOthers()); // broadcast()->toOthers() dari Laravel
await Broadcast.send('price.updated', ['prices'], {'sku': 'A1', 'price': 12});

• Nama channel memakai prefix Pusher, seperti yang ditulis PrivateChannel dan PresenceChannel di Laravel: private-orders.7, presence-chat.1.
• Nama event adalah App\Events\<Class> kecuali broadcastAs menentukan lain; itulah yang diharapkan .listen('OrderShipped') di Echo. Nama kustom didengarkan dengan titik di depan (.listen('.shipped')).
• Dart tidak punya reflection, jadi broadcastWith menentukan apa yang dikirim (Laravel mengirim property publik secara default). broadcastWhen bisa melewatinya.
• toOthers() membaca header X-Socket-ID dari Echo di request saat ini dan tidak mengirim ke tab browser itu.
• Broadcast terjadi saat event di-dispatch, bukan lewat queue (ShouldBroadcastNow di Laravel).
• Channel notifikasi broadcast mengirim BroadcastNotificationCreated dari Laravel di private-App.Models.User.1, yang diterima .notification() di Echo (Mail dan notifikasi).

Tujuan event#

BROADCAST_CONNECTION memilih tujuannya:

Laravel mem-broadcast lewat Daravel dengan cara yang sama: BROADCAST_CONNECTION=reverb dengan REVERB_HOST menunjuk ke server Daravel, dan app id, key, serta secret yang sama. Daravel mengecek tanda tangan request seperti Pusher, dan juga menolak request yang timestamp-nya meleset lebih dari sepuluh menit, sehingga request yang tersadap tidak bisa diputar ulang (Reverb tidak mengecek waktunya).

Channel cache dan channel terenkripsi#

Channel yang namanya diawali cache- (atau private-cache-, presence-cache-) menyimpan event terakhirnya selama 30 menit, seperti Pusher Channels: client yang berlangganan belakangan langsung menerimanya setelah subscription_succeeded, atau pusher:cache_miss bila belum ada.

await Broadcast.send('price.updated', ['cache-prices'], {'sku': 'A1', 'price': 13});

Echo.channel('cache-prices').listen('.price.updated', (e) => { /* harga terakhir */ });

Channel private-encrypted- dienkripsi end-to-end, seperti di Pusher: isi REVERB_ENCRYPTION_MASTER_KEY_BASE64 (32 byte acak dalam base64: openssl rand -base64 32) dan dengarkan dengan Echo.encryptedPrivate. Kunci setiap channel diturunkan dari master key, /broadcasting/auth memberikannya kepada client yang diizinkan channel itu, dan event disegel dengan secretbox dari libsodium sebelum keluar dari aplikasi, sehingga server WebSocket hanya meneruskan ciphertext. Client tidak bisa mengirim whisper di channel ini.

await Broadcast.send('secret', ['private-encrypted-orders.7'], {'code': '4821'});

Echo.encryptedPrivate('orders.7').listen('.secret', (e) => { /* sudah didekripsi */ });

Kunci yang sama berlaku untuk BROADCAST_CONNECTION=reverb atau pusher: Laravel (dengan encryption_master_key_base64) dan Daravel mengenkripsi dengan cara yang sama.

Beberapa server#

REVERB_SCALING_ENABLED=true
# REVERB_SCALING_CONNECTION=pgsql   # koneksi selain koneksi default

Tambahkan CreateBroadcastingTables() ke bootstrap/migrations.dart lalu jalankan dartisan migrate. Setelah itu setiap server menulis frame yang dikirimnya ke broadcast_messages, dan setiap server membaca frame dari server lain lalu meneruskannya ke client-nya sendiri, sehingga event yang diterbitkan di satu server (lewat API HTTP, Broadcast.send, atau whisper) sampai ke client yang terhubung ke server mana pun. Di PostgreSQL server saling membangunkan dengan NOTIFY; di MySQL dan MariaDB server membaca setiap REVERB_SCALING_POLL (100ms).

Anggota presence juga dibagi, berbeda dengan Reverb yang here-nya hanya memuat anggota di server yang sama: here, member_added (sekali per user, di server mana pun tab user itu berada), serta channels, channel, dan users dari API HTTP menjawab untuk seluruh cluster, begitu pula event terakhir sebuah channel cache. Setiap server mengirim heartbeat setiap sepuluh detik; anggota dari server yang diam selama 30 detik (karena crash) tidak dihitung lagi dan dihapus semenit kemudian.

Dengan daravel_redis, REVERB_SCALING_DRIVER=redis membagi hal yang sama lewat Redis: frame lewat Pub/Sub, anggota dan channel cache di Redis, sehingga database tidak menanggungnya sama sekali.

Beri setiap server REVERB_SERVER_ID yang tetap bila nama host dan id proses tidak cukup membedakannya. Load balancer tidak perlu sticky session: client tetap di server yang dijangkau WebSocket-nya.

Origin dan batas#

Client event (client-*, whisper di Echo) hanya diteruskan di channel private dan presence yang sudah diikuti pengirimnya, seperti yang disyaratkan Pusher Channels.

Kapasitas#

bench/interop/connections.sh membuka koneksi Echo idle ke build AOT, semuanya berlangganan satu channel, lalu mengukur waktu satu event sampai ke semuanya. Dengan 10 000 koneksi:

Sekitar separuh biaya tiap koneksi adalah WebSocket dari dart:io itu sendiri. Reverb tanpa ext-uv atau ext-event berhenti di sekitar 1 000 koneksi (stream_select dari PHP). WebSocket berjalan tanpa permessage-deflate, seperti di Reverb: mengompresi setiap frame untuk setiap koneksi membuat event yang sama butuh 7,9 s.

Diverifikasi dengan client sungguhan#

bench/interop/run.sh (Linux dan Docker) mengecek semua ini terhadap perangkat lunak yang harus didukungnya: laravel-echo dan pusher-js dari npm terhadap Daravel (publik, private, toOthers, whisper, presence, notifikasi, channel cache dan terenkripsi, otorisasi yang ditolak), dua server Daravel yang berbagi satu database, Laravel 12 yang mem-broadcast lewat Daravel dengan pusher/pusher-php-server, dan Daravel yang mem-broadcast lewat Laravel Reverb, dengan satu atau empat worker isolate (ISOLATES=4).

Tingkat bawah: channel milik Daravel sendiri#

Broadcast.publish, subscribe, dan pipe memindahkan pesan antar-worker isolate tanpa protokol Pusher, untuk route WebSocket atau SSE Anda sendiri (Respons).