Ampliar Cloud Run con activadores de eventos mediante Cloud Run Functions

Con Cloud Run Functions, puedes desplegar código para gestionar eventos activados por cambios en tu base de datos de Cloud Run. De esta forma, puedes añadir funciones del lado del servidor sin tener que ejecutar tus propios servidores.

En esta guía se describe cómo crear activadores para funciones de Cloud Run a partir de eventos de Firestore.

Puedes activar tus funciones de Cloud Run a partir de eventos de una base de datos de Firestore. Cuando se activa, tu función lee y actualiza una base de datos de Firestore en respuesta a estos eventos a través de las APIs y bibliotecas de cliente de Firestore.

El proceso por el que los eventos de Firestore activan una función de Cloud Run consta de los siguientes pasos:

  1. El servicio espera a que se produzcan cambios en un documento concreto.

  2. Cuando se produce un cambio, se activa el servicio y realiza sus tareas.

  3. El servicio recibe un objeto de datos con una vista general del documento afectado. En el caso de los eventos write o update, el objeto de datos contiene capturas que representan el estado del documento antes y después del evento activador.

Antes de empezar

  1. Asegúrate de haber configurado un proyecto para Cloud Run tal como se describe en la página de configuración.

  2. Habilita las APIs Artifact Registry, Cloud Build, Cloud Run Admin, Eventarc, Firestore Cloud Logging y Pub/Sub:

    Habilitar las APIs

Roles obligatorios

Tú o tu administrador debéis conceder acceso a la cuenta de implementación y a la identidad del activador. Opcionalmente, concede al agente de servicio de Pub/Sub los siguientes roles de gestión de identidades y accesos.

Roles necesarios para la cuenta de implementación

Para obtener los permisos que necesitas para activar funciones a partir de eventos de Firestore, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Ten en cuenta que, de forma predeterminada, los permisos de Cloud Build incluyen permisos para subir y descargar artefactos de Artifact Registry.

Roles necesarios para la identidad del activador

  1. Anota la cuenta de servicio predeterminada de Compute Engine, ya que la asociarás a un activador de Eventarc para representar la identidad del activador con fines de prueba. Esta cuenta de servicio se crea automáticamente después de habilitar o usar un servicio que utiliza Compute Engine y tiene el siguiente formato de correo electrónico: Google Cloud 

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Sustituye PROJECT_NUMBER por el número de tu proyecto. Google Cloud Puedes encontrar el número de tu proyecto en la página Bienvenido de la consola Google Cloud o ejecutando el siguiente comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

    En los entornos de producción, te recomendamos que crees una cuenta de servicio y le asignes uno o varios roles de IAM que contengan los permisos mínimos necesarios y que sigas el principio de privilegio mínimo.

  2. De forma predeterminada, solo los propietarios y editores de proyectos, así como los administradores e invocadores de Cloud Run, pueden llamar a los servicios de Cloud Run. Puedes controlar el acceso por servicio. Sin embargo, para hacer pruebas, otorga el rol Invocador de Cloud Run (run.invoker) en el proyecto Google Cloud a la cuenta de servicio de Compute Engine. Concede el rol en todos los servicios y trabajos de Cloud Run de un proyecto. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/run.invoker

    Ten en cuenta que, si creas un activador para un servicio de Cloud Run autenticado sin conceder el rol Invocador de Cloud Run, el activador se creará correctamente y estará activo. Sin embargo, el activador no funcionará como se espera y aparecerá un mensaje similar al siguiente en los registros:

    The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
  3. Concede el rol Receptor de eventos de Eventarc (roles/eventarc.eventReceiver) en el proyecto a la cuenta de servicio predeterminada de Compute Engine para que el activador de Eventarc pueda recibir eventos de proveedores de eventos. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/eventarc.eventReceiver

Rol opcional del agente de servicio de Pub/Sub

  • Si habilitaste el agente de servicio de Cloud Pub/Sub el 8 de abril del 2021 o antes para admitir solicitudes push de Pub/Sub autenticadas, asigna el rol Creador de tokens de cuenta de servicio (roles/iam.serviceAccountTokenCreator) al agente de servicio. De lo contrario, este rol se asigna de forma predeterminada: 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator

Configurar una base de datos de Firestore

