Gatilhos do Firebase Realtime Database

Com o Cloud Run functions, é possível processar eventos no Firebase Realtime Database no mesmo projeto do Google Cloud que a função. O Cloud Run functions permite executar operações de banco de dados com todos os privilégios administrativos e garante o processamento individual de cada alteração feita no banco de dados. É possível fazer alterações no Firebase Realtime Database por meio do SDK Admin do Firebase.

Em um ciclo de vida comum, uma função do Firebase Realtime Database faz o seguinte:

  1. Aguarda alterações feitas em um local de banco de dados específico.

  2. É acionada quando um evento ocorre e realiza as tarefas dele.

  3. Recebe um objeto de dados que contém um snapshot dos dados armazenados no documento especificado.

Tipos de evento

O Functions permite processar eventos de banco de dados em dois níveis de especificidade. É possível detectar especificamente apenas eventos de criação, atualização ou exclusão ou detectar qualquer alteração de qualquer tipo em um caminho. O Cloud Run functions dá suporte aos seguintes tipos de evento para o Realtime Database:

Tipo de evento Gatilho
providers/google.firebase.database/eventTypes/ref.write Acionado em qualquer evento de mutação: quando os dados são criados, atualizados ou excluídos no Realtime Database.
providers/google.firebase.database/eventTypes/ref.create (padrão) Acionado quando novos dados são criados no Realtime Database.
providers/google.firebase.database/eventTypes/ref.update Acionado quando os dados são atualizados no Realtime Database.
providers/google.firebase.database/eventTypes/ref.delete Acionado quando os dados são excluídos do Realtime Database.

Como especificar o caminho e a instância do banco de dados

Para controlar quando e onde a função será acionada, você precisa especificar um caminho e, como opção, uma instância de banco de dados.

Caminho

As especificações de caminho correspondem a todas as gravações realizadas em um caminho, inclusive as que acontecem em qualquer lugar abaixo dele. Se você definir o caminho para sua função como /foo/bar, ele corresponderá aos eventos nestes dois locais:

 /foo/bar
 /foo/bar/baz/really/deep/path

Em ambos os casos, o Firebase interpreta que o evento ocorre em /foo/bar, e os dados do evento incluem os dados antigos e novos em /foo/bar. Se os dados do evento forem grandes, considere usar várias funções em caminhos mais profundos, em vez de uma única função próxima da raiz do banco de dados. Para ter o melhor desempenho, solicite apenas dados no nível mais profundo possível.

Para especificar um componente do caminho como caractere curinga, basta colocá-lo entre chaves. foo/{bar} corresponde a qualquer filho de /foo. Os valores desses componentes de caminho curinga estão disponíveis no objeto event.params da sua função. Neste exemplo, o valor está disponível como event.params.bar.

Os caminhos com caracteres curinga podem corresponder a vários eventos de uma única gravação. Uma inserção de:

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

corresponde ao caminho /foo/{bar} duas vezes: uma vez com "hello": "world" e novamente com "firebase": "functions".

Instância

Ao usar o console do Google Cloud, é preciso especificar a instância do banco de dados.

Ao usar a CLI do Google Cloud, a instância precisa ser especificada como parte da string --trigger-resource.

O exemplo a seguir usaria o seguinte na string --trigger-resource:

--trigger-resource projects/_/instances/DATABASE_INSTANCE/refs/PATH

Estrutura do evento

Ao manipular um evento do Realtime Database, o objeto data contém duas propriedades que são fornecidas no formato de objeto JSON:

  • data: um instantâneo dos dados registrados antes do evento que acionaram a função.

  • delta: um snapshot dos dados obtidos após o evento que acionou a função.

Exemplo de código

Node.js 

/**
 * Background Function triggered by a change to a Firebase RTDB reference.
 *
 * @param {!Object} event The Cloud Functions event.
 * @param {!Object} context The Cloud Functions event context.
 */
exports.helloRTDB = (event, context) => {
  const triggerResource = context.resource;

  console.log(`Function triggered by change to: ${triggerResource}`);
  console.log(`Admin?: ${!!context.auth.admin}`);
  console.log('Delta:');
  console.log(JSON.stringify(event.delta, null, 2));
};

Python 

import json

def hello_rtdb(data, context):
    """Triggered by a change to a Firebase RTDB reference.
    Args:
        data (dict): The event payload.
        context (google.cloud.functions.Context): Metadata for the event.
    """
    trigger_resource = context.resource

    print("Function triggered by change to: %s" % trigger_resource)
    print("Admin?: %s" % data.get("admin", False))
    print("Delta:")
    print(json.dumps(data["delta"]))

Go


// Package p contains a Cloud Function triggered by a Firebase Realtime Database
// event.
package p

import (
	"context"
	"fmt"
	"log"

	"cloud.google.com/go/functions/metadata"
)

