Attivare funzioni con i documenti Firestore

Questa guida mostra esempi di funzioni attivate quando apporti modifiche a un documento all'interno di una raccolta specificata.

Prima di iniziare

Prima di eseguire il codice campione in questa guida, devi:

• Abilitare le API e concedere i ruoli richiesti per il deployment delle funzioni
• Configura un database Firestore

Esempi

Gli esempi riportati di seguito mostrano come scrivere funzioni che rispondono a un trigger Firestore.

Esempio 1: funzione Hello Firestore

Il seguente esempio stampa i campi di un evento Firestore trigger:

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

Esegui il deployment della funzione Hello Firestore

Se non l'hai ancora fatto, configura il tuo database Firestore.

Dopo aver eseguito il deployment di una funzione, puoi configurare un trigger utilizzando la console Google Cloud , Google Cloud CLI o Terraform.

Console

Quando utilizzi la console Google Cloud per creare una funzione, puoi anche aggiungere un trigger alla funzione. Per creare un attivatore per la tua funzione:

1. Nella console Google Cloud , vai a Cloud Run:

   Vai a Cloud Run

2. Fai clic su Scrivi una funzione e inserisci i dettagli della funzione. Per ulteriori informazioni sulla configurazione delle funzioni durante il deployment, consulta Esegui il deployment delle funzioni.

3. Nella sezione Attivatore, fai clic su Aggiungi attivatore.

4. Seleziona Trigger di Firestore.

5. Nel riquadro Trigger Eventarc, modifica i dettagli del trigger come segue:

   1. Inserisci un nome per l'attivatore nel campo Nome attivatore o utilizza il nome predefinito.

   2. Seleziona un tipo di trigger dall'elenco:

      • Origini Google per specificare i trigger per Pub/Sub, Cloud Storage, Firestore e altri provider di eventi Google.

      • Terze parti per l'integrazione con provider non Google che offrono un'origine Eventarc. Per saperne di più, vedi Eventi di terze parti in Eventarc.

   3. Seleziona Cloud Firestore dall'elenco Provider di eventi per selezionare un prodotto che fornisca il tipo di evento per attivare la funzione. Per l'elenco dei fornitori di eventi, vedi Fornitori e destinazioni di eventi.

   4. Seleziona type=google.cloud.firestore.document.v1.written dall'elenco Tipo di evento. La configurazione del trigger varia a seconda del tipo di evento supportato. Per saperne di più, consulta Tipi di eventi.

   5. Lascia invariato il campo Tipo di contenuti dei dati sugli eventi.

   6. Nella sezione Filtri, seleziona un database, un'operazione e valori degli attributi oppure utilizza le selezioni predefinite.

   7. Se il campo Regione è attivo, seleziona una posizione per il trigger Eventarc. In generale, la località di un trigger Eventarc deve corrispondere a quella della risorsaGoogle Cloud che vuoi monitorare per gli eventi. Nella maggior parte degli scenari, devi anche eseguire il deployment della funzione nella stessa regione. Per ulteriori dettagli sulle località dei trigger Eventarc, consulta la sezione Informazioni sulle località Eventarc.

   8. Nel campo Service account, seleziona un account di servizio. I trigger Eventarc sono collegati a service account da utilizzare come identità quando viene richiamata la funzione. Il account di servizio del trigger Eventarc deve disporre dell'autorizzazione per richiamare la funzione. Per impostazione predefinita, Cloud Run utilizza l'account di servizio predefinito di Compute Engine.

   9. (Facoltativo) Specifica il percorso dell'URL del servizio a cui inviare la richiesta in entrata. Questo è il percorso relativo nel servizio di destinazione a cui devono essere inviati gli eventi per il trigger. Ad esempio: /, /route, route e route/subroute.

   10. (Facoltativo) Per abilitare i nuovi tentativi se il tentativo di consegna non va a buon fine, seleziona la casella di controllo Abilita ripetizione dei tentativi in caso di errore; in caso contrario, il comportamento predefinito è un singolo tentativo di consegna senza ripetizioni. Per saperne di più, consulta Nuovi tentativi per gli eventi.