Antes de implementar tu servicio, debes crear una base de datos de Firestore:

  1. Ve a la página de Firestore.

  2. Selecciona Crear una base de datos de Firestore.

  3. En el campo Name your database (Asigna un nombre a tu base de datos), introduce un ID de base de datos, como firestore-db.

  4. En la sección Opciones de configuración, Firestore nativo está seleccionado de forma predeterminada junto con las reglas de seguridad aplicables.

  5. En Tipo de ubicación, selecciona Región y elige la región en la que quieres que se encuentre tu base de datos. Esta selección es permanente.

  6. Haz clic en Crear base de datos.

El modelo de datos de Firestore consta de colecciones que contienen documentos. Un documento contiene un conjunto de pares clave-valor.

Escribir una función activada por Firestore

Para escribir una función que responda a eventos de Firestore, prepárate para especificar lo siguiente durante la implementación:

Tipos de eventos

Firestore admite eventos create, update, delete y write. El evento write abarca todas las modificaciones que se hagan en un documento.

Tipo de evento Activador
google.cloud.firestore.document.v1.created (predeterminado) Se activa cuando se escribe en un documento por primera vez.
google.cloud.firestore.document.v1.updated Se activa cuando ya existe un documento y se cambia algún valor.
google.cloud.firestore.document.v1.deleted Se activa cuando se elimina un documento con datos.
google.cloud.firestore.document.v1.written Se activa cuando se crea, actualiza o elimina un documento.
google.cloud.firestore.document.v1.created.withAuthContext Es igual que created, pero añade información de autenticación.
google.cloud.firestore.document.v1.updated.withAuthContext Es igual que updated, pero añade información de autenticación.
google.cloud.firestore.document.v1.deleted.withAuthContext Es igual que deleted, pero añade información de autenticación.
google.cloud.firestore.document.v1.written.withAuthContext Es igual que written, pero añade información de autenticación.

Los comodines se escriben en los activadores con llaves. Por ejemplo: projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}

Filtros de eventos de activación

Para activar tu servicio, especifica una ruta de documento que quieras monitorizar. La ruta del documento debe estar en el mismo proyecto que el servicio. Google Cloud

Estos son algunos ejemplos de rutas de documentos válidas:

  • users/marie: monitoriza un solo documento, /users/marie.

  • users/{username}: monitoriza todos los documentos de los usuarios. Los comodines se usan para monitorizar todos los documentos de la colección.

  • users/{username}/addresses/home: monitoriza el documento de domicilio de todos los usuarios.

  • users/{username}/addresses/{addressId}: monitoriza todos los documentos de dirección.

  • users/{user=**}: monitoriza todos los documentos de usuario y los documentos de las subcolecciones de cada documento de usuario, como /users/userID/address/home o /users/userID/phone/work.

  • users/{username}/addresses: ruta de dirección no válida. Hace referencia a la subcolección addresses, no a un documento.

Comodines y parámetros

Si no sabes qué documento quieres monitorizar, usa {wildcard} en lugar del ID de documento:

  • users/{username} escucha los cambios en todos los documentos de los usuarios.

En este ejemplo, cuando se cambia cualquier campo de cualquier documento de users, coincide con un comodín llamado {username}.

Si un documento de users tiene subcolecciones y se cambia un campo de uno de los documentos de esas subcolecciones, el comodín {username} no se activará. Si tu objetivo es responder a eventos en subcolecciones, usa el comodín multisegmento {username=**}.

Las coincidencias con comodines se extraen de las rutas de los documentos. Puedes definir tantos comodines como quieras para sustituir los IDs de colecciones o documentos explícitos. Puedes usar hasta un comodín multisegmento, como {username=**}.

Código de función

Consulta ejemplos de cómo usar eventos de Firestore en modo nativo para activar una función de Cloud Run.

Incluye las dependencias de proto en tu fuente

Debe incluir el archivo Cloud Run data.proto en el directorio de origen de su función. Este archivo importa los siguientes protos, que también debes incluir en tu directorio de origen:

Usa la misma estructura de directorios para las dependencias. Por ejemplo, coloca struct.proto dentro de google/protobuf.

Estos archivos son necesarios para decodificar los datos de eventos. Si la fuente de la función no incluye estos archivos, devuelve un error cuando se ejecuta.

Atributos de evento

Cada evento incluye atributos de datos que contienen información sobre el evento, como la hora en la que se ha activado. Cloud Run añade datos adicionales sobre la base de datos y el documento implicados en el evento. Puedes acceder a estos atributos de la siguiente manera:

Java
logger.info("Function triggered by event on: " + event.getSource());
logger.info("Event type: " + event.getType());
logger.info("Event time " + event.getTime());
logger.info("Event project: " + event.getExtension("project"));
logger.info("Event location: " + event.getExtension("location"));
logger.info("Database name: " + event.getExtension("database"));
logger.info("Database document: " + event.getExtension("document"));
// For withAuthContext events
logger.info("Auth information: " + event.getExtension("authid"));
logger.info("Auth information: " + event.getExtension("authtype"));
Node.js
console.log(`Function triggered by event on: ${cloudEvent.source}`);
console.log(`Event type: ${cloudEvent.type}`);
console.log(`Event time: ${cloudEvent.time}`);
console.log(`Event project: ${cloudEvent.project}`);
console.log(`Event location: ${cloudEvent.location}`);
console.log(`Database name: ${cloudEvent.database}`);
console.log(`Document name: ${cloudEvent.document}`);
// For withAuthContext events
console.log(`Auth information: ${cloudEvent.authid}`);
console.log(`Auth information: ${cloudEvent.authtype}`);
Python
print(f"Function triggered by change to: {cloud_event['source']}")
print(f"Event type: {cloud_event['type']}")
print(f"Event time: {cloud_event['time']}")
print(f"Event project: {cloud_event['project']}")
print(f"Location: {cloud_event['location']}")
print(f"Database name: {cloud_event['database']}")
print(f"Document: {cloud_event['document']}")
// For withAuthContext events
print(f"Auth information: {cloud_event['authid']}")
print(f"Auth information: {cloud_event['authtype']}")

Estructuras de eventos

Este activador invoca tu servicio con un evento similar al siguiente: 

{
    "oldValue": { // Update and Delete operations only
        A Document object containing a pre-operation document snapshot
    },
    "updateMask": { // Update operations only
        A DocumentMask object that lists changed fields.
    },
    "value": {
        // A Document object containing a post-operation document snapshot
    }
}

Cada objeto Document contiene uno o varios objetos Value. Consulta la documentación de Value para ver las referencias de tipos.

Crear activadores para funciones

Haga clic en la pestaña para ver las instrucciones sobre cómo usar la herramienta que prefiera.

Consola

Cuando usas la consola Google Cloud para crear una función, también puedes añadir un activador a la función. Sigue estos pasos para crear un activador para tu función:

  1. En la Google Cloud consola, ve a Cloud Run:

    Ir a Cloud Run

  2. Haz clic en Escribir una función e introduce los detalles de la función. Para obtener más información sobre cómo configurar funciones durante la implementación, consulta Implementar funciones.

  3. En la sección Activador, haz clic en Añadir activador.

  4. Seleccione Activador de Firestore.

  5. En el panel Activador de Eventarc, modifica los detalles del activador de la siguiente manera:

    1. En el campo Nombre del activador, escriba un nombre para el activador o use el predeterminado.

    2. Selecciona un Tipo de activador de la lista:

      • Fuentes de Google para especificar activadores de Pub/Sub, Cloud Storage, Firestore y otros proveedores de eventos de Google.

      • Terceros: para integrarse con proveedores que no sean de Google y que ofrezcan una fuente de Eventarc. Para obtener más información, consulta Eventos de terceros en Eventarc.

    3. Seleccione Firestore en la lista Proveedor de eventos para seleccionar un producto que proporcione el tipo de evento que activará su función. Para ver la lista de proveedores de eventos, consulte Proveedores y destinos de eventos.

    4. Selecciona type=google.cloud.firestore.document.v1.created en la lista Tipo de evento. La configuración del activador varía en función del tipo de evento admitido. Para obtener más información, consulta Tipos de eventos.

    5. En la sección Filtros, seleccione una base de datos, una operación y valores de atributos, o utilice las selecciones predeterminadas.

    6. Si el campo Región está habilitado, selecciona una ubicación para el activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debes desplegar tu función en la misma región. Consulta ¿Qué son las ubicaciones de Eventarc? para obtener más información sobre las ubicaciones de los activadores de Eventarc.

    7. En el campo Cuenta de servicio, selecciona una cuenta de servicio. Los activadores de Eventarc están vinculados a cuentas de servicio para usarlas como identidad al invocar tu función. La cuenta de servicio del activador de Eventarc debe tener permiso para invocar tu función. De forma predeterminada, Cloud Run usa la cuenta de servicio predeterminada de Compute Engine.

    8. Si quiere, especifique la ruta de la URL del servicio a la que se enviará la solicitud entrante. Es la ruta relativa del servicio de destino a la que se deben enviar los eventos del activador. Por ejemplo: /, /route, route y route/subroute.

  6. Una vez que haya completado los campos obligatorios, haga clic en Guardar activador.

