Tutorial membangun layanan Chat WebSocket untuk Cloud Run

Menyiapkan default gcloud

Untuk mengonfigurasi gcloud dengan setelan default untuk layanan Cloud Run Anda:

1. Setel project default Anda:

   gcloud config set project PROJECT_ID

   Ganti PROJECT_ID dengan nama project yang Anda buat untuk tutorial ini.

2. Konfigurasi gcloud untuk region yang Anda pilih:

   gcloud config set run/region REGION

   Ganti REGION dengan region Cloud Run pilihan Anda yang didukung.

Mengambil contoh kode

Untuk mengambil contoh kode agar dapat digunakan:

1. Clone repositori contoh ke komputer lokal Anda:

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   Atau, Anda dapat mendownload sampel sebagai file ZIP dan mengekstraknya.

2. Ubah ke direktori yang memuat kode contoh Cloud Run:

   Node.js

   cd nodejs-docs-samples/run/websockets/

Memahami kode

Socket.io adalah library yang memungkinkan komunikasi dua arah secara real-time antara browser dan server. Meskipun bukan implementasi WebSocket, Socket.io menggabungkan fungsi untuk menyediakan API yang lebih sederhana bagi beberapa protokol komunikasi dengan fitur tambahan seperti keandalan yang lebih baik, sambungan ulang otomatis, dan menyiarkan pesan ke semua atau sebagian klien.

Integrasi sisi klien

<script src="/socket.io/socket.io.js"></script>

Klien membuat instance instance Socket baru untuk setiap koneksi. Karena contoh ini dirender di sisi server, URL server tidak perlu ditentukan. Instance soket dapat memunculkan dan memproses peristiwa.

// Initialize Socket.io
const socket = io('', {
  transports: ['websocket'],
});

// Emit "sendMessage" event with message
socket.emit('sendMessage', msg, error => {
  if (error) {
    console.error(error);
  } else {
    // Clear message
    $('#msg').val('');
  }
});

// Listen for new messages
socket.on('message', msg => {
  log(msg.user, msg.text);
});

// Listen for notifications
socket.on('notification', msg => {
  log(msg.title, msg.description);
});

// Listen connect event
socket.on('connect', () => {
  console.log('connected');
});

Integrasi sisi server

Di sisi server, server Socket.io diinisialisasi dan dipasang ke server HTTP. Mirip dengan sisi klien, setelah server Socket.io membuat koneksi ke klien, instance socket dibuat untuk setiap koneksi yang dapat digunakan untuk memunculkan dan memproses pesan. Socket.io juga menyediakan antarmuka yang mudah untuk membuat "ruang" atau saluran arbitrer tempat soket dapat bergabung dan keluar.

// Initialize Socket.io
const server = require('http').Server(app);
const io = require('socket.io')(server);

const {createAdapter} = require('@socket.io/redis-adapter');
// Replace in-memory adapter with Redis
const subClient = redisClient.duplicate();
io.adapter(createAdapter(redisClient, subClient));
// Add error handlers
redisClient.on('error', err => {
  console.error(err.message);
});

subClient.on('error', err => {
  console.error(err.message);
});

// Listen for new connection
io.on('connection', socket => {
  // Add listener for "signin" event
  socket.on('signin', async ({user, room}, callback) => {
    try {
      // Record socket ID to user's name and chat room
      addUser(socket.id, user, room);
      // Call join to subscribe the socket to a given channel
      socket.join(room);
      // Emit notification event
      socket.in(room).emit('notification', {
        title: "Someone's here",
        description: `${user} just entered the room`,
      });
      // Retrieve room's message history or return null
      const messages = await getRoomFromCache(room);
      // Use the callback to respond with the room's message history
      // Callbacks are more commonly used for event listeners than promises
      callback(null, messages);
    } catch (err) {
      callback(err, null);
    }
  });

  // Add listener for "updateSocketId" event
  socket.on('updateSocketId', async ({user, room}) => {
    try {
      addUser(socket.id, user, room);
      socket.join(room);
    } catch (err) {
      console.error(err);
    }
  });

  // Add listener for "sendMessage" event
  socket.on('sendMessage', (message, callback) => {
    // Retrieve user's name and chat room  from socket ID
    const {user, room} = getUser(socket.id);
    if (room) {
      const msg = {user, text: message};
      // Push message to clients in chat room
      io.in(room).emit('message', msg);
      addMessageToCache(room, msg);
      callback();
    } else {
      callback('User session not found.');
    }
  });

  // Add listener for disconnection
  socket.on('disconnect', () => {
    // Remove socket ID from list
    const {user, room} = deleteUser(socket.id);
    if (user) {
      io.in(room).emit('notification', {
        title: 'Someone just left',
        description: `${user} just left the room`,
      });
    }
  });
});

Socket.io juga menyediakan adaptor Redis untuk menyiarkan peristiwa ke semua klien, terlepas dari server mana yang melayani soket. Socket.io hanya menggunakan mekanisme Pub/Sub Redis dan tidak menyimpan data apa pun.

const {createAdapter} = require('@socket.io/redis-adapter');
// Replace in-memory adapter with Redis
const subClient = redisClient.duplicate();
io.adapter(createAdapter(redisClient, subClient));

Adaptor Redis Socket.io dapat menggunakan kembali klien Redis yang digunakan untuk menyimpan histori pesan ruang. Setiap container akan membuat koneksi ke instance Redis dan Cloud Run dapat membuat instance dalam jumlah besar. Koneksi ini jauh di bawah 65000 koneksi yang dapat didukung Redis. Jika Anda perlu mendukung jumlah traffic ini, Anda juga perlu mengevaluasi throughput konektor Akses VPC Serverless.

