Criar um serviço de chat WebSocket para o tutorial do Cloud Run

Este tutorial mostra como criar um serviço de chat em tempo real com várias salas usando WebSockets com uma ligação persistente para comunicação bidirecional. Com os WebSockets, o cliente e o servidor podem enviar mensagens entre si sem sondar o servidor para atualizações.

Embora possa configurar o Cloud Run para usar a afinidade de sessão, esta oferece uma afinidade de melhor esforço, o que significa que qualquer novo pedido ainda pode ser potencialmente encaminhado para uma instância diferente. Consequentemente, as mensagens do utilizador no serviço de chat têm de ser sincronizadas em todas as instâncias e não apenas entre os clientes ligados a uma instância.

Crie um serviço de chat em tempo real

Este serviço de chat de exemplo usa uma instância do Memorystore para Redis para armazenar e sincronizar mensagens do utilizador em todas as instâncias. O Redis usa um mecanismo de Pub/Sub, que não deve ser confundido com o produto Cloud Pub/Sub, para enviar dados para clientes subscritos ligados a qualquer instância, de modo a eliminar a sondagem HTTP para atualizações.

No entanto, mesmo com as atualizações push, qualquer instância iniciada só recebe novas mensagens enviadas para o contentor. Para carregar mensagens anteriores, o histórico de mensagens teria de ser armazenado e obtido a partir de uma solução de armazenamento persistente. Este exemplo usa a funcionalidade convencional de uma loja de objetos do Redis para colocar em cache e obter o histórico de mensagens.

A instância do Redis está protegida da Internet através de IPs privados com acesso controlado e limitado a serviços executados na mesma rede privada virtual que a instância do Redis. Recomendamos que use a saída de VPC direta.

Limitações

• Este tutorial não mostra a autenticação do utilizador final nem o armazenamento em cache da sessão. Para saber mais sobre a autenticação do utilizador final, consulte o tutorial do Cloud Run sobre a autenticação do utilizador final.

• Este tutorial não implementa uma base de dados, como o Firestore, para o armazenamento e a obtenção indefinidos do histórico de mensagens de chat.

• São necessários elementos adicionais para que este serviço de exemplo esteja pronto para produção. Recomendamos uma instância do Redis de nível padrão para oferecer alta disponibilidade através da replicação e da comutação por falha automática.

Objetivos

• Escreva, crie e implemente um serviço do Cloud Run que use WebSockets.

• Estabeleça ligação a uma instância do Memorystore for Redis para publicar e subscrever novas mensagens em várias instâncias.

• Ligue o serviço do Cloud Run ao Memorystore através da saída da VPC direta.

Custos

Neste documento, usa os seguintes componentes faturáveis do Google Cloud:

• Cloud Build
• Artifact Registry
• Memorystore
• Cloud Run

Para gerar uma estimativa de custos com base na sua utilização projetada, use a calculadora de preços.

Os novos Google Cloud utilizadores podem ser elegíveis para uma avaliação gratuita.

Antes de começar

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Enable the Cloud Run, Memorystore for Redis, Artifact Registry, and Cloud Build APIs.

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

   Enable the APIs

2. Instale e inicialize a CLI gcloud.

Funções necessárias

Para receber as autorizações de que precisa para concluir o tutorial, peça ao seu administrador para lhe conceder as seguintes funções da IAM no seu projeto:

• Leitor do Artifact Registry (roles/artifactregistry.reader)
• Editor do Cloud Build (roles/cloudbuild.builds.editor)
• Administrador do Cloud Memorystore Redis (roles/redis.admin)
• Administrador do Cloud Run (roles/run.admin)
• Criar contas de serviço (roles/iam.serviceAccountCreator)
• Project IAM Admin (roles/resourcemanager.projectIamAdmin)
• Administrador da conta de serviço (roles/iam.serviceAccountAdmin)
• Consumidor de utilização do serviço (roles/serviceusage.serviceUsageConsumer)

Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

Nota: as funções básicas de IAM também podem conter autorizações para concluir o tutorial. Não deve conceder funções básicas num ambiente de produção, mas pode concedê-las num ambiente de desenvolvimento ou de teste.