gcloud

Cuando creas una función con la CLI de gcloud, primero debes desplegar la función y, a continuación, crear un activador. Sigue estos pasos para crear un activador para tu función:

  1. Ejecuta el siguiente comando en el directorio que contiene el código de muestra para desplegar tu función:

    gcloud run deploy FUNCTION \
        --source . \
        --function FUNCTION_ENTRYPOINT \
        --base-image BASE_IMAGE_ID \
        --region REGION

    Sustituye:

    • FUNCTION con el nombre de la función que vas a implementar. Puedes omitir este parámetro por completo, pero se te pedirá el nombre si lo haces.

    • FUNCTION_ENTRYPOINT con el punto de entrada de tu función en el código fuente. Este es el código que ejecuta Cloud Run cuando se ejecuta tu función. El valor de esta marca debe ser un nombre de función o un nombre de clase completo que exista en el código fuente.

    • BASE_IMAGE_ID con el entorno de la imagen base de tu función. Para obtener más información sobre las imágenes base y los paquetes incluidos en cada imagen, consulta Imágenes base de los entornos de ejecución.

    • REGION con la Google Cloud región en la que quieras desplegar tu función. Por ejemplo, europe-west1.

  2. Ejecuta el siguiente comando para crear un activador que filtre eventos:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=EVENTARC_TRIGGER_LOCATION \
    --destination-run-service=FUNCTION  \
    --destination-run-region=REGION \
    --event-filters="type=google.cloud.firestore.document.v1.created" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Sustituye:

    • TRIGGER_NAME con el nombre del activador.

    • EVENTARC_TRIGGER_LOCATION con la ubicación del activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debes implementar tu función en la misma región. Para obtener más información, consulta Ubicaciones de Eventarc.

    • FUNCTION con el nombre de la función que vas a implementar.

    • REGION con la región de Cloud Run de la función.

    • PROJECT_NUMBER con el número de tu proyecto Google Cloud . Los activadores de Eventarc están vinculados a cuentas de servicio para usarse como identidad al invocar tu función. La cuenta de servicio de tu activador de Eventarc debe tener permiso para invocar tu función. De forma predeterminada, Cloud Run usa la cuenta de servicio predeterminada de Compute.

    Cada marca event-filters especifica un tipo de evento. La función solo se activa cuando un evento cumple todos los criterios especificados en sus marcas event-filters. Cada activador debe tener una marca event-filters que especifique un tipo de evento admitido, como un documento nuevo escrito en Firestore o un archivo subido a Cloud Storage. No puedes cambiar el tipo de filtro de eventos después de crearlo. Para cambiar el tipo de filtro de eventos, debe crear un activador y eliminar el antiguo. Opcionalmente, puedes repetir la marca --event-filters con un filtro admitido en el formato ATTRIBUTE=VALUE para añadir más filtros.

Terraform

Para crear un activador de Eventarc para una función de Cloud Run, consulta Crear un activador con Terraform.

Ejemplos

En los siguientes ejemplos se describe cómo usar eventos de Firestore en modo nativo para activar una función de Cloud Run.

Ejemplo 1: función Hello Firestore

En el siguiente ejemplo se imprimen los campos de un evento de Firestore que activa un Cloud Function:

Node.js

/**
 * Cloud Event Function triggered by a change to a Firestore document.
 */
const functions = require('@google-cloud/functions-framework');
const protobuf = require('protobufjs');

functions.cloudEvent('helloFirestore', async cloudEvent => {
  console.log(`Function triggered by event on: ${cloudEvent.source}`);
  console.log(`Event type: ${cloudEvent.type}`);

  console.log('Loading protos...');
  const root = await protobuf.load('data.proto');
  const DocumentEventData = root.lookupType(
    'google.events.cloud.firestore.v1.DocumentEventData'
  );

  console.log('Decoding data...');
  const firestoreReceived = DocumentEventData.decode(cloudEvent.data);

  console.log('\nOld value:');
  console.log(JSON.stringify(firestoreReceived.oldValue, null, 2));

  console.log('\nNew value:');
  console.log(JSON.stringify(firestoreReceived.value, null, 2));
});