6. Una volta compilati i campi obbligatori, fai clic su Salva attivatore.

7. Fai clic su Crea.

8. Nella scheda Origine, modifica il codice sorgente se necessario, poi seleziona Salva e ridistribuisci.

gcloud

Quando crei una funzione utilizzando gcloud CLI, devi prima eseguirne il deployment e poi creare un trigger. Per creare un trigger per la tua funzione:

1. Esegui questo comando nella directory che contiene il codice campione per eseguire il deployment della funzione:

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

   Sostituisci quanto segue:

   • FUNCTION: il nome della funzione di cui stai eseguendo il deployment. Puoi omettere completamente questo parametro, ma ti verrà chiesto il nome se lo ometti.

   • FUNCTION_ENTRYPOINT: l'entry point della funzione nel codice sorgente. Questo è il codice che Cloud Run esegue quando viene eseguita la funzione. Il valore di questo flag deve essere un nome di funzione o un nome di classe completo esistente nel codice sorgente.

   • BASE_IMAGE_ID: l'ambiente dell'immagine di base per la funzione. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Immagini di base dei runtime.

   • REGION: la regione Google Cloudin cui vuoi eseguire il deployment della funzione. Ad esempio: europe-west1.

2. Esegui questo comando per creare un trigger che filtri ed esegua il routing degli eventi:

   gcloud eventarc triggers create TRIGGER_NAME  \
       --location=LOCATION \
       --destination-run-service=FUNCTION  \
       --destination-run-region=DESTINATION_RUN_REGION \
       --event-filters="type=EVENT_FILTER_TYPE" \
       --event-filters=database='(default)' \
       --event-data-content-type=application/protobuf \
       --event-filters-path-pattern=document='users/{username}' \
       --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.
   

   Sostituisci quanto segue:

   • TRIGGER_NAME: l'ID del trigger o un identificatore completo.
   • LOCATION: la posizione del trigger Eventarc. In alternativa, puoi impostare la proprietà eventarc/location, ad esempio gcloud config set eventarc/location us-central1.

     Per evitare problemi di prestazioni e residenza dei dati, la località deve corrispondere a quella del Google Cloud servizio che genera eventi. Per saperne di più, consulta Località Eventarc.

   • FUNCTION: il nome della funzione Cloud Run di cui è stato eseguito il deployment che riceve gli eventi per il trigger.
   • DESTINATION_RUN_REGION: (facoltativo) la posizione di Cloud Run in cui si trova la funzione Cloud Run di destinazione. Se non specificato, si presume che la funzione si trovi nella stessa regione del trigger.
   • EVENT_FILTER_TYPE: l'identificatore dell'evento. Viene generato un evento quando una chiamata API per il metodo ha esito positivo. Per le operazioni a lunga esecuzione, l'evento viene generato solo al termine dell'operazione e solo se l'azione viene eseguita correttamente. Per un elenco dei tipi di eventi supportati, consulta Tipi di eventi Google supportati da Eventarc.
   • SERVICE_ACCOUNT_NAME: il nome del account di servizio gestito dall'utente.
   • PROJECT_ID: il tuo ID progetto Google Cloud .

   Note:

   • Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
   • --event-filters=type=google.cloud.firestore.document.v1.written specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di evento.
   • --event-filters=database='(default)' specifica il database Firebase. Per il nome del database predefinito, utilizza (default).
   • --event-filters-path-pattern=document='users/{username}' fornisce il pattern del percorso dei documenti da monitorare per le modifiche pertinenti. Questo pattern di percorso indica che devono essere monitorati tutti i documenti della raccolta users. Per saperne di più, vedi Informazioni sui pattern di percorso.
   • (Facoltativo) Per specificare un singolo tentativo di invio di eventi senza ripetizioni, utilizza il flag --max-retry-attempts. L'unico valore valido è 1. Se ometti il flag, viene applicato il comportamento di ripetizione standard. Per saperne di più, vedi Nuovi tentativi per gli eventi.
   • Sono disponibili altri flag. Per saperne di più, vedi gcloud eventarc triggers create.