Configure as predefinições do gcloud

Para configurar o gcloud com as predefinições do seu serviço do Cloud Run:

1. Defina o projeto predefinido:

   gcloud config set project PROJECT_ID

   Substitua PROJECT_ID pelo nome do projeto que criou para este tutorial.

2. Configure o gcloud para a região escolhida:

   gcloud config set run/region REGION

   Substitua REGION pela região do Cloud Run suportada à sua escolha.

Localizações do Cloud Run

O Cloud Run é regional, o que significa que a infraestrutura que executa os seus serviços do Cloud Run está localizada numa região específica e é gerida pela Google para estar disponível de forma redundante em todas as zonas dessa região.

O cumprimento dos seus requisitos de latência, disponibilidade ou durabilidade são fatores principais para selecionar a região onde os seus serviços do Cloud Run são executados. Geralmente, pode selecionar a região mais próxima dos seus utilizadores, mas deve considerar a localização dos outros Google Cloudprodutos usados pelo seu serviço do Cloud Run. A utilização Google Cloud de produtos em conjunto em várias localizações pode afetar a latência do seu serviço, bem como o custo.

O Cloud Run está disponível nas seguintes regiões:

Sujeito aos preços de Nível 1

• asia-east1 (Taiwan)
• asia-northeast1 (Tóquio)
• asia-northeast2 (Osaca)
• asia-south1 (Mumbai, Índia)
• europe-north1 (Finlândia) Baixo CO₂
• europe-north2 (Estocolmo) Baixo CO₂
• europe-southwest1 (Madrid) Baixo CO₂
• europe-west1 (Bélgica) Baixo CO₂
• europe-west4 (Países Baixos) Baixo CO₂
• europe-west8 (Milão)
• europe-west9 (Paris) Baixo CO₂
• me-west1 (Telavive)
• northamerica-south1 (México)
• us-central1 (Iowa) Baixo CO₂
• us-east1 (Carolina do Sul)
• us-east4 (Virgínia do Norte)
• us-east5 (Columbus)
• us-south1 (Dallas) Baixo CO₂
• us-west1 (Oregão) Baixo CO₂

Sujeito aos preços de Nível 2

• africa-south1 (Joanesburgo)
• asia-east2 (Hong Kong)
• asia-northeast3 (Seul, Coreia do Sul)
• asia-southeast1 (Singapura)
• asia-southeast2 (Jacarta)
• asia-south2 (Deli, Índia)
• australia-southeast1 (Sydney)
• australia-southeast2 (Melbourne)
• europe-central2 (Varsóvia, Polónia)
• europe-west10 (Berlim)
• europe-west12 (Turim)
• europe-west2 (Londres, Reino Unido) Baixo CO₂
• europe-west3 (Frankfurt, Alemanha)
• europe-west6 (Zurique, Suíça) Baixo CO₂
• me-central1 (Doha)
• me-central2 (Dammam)
• northamerica-northeast1 (Montreal) Baixo CO₂
• northamerica-northeast2 (Toronto) Baixo CO₂
• southamerica-east1 (São Paulo, Brasil) Baixo CO₂
• southamerica-west1 (Santiago, Chile) Baixo CO₂
• us-west2 (Los Angeles)
• us-west3 (Salt Lake City)
• us-west4 (Las Vegas)

Se já criou um serviço do Cloud Run, pode ver a região no painel de controlo do Cloud Run na Google Cloud consola.

OK

Obtenha o exemplo de código

Para obter o exemplo de código para utilização:

1. Clone o repositório de exemplo para a sua máquina local:

   Node.js

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

   Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.

2. Altere para o diretório que contém o código de exemplo do Cloud Run:

   Node.js

   cd nodejs-docs-samples/run/websockets/

Compreenda o código WebSockets

O Socket.io é uma biblioteca que permite a comunicação bidirecional em tempo real entre o navegador e o servidor. Embora o Socket.io não seja uma implementação do WebSocket, envolve a funcionalidade para fornecer uma API mais simples para vários protocolos de comunicação com funcionalidades adicionais, como fiabilidade melhorada, reconexão automática e transmissão para todos ou um subconjunto de clientes.