Python

from cloudevents.http import CloudEvent
import functions_framework
from google.events.cloud import firestore


@functions_framework.cloud_event
def hello_firestore(cloud_event: CloudEvent) -> None:
    """Triggers by a change to a Firestore document.

    Args:
        cloud_event: cloud event with information on the firestore event trigger
    """
    firestore_payload = firestore.DocumentEventData()
    firestore_payload._pb.ParseFromString(cloud_event.data)

    print(f"Function triggered by change to: {cloud_event['source']}")

    print("\nOld value:")
    print(firestore_payload.old_value)

    print("\nNew value:")
    print(firestore_payload.value)

Go


// Package hellofirestore contains a Cloud Event Function triggered by a Cloud Firestore event.
package hellofirestore

import (
	"context"
	"fmt"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
	"github.com/cloudevents/sdk-go/v2/event"
	"github.com/googleapis/google-cloudevents-go/cloud/firestoredata"
	"google.golang.org/protobuf/proto"
)

func init() {
	functions.CloudEvent("helloFirestore", HelloFirestore)
}

// HelloFirestore is triggered by a change to a Firestore document.
func HelloFirestore(ctx context.Context, event event.Event) error {
	var data firestoredata.DocumentEventData

	// If you omit `DiscardUnknown`, protojson.Unmarshal returns an error
	// when encountering a new or unknown field.
	options := proto.UnmarshalOptions{
		DiscardUnknown: true,
	}
	err := options.Unmarshal(event.Data(), &data)

	if err != nil {
		return fmt.Errorf("proto.Unmarshal: %w", err)
	}

	fmt.Printf("Function triggered by change to: %v\n", event.Source())
	fmt.Printf("Old value: %+v\n", data.GetOldValue())
	fmt.Printf("New value: %+v\n", data.GetValue())
	return nil
}

Java

import com.google.cloud.functions.CloudEventsFunction;
import com.google.events.cloud.firestore.v1.DocumentEventData;
import com.google.protobuf.InvalidProtocolBufferException;
import io.cloudevents.CloudEvent;
import java.util.logging.Logger;

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

  @Override
  public void accept(CloudEvent event) throws InvalidProtocolBufferException {
    DocumentEventData firestoreEventData = DocumentEventData
        .parseFrom(event.getData().toBytes());

    logger.info("Function triggered by event on: " + event.getSource());
    logger.info("Event type: " + event.getType());

    logger.info("Old value:");
    logger.info(firestoreEventData.getOldValue().toString());

    logger.info("New value:");
    logger.info(firestoreEventData.getValue().toString());
  }
}

C#

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Cloud.Firestore.V1;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace FirebaseFirestore;

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

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

    public Task HandleAsync(CloudEvent cloudEvent, DocumentEventData data, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Function triggered by event on {subject}", cloudEvent.Subject);
        _logger.LogInformation("Event type: {type}", cloudEvent.Type);
        MaybeLogDocument("Old value", data.OldValue);
        MaybeLogDocument("New value", data.Value);

        // 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;
    }

    /// <summary>
    /// Logs the names and values of the fields in a document in a very simplistic way.
    /// </summary>
    private void MaybeLogDocument(string message, Document document)
    {
        if (document is null)
        {
            return;
        }

        // ConvertFields converts the Firestore representation into a .NET-friendly
        // representation.
        IReadOnlyDictionary<string, object> fields = document.ConvertFields();
        var fieldNamesAndTypes = fields
            .OrderBy(pair => pair.Key)
            .Select(pair => $"{pair.Key}: {pair.Value}");
        _logger.LogInformation(message + ": {fields}", string.Join(", ", fieldNamesAndTypes));
    }
}

Desplegar la función

Para desplegar la función Hello Firestore, ejecuta el siguiente comando:

Si aún no lo has hecho, configura tu base de datos de Firestore.

Para implementar la función, consulta Crear activadores para funciones.

Probar función

