Escribe y responde mensajes de Pub/Sub

ID de región

REGION_ID es un código abreviado que Google asigna en función de la región que seleccionas cuando creas la app. El código no corresponde a un país ni a una provincia, aunque algunos ID de región puedan parecer similares a los códigos de país y provincia que se suelen usar. En el caso de las apps creadas después de febrero de 2020, REGION_ID.r se incluye en las URL de App Engine. En el caso de las apps existentes creadas antes de esta fecha, el ID de región es opcional en la URL.

Obtén más información acerca de los ID de región.

Pub/Sub proporciona mensajería asíncrona, confiable y de varios a varios entre aplicaciones. Las aplicaciones de publicador pueden enviar mensajes a un tema, y otras aplicaciones pueden suscribirse a ese tema para recibir los mensajes.

En este documento, se describe cómo usar la biblioteca cliente de Cloud para enviar y recibir mensajes de Pub/Sub en una app de Node.js.

Requisitos previos

  • Sigue las instrucciones que aparecen en “Hello, World!” para Node.js en App Engine si deseas configurar tu entorno y proyecto, y comprender cómo se estructuran las apps de Node.js en App Engine.
  • Anota y guarda el ID del proyecto porque lo necesitarás para ejecutar la aplicación de muestra que se describe en este documento.

    Clona la app de muestra

    Copia las apps de muestra en tu máquina local y navega hasta el directorio pubsub:

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

    Crea un tema y una suscripción

    Crea un tema y una suscripción, lo que incluye especificar el extremo al que el servidor Pub/Sub debe enviar solicitudes:

    gcloud pubsub topics create YOUR_TOPIC_NAME
gcloud pubsub subscriptions create YOUR_SUBSCRIPTION_NAME \
    --topic YOUR_TOPIC_NAME \
    --push-endpoint \
    https://YOUR_PROJECT_ID.REGION_ID.r.appspot.com/pubsub/push?token=YOUR_TOKEN \
    --ack-deadline 10

    Reemplaza YOUR_TOKEN con un token secreto aleatorio. El extremo lo utiliza para verificar las solicitudes.

    Configure las variables de entorno

    Edita app.standard.yaml a fin de establecer las variables de entorno para el ID del proyecto, tema y token de verificación:

    appengine/pubsub/app.standard.yaml 
    env_variables:
  PUBSUB_TOPIC: YOUR_TOPIC_NAME
  # This token is used to verify that requests originate from your
  # application. It can be any sufficiently random string.
  PUBSUB_VERIFICATION_TOKEN: YOUR_VERIFICATION_TOKEN

    Revisión de código

    La app de muestra usa las bibliotecas cliente de Cloud.

    La app de muestra usa los valores que estableces en el archivo app.standard.yaml para configurar las variables de entorno. El controlador de las solicitudes push utiliza estos valores para confirmar que la solicitud provenga de Pub/Sub y que se origine en una fuente confiable:

    // The following environment variables are set by app.standard.yaml when
// running on App Engine, but will need to be manually set when running locally.
var PUBSUB_VERIFICATION_TOKEN = process.env.PUBSUB_VERIFICATION_TOKEN;
var pubsub = gcloud.pubsub({
    projectId: process.env.GOOGLE_CLOUD_PROJECT
});
var topic = pubsub.topic(process.env.PUBSUB_TOPIC);

    La app de muestra mantiene una lista global a fin de almacenar los mensajes que recibe esta instancia:

    // List of all messages received by this instance
var messages = [];

    Este método recibe mensajes enviados y los agrega a la lista global messages:

    appengine/pubsub/app.js 
    app.post('/pubsub/push', jsonBodyParser, (req, res) => {
  if (req.query.token !== PUBSUB_VERIFICATION_TOKEN) {
    res.status(400).send();
    return;
  }

  // The message is a unicode string encoded in base64.
  const message = Buffer.from(req.body.message.data, 'base64').toString(
    'utf-8'
  );

  messages.push(message);

  res.status(200).send();
});

    Este método interactúa con la aplicación web de App Engine para publicar mensajes nuevos y mostrar los recibidos.

    appengine/pubsub/app.js 
    app.get('/', (req, res) => {
  res.render('index', {messages, tokens, claims});
});

app.post('/', formBodyParser, async (req, res, next) => {
  if (!req.body.payload) {
    res.status(400).send('Missing payload');
    return;
  }

  const data = Buffer.from(req.body.payload);
  try {
    const messageId = await topic.publish(data);
    res.status(200).send(`Message ${messageId} sent.`);
  } catch (error) {
    next(error);
  }
});

    Ejecuta la muestra de forma local

    En la ejecución local, puedes usar Google Cloud CLI para proporcionar autenticación a fin de emplear las API de Google Cloud. Si configuraste tu entorno como se describe en Requisitos, ya ejecutaste el comando gcloud init que proporciona esta autenticación.

    A continuación, configura las variables de entorno antes de iniciar la aplicación:

    export GOOGLE_CLOUD_PROJECT=[your-project-id]
export PUBSUB_VERIFICATION_TOKEN=[your-verification-token]
export PUBSUB_TOPIC=[your-topic]
npm install
npm start

    Simular notificaciones push

    La aplicación puede enviar mensajes de forma local, pero no puede recibir mensajes push localmente. Sin embargo, puedes simular un mensaje push; para ello, envía una solicitud HTTP al extremo de notificación push local. La muestra incluye el archivo sample_message.json.

    Puedes usar curl o un cliente httpie para enviar una solicitud HTTP POST:

    curl -H "Content-Type: application/json" -i --data @sample_message.json "localhost:8080/pubsub/push?token=[your-token]"

    O

    http POST ":8080/pubsub/push?token=[your-token]" < sample_message.json

    Respuesta:

    HTTP/1.1 200 OK
Connection: keep-alive
Date: Mon, 31 Aug 2015 22:19:50 GMT
Transfer-Encoding: chunked
X-Powered-By: Express

    Una vez completada la solicitud, puedes actualizar localhost:8080 y ver el mensaje en la lista de mensajes recibidos.

    Ejecuta en App Engine

    Para implementar la app de demostración en App Engine mediante la herramienta de línea de comandos de gcloud, debes ejecutar el siguiente comando desde el directorio en el que se encuentra app.standard.yaml:

    gcloud app deploy app.standard.yaml

    Ahora puedes acceder a la aplicación en https://PROJECT_ID.REGION_ID.r.appspot.com. Puedes usar el formulario para enviar mensajes, pero no hay forma de garantizar qué instancia de tu aplicación recibirá la notificación. Puedes enviar varios mensajes y actualizar la página para ver el mensaje recibido.