// RTDBEvent is the payload of a RTDB event.
type RTDBEvent struct {
	Data  interface{} `json:"data"`
	Delta interface{} `json:"delta"`
}

// HelloRTDB handles changes to a Firebase RTDB.
func HelloRTDB(ctx context.Context, e RTDBEvent) error {
	meta, err := metadata.FromContext(ctx)
	if err != nil {
		return fmt.Errorf("metadata.FromContext: %w", err)
	}
	log.Printf("Function triggered by change to: %v", meta.Resource)
	log.Printf("%+v", e)
	return nil
}

Java 

import com.google.cloud.functions.Context;
import com.google.cloud.functions.RawBackgroundFunction;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import java.util.logging.Logger;

public class FirebaseRtdb implements RawBackgroundFunction {
  private static final Logger logger = Logger.getLogger(FirebaseRtdb.class.getName());

  // Use GSON (https://github.com/google/gson) to parse JSON content.
  private static final Gson gson = new Gson();

  @Override
  public void accept(String json, Context context) {
    logger.info("Function triggered by change to: " + context.resource());

    JsonObject body = gson.fromJson(json, JsonObject.class);

    boolean isAdmin = false;
    if (body != null && body.has("auth")) {
      JsonObject authObj = body.getAsJsonObject("auth");
      isAdmin = authObj.has("admin") && authObj.get("admin").getAsBoolean();
    }

    logger.info("Admin?: " + isAdmin);

    if (body != null && body.has("delta")) {
      logger.info("Delta:");
      logger.info(body.get("delta").toString());
    }
  }
}

C# 

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Firebase.Database.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace FirebaseRtdb;

public class Function : ICloudEventFunction<ReferenceEventData>
{
    private readonly ILogger _logger;

    public Function(ILogger<Function> logger) =>
        _logger = logger;

    public Task HandleAsync(CloudEvent cloudEvent, ReferenceEventData data, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Function triggered by change to {subject}", cloudEvent.Subject);
        _logger.LogInformation("Delta: {delta}", data.Delta);

        // In this example, we don't need to perform any asynchronous operations, so the
        // method doesn't need to be declared async.
        return Task.CompletedTask;
    }
}

Ruby 

require "functions_framework"

# Triggered by a change to a Firebase RTDB document.
FunctionsFramework.cloud_event "hello_rtdb" do |event|
  # Event-triggered Ruby functions receive a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  # The Firebase event payload can be obtained from the `data` field.
  payload = event.data

  logger.info "Function triggered by change to: #{event.source}"
  logger.info "Admin?: #{payload.fetch 'admin', false}"
  logger.info "Delta: #{payload['delta']}"
end

PHP 


use Google\CloudFunctions\CloudEvent;

function firebaseRTDB(CloudEvent $cloudevent)
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    fwrite($log, 'Event: ' . $cloudevent->getId() . PHP_EOL);

    $data = $cloudevent->getData();
    $resource = $data['resource'] ?? '<null>';

    fwrite($log, 'Function triggered by change to: ' . $resource . PHP_EOL);

    $isAdmin = isset($data['auth']['admin']) && $data['auth']['admin'] == true;

    fwrite($log, 'Admin?: ' . var_export($isAdmin, true) . PHP_EOL);
    fwrite($log, 'Delta: ' . json_encode($data['delta'] ?? '') . PHP_EOL);
}

Como implantar a função

O comando gcloud a seguir implanta uma função que será acionada por eventos create no caminho /messages/{pushId}/original:

gcloud functions deploy FUNCTION_NAME \
  --no-gen2 \
  --entry-point ENTRY_POINT \
  --trigger-event providers/google.firebase.database/eventTypes/ref.create \
  --trigger-resource projects/_/instances/DATABASE_INSTANCE/refs/messages/{pushId}/original \
  --runtime RUNTIME
Argumento Descrição
FUNCTION_NAME O nome registrado da função do Cloud Run que você está implantando. Pode ser o nome de uma função no código-fonte ou uma string arbitrária. Se FUNCTION_NAME for uma string arbitrária, você precisará incluir a sinalização --entry-point.
--entry-point ENTRY_POINT O nome de uma função ou classe no código-fonte. Opcional, a menos que você não tenha usado FUNCTION_NAME para especificar a função no código-fonte a ser executada durante a implantação. Nesse caso, use --entry-point para fornecer o nome da função executável.
--trigger-event NAME O nome do tipo de evento que a função quer receber. Neste caso, ele será um dos seguintes: escrever, criar, atualizar ou excluir.
--trigger-resource NAME O caminho completo do banco de dados em que a função vai detectar. Ele precisa estar de acordo com o seguinte formato: projects/_/instances/DATABASE_INSTANCE/refs/PATH
--runtime RUNTIME O nome do ambiente de execução que você está usando. Para uma lista completa, consulte a referência do gcloud.