Terraform

Per creare un trigger Eventarc per una funzione Cloud Run, consulta Creare un trigger utilizzando Terraform.

Testa la funzione Hello Firestore

Per testare la funzione Hello Firestore, configura una raccolta denominata users nel tuo database Firestore:

1. Nella console Google Cloud , vai alla pagina dei database Firestore:

   Vai a Firestore

2. Fai clic su Avvia una raccolta.

3. Specifica users come ID raccolta.

4. Per iniziare ad aggiungere il primo documento della raccolta, accetta l'ID documento generato automaticamente in Aggiungi il primo documento.

5. Aggiungi almeno un campo per il documento, specificando un nome e un valore. Ad esempio, in Nome campo, inserisci username e in Valore campo, inserisci rowan.

6. Quando hai terminato, fai clic su Salva.

   Questa azione crea un nuovo documento, attivando così la funzione.

7. Per verificare che la funzione sia stata attivata, fai clic sul nome collegato della funzione nella console Google Cloud nella pagina Panoramica di Cloud Run per aprire la pagina Dettagli servizio.

8. Nella scheda Osservabilità, seleziona la scheda Log e cerca la seguente stringa:

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

Esempio 2: funzione Converti in maiuscolo

L'esempio seguente recupera il valore aggiunto dall'utente, converte la stringa in quella posizione in maiuscolo e sostituisce il valore con la stringa in maiuscolo:

Node.js

Utilizza protobufjs per decodificare i dati dell'evento. Includi google.events.cloud.firestore.v1 data.proto nella tua fonte.

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: l'aggiornamento del documento Firestore che attiva la funzione potrebbe creare eventi updated successivi, che potrebbero generare un ciclo infinito all'interno della funzione. Per risolvere questo problema, utilizza tipi di trigger che ignorano gli aggiornamenti (ad esempio created) o configura la funzione in modo che scriva in Firestore solo se il valore sottostante è cambiato.

Esegui il deployment della funzione Converti in maiuscolo

Se non l'hai ancora fatto, configura il tuo database Firestore.

Dopo aver eseguito il deployment di una funzione, puoi configurare un trigger utilizzando la console Google Cloud , Google Cloud CLI o Terraform.

Console

Quando utilizzi la console Google Cloud per creare una funzione, puoi anche aggiungere un trigger alla funzione. Per creare un attivatore per la tua funzione:

1. Nella console Google Cloud , vai a Cloud Run:

   Vai a Cloud Run

2. Fai clic su Scrivi una funzione e inserisci i dettagli della funzione. Per ulteriori informazioni sulla configurazione delle funzioni durante il deployment, consulta Esegui il deployment delle funzioni.

3. Nella sezione Attivatore, fai clic su Aggiungi attivatore.

4. Seleziona Trigger di Firestore.

