Gestire le funzioni


Puoi eseguire il deployment, eliminare e modificare le funzioni utilizzando i Firebasecomandi dell'interfaccia a riga di comando o impostando le opzioni di runtime nel codice sorgente delle funzioni.

Esegui il deployment delle funzioni

Per eseguire il deployment delle funzioni, esegui questo comando CLI Firebase:

firebase deploy --only functions

Per impostazione predefinita, la CLI Firebase esegue il deployment di tutte le funzioni all'interno dell'origine contemporaneamente. Se il progetto contiene più di 5 funzioni, ti consigliamo di utilizzare il flag --only con nomi di funzioni specifici per eseguire il deployment solo delle funzioni che hai modificato. Deployment di funzioni specifiche In questo modo, il processo di deployment viene velocizzato e ti aiuta a evitare di raggiungere le quote di deployment. Ad esempio:

firebase deploy --only functions:addMessage,functions:makeUppercase

Quando esegui il deployment di un numero elevato di funzioni, potresti superare la quota standard e ricevere messaggi di errore HTTP 429 o 500. Per risolvere questo problema, esegui il deployment delle funzioni in gruppi di massimo 10.

Consulta la documentazione di riferimento della CLI Firebase per l'elenco completo dei comandi disponibili.

Per impostazione predefinita, la CLI Firebase cerca il codice sorgente nella cartella functions/. Se preferisci, puoi organizzare le funzioni in codebase o in più set di file.

Esegui la pulizia degli artefatti di deployment

Nell'ambito del deployment delle funzioni, le immagini container vengono generate e archiviate in Artifact Registry. Queste immagini non sono necessarie per l'esecuzione delle funzioni di cui è stato eseguito il deployment; Cloud Functions recupera e conserva una copia dell'immagine durante il deployment iniziale, ma gli artefatti archiviati non sono necessari per il funzionamento della funzione in fase di runtime.

Sebbene queste immagini container siano spesso piccole, possono accumularsi nel tempo e contribuire ai costi di archiviazione. Potresti preferire conservarli per un periodo di tempo se prevedi di ispezionare gli artefatti creati o eseguire scansioni delle vulnerabilità dei container.

Per gestire i costi di archiviazione, la CLI Firebase 14.0.0 e versioni successive ti consente di configurare un criterio di pulizia Artifact Registry per i repository che archiviano gli artefatti di deployment dopo ogni deployment della funzione.

Puoi configurare o modificare manualmente una policy di pulizia utilizzando il comando functions:artifacts:setpolicy:

firebase functions:artifacts:setpolicy

Per impostazione predefinita, questo comando configura Artifact Registry per eliminare automaticamente le immagini dei container più vecchie di un giorno. In questo modo si ottiene un equilibrio ragionevole tra la riduzione al minimo dei costi di archiviazione e la possibilità di ispezionare le build recenti.

Puoi personalizzare il periodo di conservazione utilizzando l'opzione --days:

firebase functions:artifacts:setpolicy --days 7  # Delete images older than 7 days

Se esegui il deployment delle funzioni in più regioni, puoi configurare un criterio di pulizia per una località specifica utilizzando l'opzione --location:

$ firebase functions:artifacts:setpolicy --location europe-west1

Disattivare la pulizia degli artefatti

Se preferisci gestire manualmente la pulizia delle immagini o se non vuoi che vengano eliminate, puoi disattivare completamente le norme di pulizia:

$ firebase functions:artifacts:setpolicy --none

Questo comando rimuove qualsiasi criterio di pulizia esistente configurato dall'interfaccia a riga di comando di Firebase e impedisce a Firebase di configurare un criterio di pulizia dopo i deployment delle funzioni.

Elimina funzioni

Puoi eliminare le funzioni di cui è stato eseguito il deployment in precedenza nei seguenti modi:

  • esplicitamente nella CLI Firebase con functions:delete
  • esplicitamente nella consoleGoogle Cloud.
  • Implicitamente rimuovendo la funzione dall'origine prima del deployment.

Tutte le operazioni di eliminazione ti chiedono di confermare prima di rimuovere la funzione dalla produzione.

