Upgrade delle funzioni Node.js di 1a generazione alla 2a generazione

Le app che utilizzano funzioni di 1ª gen. devono valutare la migrazione alla 2ª gen. seguendo le istruzioni riportate in questa guida. Le funzioni di 2ª gen. utilizzano Cloud Run per offrire prestazioni, configurazione e monitoraggio migliori e altro ancora.

Gli esempi in questo documento presuppongono che tu stia utilizzando JavaScript con i moduli CommonJS (importazioni in stile require), ma gli stessi principi si applicano a JavaScript con ESM (importazioni in stile import … from) e TypeScript.

Il processo di migrazione

Le funzioni di 1ª gen. e 2ª gen. possono coesistere nello stesso file sorgente. In questo modo puoi eseguire la migrazione del codebase pezzo per pezzo, quando è tutto pronto. Tieni presente, tuttavia, che questa combinazione di pacchetti non funziona all'interno di una singola funzione discreta.

Ti consigliamo di eseguire la migrazione di una funzione alla volta, eseguendo test e verifica prima di procedere.

Verificare le versioni di Firebase CLI e firebase-function

Assicurati di utilizzare almeno la versione Firebase della CLI 12.00 e la versione firebase-functions di 4.3.0. Qualsiasi versione più recente supporterà sia la 2ª che la 1ª gen.

Aggiorna importazioni

Le funzioni di 2ª gen. vengono importate dal sottopacchetto v2 nell'SDK firebase-functions. Questo percorso di importazione diverso è tutto ciò di cui ha bisogno la CLI Firebase per determinare se eseguire il deployment del codice della funzione come funzione di 1ª o 2ª gen.

Il sottopacchetto v2 è modulare e ti consigliamo di importare solo il modulo specifico di cui hai bisogno.

Prima: 1ª gen.

const functions = require("firebase-functions/v1");

Dopo: 2ª gen.

// explicitly import each trigger
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

Aggiorna le definizioni dei trigger

Poiché l'SDK di 2ª gen. favorisce le importazioni modulari, aggiorna le definizioni dei trigger in modo che riflettano le importazioni modificate del passaggio precedente.

Gli argomenti passati ai callback per alcuni trigger sono stati modificati. In questo esempio, nota che gli argomenti del callback onDocumentCreated sono stati consolidati in un unico oggetto event. Inoltre, alcuni trigger dispongono di nuove pratiche funzionalità di configurazione, come l'opzione cors del trigger onRequest.

Prima: 1ª gen.

const functions = require("firebase-functions/v1");

exports.date = functions.https.onRequest((req, res) => {
  // ...
});

exports.uppercase = functions.firestore
  .document("my-collection/{docId}")
  .onCreate((change, context) => {
    // ...
  });

Dopo: 2ª gen.

const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

exports.date = onRequest({cors: true}, (req, res) => {
  // ...
});

exports.uppercase = onDocumentCreated("my-collection/{docId}", (event) => {
  /* ... */
});

Ridurre al minimo gli sforzi di riscrittura con la destrutturazione di JavaScript

Se le tue funzioni hanno corpi complessi che si basano fortemente sul contesto di 1ª gen. o su parametri specifici del provider (come message o snapshot), puoi utilizzare gli helper di compatibilità di 1ª gen. integrati nell'SDK di 2ª gen.

L'SDK di 2ª gen. applica automaticamente patch all'oggetto evento con getter che corrispondono alle firme di 1ª gen.. In questo modo puoi utilizzare la destrutturazione JavaScript per estrarre queste proprietà direttamente nella firma del gestore, riducendo al minimo la necessità di riscrivere la logica della funzione.

Riferimento per la mappatura dei provider

Fornitore Argomenti di 1ª gen. 2nd gen Patched Event Destructuring
Pub/Sub (message, context) ({ message, context }) => { ... }
Firestore (snapshot, context) ({ snapshot, context }) => { ... }
Archiviazione (object, context) ({ object, context }) => { ... }
Realtime Database (snapshot, context) ({ snapshot, context }) => { ... }
Remote Config (version, context) ({ version, context }) => { ... }
Scheduler (context) ({ context }) => { ... }
Coda di attività (data, context) ({ data, context }) => { ... }

Prima (1ª gen.):

export const myPubSubV1 = functions.pubsub.topic("my-topic").onPublish((message, context) => {
  const data = message.json;
  const eventId = context.eventId;
  // ... rest of the logic
});

