Esta página foi traduzida pela API Cloud Translation.

Codelab: criar um servidor de notificações push

Kate Jeffreys

Kayce Basques

Este codelab mostra em etapas como criar um servidor de notificações push. Ao final do codelab, você terá um servidor que:

Monitora as assinaturas de notificações push (ou seja, o servidor cria um novo registro de banco de dados quando um cliente ativa as notificações push e exclui um registro de banco de dados existente quando um cliente recusa)
Envia uma notificação push para um único cliente
Envia uma notificação push para todos os clientes inscritos

Este codelab tem como foco ajudar você a aprender fazendo e não fala muito sobre conceitos. Confira Como funcionam as notificações push? para saber mais sobre os conceitos de notificação push.

O código do cliente deste codelab já está concluído. Você só vai implementar o servidor neste codelab. Para aprender a implementar um cliente de notificação push, consulte Codelab: criar um cliente de notificação push.

Confira push-notifications-server-codelab-complete (fonte) para conferir o código completo.

Compatibilidade com navegadores

Este codelab funciona com as seguintes combinações de sistema operacional e navegador:

Windows: Chrome, Edge
macOS: Chrome e Firefox
Android: Chrome, Firefox

Este codelab não funciona com os seguintes sistemas operacionais (ou combinações de sistema operacional e navegador):

macOS: Brave, Edge e Safari
iOS

Pilha de aplicativos

O servidor é criado com base no Express.js.
A biblioteca Node.js web-push processa toda a lógica de notificações push.
Os dados de assinatura são gravados em um arquivo JSON usando lowdb.

Você não precisa usar nenhuma dessas tecnologias para implementar as notificações push. Escolhemos essas tecnologias porque elas oferecem uma experiência de codelab confiável.

Configuração

Gerar uma cópia editável do código

O editor de código à direita destas instruções será chamado de interface do Glitch ao longo deste codelab.

Clique em Remixar para editar para tornar o projeto editável.

Configurar a autenticação

Para que as notificações push funcionem, é preciso configurar o servidor e o cliente com chaves de autenticação. Consulte Assinar suas solicitações de protocolo de push da Web para saber o motivo.

Abra o terminal do Glitch clicando em Tools e em Terminal.
No terminal, execute npx web-push generate-vapid-keys. Copie os valores da chave privada e da chave pública.
Abra .env e atualize VAPID_PUBLIC_KEY e VAPID_PRIVATE_KEY. Defina VAPID_SUBJECT como mailto:test@test.test. Todos esses valores devem ser colocados entre aspas duplas. Depois de fazer as atualizações, o arquivo .env ficará semelhante a este:

VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"

Feche o terminal do Glitch.

Os valores das variáveis de ambiente (os itens em .env) são exclusivos para um único projeto do Glitch. Se você remixar seu projeto, os valores em .env não serão copiados.

Abra o public/index.js.
Substitua VAPID_PUBLIC_KEY_VALUE_HERE pelo valor da chave pública.

Gerenciar assinaturas

Seu cliente lida com a maior parte do processo de assinatura. As principais coisas que seu servidor precisa fazer são salvar novas assinaturas de notificação push e excluir assinaturas antigas. Com essas assinaturas, é possível enviar mensagens por push para clientes no futuro. Consulte Inscrever o cliente para receber notificações push para mais contexto sobre o processo de assinatura.

Salvar informações da nova assinatura

Para visualizar o site, pressione View App. Em seguida, pressione Fullscreen .

Clique em Registrar service worker na guia do app. Na caixa de status, uma mensagem semelhante a esta será exibida:

Service worker registered. Scope: https://desert-cactus-sunset.glitch.me/

Na guia do app, clique em Inscrever-se para push. Seu navegador ou sistema operacional provavelmente perguntará se você quer permitir que o site envie notificações push. Clique em Permitir ou em qualquer frase equivalente usada pelo seu navegador/SO. Na caixa de status, você verá uma mensagem semelhante a esta:

Service worker subscribed to push.  Endpoint: https://fcm.googleapis.com/fcm/send/…

Observação : o URL do endpoint muda de acordo com o navegador usado. Por exemplo, no Firefox, o URL começa com https://updates.push.services.mozilla.com/….

Volte ao código clicando em Ver código-fonte na interface do Glitch.
Abra os registros do Glitch clicando em Tools e em Logs. Você vai ver /add-subscription seguido por alguns dados. /add-subscription é o URL para onde o cliente envia uma solicitação POST quando quer se inscrever nas notificações push. Os dados a seguir são as informações da assinatura do cliente que você precisa salvar.
Abra o server.js.
Atualize a lógica do gerenciador de rotas /add-subscription com o seguinte código:

app.post('/add-subscription', (request, response) => {
  console.log('/add-subscription');
  console.log(request.body);
  console.log(`Subscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .push(request.body)
    .write();
  response.sendStatus(200);
});

Observação : o banco de dados grava em .data/db.json. Para inspecionar esse arquivo no Glitch, clique em Tools, selecione Terminal e execute cat .data/db.json no terminal. O .data/db.json é excluído sempre que você edita o app. Isso ocorre porque o Glitch executa o script start no package.json sempre que você edita o app, e esse script inclui uma chamada para rm .data/db.json.

Excluir informações de assinaturas antigas

Volte para a guia do app.
Clique em Cancelar inscrição por push.
Olhe os registros de falha de novo. Vai aparecer /remove-subscription seguido das informações de assinatura do cliente.
Atualize a lógica do gerenciador de rotas /remove-subscription com o seguinte código:

app.post('/remove-subscription', (request, response) => {
  console.log('/remove-subscription');
  console.log(request.body);
  console.log(`Unsubscribing ${request.body.endpoint}`);
  db.get('subscriptions')
    .remove({endpoint: request.body.endpoint})
    .write();
  response.sendStatus(200);
});

Envie notificações

Conforme explicado em Enviar uma mensagem push, o servidor não envia as mensagens push diretamente aos clientes. Em vez disso, ele depende de um serviço de push para fazer isso. Basicamente, o servidor apenas inicia o processo de envio de mensagens para os clientes, fazendo solicitações de serviços da Web (solicitações de protocolo de push da Web) para um serviço da Web (o serviço de push) de propriedade do fornecedor do navegador que seu usuário usa.

Atualize a lógica do gerenciador de rotas /notify-me com o seguinte código:

app.post('/notify-me', (request, response) => {
  console.log('/notify-me');
  console.log(request.body);
  console.log(`Notifying ${request.body.endpoint}`);
  const subscription = 
      db.get('subscriptions').find({endpoint: request.body.endpoint}).value();
  sendNotifications([subscription]);
  response.sendStatus(200);
});

Atualize a função sendNotifications() com o seguinte código:

function sendNotifications(subscriptions) {
  // TODO
  // Create the notification content.
  const notification = JSON.stringify({
    title: "Hello, Notifications!",
    options: {
      body: `ID: ${Math.floor(Math.random() * 100)}`
    }
  });
  // Customize how the push service should attempt to deliver the push message.
  // And provide authentication information.
  const options = {
    TTL: 10000,
    vapidDetails: vapidDetails
  };
  // Send a push message to each client specified in the subscriptions array.
  subscriptions.forEach(subscription => {
    const endpoint = subscription.endpoint;
    const id = endpoint.substr((endpoint.length - 8), endpoint.length);
    webpush.sendNotification(subscription, notification, options)
      .then(result => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Result: ${result.statusCode}`);
      })
      .catch(error => {
        console.log(`Endpoint ID: ${id}`);
        console.log(`Error: ${error} `);
      });
  });
}

Atualize a lógica do gerenciador de rotas /notify-all com o seguinte código:

app.post('/notify-all', (request, response) => {
  console.log('/notify-all');
  response.sendStatus(200);
  console.log('Notifying all subscribers');
  const subscriptions =
      db.get('subscriptions').cloneDeep().value();
  if (subscriptions.length > 0) {
    sendNotifications(subscriptions);
    response.sendStatus(200);
  } else {
    response.sendStatus(409);
  }
});

Volte para a guia do app.
Clique em Cancelar inscrição de push e depois em Inscrever-se para envio novamente. Isso só é necessário porque, como mencionado anteriormente, o Glitch reinicia o projeto sempre que você edita o código, e o projeto está configurado para excluir o banco de dados na inicialização.
Clique em Receber notificação. Você vai receber uma notificação push. O título precisa ser Hello, Notifications! e o corpo precisa ser ID: <ID>, em que <ID> é um número aleatório.
Abra o app em outros navegadores ou dispositivos, inscreva-os para receber notificações push e clique no botão Notificar tudo. Você receberá a mesma notificação em todos os dispositivos inscritos (ou seja, o ID no corpo da notificação push deve ser o mesmo).

Próximas etapas

Leia a Visão geral das notificações push para entender melhor os conceitos conceituais de como as notificações push funcionam.
Confira Codelab: criar um cliente de notificação push para saber como criar um cliente que solicita permissão de notificação, inscreve o dispositivo para receber notificações push e usa um service worker para receber mensagens push e exibir as mensagens como notificações.