L'eliminazione esplicita delle funzioni nell'interfaccia a riga di comando Firebase supporta più argomenti nonché gruppi di funzioni e consente di specificare una funzione in esecuzione in una determinata regione. Inoltre, puoi ignorare la richiesta di conferma.

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction

# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1

# Delete more than one function
firebase functions:delete myFunction myOtherFunction

# Delete a specified functions group.
firebase functions:delete groupA

# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

Con l'eliminazione implicita delle funzioni, firebase deploy analizza l'origine e rimuove dalla produzione tutte le funzioni che sono state rimosse dal file.

Modificare il nome, la regione o il trigger di una funzione

Se stai rinominando o modificando le regioni o il trigger per le funzioni che gestiscono il traffico di produzione, segui i passaggi descritti in questa sezione per evitare di perdere eventi durante la modifica. Prima di seguire questi passaggi, assicurati che la tua funzione sia idempotente, poiché la nuova e la vecchia versione della funzione verranno eseguite contemporaneamente durante la modifica.

Rinominare una funzione

Per rinominare una funzione, crea una nuova versione rinominata della funzione nell'origine e poi esegui due comandi di deployment separati. Il primo comando esegue il deployment della funzione con il nuovo nome, mentre il secondo rimuove la versione di cui è stato eseguito il deployment in precedenza. Ad esempio, se hai una funzione Node.js denominata webhook che vuoi modificare in webhookNew, rivedi il codice nel seguente modo:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

Quindi esegui questi comandi per eseguire il deployment della nuova funzione:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Modificare la regione o le regioni di una funzione

Se stai modificando le regioni specificate per una funzione che gestisce il traffico di produzione, puoi evitare la perdita di eventi eseguendo questi passaggi in ordine:

  1. Rinomina la funzione e modifica la regione o le regioni come preferisci.
  2. Esegui il deployment della funzione rinominata, il che comporta l'esecuzione temporanea dello stesso codice in entrambi i gruppi di regioni.
  3. Elimina la funzione precedente.

Ad esempio, se hai una funzione chiamata webhook che si trova attualmente nella regione delle funzioni predefinita di us-central1 e vuoi eseguirne la migrazione a asia-northeast1, devi prima modificare il codice sorgente per rinominare la funzione e rivedere la regione.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

Quindi esegui il deployment eseguendo:

firebase deploy --only functions:webhookAsia

Ora sono in esecuzione due funzioni identiche: webhook è in esecuzione in us-central1 e webhookAsia è in esecuzione in asia-northeast1.

Quindi, elimina webhook:

firebase functions:delete webhook

Ora è presente una sola funzione, webhookAsia, in esecuzione in asia-northeast1.

Modificare il tipo di trigger di una funzione

Man mano che sviluppi il deployment di Cloud Functions for Firebase nel tempo, potresti dover modificare il tipo di trigger di una funzione per vari motivi. Ad esempio, potresti voler passare da un tipo di evento Firebase Realtime Database o Cloud Firestore a un altro tipo.

Non è possibile modificare il tipo di evento di una funzione semplicemente modificando il codice sorgente ed eseguendo firebase deploy. Per evitare errori, modifica il tipo di attivatore di una funzione seguendo questa procedura:

  1. Modifica il codice sorgente per includere una nuova funzione con il tipo di trigger desiderato.
  2. Esegui il deployment della funzione, che comporta l'esecuzione temporanea sia della funzione precedente che di quella nuova.
  3. Elimina esplicitamente la vecchia funzione dalla produzione utilizzando la CLI Firebase.

Ad esempio, se avevi una funzione Node.js denominata objectChanged con il tipo di evento legacy onChange e vuoi modificarlo in onFinalize, rinomina prima la funzione e modificala in modo che abbia il tipo di evento onFinalize.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

Quindi esegui questi comandi per creare prima la nuova funzione, prima di eliminare quella precedente:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Impostare le opzioni di runtime

Cloud Functions for Firebase ti consente di selezionare opzioni di runtime come la versione del runtime Node.js e il timeout per funzione, l'allocazione di memoria e le istanze di funzione minime/massime.

