Komunikasi dua arah dengan pekerja layanan

Andrew Guan

Demián Renzulli

Dalam beberapa kasus, aplikasi web mungkin perlu membuat saluran komunikasi dua arah antara halaman dan pekerja layanan.

Misalnya: di PWA podcast, seseorang dapat membuat fitur untuk memungkinkan pengguna mendownload episode untuk konsumsi offline dan mengizinkan service worker untuk terus memberi tahu halaman secara rutin tentang progresnya, sehingga thread utama dapat memperbarui UI.

Dalam panduan ini, kita akan mempelajari berbagai cara untuk menerapkan komunikasi dua arah antara konteks Jendela dan service worker, dengan mempelajari berbagai API, library Workbox, serta beberapa kasus lanjutan.

Catatan: Lihat Ringkasan worker untuk penjelasan tingkat tinggi tentang kapan harus menggunakan worker web versus worker layanan dan bagian lain dari seri Berkomunikasi dengan worker untuk panduan tentang kasus penggunaan umum lainnya.

Menggunakan Workbox

workbox-window adalah kumpulan modul library Workbox yang dimaksudkan untuk dijalankan dalam konteks jendela. Class Workbox menyediakan metode messageSW() untuk mengirim pesan ke pekerja layanan terdaftar instance dan menunggu respons.

Kode halaman berikut membuat instance Workbox baru dan mengirim pesan ke pekerja layanan untuk mendapatkan versinya:

const wb = new Workbox('/sw.js');
wb.register();

const swVersion = await wb.messageSW({type: 'GET_VERSION'});
console.log('Service Worker version:', swVersion);

Service worker mengimplementasikan pemroses pesan di ujung lain, dan merespons service worker yang terdaftar:

const SW_VERSION = '1.0.0';

self.addEventListener('message', (event) => {
  if (event.data.type === 'GET_VERSION') {
    event.ports[0].postMessage(SW_VERSION);
  }
});

Di balik layar, library ini menggunakan API browser yang akan kita ulas di bagian berikutnya: Message Channel, tetapi mengabstraksi banyak detail implementasi, sehingga lebih mudah digunakan, sekaligus memanfaatkan dukungan browser yang luas yang dimiliki API ini.

Menggunakan API browser

Jika library Workbox tidak cukup untuk kebutuhan Anda, ada beberapa API level rendah yang tersedia untuk mengimplementasikan komunikasi "dua arah" antara halaman dan pekerja layanan. Keduanya memiliki beberapa persamaan dan perbedaan:

Persamaan:

• Dalam semua kasus, komunikasi dimulai di satu ujung melalui antarmuka postMessage() dan diterima di ujung lainnya dengan mengimplementasikan pengendali message.
• Dalam praktiknya, semua API yang tersedia memungkinkan kita mengimplementasikan kasus penggunaan yang sama, tetapi beberapa di antaranya mungkin menyederhanakan pengembangan dalam beberapa skenario.

Perbedaan:

• Keduanya memiliki cara yang berbeda untuk mengidentifikasi sisi lain komunikasi: beberapa di antaranya menggunakan referensi eksplisit ke konteks lain, sementara yang lain dapat berkomunikasi secara implisit melalui objek proxy yang dibuat di setiap sisi.
• Dukungan browser bervariasi di antara keduanya.

Broadcast Channel API

Browser Support

• 54
• 79
• 38
• 15.4

Source

Broadcast Channel API memungkinkan komunikasi dasar antara konteks penjelajahan melalui objek BroadcastChannel.

Untuk menerapkannya, pertama, setiap konteks harus membuat instance objek BroadcastChannel dengan ID yang sama serta mengirim dan menerima pesan darinya:

const broadcast = new BroadcastChannel('channel-123');

Objek BroadcastChannel mengekspos antarmuka postMessage() untuk mengirim pesan ke konteks pemrosesan apa pun:

//send message
broadcast.postMessage({ type: 'MSG_ID', });

Setiap konteks browser dapat memproses pesan melalui metode onmessage dari objek BroadcastChannel:

//listen to messages
broadcast.onmessage = (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //process message...
  }
};

Seperti yang terlihat, tidak ada referensi eksplisit ke konteks tertentu, sehingga tidak perlu mendapatkan referensi terlebih dahulu ke pekerja layanan atau klien tertentu.

