WebSocketStream: mengintegrasikan streaming dengan WebSocket API

Cegah aplikasi Anda tenggelam dalam pesan WebSocket atau membanjiri server WebSocket dengan pesan dengan menerapkan backpressure.

Thomas Steiner

Latar belakang

WebSocket API menyediakan antarmuka JavaScript ke protokol WebSocket, yang memungkinkan Anda membuka sesi komunikasi interaktif dua arah antara browser pengguna dan server. Dengan API ini, Anda dapat mengirim pesan ke server dan menerima respons berbasis peristiwa tanpa melakukan polling server untuk memberikan balasan.

Streams API

Dengan Streams API, JavaScript dapat mengakses secara terprogram aliran potongan data yang diterima melalui jaringan dan memprosesnya sesuai keinginan. Konsep penting dalam konteks streaming adalah tekanan balik. Ini adalah proses yang digunakan oleh satu aliran atau rantai pipa untuk mengatur kecepatan pembacaan atau penulisan. Jika aliran itu sendiri atau aliran di kemudian hari dalam rantai pipa masih sibuk dan belum siap menerima lebih banyak bagian, aliran akan mengirimkan sinyal ke belakang melalui rantai untuk memperlambat pengiriman sebagaimana mestinya.

Masalah dengan WebSocket API saat ini

Penerapan backpressure ke pesan yang diterima tidak mungkin

Dengan WebSocket API saat ini, bereaksi terhadap pesan terjadi di WebSocket.onmessage, EventHandler yang dipanggil saat pesan diterima dari server.

Anggaplah Anda memiliki aplikasi yang perlu melakukan operasi pemrosesan data yang berat setiap kali pesan baru diterima. Anda mungkin akan menyiapkan alur yang mirip dengan kode di bawah, dan karena Anda await hasil panggilan process(), Anda akan baik-baik saja, bukan?

// A heavy data crunching operation.
const process = async (data) => {
  return new Promise((resolve) => {
    window.setTimeout(() => {
      console.log('WebSocket message processed:', data);
      return resolve('done');
    }, 1000);
  });
};

webSocket.onmessage = async (event) => {
  const data = event.data;
  // Await the result of the processing step in the message handler.
  await process(data);
};

Salah! Masalah dengan WebSocket API saat ini adalah tidak ada cara untuk menerapkan backpressure. Jika pesan tiba lebih cepat daripada metode process() untuk menanganinya, proses render akan mengisi memori dengan buffering pesan tersebut, menjadi tidak responsif karena penggunaan CPU 100%, atau keduanya.

Menerapkan backpressure ke pesan yang dikirim tidak ergonomis

Menerapkan backpressure ke pesan yang dikirim dapat dilakukan, tetapi melibatkan polling properti WebSocket.bufferedAmount, yang tidak efisien dan tidak ergonomis. Properti hanya baca ini menampilkan jumlah byte data yang telah diantrekan menggunakan panggilan ke WebSocket.send(), tetapi belum dikirim ke jaringan. Nilai ini direset ke nol setelah semua data dalam antrean terkirim, tetapi jika Anda terus memanggil WebSocket.send(), nilai tersebut akan terus naik.

Apa itu WebSocketStream API?

WebSocketStream API menangani masalah backpressure yang tidak ada atau tidak ergonomis dengan mengintegrasikan streaming dengan WebSocket API. Artinya, backpressure dapat diterapkan "secara gratis", tanpa biaya tambahan.

Kasus penggunaan yang disarankan untuk WebSocketStream API

Contoh situs yang dapat menggunakan API ini meliputi:

  • Aplikasi WebSocket bandwidth tinggi yang perlu mempertahankan interaktivitas, khususnya berbagi layar dan video.
  • Demikian pula, perekaman video dan aplikasi lain yang menghasilkan banyak data di browser yang perlu diupload ke server. Dengan backpressure, klien dapat berhenti menghasilkan data, bukan mengumpulkan data dalam memori.

Status saat ini

Langkah Status
1. Buat penjelasan Selesai
2. Membuat draf awal spesifikasi Sedang berlangsung
3. Mengumpulkan masukan & melakukan iterasi pada desain Dalam proses
4. Uji coba origin Selesai
5. Luncurkan Belum dimulai

Cara menggunakan WebSocketStream API

WebSocketStream API berbasis promise, yang membuat penanganannya terasa alami di dunia JavaScript modern. Anda mulai dengan membuat WebSocketStream baru dan meneruskan URL server WebSocket ke sini. Selanjutnya, Anda menunggu koneksi menjadi opened, yang menghasilkan ReadableStream dan/atau WritableStream.

Dengan memanggil metode ReadableStream.getReader(), Anda akhirnya mendapatkan ReadableStreamDefaultReader, yang kemudian dapat digunakan read() datanya hingga aliran selesai, yaitu, hingga objek berformat {value: undefined, done: true} ditampilkan.