Nuova alternativa (2ª gen. con destrutturazione):

import { onMessagePublished } from "firebase-functions/v2/pubsub";

export const myPubSubV2 = onMessagePublished("my-topic", ({ message, context }) => {
  // No need to change the function body!
  const data = message.json;      // Uses v1 Message wrapper
  const eventId = context.eventId; // Uses v1 EventContext map
  // ... rest of the logic
});

Utilizzare la configurazione con parametri

Le funzioni di 2ª gen. non supportano più functions.config a favore di un'interfaccia più sicura per definire i parametri di configurazione in modo dichiarativo all'interno del codebase. Con il nuovo modulo params, la CLI blocca il deployment a meno che tutti i parametri non abbiano un valore valido, garantendo che una funzione non venga sottoposta a deployment con una configurazione mancante.

Prima: 1ª gen.

const functions = require("firebase-functions/v1");

exports.getQuote = functions.https.onRequest(async (req, res) => {
  const quote = await fetchMotivationalQuote(functions.config().apiKey);
  // ...
});

Dopo: 2ª gen.

const {onRequest} = require("firebase-functions/v2/https");
const {defineSecret} = require("firebase-functions/params");

// Define the secret parameter
const apiKey = defineSecret("API_KEY");

exports.getQuote = onRequest(
  // make the secret available to this function
  { secrets: [apiKey] },
  async (req, res) => {
    // retrieve the value of the secret
    const quote = await fetchMotivationalQuote(apiKey.value());
    // ...
  }
);

Se hai una configurazione dell'ambiente esistente con functions.config, esegui la migrazione di questa configurazione nell'ambito dell'upgrade alla 2ª gen.

L'API functions.config è obsoleta e verrà ritirata a marzo 2027. Dopo questa data, i deployment con functions.config non andranno a buon fine.

Per evitare errori di deployment, esegui la migrazione della configurazione a Cloud Secret Manager utilizzando la CLI Firebase. Questa opzione è vivamente consigliata in quanto è il modo più efficiente e sicuro per eseguire la migrazione della configurazione.

  1. Configurazione dell'esportazione con l'interfaccia a riga di comando di Firebase

    Utilizza il comando config export per esportare la configurazione dell'ambiente esistente in un nuovo secret in Cloud Secret Manager:

    $ firebase functions:config:export
i  This command retrieves your Runtime Config values (accessed via functions.config())
   and exports them as a Secret Manager secret.

i  Fetching your existing functions.config() from your project...  ✔
   Fetched your existing functions.config().

i  Configuration to be exported:
⚠  This may contain sensitive data. Do not share this output.

{
   ...
}

✔ What would you like to name the new secret for your configuration? RUNTIME_CONFIG

