Gatilhos do Pub/Sub

O Pub/Sub do Google Cloud é um barramento de mensagens distribuído globalmente e dimensionado automaticamente conforme sua necessidade. É possível criar uma função que gerencie eventos do Pub/Sub usando functions.pubsub.

Acionar uma função Pub/Sub

Você pode acionar uma função sempre que uma nova mensagem do Pub/Sub for enviada para um tópico específico. É necessário especificar o nome do tópico do Pub/Sub que acionará sua função e definir o evento no manipulador de eventos onPublish():

exports.helloPubSub = functions.pubsub.topic('topic-name').onPublish((message) => {
  // ...
});

Acessar o payload da mensagem do Pub/Sub {:#access-pub/sub}

O payload de mensagens do Pub/Sub pode ser acessado a partir do objeto Message retornado para sua função. O SDK do Firebase para Cloud Functions tem uma propriedade auxiliar que pode decodificar mensagens com JSON no corpo da mensagem do Pub/Sub. Por exemplo, esta é uma mensagem publicada com um payload JSON simples:

gcloud pubsub topics publish topic-name --message '{"name":"Xenia"}'

É possível acessar um payload de dados JSON como este usando a propriedade json:

  // Get the `name` attribute of the PubSub message JSON body.
  let name = null;
  try {
    name = message.json.name;
  } catch (e) {
    functions.logger.error('PubSub message was not JSON', e);
  }
index.js

Outros payloads não JSON estão contidos na mensagem Pub/Sub como strings base64 codificadas no objeto de mensagem. Para ler uma mensagem como o exemplo a seguir, você precisa decodificar a string base64 conforme mostrado:

gcloud pubsub topics publish topic-name --message 'MyMessage'

// Decode the PubSub Message body.
const messageBody = message.data ? Buffer.from(message.data, 'base64').toString() : null;
index.js

Acessar atributos de mensagem {:#access-message}

A mensagem Pub/Sub pode ser enviada com atributos de dados definidos no comando publish. Por exemplo, você poderia publicar uma mensagem com um atributo name:

gcloud pubsub topics publish topic-name --attribute name=Xenia

É possível ler os atributos em Message.attributes:

// Get the `name` attribute of the message.
const name = message.attributes.name;
index.js

Alguns dados básicos, como o ID ou o horário de publicação da mensagem, não estão disponíveis em Message.attributes. Como solução alternativa, acesse esses detalhes no EventContext do evento de gatilho. Exemplo:

exports.myFunction = functions.pubsub.topic('topic1').onPublish((message, context) => {
    console.log('The function was triggered at ', context.timestamp);
    console.log('The unique ID for the event is', context.eventId);
});