5. Nel riquadro Trigger Eventarc, modifica i dettagli del trigger come segue:

   1. Inserisci un nome per l'attivatore nel campo Nome attivatore o utilizza il nome predefinito.

   2. Seleziona un tipo di trigger dall'elenco:

      • Origini Google per specificare i trigger per Pub/Sub, Cloud Storage, Firestore e altri provider di eventi Google.

      • Terze parti per l'integrazione con provider non Google che offrono un'origine Eventarc. Per saperne di più, vedi Eventi di terze parti in Eventarc.

   3. Seleziona Firestore dall'elenco Provider di eventi per selezionare un prodotto che fornisca il tipo di evento per attivare la funzione. Per l'elenco dei fornitori di eventi, vedi Fornitori e destinazioni di eventi.

   4. Seleziona type=google.cloud.firestore.document.v1.written dall'elenco Tipo di evento. La configurazione del trigger varia a seconda del tipo di evento supportato. Per saperne di più, consulta Tipi di eventi.

   5. Lascia invariato il campo Tipo di contenuti dei dati sugli eventi.

   6. Nella sezione Filtri, seleziona un database, un'operazione e valori degli attributi oppure utilizza le selezioni predefinite. Se hai assegnato un nome al database, inseriscilo nel campo Valore dell'attributo 1.

   7. Se il campo Regione è attivo, seleziona una posizione per il trigger Eventarc. In generale, la località di un trigger Eventarc deve corrispondere a quella della risorsaGoogle Cloud che vuoi monitorare per gli eventi. Nella maggior parte degli scenari, devi anche eseguire il deployment della funzione nella stessa regione. Per ulteriori dettagli sulle località dei trigger Eventarc, consulta la sezione Informazioni sulle località Eventarc.

   8. Nel campo Service account, seleziona un account di servizio. I trigger Eventarc sono collegati a service account da utilizzare come identità quando viene richiamata la funzione. Il account di servizio del trigger Eventarc deve disporre dell'autorizzazione per richiamare la funzione. Per impostazione predefinita, Cloud Run utilizza l'account di servizio predefinito di Compute Engine.

   9. (Facoltativo) Specifica il percorso dell'URL del servizio a cui inviare la richiesta in entrata. Questo è il percorso relativo nel servizio di destinazione a cui devono essere inviati gli eventi per il trigger. Ad esempio: /, /route, route e route/subroute.

   10. (Facoltativo) Per abilitare i nuovi tentativi se il tentativo di consegna non va a buon fine, seleziona la casella di controllo Abilita ripetizione dei tentativi in caso di errore; in caso contrario, il comportamento predefinito è un singolo tentativo di consegna senza ripetizioni. Per saperne di più, consulta Nuovi tentativi per gli eventi.

6. Una volta compilati i campi obbligatori, fai clic su Salva attivatore.

7. Fai clic su Crea.

8. Nella scheda Origine, modifica il codice sorgente se necessario, poi seleziona Salva e ridistribuisci.

gcloud

Quando crei una funzione utilizzando gcloud CLI, devi prima eseguirne il deployment e poi creare un trigger. Per creare un trigger per la tua funzione:

1. Esegui questo comando nella directory che contiene il codice campione per eseguire il deployment della funzione:

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

   Sostituisci quanto segue:

   • FUNCTION: il nome della funzione di cui stai eseguendo il deployment. Puoi omettere completamente questo parametro, ma ti verrà chiesto il nome se lo ometti.

   • FUNCTION_ENTRYPOINT: l'entry point della funzione nel codice sorgente. Questo è il codice che Cloud Run esegue quando viene eseguita la funzione. Il valore di questo flag deve essere un nome di funzione o un nome di classe completo esistente nel codice sorgente.

   • BASE_IMAGE_ID: l'ambiente dell'immagine di base per la funzione. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Immagini di base dei runtime.

   • REGION: la regione Google Cloudin cui vuoi eseguire il deployment della funzione. Ad esempio: europe-west1.

