Se usó la API de Cloud Translation para traducir esta página.

Codelab: Compila un cliente de notificaciones push

Kate Jeffreys

Kayce Basques

En este codelab, se muestra paso a paso cómo compilar un cliente de notificaciones push. Al final de este codelab, tendrás un cliente con las siguientes características:

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 haciendo y no habla mucho sobre los 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. Solo implementarás el cliente en este codelab. Para obtener información sobre cómo implementar un servidor de notificaciones push, consulta el Codelab: Cómo compilar un servidor de notificaciones push.

Consulta push-notifications-client-codelab-complete (source) para ver el código completo.

Compatibilidad del navegador

Este codelab funciona con las siguientes combinaciones de sistema operativo y navegador:

Windows: Chrome y 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

El editor de código que ves a la derecha de estas instrucciones se denominará IU de Glitch a lo largo de este codelab.

Haz clic en Remix para editar para que el proyecto sea editable.

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 conocer el motivo.

En la IU de Glitch, haz clic en Tools y, luego, en Terminal para abrir la terminal de Glitch.
En la terminal de Glitch, ejecuta npx web-push generate-vapid-keys. Copia los valores de la clave privada y la clave pública.
En la IU de Glitch, abre .env y actualiza VAPID_PUBLIC_KEY y VAPID_PRIVATE_KEY. Establece VAPID_SUBJECT en mailto:test@test.test. Todos estos valores deben estar entre comillas dobles. Después de realizar las actualizaciones, tu archivo .env debería verse de la siguiente manera:

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

Cierra la terminal de Glitch.

Los valores de las variables de entorno (los elementos de .env) son únicos para un solo proyecto de Glitch. Si haces un remix de tu proyecto, no se copiarán los valores de .env.

Abre public/index.js.
Reemplaza VAPID_PUBLIC_KEY_VALUE_HERE por el valor de tu clave pública.

Registra un service worker

Con el tiempo, tu cliente necesitará un service worker para recibir y mostrar notificaciones. Es mejor registrar el service worker lo antes posible. Consulta Recibe y muestra los mensajes enviados 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);

Para obtener una vista previa del sitio, presiona Ver app. Luego, presiona Pantalla completa .

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 de notificaciones push

Nunca debes solicitar permiso para enviar notificaciones push cuando se carga la página. En su lugar, la IU debe preguntarle al usuario si quiere recibir notificaciones push. Una vez que lo confirmen de forma explícita (por ejemplo, con un clic en un botón), puedes iniciar el proceso formal para obtener el permiso de notificaciones push del navegador.

En la IU de Glitch, haz clic en Ver código fuente para volver a tu código.
En public/index.js, reemplaza el comentario // TODO de 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 Suscribirse a notificaciones 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 cualquier frase equivalente que use tu navegador o SO). En Play Console, deberías ver un mensaje que indique si se aceptó o rechazó la solicitud.

Cómo suscribirse 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, debes enviarla a un servidor y hacer que la almacene en una base de datos a largo plazo. Consulta Cómo suscribir al cliente a notificaciones push para obtener más información 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 sea posible enviar mensajes sin mostrar notificaciones visibles para el usuario (inserciones silenciosas), pero actualmente los navegadores no permiten esa función debido a cuestiones de 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 notificaciones push.

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

Después de que un usuario se suscriba a las notificaciones push, tu IU debe proporcionar una forma de cancelar la suscripción en caso de que 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 visualización de los mensajes que se enviaron al cliente desde tu servidor. Consulta Cómo recibir y mostrar los mensajes enviados como notificaciones para obtener más información.

Abre public/service-worker.js y reemplaza el comentario // TODO en el controlador de eventos push del service worker por el siguiente código:

// TODO
let data = event.data.json();
const image = 'https://cdn.glitch.com/614286c9-b4fc-4303-a6a9-a4cef0601b74%2Flogo.png?v=1605150951230';
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 con navegadores para ver una lista de combinaciones de navegadores 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.

Es importante comprender la llamada a self.skipWaiting() en el objeto de escucha install de tu trabajador de servicio. Consulta Omite la fase de espera para obtener una explicación. Sin él, los cambios de código que realices en tu trabajador de servicio no se aplicarían de inmediato. Puedes usar esta función en tu propio sitio web o no, según tus necesidades, pero, de cualquier manera, es importante comprender su efecto.

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

En el mundo real, es probable que uses 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. Tu navegador debería abrir una pestaña nueva y cargar https://web.dev.

Próximos pasos

Consulta ServiceWorkerRegistration.showNotification() para descubrir todas las diferentes formas en que puedes personalizar las notificaciones.
Lee la descripción general de las notificaciones push para obtener una comprensión más profunda de cómo funcionan las notificaciones push.
Consulta Codelab: Compila un servidor de notificaciones push para aprender a compilar un servidor que administre suscripciones y envíe solicitudes de protocolo push web.
Prueba el Notification Generator para probar todas las formas en que puedes personalizar las notificaciones.