Sambungan ulang

Cloud Run memiliki waktu tunggu maksimum 60 menit. Jadi, Anda perlu menambahkan logika sambungan ulang untuk kemungkinan waktu tunggu. Dalam beberapa kasus, Socket.io secara otomatis mencoba menghubungkan kembali setelah peristiwa pemutusan koneksi atau error koneksi. Tidak ada jaminan bahwa klien akan terhubung kembali ke instance yang sama.

// Listen for reconnect event
socket.io.on('reconnect', () => {
  console.log('reconnected');
  // Emit "updateSocketId" event to update the recorded socket ID with user and room
  socket.emit('updateSocketId', {user, room}, error => {
    if (error) {
      console.error(error);
    }
  });
});

// Add listener for "updateSocketId" event
socket.on('updateSocketId', async ({user, room}) => {
  try {
    addUser(socket.id, user, room);
    socket.join(room);
  } catch (err) {
    console.error(err);
  }
});

Instance akan tetap ada jika ada koneksi yang aktif hingga semua permintaan ditutup atau waktu habis. Meskipun Anda menggunakan afinitas sesi Cloud Run, permintaan baru dapat di-load balanced ke container aktif, sehingga container dapat menurunkan skala. Jika Anda khawatir mengenai banyaknya container yang terus ada setelah terjadi lonjakan traffic, Anda dapat menurunkan nilai waktu tunggu maksimum agar soket yang tidak digunakan lebih sering dibersihkan.

Mengirimkan layanan

1. Buat instance Memorystore untuk Redis:

   gcloud redis instances create INSTANCE_ID --size=1 --region=REGION

   Ganti INSTANCE_ID dengan nama instance, yaitu my-redis-instance, dan REGION_ID dengan region untuk semua resource dan layanan Anda, yaitu us-central1.

   Instance akan secara otomatis mendapatkan alokasi rentang IP dari rentang jaringan layanan default. Tutorial ini menggunakan memori 1 GB untuk cache lokal pesan dalam instance Redis. Pelajari lebih lanjut cara Menentukan ukuran awal instance Memorystore untuk kasus penggunaan Anda.

2. Siapkan konektor Akses VPC Serverless:

   Agar terhubung ke instance Redis, layanan Cloud Run Anda memerlukan akses ke jaringan VPC resmi instance Redis.

   Setiap konektor VPC memerlukan subnet /28 tersendiri untuk menempatkan instance konektor. Rentang IP ini tidak boleh tumpang tindih dengan reservasi alamat IP apa pun yang sudah ada di jaringan VPC Anda. Contohnya, 10.8.0.0 (/28) akan berfungsi di sebagian besar project baru atau Anda dapat menentukan rentang IP kustom lain yang tidak digunakan, seperti 10.9.0.0 (/28). Anda dapat melihat rentang IP yang saat ini dicadangkan di Konsol Google Cloud.

   gcloud compute networks vpc-access connectors create CONNECTOR_NAME \
     --region REGION \
     --range "10.8.0.0/28"
   

   Ganti CONNECTOR_NAME dengan nama untuk konektor Anda.

   Perintah ini membuat konektor di jaringan VPC default, seperti instance Redis, dengan ukuran mesin e2-micro. Meningkatkan ukuran mesin konektor dapat meningkatkan throughput konektor, tetapi juga akan meningkatkan biaya. Konektor juga harus berada di region yang sama dengan instance Redis. Pelajari lebih lanjut cara Mengonfigurasi Akses VPC Serverless.

3. Tentukan variabel lingkungan dengan alamat IP jaringan yang diizinkan instance Redis:

    export REDISHOST=$(gcloud redis instances describe INSTANCE_ID --region REGION --format "value(host)")

4. Buat akun layanan untuk digunakan sebagai identitas layanan. Secara default, opsi ini tidak memiliki hak istimewa selain keanggotaan project.

   gcloud iam service-accounts create chat-identity
   gcloud projects add-iam-policy-binding PROJECT_ID \
   --member=serviceAccount:chat-identity@PROJECT_ID.iam.gserviceaccount.com \
   --role=roles/serviceusage.serviceUsageConsumer
   

5. Bangun dan deploy image container ke Cloud Run:

   gcloud run deploy chat-app --source . \
       --vpc-connector CONNECTOR_NAME \
       --allow-unauthenticated \
       --timeout 3600 \
       --service-account chat-identity \
       --update-env-vars REDISHOST=$REDISHOST

   Respons setiap permintaan untuk menginstal API yang diperlukan dengan merespons y saat diminta. Anda hanya perlu melakukan ini sekali untuk sebuah project. Respons permintaan lain dengan menyediakan platform dan region, jika Anda belum menetapkan setelan default untuk perintah tersebut, seperti yang dijelaskan di halaman setup. Pelajari lebih lanjut cara Men-deploy dari kode sumber.

Melakukan Percobaan

Untuk mencoba layanan lengkap:

1. Buka browser Anda ke URL yang disediakan pada langkah deployment di atas.

2. Tambahkan nama Anda dan ruang chat untuk login.

3. Kirim pesan ke ruang.

Jika Anda memilih untuk terus mengembangkan layanan ini, perlu diingat bahwa layanan tersebut telah membatasi akses Identity and Access Management (IAM) ke bagian lain Google Cloud dan perlu diberi peran IAM tambahan untuk mengakses banyak layanan lainnya.