Activar funciones con documentos de Firestore

En esta guía se muestran ejemplos de funciones que se activan cuando se hacen cambios en un documento de una colección específica.

Antes de empezar

Antes de ejecutar el código de muestra de esta guía, debes hacer lo siguiente:

• Habilita las APIs y concede los roles necesarios para desplegar funciones
• Configurar una base de datos de Firestore

Ejemplos

En los siguientes ejemplos se muestra cómo escribir funciones que responden a un activador de Firestore.

Ejemplo 1: función Hello Firestore

En el siguiente ejemplo se imprimen los campos de un evento de Firestore que activa una función:

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 Hello Firestore

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

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. Selecciona Firestore en la lista Proveedor de eventos para elegir un producto que proporcione el tipo de evento que activará la función. Para ver la lista de proveedores de eventos, consulte Proveedores y destinos de eventos.

   4. Selecciona type=google.cloud.firestore.document.v1.written 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 al 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 por 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.written \
       --event-filters=database='(default)' \
       --event-data-content-type=application/protobuf \
       --event-filters-path-pattern=document='users/{username}' \
       --service-account=[e-mail]
   

   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 de Compute predeterminada.

   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.

Deja los demás campos como aparecen:

• --event-filters=type=google.cloud.firestore.document.v1.written especifica que la función se activa cuando se crea, se actualiza o se elimina un documento, según el google.cloud.firestore.document.v1.written tipo de evento.
• --event-filters=database='(default)' especifica la base de datos de Firebase. Para el nombre de la base de datos predeterminada, usa (default).
• --event-filters-path-pattern=document='users/{username}' proporciona el patrón de ruta de los documentos que se deben monitorizar para detectar cambios relevantes. Este patrón de ruta indica que se deben monitorizar todos los documentos de la colección users. Para obtener más información, consulta Información sobre los patrones de ruta.

Probar la función Hello Firestore

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

Nota: Si actualizas el documento de Firestore que activa la función, es posible que se creen eventos updated posteriores, lo que podría provocar un bucle infinito en tu función. Para solucionar este problema, usa tipos de activadores que ignoren las actualizaciones (como created) o configura tu función para que solo escriba en Firestore si el valor subyacente ha cambiado.

Desplegar la función Convert to Uppercase

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

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. Selecciona Firestore en la lista Proveedor de eventos para elegir un producto que proporcione el tipo de evento que activará la función. Para ver la lista de proveedores de eventos, consulte Proveedores y destinos de eventos.

   4. Selecciona type=google.cloud.firestore.document.v1.written 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 al 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 por 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.written \
       --event-filters=database='(default)' \
       --event-data-content-type=application/protobuf \
       --event-filters-path-pattern=document='messages/{pushId}' \
       --service-account=[e-mail]
   

   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 de Compute predeterminada.

   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.

Deja los demás campos como aparecen:

• --event-filters=type=google.cloud.firestore.document.v1.written especifica que la función se activa cuando se crea, actualiza o elimina un documento, según el google.cloud.firestore.document.v1.written tipo de evento.
• --event-filters=database='(default)' especifica la base de datos de Firestore. Para el nombre de la base de datos predeterminada, usa (default).
• --event-filters-path-pattern=document='messages/{pushId}' proporciona el patrón de ruta de los documentos que se deben monitorizar para detectar cambios relevantes. Este patrón de ruta indica que se deben monitorizar todos los documentos de la colección messages. Para obtener más información, consulta Información sobre los patrones de ruta.

Probar la función Convertir a mayúsculas

Para probar la función Convertir a mayúsculas 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.