Integração do lado do cliente

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

O cliente instancia uma nova instância de Socket para cada ligação. Uma vez que este exemplo é renderizado do lado do servidor, não é necessário definir o URL do servidor. A instância de socket pode emitir e ouvir eventos.

// 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');
});

Nota: para uma arquitetura de várias instâncias sem afinidade de sessão, o Socket.io só pode usar o transporte Websocket. Se o Socket.io recorrer ao long polling, envia vários pedidos HTTP durante a duração da sessão. O primeiro pedido estabelece um "handshake" com informações importantes, como o ID da sessão. Após o primeiro pedido, os pedidos podem ser encaminhados para outra instância que gera um erro devido ao ID da sessão ser desconhecido para o servidor.

Integração do lado do servidor

Do lado do servidor, o servidor Socket.io é inicializado e anexado ao servidor HTTP. Semelhante ao lado do cliente, assim que o servidor Socket.io estabelece uma ligação ao cliente, é criada uma instância de socket para cada ligação que pode ser usada para emitir e ouvir mensagens. O Socket.io também fornece uma interface para criar "salas" ou um canal arbitrário ao qual os sockets podem aderir e sair.

// 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`,
      });
    }
  });
});

O Socket.io também fornece um adaptador Redis para transmitir eventos a todos os clientes, independentemente do servidor que está a publicar o socket. O Socket.io usa apenas o mecanismo Pub/Sub do Redis e não armazena dados.

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

O adaptador Redis do Socket.io pode reutilizar o cliente Redis usado para armazenar o histórico de mensagens da sala. Cada contentor cria uma ligação à instância do Redis e o Cloud Run pode criar um grande número de instâncias. Este valor está muito abaixo das 65 000 ligações que o Redis pode suportar.

Nota: o ciclo de vida do contentor do Cloud Run não tem em consideração pedidos de saída, como ligações Redis; por conseguinte, uma ligação ativa ao Redis não impede o contentor de ser reduzido.

Nova associação

O Cloud Run tem um limite de tempo máximo de 60 minutos. Por isso, tem de adicionar uma lógica de restabelecimento da ligação para possíveis limites de tempo. Em alguns casos, o Socket.io tenta automaticamente restabelecer a ligação após eventos de desligamento ou erro de ligação. Não existe garantia de que o cliente volte a estabelecer ligação à mesma instância.

// 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);
  }
});

As instâncias persistem se existir uma ligação ativa até que todos os pedidos sejam fechados ou expirem. Mesmo que use a afinidade de sessão do Cloud Run, é possível que os novos pedidos sejam equilibrados em carga para contentores ativos, o que permite o dimensionamento dos contentores. Se estiver preocupado com o grande número de contentores que persistem após um pico de tráfego, pode diminuir o valor de tempo limite máximo para que os soquetes não usados sejam limpos com maior frequência.

Envie o serviço

1. Crie uma instância do Memorystore for Redis:

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

   Substitua o seguinte:

   • INSTANCE_ID: o nome da instância, por exemplo, my-redis-instance.
   • REGION_ID: a região para todos os seus recursos e serviços, por exemplo, europe-west1.

   À instância é automaticamente atribuído um intervalo de IP do intervalo de rede de serviço predefinido. Este tutorial usa 1 GB de memória para a cache local de mensagens na instância do Redis. Saiba como determinar o tamanho inicial de uma instância do Memorystore para o seu exemplo de utilização.

2. Defina uma variável de ambiente com o endereço IP da rede autorizada da sua instância do Redis:

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

   Nota: este tutorial usa o valor predefinido para a porta Redis, 6379.

3. Crie uma conta de serviço para servir como identidade do serviço. Por predefinição, esta conta não tem privilégios além da associação ao projeto.

   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

4. Encontre o nome da sua rede VPC autorizada pela instância do Redis executando o seguinte comando:

     gcloud redis instances describe INSTANCE_ID --region REGION --format "value(authorizedNetwork)"
   

   Substitua o seguinte:

   • INSTANCE_ID: o nome da instância, por exemplo, my-redis-instance.
   • REGION_ID: a região para todos os seus recursos e serviços, por exemplo, europe-west1.

   Tome nota do nome da rede de VPC.