Kelemahannya adalah, pada saat penulisan ini, API ini memiliki dukungan dari Chrome, Firefox, dan Edge, tetapi browser lain, seperti Safari, belum mendukungnya.

Client API

Browser Support

• 40
• 17
• 44
• 11.1

Source

Client API memungkinkan Anda mendapatkan referensi ke semua objek WindowClient yang mewakili tab aktif yang dikontrol oleh pekerja layanan.

Karena halaman dikontrol oleh satu pekerja layanan, halaman tersebut memproses dan mengirim pesan ke pekerja layanan aktif secara langsung melalui antarmuka serviceWorker:

//send message
navigator.serviceWorker.controller.postMessage({
  type: 'MSG_ID',
});

//listen to messages
navigator.serviceWorker.onmessage = (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //process response
  }
};

Demikian pula, pekerja layanan memproses pesan dengan mengimplementasikan pemroses onmessage:

//listen to messages
self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //Process message
  }
});

Untuk berkomunikasi kembali dengan kliennya, pekerja layanan mendapatkan array objek WindowClient dengan menjalankan metode seperti Clients.matchAll() dan Clients.get(). Kemudian, model dapat postMessage() salah satunya:

//Obtain an array of Window client objects
self.clients.matchAll(options).then(function (clients) {
  if (clients && clients.length) {
    //Respond to last focused tab
    clients[0].postMessage({type: 'MSG_ID'});
  }
});

Client API adalah opsi yang baik untuk berkomunikasi dengan mudah dengan semua tab aktif dari pekerja layanan dengan cara yang relatif mudah. API ini didukung oleh semua browser utama, tetapi tidak semua metodenya mungkin tersedia, jadi pastikan untuk memeriksa dukungan browser sebelum mengimplementasikannya di situs Anda.

Catatan: Dalam panduan ini, kami berfokus pada kasus penggunaan keandalan. Penggunaan menarik lainnya dari API ini adalah menyinkronkan data di seluruh dokumen melalui pekerja layanan. Tonton episode HTTP 203 ini untuk mengetahui informasi selengkapnya.

Saluran Pesan

Browser Support

• 2
• 12
• 41
• 5

Source

Saluran Pesan memerlukan penentuan dan penerusan port dari satu konteks ke konteks lainnya untuk membuat saluran komunikasi dua arah.

Untuk melakukan inisialisasi saluran, halaman membuat instance objek MessageChannel dan menggunakannya untuk mengirim port ke pekerja layanan terdaftar. Halaman ini juga menerapkan pemroses onmessage untuk menerima pesan dari konteks lain:

const messageChannel = new MessageChannel();

//Init port
navigator.serviceWorker.controller.postMessage({type: 'PORT_INITIALIZATION'}, [
  messageChannel.port2,
]);

//Listen to messages
messageChannel.port1.onmessage = (event) => {
  // Process message
};

Service worker menerima port, menyimpan referensi ke port tersebut, dan menggunakannya untuk mengirim pesan ke sisi lain:

let communicationPort;

//Save reference to port
self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'PORT_INITIALIZATION') {
    communicationPort = event.ports[0];
  }
});

//Send messages
communicationPort.postMessage({type: 'MSG_ID'});

MessageChannel saat ini didukung oleh semua browser utama.

API Lanjutan: Sinkronisasi Latar Belakang dan Pengambilan Latar Belakang

Dalam panduan ini, kita telah mempelajari cara menerapkan teknik komunikasi dua arah, untuk kasus yang relatif sederhana, seperti meneruskan pesan string yang menjelaskan operasi yang akan dilakukan, atau daftar URL yang akan di-cache dari satu konteks ke konteks lainnya. Di bagian ini, kita akan mempelajari dua API untuk menangani skenario tertentu: tidak adanya konektivitas dan download yang lama.

Sinkronisasi Latar Belakang

Browser Support

• 49
• 79
• x
• x

Source

Aplikasi chat mungkin ingin memastikan bahwa pesan tidak pernah hilang karena konektivitas yang buruk. Background Sync API memungkinkan Anda menunda tindakan untuk dicoba lagi saat pengguna memiliki konektivitas yang stabil. Hal ini berguna untuk memastikan bahwa apa pun yang ingin dikirim pengguna, benar-benar dikirim.