Come best practice, queste opzioni (ad eccezione della versione di Node.js) devono essere impostate su un oggetto di configurazione all'interno del codice della funzione. Questo oggetto RuntimeOptions è l'origine attendibile per le opzioni di runtime della tua funzione e sostituirà le opzioni impostate tramite qualsiasi altro metodo (ad esempio tramite la console Google Cloud o gcloud CLI).

Se il tuo flusso di lavoro di sviluppo prevede l'impostazione manuale delle opzioni di runtime tramite Google Cloud Console o gcloud CLI e non vuoi che questi valori vengano sovrascritti a ogni deployment, imposta l'opzione preserveExternalChanges su true. Se questa opzione è impostata su true, Firebase unisce le opzioni di runtime impostate nel codice con le impostazioni della versione della funzione attualmente implementata con la seguente priorità:

  1. L'opzione è impostata nel codice delle funzioni: esegui l'override delle modifiche esterne.
  2. L'opzione è impostata su RESET_VALUE nel codice delle funzioni: esegui l'override delle modifiche esterne con il valore predefinito.
  3. L'opzione non è impostata nel codice delle funzioni, ma è impostata nella funzione attualmente di cui è stato eseguito il deployment: utilizza l'opzione specificata nella funzione di cui è stato eseguito il deployment.

L'utilizzo dell'opzione preserveExternalChanges: true non è consigliato per la maggior parte degli scenari perché il codice non sarà più l'unica fonte di verità per le opzioni di runtime delle tue funzioni. Se lo utilizzi, controlla la console Google Cloud o utilizza gcloud CLI per visualizzare la configurazione completa di una funzione.

Imposta la versione di Node.js

L'SDK Firebase per Cloud Functions consente di selezionare il runtime Node.js. Puoi scegliere di eseguire tutte le funzioni di un progetto esclusivamente nell'ambiente di runtime corrispondente a una di queste versioni di Node.js supportate:

  • Node.js 20
  • Node.js 18 (obsoleto)

Consulta il programma di assistenza per informazioni importanti sull'assistenza continua per queste versioni di Node.js.

Per impostare la versione di Node.js:

Puoi impostare la versione nel campo engines del file package.json creato nella directory functions/ durante l'inizializzazione. Ad esempio, per utilizzare solo la versione 20, modifica questa riga in package.json:

  "engines": {"node": "20"}

Se utilizzi il gestore di pacchetti Yarn o hai altri requisiti specifici per il campo engines, puoi impostare il runtime per l'SDK Firebase per Cloud Functions in firebase.json:

  {
    "functions": {
      "runtime": "nodejs20"
    }
  }

La CLI utilizza il valore impostato in firebase.json anziché qualsiasi valore o intervallo impostato separatamente in package.json.

Esegui l'upgrade del runtime Node.js

Per eseguire l'upgrade del runtime Node.js:

  1. Assicurati che il tuo progetto utilizzi il piano tariffario Blaze.
  2. Assicurati di utilizzare Firebase CLI v11.18.0 o versioni successive.
  3. Modifica il valore engines nel file package.json creato nella directory functions/ durante l'inizializzazione. Ad esempio, se esegui l'upgrade dalla versione 16 alla versione 18, la voce dovrebbe avere questo aspetto: "engines": {"node": "18"}
  4. (Facoltativo) Testa le modifiche utilizzando Firebase Local Emulator Suite.
  5. Esegui nuovamente il deployment di tutte le funzioni.

Controllare il comportamento di scalabilità

Per impostazione predefinita, Cloud Functions for Firebase adatta il numero di istanze in esecuzione in base al numero di richieste in entrata, con la possibilità di ridurre il numero di istanze a zero in periodi di traffico ridotto. Tuttavia, se la tua app richiede una latenza ridotta e vuoi limitare il numero di avvii a freddo, puoi modificare questo comportamento predefinito specificando un numero minimo di istanze di container da mantenere in uso e pronte per gestire le richieste.

Allo stesso modo, puoi impostare un numero massimo per limitare lo scaling delle istanze in risposta alle richieste in entrata. Utilizza questa impostazione per controllare i costi o per limitare il numero di connessioni a un servizio di backend, ad esempio a un database.

Ridurre il numero di avvii a freddo