5. Crie e implemente a imagem de contentor no Cloud Run:

   gcloud run deploy chat-app --source . \
       --allow-unauthenticated \
       --timeout 3600 \
       --service-account chat-identity \
       --network NETWORK \
       --subnet SUBNET \
       --update-env-vars REDISHOST=$REDISHOST

   Substitua o seguinte:

   • NETWORK é o nome da rede VPC autorizada à qual a sua instância do Redis está associada.
   • SUBNET é o nome da sua sub-rede. A sub-rede tem de ter /26 ou mais. A saída direta da VPC suporta intervalos IPv4 RFC 1918, RFC 6598 e Classe E.

   Responda a todas as instruções para instalar as APIs necessárias respondendo y quando lhe for pedido. Só tem de fazer isto uma vez por projeto. Responda a outros pedidos fornecendo a plataforma e a região, se não tiver definido predefinições para estas, conforme descrito na página de configuração. Saiba mais sobre a Implementação a partir do código fonte.

Experimente o serviço

Para experimentar o serviço completo:

1. Navegue no navegador para o URL fornecido pelo passo de implementação.

2. Adicione o seu nome e uma sala de chat para iniciar sessão.

3. Envie uma mensagem para a sala!

Êxito: criou um serviço de chat em tempo real com várias salas através de WebSockets para manter uma ligação persistente para comunicação bidirecional.

Se optar por continuar a desenvolver estes serviços, lembre-se de que têm acesso restrito à gestão de identidade e acesso (IAM) ao resto do Google Cloud e terão de receber funções de IAM adicionais para aceder a muitos outros serviços.

Limpar

Para evitar custos adicionais na sua conta Google Cloud , elimine todos os recursos que implementou com este tutorial.

Elimine o projeto

Se criou um novo projeto para este tutorial, elimine-o. Se usou um projeto existente e precisa de o manter sem as alterações que adicionou neste tutorial, elimine os recursos que criou para o tutorial.

A forma mais fácil de eliminar a faturação é eliminar o projeto que criou para o tutorial.

Para eliminar o projeto:

Atenção: a eliminação de um projeto tem os seguintes efeitos:

• Tudo no projeto é eliminado. Se usou um projeto existente para as tarefas neste documento, quando o elimina, também elimina qualquer outro trabalho que tenha feito no projeto.
• Os IDs dos projetos personalizados são perdidos. Quando criou este projeto, pode ter criado um ID do projeto personalizado que quer usar no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, elimine os recursos selecionados no projeto em vez de eliminar o projeto inteiro.

Se planeia explorar várias arquiteturas, tutoriais ou inícios rápidos, a reutilização de projetos pode ajudar a evitar exceder os limites de quota de projetos.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Elimine recursos de tutoriais

1. Elimine o serviço do Cloud Run que implementou neste tutorial. Os serviços do Cloud Run não incorrem em custos até receberem pedidos.

   Para eliminar o seu serviço do Cloud Run, execute o seguinte comando:

   gcloud run services delete SERVICE-NAME

   Substitua SERVICE-NAME pelo nome do seu serviço.

   Também pode eliminar serviços do Cloud Run a partir da Google Cloud consola.

2. Remova a configuração da região predefinida gcloud que adicionou durante a configuração do tutorial:

    gcloud config unset run/region
   

3. Remova a configuração do projeto:

    gcloud config unset project
   

4. Elimine outros Google Cloud recursos criados neste tutorial:

   • Elimine a imagem do contentor de serviço denominada gcr.io/PROJECT_ID/chat-app do Artifact Registry
   • Elimine a conta de serviço chat-identity@PROJECT_ID.iam.gserviceaccount.com
   • Elimine a instância do Memorystore for Redis

O que se segue?

• Saiba como funciona o Socket.io e a utilização mais avançada.

• Explore melhor a saída direta da VPC com uma rede da VPC.

• Reveja as práticas recomendadas para o Memorystore e para usar WebSockets no Cloud Run.