Codelab: Compila un cliente de notificaciones push

Kate Jeffreys
Kate Jeffreys
Kayce Basques
Kayce Basques

En este codelab, se muestra paso a paso cómo compilar un cliente de notificaciones push. Al final del codelab, tendrás un cliente que haga lo siguiente:

  • Suscribe al usuario a las notificaciones push.
  • Recibe mensajes push y los muestra como notificaciones.
  • Anula la suscripción del usuario a las notificaciones push.

Este codelab se enfoca en ayudarte a aprender a través de la práctica y no explica muchos conceptos. Consulta ¿Cómo funcionan las notificaciones push? para obtener información sobre los conceptos de las notificaciones push.

El código del servidor de este codelab ya está completo. En este codelab, solo implementarás el cliente. Para obtener información sobre cómo implementar un servidor de notificaciones push, consulta el Codelab: Compila un servidor de notificaciones push.

Compatibilidad del navegador

Se sabe que este codelab funciona con las siguientes combinaciones de sistema operativo y navegador:

  • Windows: Chrome, Edge
  • macOS: Chrome y Firefox
  • Android: Chrome y Firefox

Se sabe que este codelab no funciona con los siguientes sistemas operativos (o combinaciones de sistema operativo y navegador):

  • macOS: Brave, Edge y Safari
  • iOS

Configuración

Obtén una copia editable del código

  • Haz clic en Remix to Edit para que el proyecto se pueda editar.

Configura la autenticación

Antes de que las notificaciones push funcionen, debes configurar tu servidor y cliente con claves de autenticación. Consulta Cómo firmar tus solicitudes de protocolo web push para obtener más información. Por lo general, los secretos se almacenan en un archivo .env, similar a este.

VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
  • Abre public/index.js.
  • Reemplaza VAPID_PUBLIC_KEY_VALUE_HERE por el valor de tu clave pública.

Cómo registrar un service worker

En algún momento, tu cliente necesitará un service worker para recibir y mostrar notificaciones. Lo mejor es registrar el service worker lo antes posible. Consulta Cómo recibir y mostrar los mensajes push como notificaciones para obtener más contexto.

  • Reemplaza el comentario // TODO add startup logic here por el siguiente código:
// TODO add startup logic here
if ('serviceWorker' in navigator && 'PushManager' in window) {
  navigator.serviceWorker.register('./service-worker.js').then(serviceWorkerRegistration => {
    console.info('Service worker was registered.');
    console.info({serviceWorkerRegistration});
  }).catch(error => {
    console.error('An error occurred while registering the service worker.');
    console.error(error);
  });
  subscribeButton.disabled = false;
} else {
  console.error('Browser does not support service workers or push messages.');
}

subscribeButton.addEventListener('click', subscribeButtonHandler);
unsubscribeButton.addEventListener('click', unsubscribeButtonHandler);
  • Presiona "Control + Mayúsculas + J" (o "Comando + Opción + J" en Mac) para abrir DevTools.
  • Haz clic en la pestaña Consola. Deberías ver el mensaje Service worker was registered. registrado en la consola.

Cómo solicitar permiso para enviar notificaciones push

Nunca debes solicitar permiso para enviar notificaciones push al cargar la página. En cambio, tu IU debe preguntarle al usuario si quiere recibir notificaciones push. Una vez que confirmen explícitamente (con un clic en un botón, por ejemplo), puedes iniciar el proceso formal para obtener permiso del navegador para enviar notificaciones push.

  • En public/index.js, reemplaza el comentario // TODO en subscribeButtonHandler() por el siguiente código:
// TODO
// Prevent the user from clicking the subscribe button multiple times.
subscribeButton.disabled = true;
const result = await Notification.requestPermission();
if (result === 'denied') {
  console.error('The user explicitly denied the permission request.');
  return;
}
if (result === 'granted') {
  console.info('The user accepted the permission request.');
}
  • Regresa a la pestaña de la app y haz clic en Subscribe to push. Es probable que tu navegador o sistema operativo te pregunte si quieres permitir que el sitio web te envíe notificaciones push. Haz clic en Permitir (o la frase equivalente que use tu navegador o SO). En la consola, deberías ver un mensaje que indica si se aceptó o rechazó la solicitud.

Suscríbete a las notificaciones push