Sebagai ganti antarmuka postMessage(), halaman mendaftarkan sync:

navigator.serviceWorker.ready.then(function (swRegistration) {
  return swRegistration.sync.register('myFirstSync');
});

Service worker kemudian memproses peristiwa sync untuk memproses pesan:

self.addEventListener('sync', function (event) {
  if (event.tag == 'myFirstSync') {
    event.waitUntil(doSomeStuff());
  }
});

Fungsi doSomeStuff() harus menampilkan promise yang menunjukkan keberhasilan/kegagalan dari apa pun yang dicoba dilakukan. Jika terpenuhi, sinkronisasi selesai. Jika gagal, sinkronisasi lain akan dijadwalkan untuk mencoba lagi. Sinkronisasi percobaan ulang juga menunggu konektivitas, dan menggunakan back-off eksponensial.

Setelah operasi dilakukan, pekerja layanan dapat berkomunikasi kembali dengan halaman untuk memperbarui UI, menggunakan salah satu API komunikasi yang telah dibahas sebelumnya.

Google Penelusuran menggunakan Sinkronisasi Latar Belakang untuk mempertahankan kueri yang gagal karena konektivitas yang buruk, dan mencoba lagi kueri tersebut nanti saat pengguna online. Setelah operasi dilakukan, mereka mengomunikasikan hasilnya kepada pengguna melalui notifikasi push web:

Catatan: Lihat Pengalaman penelusuran yang tangguh untuk mempelajari cara menerapkan fitur ini menggunakan Sinkronisasi Latar Belakang Workbox.

Pengambilan Latar Belakang

Browser Support

• 74
• 79
• x
• x

Source

Untuk pekerjaan yang relatif singkat seperti mengirim pesan, atau daftar URL yang akan di-cache, opsi yang telah dibahas sejauh ini adalah pilihan yang baik. Jika tugas memerlukan waktu terlalu lama, browser akan menghentikan pekerja layanan, jika tidak, hal ini akan berisiko terhadap privasi dan baterai pengguna.

Background Fetch API memungkinkan Anda memindahkan tugas yang panjang ke pekerja layanan, seperti mendownload film, podcast, atau level game.

Untuk berkomunikasi dengan pekerja layanan dari halaman, gunakan backgroundFetch.fetch, bukan postMessage():

navigator.serviceWorker.ready.then(async (swReg) => {
  const bgFetch = await swReg.backgroundFetch.fetch(
    'my-fetch',
    ['/ep-5.mp3', 'ep-5-artwork.jpg'],
    {
      title: 'Episode 5: Interesting things.',
      icons: [
        {
          sizes: '300x300',
          src: '/ep-5-icon.png',
          type: 'image/png',
        },
      ],
      downloadTotal: 60 * 1024 * 1024,
    },
  );
});

Objek BackgroundFetchRegistration memungkinkan halaman memproses peristiwa progress untuk mengikuti progres download:

bgFetch.addEventListener('progress', () => {
  // If we didn't provide a total, we can't provide a %.
  if (!bgFetch.downloadTotal) return;

  const percent = Math.round(
    (bgFetch.downloaded / bgFetch.downloadTotal) * 100,
  );
  console.log(`Download progress: ${percent}%`);
});

UI diupdate untuk menunjukkan progres download (kiri). Berkat pekerja layanan, operasi dapat terus berjalan saat semua tab telah ditutup (kanan).

Catatan: Lihat panduan Pengambilan Latar Belakang.

Langkah berikutnya

Dalam panduan ini, kita telah mempelajari kasus komunikasi yang paling umum antara halaman dan pekerja layanan (komunikasi dua arah).

Sering kali, satu konteks hanya perlu berkomunikasi dengan konteks lain, tanpa menerima respons. Lihat panduan berikut untuk mengetahui panduan cara menerapkan teknik searah di halaman Anda dari dan ke pekerja layanan, beserta kasus penggunaan dan contoh produksi:

• Panduan caching imperatif: Memanggil pekerja layanan dari halaman untuk meng-cache resource terlebih dahulu (misalnya, dalam skenario pengambilan data).
• Menyiarkan update: Memanggil halaman dari pekerja layanan untuk menginformasikan update penting (misalnya, versi baru aplikasi web tersedia).