Oleh sebab itu, dengan memanggil metode WritableStream.getWriter(), Anda akhirnya mendapatkan WritableStreamDefaultWriter, yang kemudian dapat digunakan write() untuk mendapatkan data.

  const wss = new WebSocketStream(WSS_URL);
  const {readable, writable} = await wss.opened;
  const reader = readable.getReader();
  const writer = writable.getWriter();

  while (true) {
    const {value, done} = await reader.read();
    if (done) {
      break;
    }
    const result = await process(value);
    await writer.write(result);
  }

Tekanan balik

Bagaimana dengan fitur backpressure yang dijanjikan? Anda mendapatkannya "gratis", tanpa perlu langkah tambahan. Jika process() memerlukan waktu tambahan, pesan berikutnya hanya akan digunakan setelah pipeline siap. Demikian pula, langkah WritableStreamDefaultWriter.write() hanya akan dilanjutkan jika aman untuk melakukannya.

Contoh lanjutan

Argumen kedua untuk WebSocketStream adalah paket opsi untuk memungkinkan ekstensi di masa mendatang. Satu-satunya opsi adalah protocols, yang berperilaku sama seperti argumen kedua untuk konstruktor WebSocket:

const chatWSS = new WebSocketStream(CHAT_URL, {protocols: ['chat', 'chatv2']});
const {protocol} = await chatWSS.opened;

protocol yang dipilih serta extensions potensial adalah bagian dari kamus yang tersedia melalui promise WebSocketStream.opened. Semua informasi tentang koneksi langsung disediakan oleh promise ini, karena tidak relevan jika koneksi gagal.

const {readable, writable, protocol, extensions} = await chatWSS.opened;

Informasi tentang koneksi WebSocketStream tertutup

Informasi yang tersedia dari peristiwa WebSocket.onclose dan WebSocket.onerror di WebSocket API kini tersedia melalui promise WebSocketStream.closed. Promise akan ditolak jika terjadi penutupan yang tidak bersih, jika tidak, promise akan di-resolve ke kode dan alasan yang dikirim oleh server.

Semua kemungkinan kode status dan artinya dijelaskan dalam daftar kode status CloseEvent.

const {code, reason} = await chatWSS.closed;

Menutup koneksi WebSocketStream

WebSocketStream dapat ditutup dengan AbortController. Oleh karena itu, teruskan AbortSignal ke konstruktor WebSocketStream.

const controller = new AbortController();
const wss = new WebSocketStream(URL, {signal: controller.signal});
setTimeout(() => controller.abort(), 1000);

Sebagai alternatif, Anda juga dapat menggunakan metode WebSocketStream.close(), tetapi tujuan utamanya adalah untuk mengizinkan penentuan kode dan alasan pengiriman ke server.

wss.close({code: 4000, reason: 'Game over'});

Progressive enhancement dan interoperabilitas

Saat ini, Chrome adalah satu-satunya browser yang menerapkan WebSocketStream API. Untuk interoperabilitas dengan WebSocket API klasik, backpressure ke pesan yang diterima tidak dapat diterapkan. Backpressure dapat diterapkan ke pesan yang dikirim, tetapi melibatkan polling properti WebSocket.bufferedAmount, yang tidak efisien dan tidak ergonomis.

Deteksi fitur

Untuk memeriksa apakah WebSocketStream API didukung, gunakan:

if ('WebSocketStream' in window) {
  // `WebSocketStream` is supported!
}

Demo

Di browser pendukung, Anda dapat melihat cara kerja WebSocketStream API di iframe tersemat, atau langsung di Glitch.

Masukan

Tim Chrome ingin mengetahui pengalaman Anda saat menggunakan WebSocketStream API.

Ceritakan kepada kami tentang desain API

Apakah ada sesuatu tentang API yang tidak berfungsi seperti yang Anda harapkan? Atau apakah ada metode atau properti yang hilang yang Anda perlukan untuk menerapkan ide Anda? Ada pertanyaan atau komentar tentang model keamanan? Ajukan masalah spesifikasi di repo GitHub yang sesuai, atau tambahkan pendapat Anda ke masalah yang sudah ada.

Laporkan masalah terkait penerapan

Apakah Anda menemukan bug pada penerapan Chrome? Atau apakah implementasinya berbeda dengan spesifikasi? Laporkan bug di new.crbug.com. Pastikan untuk menyertakan detail sebanyak mungkin, petunjuk sederhana untuk mereproduksi, dan masukkan Blink>Network>WebSockets di kotak Components. Glitch sangat cocok untuk berbagi kasus reproduksi dengan cepat dan mudah.

Menampilkan dukungan untuk API

Apakah Anda berencana menggunakan WebSocketStream API? Dukungan publik Anda membantu tim Chrome memprioritaskan fitur dan menunjukkan kepada vendor browser lain betapa pentingnya mendukung mereka.

Kirim tweet ke @ChromiumDev menggunakan hashtag #WebSocketStream dan beri tahu kami tempat dan cara Anda menggunakannya.

Link bermanfaat

Ucapan terima kasih

WebSocketStream API diimplementasikan oleh Adam Rice dan Yutaka Hirano.