El proceso de suscripción implica interactuar con un servicio web controlado por el proveedor del navegador, que se denomina servicio push. Una vez que obtengas la información de suscripción a las notificaciones push, deberás enviarla a un servidor y hacer que este la almacene en una base de datos a largo plazo. Consulta Cómo suscribir el cliente a las notificaciones push para obtener más contexto sobre el proceso de suscripción.

  • Agrega el siguiente código destacado a subscribeButtonHandler():
subscribeButton.disabled = true;
const result = await Notification.requestPermission();
if (result === 'denied') {
  console.error('The user explicitly denied the permission request.');
  return;
}
if (result === 'granted') {
  console.info('The user accepted the permission request.');
}
const registration = await navigator.serviceWorker.getRegistration();
const subscribed = await registration.pushManager.getSubscription();
if (subscribed) {
  console.info('User is already subscribed.');
  notifyMeButton.disabled = false;
  unsubscribeButton.disabled = false;
  return;
}
const subscription = await registration.pushManager.subscribe({
  userVisibleOnly: true,
  applicationServerKey: urlB64ToUint8Array(VAPID_PUBLIC_KEY)
});
notifyMeButton.disabled = false;
fetch('/add-subscription', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(subscription)
});

La opción userVisibleOnly debe ser true. Es posible que algún día se puedan enviar mensajes sin mostrar notificaciones visibles para el usuario (envíos silenciosos), pero, actualmente, los navegadores no permiten esa capacidad debido a preocupaciones relacionadas con la privacidad.

El valor applicationServerKey se basa en una función de utilidad que convierte una cadena base64 en un Uint8Array. Este valor se usa para la autenticación entre tu servidor y el servicio de envío de notificaciones push.

Cómo anular la suscripción a las notificaciones push

Después de que un usuario se suscribe a las notificaciones push, tu IU debe proporcionar una forma de cancelar la suscripción en caso de que el usuario cambie de opinión y ya no quiera recibir notificaciones push.

  • Reemplaza el comentario // TODO en unsubscribeButtonHandler() por el siguiente código:
// TODO
const registration = await navigator.serviceWorker.getRegistration();
const subscription = await registration.pushManager.getSubscription();
fetch('/remove-subscription', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({endpoint: subscription.endpoint})
});
const unsubscribed = await subscription.unsubscribe();
if (unsubscribed) {
  console.info('Successfully unsubscribed from push notifications.');
  unsubscribeButton.disabled = true;
  subscribeButton.disabled = false;
  notifyMeButton.disabled = true;
}

Recibir un mensaje push y mostrarlo como una notificación

Como se mencionó antes, necesitas un service worker para controlar la recepción y la visualización de los mensajes que se enviaron al cliente desde tu servidor. Consulta Cómo recibir y mostrar los mensajes push como notificaciones para obtener más detalles.

  • Abre public/service-worker.js y reemplaza el comentario // TODO en el controlador de eventos push del trabajador de servicio por el siguiente código:
// TODO
let data = event.data.json();
const image = 'logo.png';
const options = {
  body: data.options.body,
  icon: image
}
self.registration.showNotification(
  data.title, 
  options
);
  • Regresa a la pestaña de la app.
  • Haz clic en Notificarme. Deberías recibir una notificación push.
  • Intenta abrir la URL de la pestaña de tu app en otros navegadores (o incluso en otros dispositivos), sigue el flujo de trabajo de suscripción y, luego, haz clic en Notificar a todos. Deberías recibir la misma notificación push en todos los navegadores a los que te suscribiste. Consulta Compatibilidad del navegador para ver una lista de combinaciones de navegador y SO que se sabe que funcionan o no.

Puedes personalizar la notificación de muchas maneras. Consulta los parámetros de ServiceWorkerRegistration.showNotification() para obtener más información.

Cómo abrir una URL cuando un usuario hace clic en una notificación

En el mundo real, probablemente usarás la notificación como una forma de volver a atraer a tu usuario y pedirle que visite tu sitio. Para ello, debes configurar un poco más tu trabajador de servicio.

  • Reemplaza el comentario // TODO en el controlador de eventos notificationclick del trabajador de servicio por el siguiente código:
// TODO
event.notification.close();
event.waitUntil(self.clients.openWindow('https://web.dev'));
  • Vuelve a la pestaña de la app, envíate otra notificación y, luego, haz clic en ella. El navegador debería abrir una pestaña nueva y cargar https://web.dev.

Próximos pasos