✔  Created new secret version projects/project/secrets/RUNTIME_CONFIG/versions/1```

  2. Aggiorna il codice della funzione per associare i secret

    Per utilizzare la configurazione archiviata nel nuovo secret in Secret Manager di Cloud, utilizza l'API defineJsonSecret nell'origine della funzione. Inoltre, assicurati che i secret siano associati a tutte le funzioni che ne hanno bisogno.

    Prima

    const functions = require("firebase-functions/v1");

exports.myFunction = functions.https.onRequest((req, res) => {
  const apiKey = functions.config().someapi.key;
  // ...
});

    Dopo

    const { onRequest } = require("firebase-functions/v2/https");
const { defineJsonSecret } = require("firebase-functions/params");

const config = defineJsonSecret("RUNTIME_CONFIG");

exports.myFunction = onRequest(
  // Bind secret to your function
  { secrets: [config] },
  (req, res) => {
    // Access secret values via .value()
    const apiKey = config.value().someapi.key;
    // ...
});

  3. Esegui il deployment delle funzioni

    Esegui il deployment delle funzioni aggiornate per applicare le modifiche e associare le autorizzazioni del secret.

    firebase deploy --only functions:<your-function-name>

Impostare le opzioni di runtime

La configurazione delle opzioni di runtime è cambiata tra la 1ª e la 2ª gen. La 2ª gen. aggiunge anche una nuova funzionalità per impostare le opzioni per tutte le funzioni.

Prima: 1ª gen.

const functions = require("firebase-functions/v1");

exports.date = functions
  .runWith({
    // Keep 5 instances warm for this latency-critical function
    minInstances: 5,
  })
  // locate function closest to users
  .region("asia-northeast1")
  .https.onRequest((req, res) => {
    // ...
  });

exports.uppercase = functions
  // locate function closest to users and database
  .region("asia-northeast1")
  .firestore.document("my-collection/{docId}")
  .onCreate((change, context) => {
    // ...
  });

Dopo: 2ª gen.

const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");
const {setGlobalOptions} = require("firebase-functions/v2");

// locate all functions closest to users
setGlobalOptions({ region: "asia-northeast1" });

exports.date = onRequest({
    // Keep 5 instances warm for this latency-critical function
    minInstances: 5,
  }, (req, res) => {
  // ...
});

exports.uppercase = onDocumentCreated("my-collection/{docId}", (event) => {
  /* ... */
});

Aggiorna il service account predefinito (facoltativo)

Mentre le funzioni di 1ª gen. utilizzano il service account predefinito di Google App Engine per autorizzare l'accesso alle API Firebase, le funzioni di 2ª gen. utilizzano il service account predefinito di Compute Engine. Questa differenza può causare problemi di autorizzazioni per le funzioni migrate alla 2ª gen. nei casi in cui hai concesso autorizzazioni speciali al service account di 1ª gen.. Se non hai modificato le autorizzazioni del service account, puoi saltare questo passaggio.

La soluzione consigliata è assegnare esplicitamente il service account predefinito di App Engine di 1ª gen. esistente alle funzioni di cui vuoi eseguire la migrazione alla 2ª gen., sovrascrivendo il valore predefinito della 2ª gen. Puoi farlo assicurandoti che ogni funzione di cui è stata eseguita la migrazione imposti il valore corretto per serviceAccountEmail:

const {onRequest} = require("firebase-functions/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");
const {setGlobalOptions} = require("firebase-functions");

// Use the App Engine default service account for all functions
setGlobalOptions({serviceAccountEmail: '<my-project-number>@<wbr>appspot.gserviceaccount.com'});

// Now I use the App Engine default service account.
exports.date = onRequest({cors: true}, (req, res) => {
  // ...
});

// I do too!
exports.uppercase = onDocumentCreated("my-collection/{docId}", (event) => {
  // ...
});

In alternativa, puoi assicurarti di modificare i dettagli del service account in modo che corrispondano a tutte le autorizzazioni necessarie sia per il service account predefinito di App Engine (per la 1ª gen.) sia per il service account predefinito di Compute Engine (per la 2ª gen.).

Utilizzare la concorrenza

Un vantaggio significativo delle funzioni di seconda generazione è la capacità di una singola istanza di funzione di gestire più richieste contemporaneamente. Ciò può ridurre drasticamente il numero di avvii a freddo riscontrati dagli utenti finali. Per impostazione predefinita, la concorrenza è impostata su 80, ma puoi impostarla su qualsiasi valore da 1 a 1000:

const {onRequest} = require("firebase-functions/v2/https");

exports.date = onRequest({
    // set concurrency value
    concurrency: 500
  },
  (req, res) => {
    // ...
});

La regolazione della concorrenza può migliorare le prestazioni e ridurre il costo delle funzioni. Scopri di più sulla concorrenza in Consenti richieste simultanee.

Controllare l'utilizzo delle variabili globali

Le funzioni di 1ª gen. scritte senza tenere conto della concorrenza potrebbero utilizzare variabili globali che vengono impostate e lette a ogni richiesta. Quando la concorrenza è abilitata e una singola istanza inizia a gestire più richieste contemporaneamente, potrebbero verificarsi bug nella funzione quando le richieste simultanee iniziano a impostare e leggere le variabili globali contemporaneamente.

Durante l'upgrade, puoi impostare la CPU della funzione su gcf_gen1 e impostare concurrency su 1 per ripristinare il comportamento di 1ª gen.:

const {onRequest} = require("firebase-functions/v2/https");

exports.date = onRequest({
    // TEMPORARY FIX: remove concurrency
    cpu: "gcf_gen1",
    concurrency: 1
  },
  (req, res) => {
    // ...
});

Tuttavia, questa soluzione non è consigliata come correzione a lungo termine, perché rinuncia ai vantaggi in termini di prestazioni delle funzioni di 2ª gen. Controlla invece l'utilizzo delle variabili globali nelle tue funzioni e rimuovi queste impostazioni temporanee quando è tutto pronto.

Eseguire la migrazione del traffico alle nuove funzioni di 2ª gen.

Proprio come quando modificavi la regione o il tipo di trigger di una funzione, dovrai assegnare un nuovo nome alla funzione di 2ª gen. e migrare lentamente il traffico.

Non è possibile eseguire l'upgrade di una funzione dalla 1ª alla 2ª gen. con lo stesso nome ed eseguire firebase deploy. In questo modo, verrà visualizzato l'errore:

Upgrading from GCFv1 to GCFv2 is not yet supported. Please delete your old function or wait for this feature to be ready.

La strategia di migrazione dipende dal tipo di trigger utilizzato dalla funzione.

Esegui la migrazione dei trigger chiamabili, di Task Queue e HTTP

Questi trigger sono invocazioni dirette. Poiché la funzione di 2ª gen. avrà un nuovo nome (e un nuovo URL per i trigger HTTP), puoi eseguire la migrazione del traffico aggiornando i client.

  1. Rinomina la funzione nel codice (ad esempio, rinomina myCallable in myCallableV2).
  2. Eseguire il deployment della funzione. Ora sono in esecuzione sia la funzione di 1ª gen. sia quella di 2ª gen.
  3. Aggiorna il codice client o il chiamante in modo che punti al nuovo nome o URL della funzione di 2ª gen.
  4. Una volta che tutto il traffico è stato spostato sulla nuova funzione, elimina la funzione di 1ª gen. utilizzando il comando firebase functions:delete dell'interfaccia a riga di comando di Firebase.

Migrazione dei trigger in background

I trigger in background (come i trigger Pub/Sub, Cloud Firestore e Cloud Storage) rispondono agli eventi nel tuo progetto. Per evitare di perdere eventi durante la transizione, devi eseguire temporaneamente le funzioni di 1ª gen. e 2ª gen. contemporaneamente.

Durante il periodo di transizione, entrambe le funzioni verranno attivate dallo stesso evento. Ciò significa che la logica di business verrà eseguita due volte per evento. Prima di procedere, assicurati che la funzione sia idempotente.

  1. Aggiungi la funzione di 2ª gen. accanto a quella di 1ª gen., mantenendo la funzione di 1ª gen. esistente nel codice e aggiungendo la funzione di 2ª gen. in ascolto della stessa origine eventi.

    import * as functions from "firebase-functions/v1";
import { onMessagePublished } from "firebase-functions/v2/pubsub";

// --- Existing 1st gen function ---
export const myPubSub = functions.pubsub.topic("my-topic").onPublish((message, context) => {
  console.log("V1 handler running for event:", context.eventId);
  // ... existing v1 function logic ...
});

// --- New v2 passthrough function ---
export const myPubSubV2 = onMessagePublished("my-topic", async ({ message, context }) => {
  console.log("v2 handler triggering V1 for event:", context.eventId);
  // Call the v1 function's handler
  await myPubSub.run(message, context);
});

  2. Esegui firebase deploy. Entrambe le funzioni sono ora attive e in ascolto degli stessi eventi.

  3. Verifica che la funzione di 2ª gen. riceva traffico. Monitora i log di entrambe le funzioni. Assicurati che la funzione di 2ª gen. venga richiamata per tutti gli eventi e che le chiamate vadano a buon fine.

  4. Quando hai la certezza che la funzione funzioni correttamente, sposta la logica di business effettiva dalla funzione di 1ª gen. nel corpo della funzione di 2ª gen. Se hai utilizzato il metodo passthrough, rimuovi la chiamata a myPubSub.run().

    import * as functions from "firebase-functions/v1";
import { onMessagePublished } from "firebase-functions/v2/pubsub";

// --- Existing v1 function (to be removed next) ---
export const myPubSub = functions.pubsub.topic("my-topic").onPublish((message, context) => {
  console.log("v1 handler running for event:", context.eventId);
  // ... existing v1 function logic ...
});

// --- New v2 function with full logic ---
export const myPubSubV2 = onMessagePublished("my-topic", ({ message, context }) => {
  console.log("v2 handler running for event:", context.eventId);
  // ... existing v1 function logic WAS MOVED HERE ...
});

    Esegui il deployment di questa modifica.

  5. Rimuovi la definizione della funzione di 1ª gen. dal codice ed esegui nuovamente il deployment. La CLI ti chiederà di eliminare la funzione di 1ª gen. da Google Cloud.