Gestire le funzioni


Puoi distribuire, eliminare e modificare le funzioni utilizzando i comandi CLI di Firebase o impostando le opzioni di runtime nel codice sorgente delle funzioni.

Distribuire funzioni

Per distribuire le funzioni, esegui questo comando CLI di Firebase:

firebase deploy --only functions

Per impostazione predefinita, la CLI Firebase distribuisce tutte le funzioni all'interno dell'origine contemporaneamente. Se il tuo progetto contiene più di 5 funzioni, ti consigliamo di utilizzare il flag --only con nomi di funzioni specifici per distribuire solo le funzioni che hai modificato. La distribuzione di funzioni specifiche in questo modo accelera il processo di distribuzione e aiuta a evitare di incorrere in quote di distribuzione. Per esempio:

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

Quando si distribuiscono un numero elevato di funzioni, è possibile superare la quota standard e ricevere messaggi di errore HTTP 429 o 500. Per risolvere questo problema, distribuire le funzioni in gruppi di 10 o meno.

Consulta il riferimento alla CLI di Firebase per l'elenco completo dei comandi disponibili.

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

Elimina funzioni

È possibile eliminare le funzioni precedentemente distribuite in questi modi:

  • esplicitamente nella CLI Firebase con functions:delete
  • esplicitamente in Google Cloud Console .
  • implicitamente rimuovendo la funzione dall'origine prima della distribuzione.

Tutte le operazioni di cancellazione richiedono una conferma prima di rimuovere la funzione dalla produzione.

L'eliminazione esplicita delle funzioni nella CLI di Firebase supporta più argomenti e gruppi di funzioni e consente di specificare una funzione in esecuzione in una particolare regione. Inoltre, è possibile 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.

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

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

Rinominare una funzione

Per rinominare una funzione, crea una nuova versione rinominata della funzione nell'origine e quindi esegui due comandi di distribuzione separati. Il primo comando distribuisce la funzione appena denominata e il secondo comando rimuove la versione precedentemente distribuita. Ad esempio, se disponi di una funzione Node.js chiamata webhook che desideri modificare in webhookNew , rivedi il codice come segue:

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

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

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

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

Quindi esegui i seguenti comandi per distribuire la 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 prevenire la perdita di eventi eseguendo questi passaggi in ordine:

  1. Rinominare la funzione e modificarne la regione o le regioni come desiderato.
  2. Distribuire la funzione rinominata, che comporta l'esecuzione temporanea dello stesso codice in entrambi i gruppi di regioni.
  3. Elimina la funzione precedente.

Ad esempio, se disponi di una funzione chiamata webhook che si trova attualmente nella regione delle funzioni predefinite di us-central1 e desideri migrarla in asia-northeast1 , devi prima modificare il codice sorgente per rinominare la funzione e rivedere la regione .

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

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

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

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

Quindi distribuire eseguendo:

firebase deploy --only functions:webhookAsia

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

Quindi, elimina webhook :

firebase functions:delete webhook

Ora c'è solo una funzione: webhookAsia , che è in esecuzione in asia-northeast1 .

Modificare il tipo di trigger di una funzione

Man mano che sviluppi la distribuzione di Cloud Functions for Firebase nel tempo, potrebbe essere necessario 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, modificare il tipo di trigger di una funzione con questa procedura:

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

Ad esempio, se disponi di una funzione Node.js denominata objectChanged che ha il tipo di evento legacy onChange e desideri cambiarla in onFinalize , prima rinomina la funzione e modificala per avere il tipo di evento onFinalize .

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

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

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

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

Quindi esegui i seguenti comandi per creare prima la nuova funzione, prima di eliminare la vecchia funzione:

# 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

Imposta le opzioni di esecuzione

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

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

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

  1. L'opzione è impostata nel codice delle funzioni: sovrascrive le modifiche esterne.
  2. L'opzione è impostata su RESET_VALUE nel codice delle funzioni: sovrascrive le modifiche esterne con il valore predefinito.
  3. L'opzione non è impostata nel codice delle funzioni, ma è impostata nella funzione attualmente distribuita: utilizzare l'opzione specificata nella funzione distribuita.

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

Imposta la versione di Node.js

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

  • Node.js 20 (anteprima)
  • Node.js 18
  • Node.js 16
  • Node.js 14

Per impostare la versione di Node.js:

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

  "engines": {"node": "18"}

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

  {
    "functions": {
      "runtime": "nodejs18" // or nodejs14, nodejs16 or nodejs20
    }
  }

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

Aggiorna il tuo runtime Node.js

Per aggiornare il tuo runtime Node.js:

  1. Assicurati che il tuo progetto sia incluso nel piano tariffario Blaze .
  2. Assicurati di utilizzare la CLI Firebase v11.18.0 o successiva.
  3. Modifica il valore engines nel file package.json creato nella directory functions/ durante l'inizializzazione. Ad esempio, se stai aggiornando dalla versione 16 alla versione 18, la voce dovrebbe essere simile a questa: "engines": {"node": "18"}
  4. Facoltativamente, prova le modifiche utilizzando Firebase Local Emulator Suite .
  5. Ridistribuire tutte le funzioni.

Controllare il comportamento di ridimensionamento

Per impostazione predefinita, Cloud Functions for Firebase ridimensiona il numero di istanze in esecuzione in base al numero di richieste in entrata, riducendo potenzialmente fino a zero istanze in periodi di traffico ridotto. Tuttavia, se la tua app richiede una latenza ridotta e desideri limitare il numero di avvii a freddo, puoi modificare questo comportamento predefinito specificando un numero minimo di istanze di contenitore da mantenere attive e pronte a servire le richieste.

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

Ridurre il numero di avviamenti a freddo

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

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 alcune cose da considerare quando si imposta un valore per minInstances :

  • Se Cloud Functions for Firebase ridimensiona la tua app al di sopra dell'impostazione minInstances , si verificherà un avvio a freddo per ogni istanza superiore a tale soglia.
  • Gli avvii a freddo hanno l'effetto più grave sulle app con traffico intenso. Se la tua app presenta picchi di traffico e imposti un valore minInstances sufficientemente alto da ridurre gli avviamenti a freddo a ogni aumento del traffico, noterai una latenza notevolmente ridotta. Per le app con traffico costante, è improbabile che gli avvii a freddo influenzino gravemente le prestazioni.

  • L'impostazione di istanze minime può avere senso per gli ambienti di produzione, ma in genere dovrebbe essere evitata negli ambienti di test. Per scalare a zero nel tuo progetto di test ma ridurre comunque gli avvii a freddo nel tuo 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

Limita il numero massimo di istanze per una funzione

Per impostare il numero massimo di istanze nel codice sorgente della funzione, utilizzare 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 maxInstances , le nuove richieste vengono accodate per 30 secondi e quindi rifiutate con un codice di risposta di 429 Too Many Requests se entro quel momento non è disponibile alcuna istanza.

Per ulteriori informazioni sulle best practice per l'utilizzo delle impostazioni del numero massimo di istanze, consulta queste best practice per l'utilizzo maxInstances .

Imposta il timeout e l'allocazione della memoria

In alcuni casi, le funzioni potrebbero avere requisiti speciali per un valore di timeout lungo o una grande allocazione di memoria. Puoi impostare questi valori in Google Cloud Console 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 in Firebase SDK for 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 scade 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 dettagliato in questo elenco di valori validi per memory :

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

Per impostare l'allocazione della memoria e il timeout in Google Cloud Console:

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