Para probar la función Hello Firestore, configura una colección llamada users en tu base de datos de Firestore:

  1. En la Google Cloud consola, ve a la página de bases de datos de Firestore:

    Ir a Firestore

  2. Haz clic en Iniciar una colección.

  3. Especifica users como ID de la colección.

  4. Para empezar a añadir el primer documento de la colección, en Añadir el primer documento, acepta el ID de documento generado automáticamente.

  5. Añade al menos un campo al documento, especificando un nombre y un valor. Por ejemplo, en Nombre del campo, escribe username y, en Valor del campo, introduce rowan.

  6. Cuando hayas terminado, haz clic en Guardar.

    Esta acción crea un nuevo documento, lo que activa la función.

  7. Para confirmar que se ha activado la función, haz clic en el nombre vinculado de la función en la Google Cloud consola página de resumen de Cloud Run para abrir la página Detalles del servicio.

  8. Selecciona la pestaña Registros y busca esta cadena:

Function triggered by change to: //firestore.googleapis.com/projects/your-project-id/databases/(default)'

Ejemplo 2: función Convertir en mayúsculas

En el siguiente ejemplo, se obtiene el valor añadido por el usuario, se convierte la cadena de esa ubicación a mayúsculas y se sustituye el valor por la cadena en mayúsculas:

Node.js

Usa protobufjs para decodificar los datos del evento. Incluye google.events.cloud.firestore.v1 data.proto en tu fuente.

const functions = require('@google-cloud/functions-framework');
const Firestore = require('@google-cloud/firestore');
const protobuf = require('protobufjs');

const firestore = new Firestore({
  projectId: process.env.GOOGLE_CLOUD_PROJECT,
});

// Converts strings added to /messages/{pushId}/original to uppercase
functions.cloudEvent('makeUpperCase', async cloudEvent => {
  console.log('Loading protos...');
  const root = await protobuf.load('data.proto');
  const DocumentEventData = root.lookupType(
    'google.events.cloud.firestore.v1.DocumentEventData'
  );

  console.log('Decoding data...');
  const firestoreReceived = DocumentEventData.decode(cloudEvent.data);

  const resource = firestoreReceived.value.name;
  const affectedDoc = firestore.doc(resource.split('/documents/')[1]);

  const curValue = firestoreReceived.value.fields.original.stringValue;
  const newValue = curValue.toUpperCase();

  if (curValue === newValue) {
    // Value is already upper-case
    // Don't perform a(nother) write to avoid infinite loops
    console.log('Value is already upper-case.');
    return;
  }

  console.log(`Replacing value: ${curValue} --> ${newValue}`);
  affectedDoc.set({
    original: newValue,
  });
});

Python

from cloudevents.http import CloudEvent
import functions_framework
from google.cloud import firestore
from google.events.cloud import firestore as firestoredata

client = firestore.Client()


# Converts strings added to /messages/{pushId}/original to uppercase
@functions_framework.cloud_event
def make_upper_case(cloud_event: CloudEvent) -> None:
    firestore_payload = firestoredata.DocumentEventData()
    firestore_payload._pb.ParseFromString(cloud_event.data)

    path_parts = firestore_payload.value.name.split("/")
    separator_idx = path_parts.index("documents")
    collection_path = path_parts[separator_idx + 1]
    document_path = "/".join(path_parts[(separator_idx + 2) :])

    print(f"Collection path: {collection_path}")
    print(f"Document path: {document_path}")

    affected_doc = client.collection(collection_path).document(document_path)

    cur_value = firestore_payload.value.fields["original"].string_value
    new_value = cur_value.upper()

    if cur_value != new_value:
        print(f"Replacing value: {cur_value} --> {new_value}")
        affected_doc.set({"original": new_value})
    else:
        # Value is already upper-case
        # Don't perform a second write (which can trigger an infinite loop)
        print("Value is already upper-case.")

Go


// Package upper contains a Firestore Cloud Function.
package upper

import (
	"context"
	"errors"
	"fmt"
	"log"
	"os"
	"strings"

	"cloud.google.com/go/firestore"
	firebase "firebase.google.com/go/v4"
	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
	"github.com/cloudevents/sdk-go/v2/event"
	"github.com/googleapis/google-cloudevents-go/cloud/firestoredata"
	"google.golang.org/protobuf/proto"
)

// set the GOOGLE_CLOUD_PROJECT environment variable when deploying.
var projectID = os.Getenv("GOOGLE_CLOUD_PROJECT")

// client is a Firestore client, reused between function invocations.
var client *firestore.Client