Per impostare il numero minimo di istanze per una funzione nel codice sorgente, utilizza il metodo runWith. Questo metodo accetta un oggetto JSON conforme all'interfaccia RuntimeOptions, che definisce il valore di minInstances. Ad esempio, questa funzione imposta un minimo di 5 istanze da mantenere in uso:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });
index.js

Ecco alcuni aspetti da considerare quando imposti un valore per minInstances:

  • Se Cloud Functions for Firebase esegue lo scale up della tua app al di sopra dell'impostazione minInstances, si verificherà un avvio a freddo per ogni istanza al di sopra di questa soglia.
  • Gli avvii a freddo hanno l'effetto più grave sulle app con picchi di traffico. Se la tua app ha un traffico variabile e imposti un valore minInstances sufficientemente alto da ridurre gli avvii a freddo a ogni aumento del traffico, noterai una latenza significativamente ridotta. Per le app con traffico costante, è improbabile che gli avvii a freddo influiscano gravemente sulle prestazioni.

  • L'impostazione delle istanze minime può essere utile per gli ambienti di produzione, ma in genere deve essere evitata negli ambienti di test. Per scalare a zero nel progetto di test, ma ridurre comunque gli avvii a freddo nel progetto di produzione, puoi impostare minInstances in base alla variabile di ambiente FIREBASE_CONFIG:

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      // in production only. Default to 0 for test projects.
      minInstances: envProjectId === "my-production-project" ? 5 : 0,
    })
    .https.onRequest((req, res) => {
      // render some html
    });
    index.js

Limitare il numero massimo di istanze per una funzione

Per impostare il numero massimo di istanze nel codice sorgente della funzione, utilizza il metodo runWith. Questo metodo accetta un oggetto JSON conforme all'interfaccia RuntimeOptions, che definisce i valori per maxInstances. Ad esempio, questa funzione imposta un limite di 100 istanze per non sovraccaricare un ipotetico database legacy:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });
index.js

Se una funzione HTTP viene scalata fino al limite di maxInstances, le nuove richieste vengono inserite in coda per 30 secondi e poi rifiutate con un codice di risposta 429 Too Many Requests se nessuna istanza è disponibile entro questo periodo.

Per scoprire di più sulle best practice per l'utilizzo delle impostazioni relative al numero massimo di istanze, consulta queste best practice per l'utilizzo di maxInstances.

Impostare il timeout e l'allocazione della memoria

In alcuni casi, le tue funzioni potrebbero avere requisiti speciali per un valore di timeout lungo o una grande allocazione di memoria. Puoi impostare questi valori nella console Google Cloud o nel codice sorgente della funzione (solo Firebase).

Per impostare l'allocazione della memoria e il timeout nel codice sorgente delle funzioni, utilizza il parametro runWith introdotto nell'SDK Firebase per Cloud Functions 2.0.0. Questa opzione di runtime accetta un oggetto JSON conforme all'interfaccia RuntimeOptions, che definisce i valori per timeoutSeconds e memory. Ad esempio, questa funzione di archiviazione utilizza 1 GB di memoria e va in timeout dopo 300 secondi:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });
index.js

Il valore massimo per timeoutSeconds è 540 o 9 minuti. La quantità di memoria concessa a una funzione corrisponde alla CPU allocata per la funzione, come descritto in questo elenco di valori validi per memory:

  • 128MB - 200 MHz
  • 256MB - 400 MHz
  • 512MB - 800 MHz
  • 1GB - 1,4 GHz
  • 2GB - 2,4 GHz
  • 4GB - 4,8 GHz
  • 8GB - 4,8 GHz

Per impostare l'allocazione della memoria e il timeout nella console Google Cloud:

  1. Nella console Google Google Cloud, seleziona Cloud Functions dal menu a sinistra.
  2. Seleziona una funzione facendo clic sul suo nome nell'elenco delle funzioni.
  3. Fai clic sull'icona Modifica nel menu in alto.
  4. Seleziona un'allocazione di memoria dal menu a discesa etichettato Memoria allocata.
  5. Fai clic su Altro per visualizzare le opzioni avanzate e inserisci un numero di secondi nella casella di testo Timeout.
  6. Fai clic su Salva per aggiornare la funzione.