2. Esegui questo comando per creare un trigger che filtri ed esegua il routing degli eventi:

   gcloud eventarc triggers create TRIGGER_NAME  \
       --location=LOCATION \
       --destination-run-service=FUNCTION  \
       --destination-run-region=DESTINATION_RUN_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=SERVICE_ACCOUNT_NAME@PROJECT_ID.
   

   Sostituisci quanto segue:

   • TRIGGER_NAME: l'ID del trigger o un identificatore completo.
   • LOCATION: la posizione del trigger Eventarc. In alternativa, puoi impostare la proprietà eventarc/location, ad esempio gcloud config set eventarc/location us-central1.

     Per evitare problemi di prestazioni e residenza dei dati, la località deve corrispondere a quella del Google Cloud servizio che genera eventi. Per saperne di più, consulta Località Eventarc.

   • FUNCTION: il nome della funzione Cloud Run di cui è stato eseguito il deployment che riceve gli eventi per il trigger.
   • DESTINATION_RUN_REGION: (facoltativo) la posizione di Cloud Run in cui si trova la funzione Cloud Run di destinazione. Se non specificato, si presume che la funzione si trovi nella stessa regione del trigger.
   • EVENT_FILTER_TYPE: l'identificatore dell'evento. Viene generato un evento quando una chiamata API per il metodo ha esito positivo. Per le operazioni a lunga esecuzione, l'evento viene generato solo al termine dell'operazione e solo se l'azione viene eseguita correttamente. Per un elenco dei tipi di eventi supportati, consulta Tipi di eventi Google supportati da Eventarc.
   • SERVICE_ACCOUNT_NAME: il nome del account di servizio gestito dall'utente.
   • PROJECT_ID: il tuo ID progetto Google Cloud .

   Note:

   • Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
   • --event-filters=type=google.cloud.firestore.document.v1.written specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di evento.
   • --event-filters=database='(default)' specifica il database Firebase. Per il nome del database predefinito, utilizza (default).
   • --event-filters-path-pattern=document='users/{username}' fornisce il pattern del percorso dei documenti da monitorare per le modifiche pertinenti. Questo pattern di percorso indica che devono essere monitorati tutti i documenti della raccolta users. Per saperne di più, vedi Informazioni sui pattern di percorso.
   • (Facoltativo) Per specificare un singolo tentativo di invio di eventi senza ripetizioni, utilizza il flag --max-retry-attempts. L'unico valore valido è 1. Se ometti il flag, viene applicato il comportamento di ripetizione standard. Per saperne di più, vedi Nuovi tentativi per gli eventi.
   • Sono disponibili altri flag. Per saperne di più, vedi gcloud eventarc triggers create.

Terraform

Per creare un trigger Eventarc per una funzione Cloud Run, consulta Creare un trigger utilizzando Terraform.

Utilizza gli altri campi così come sono:

• --event-filters=type=google.cloud.firestore.document.v1.written specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al google.cloud.firestore.document.v1.written tipo di evento.
• --event-filters=database='(default)' specifica il database Firestore. Per il nome del database predefinito, utilizza (default).
• --event-filters-path-pattern=document='messages/{pushId}' fornisce il pattern del percorso dei documenti che devono essere monitorati per rilevare modifiche pertinenti. Questo pattern di percorso indica che devono essere monitorati tutti i documenti nella raccolta messages. Per saperne di più, vedi Informazioni sui pattern di percorso.

Testare la funzione Converti in maiuscolo

Per testare la funzione Converti in maiuscolo che hai appena implementato, configura una raccolta denominata messages nel tuo database Firestore:

1. Nella console Google Cloud , vai alla pagina dei database Firestore:

   Vai a Firestore

2. Seleziona l'ID database per il tuo database Firestore.

3. Fai clic su Avvia una raccolta.

4. Specifica messages come ID raccolta.

5. Per iniziare ad aggiungere il primo documento della raccolta, accetta l'ID documento generato automaticamente in Aggiungi il primo documento.

6. Per attivare la funzione di cui è stato eseguito il deployment, aggiungi un documento in cui il Nome campo è original e il Valore campo è minka.

7. Quando salvi il documento, puoi vedere la parola in minuscolo nel campo valore convertita in maiuscolo.

   Se in seguito modifichi il valore del campo in modo che contenga lettere minuscole, la funzione viene attivata di nuovo, convertendo tutte le lettere minuscole in maiuscole.

Limitazioni per le funzioni

• L'ordinamento non è garantito. Le modifiche rapide possono attivare le chiamate di funzioni in un ordine imprevisto.
• Gli eventi vengono inviati almeno una volta, ma un singolo evento può comportare più chiamate di funzione. Evita di fare affidamento sulla meccanica di esecuzione "esattamente una volta" e scrivi funzioni idempotenti.
• Un trigger è associato a un singolo database. Non puoi creare un trigger che corrisponda a più database.
• L'eliminazione di un database non comporta l'eliminazione automatica di eventuali trigger per quel database. Il trigger smette di inviare eventi, ma continua a esistere finché non lo elimini.