func init() {
	// Use the application default credentials.
	conf := &firebase.Config{ProjectID: projectID}

	// Use context.Background() because the app/client should persist across
	// invocations.
	ctx := context.Background()

	app, err := firebase.NewApp(ctx, conf)
	if err != nil {
		log.Fatalf("firebase.NewApp: %v", err)
	}

	client, err = app.Firestore(ctx)
	if err != nil {
		log.Fatalf("app.Firestore: %v", err)
	}

	// Register cloud event function
	functions.CloudEvent("MakeUpperCase", MakeUpperCase)
}

// MakeUpperCase is triggered by a change to a Firestore document. It updates
// the `original` value of the document to upper case.
func MakeUpperCase(ctx context.Context, e event.Event) error {
	var data firestoredata.DocumentEventData

	// If you omit `DiscardUnknown`, protojson.Unmarshal returns an error
	// when encountering a new or unknown field.
	options := proto.UnmarshalOptions{
		DiscardUnknown: true,
	}
	err := options.Unmarshal(e.Data(), &data)

	if err != nil {
		return fmt.Errorf("proto.Unmarshal: %w", err)
	}

	if data.GetValue() == nil {
		return errors.New("Invalid message: 'Value' not present")
	}

	fullPath := strings.Split(data.GetValue().GetName(), "/documents/")[1]
	pathParts := strings.Split(fullPath, "/")
	collection := pathParts[0]
	doc := strings.Join(pathParts[1:], "/")

	var originalStringValue string
	if v, ok := data.GetValue().GetFields()["original"]; ok {
		originalStringValue = v.GetStringValue()
	} else {
		return errors.New("Document did not contain field \"original\"")
	}

	newValue := strings.ToUpper(originalStringValue)
	if originalStringValue == newValue {
		log.Printf("%q is already upper case: skipping", originalStringValue)
		return nil
	}
	log.Printf("Replacing value: %q -> %q", originalStringValue, newValue)

	newDocumentEntry := map[string]string{"original": newValue}
	_, err = client.Collection(collection).Doc(doc).Set(ctx, newDocumentEntry)
	if err != nil {
		return fmt.Errorf("Set: %w", err)
	}
	return nil
}

Java

import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreOptions;
import com.google.cloud.firestore.SetOptions;
import com.google.cloud.functions.CloudEventsFunction;
import com.google.events.cloud.firestore.v1.DocumentEventData;
import com.google.events.cloud.firestore.v1.Value;
import com.google.protobuf.InvalidProtocolBufferException;
import io.cloudevents.CloudEvent;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.logging.Logger;

public class FirebaseFirestoreReactive implements CloudEventsFunction {
  private static final Logger logger = Logger.getLogger(FirebaseFirestoreReactive.class.getName());
  private final Firestore firestore;

  private static final String FIELD_KEY = "original";
  private static final String APPLICATION_PROTOBUF = "application/protobuf";

  public FirebaseFirestoreReactive() {
    this(FirestoreOptions.getDefaultInstance().getService());
  }

  public FirebaseFirestoreReactive(Firestore firestore) {
    this.firestore = firestore;
  }

  @Override
  public void accept(CloudEvent event)
      throws InvalidProtocolBufferException, InterruptedException, ExecutionException {
    if (event.getData() == null) {
      logger.warning("No data found in event!");
      return;
    }

    if (!event.getDataContentType().equals(APPLICATION_PROTOBUF)) {
      logger.warning(String.format("Found unexpected content type %s, expected %s",
          event.getDataContentType(),
          APPLICATION_PROTOBUF));
      return;
    }

    DocumentEventData firestoreEventData = DocumentEventData
        .parseFrom(event.getData().toBytes());

    // Get the fields from the post-operation document snapshot
    // https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
    Map<String, Value> fields = firestoreEventData.getValue().getFieldsMap();
    if (!fields.containsKey(FIELD_KEY)) {
      logger.warning("Document does not contain original field");
      return;
    }
    String currValue = fields.get(FIELD_KEY).getStringValue();
    String newValue = currValue.toUpperCase();

    if (currValue.equals(newValue)) {
      logger.info("Value is already upper-case");
      return;
    }

    // Retrieve the document name from the resource path:
    // projects/{project_id}/databases/{database_id}/documents/{document_path}
    String affectedDoc = firestoreEventData.getValue()
        .getName()
        .split("/documents/")[1]
        .replace("\"", "");

    logger.info(String.format("Replacing values: %s --> %s", currValue, newValue));

    // Wait for the async call to complete
    this.firestore
        .document(affectedDoc)
        .set(Map.of(FIELD_KEY, newValue), SetOptions.merge())
        .get();
  }
}

C#

using CloudNative.CloudEvents;
using Google.Cloud.Firestore;
using Google.Cloud.Functions.Framework;
using Google.Cloud.Functions.Hosting;
using Google.Events.Protobuf.Cloud.Firestore.V1;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

namespace FirestoreReactive;

public class Startup : FunctionsStartup
{
    public override void ConfigureServices(WebHostBuilderContext context, IServiceCollection services) =>
        services.AddSingleton(FirestoreDb.Create());
}

// Register the startup class to provide the Firestore dependency.
[FunctionsStartup(typeof(Startup))]
public class Function : ICloudEventFunction<DocumentEventData>
{
    private readonly ILogger _logger;
    private readonly FirestoreDb _firestoreDb;

    public Function(ILogger<Function> logger, FirestoreDb firestoreDb) =>
        (_logger, _firestoreDb) = (logger, firestoreDb);

    public async Task HandleAsync(CloudEvent cloudEvent, DocumentEventData data, CancellationToken cancellationToken)
    {
        // Get the recently-written value. This expression will result in a null value
        // if any of the following is true:
        // - The event doesn't contain a "new" document
        // - The value doesn't contain a field called "original"
        // - The "original" field isn't a string
        string currentValue = data.Value?.ConvertFields().GetValueOrDefault("original") as string;
        if (currentValue is null)
        {
            _logger.LogWarning($"Event did not contain a suitable document");
            return;
        }

        string newValue = currentValue.ToUpperInvariant();
        if (newValue == currentValue)
        {
            _logger.LogInformation("Value is already upper-cased; no replacement necessary");
            return;
        }

        // The CloudEvent subject is "documents/x/y/...".
        // The Firestore SDK FirestoreDb.Document method expects a reference relative to
        // "documents" (so just the "x/y/..." part). This may be simplified over time.
        if (cloudEvent.Subject is null || !cloudEvent.Subject.StartsWith("documents/"))
        {
            _logger.LogWarning("CloudEvent subject is not a document reference.");
            return;
        }
        string documentPath = cloudEvent.Subject.Substring("documents/".Length);

        _logger.LogInformation("Replacing '{current}' with '{new}' in '{path}'", currentValue, newValue, documentPath);
        await _firestoreDb.Document(documentPath).UpdateAsync("original", newValue, cancellationToken: cancellationToken);
    }
}

Desplegar la función

Para desplegar la función Convert to Uppercase, ejecuta el siguiente comando:

Si aún no lo has hecho, configura tu base de datos de Firestore.

Para implementar la función, consulta Crear activadores para funciones.

Probar función

Para probar la función Convert to Uppercase que acabas de implementar, configura una colección llamada messages en tu base de datos de Firestore:

  1. En la Google Cloud consola, ve a la página de bases de datos de Firestore:

    Ir a Firestore

  2. Haz clic en Iniciar una colección.

  3. Especifica messages como ID de la colección.

  4. Para empezar a añadir el primer documento de la colección, en Añadir el primer documento, acepta el ID de documento generado automáticamente.

  5. Para activar la función implementada, añade un documento en el que el nombre del campo sea original y el valor del campo sea minka.

  6. Cuando guardes el documento, verás que la palabra en minúsculas del campo de valor se convierte en mayúsculas.

    Si posteriormente editas el valor del campo para que contenga letras minúsculas, se activará de nuevo la función, que convertirá todas las letras minúsculas en mayúsculas.

Limitaciones de las funciones

  • No se garantiza la realización del pedido. Los cambios rápidos pueden activar invocaciones de funciones en un orden inesperado.
  • Los eventos se entregan al menos una vez, pero un solo evento puede dar lugar a varias invocaciones de funciones. No dependas de los mecanismos de entrega exactamente una vez y escribe funciones idempotentes.
  • Un activador está asociado a una sola base de datos. No puedes crear un activador que coincida con varias bases de datos.
  • Si eliminas una base de datos, no se eliminarán automáticamente los activadores de esa base de datos. El activador deja de enviar eventos, pero sigue existiendo hasta que lo elimines.