Utilizza l'emulatore di estensioni per valutare le estensioni

Prima di utilizzare l'emulatore di estensioni con la tua app, assicurati di comprendere il flusso di lavoro generale di Firebase Local Emulator Suite , di installare e configurare Local Emulator Suite ed esaminare i relativi comandi CLI .

Questa guida presuppone inoltre che tu abbia familiarità con le estensioni Firebase e come utilizzarle nelle tue app Firebase .

Cosa posso fare con l'emulatore di estensioni?

Con l'emulatore di estensioni, puoi installare e gestire le estensioni in un ambiente locale sicuro e comprenderne meglio le capacità riducendo al minimo i costi di fatturazione. L'emulatore esegue le funzioni dell'estensione localmente, incluse le funzioni attivate da eventi in background utilizzando gli emulatori per Cloud Firestore, Realtime Database, Cloud Storage for Firebase, Authentication e Pub/Sub e le funzioni attivate da Eventarc implementate in Cloud Functions v2.

Scegli un progetto Firebase

La Firebase Local Emulator Suite emula i prodotti per un singolo progetto Firebase.

Per selezionare il progetto da utilizzare, prima di avviare gli emulatori, nella CLI eseguire firebase use nella directory di lavoro. In alternativa, puoi passare il flag --project a ciascun comando dell'emulatore.

Local Emulator Suite supporta l'emulazione di progetti Firebase reali e progetti demo .

Tipo di progetto Caratteristiche Utilizzare con emulatori
Vero

Un vero progetto Firebase è quello che hai creato e configurato (molto probabilmente tramite la console Firebase).

I progetti reali hanno risorse attive, come istanze di database, bucket di archiviazione, funzioni o qualsiasi altra risorsa configurata per quel progetto Firebase.

Quando lavori con progetti Firebase reali, puoi eseguire emulatori per uno o tutti i prodotti supportati.

Per tutti i prodotti che non stai emulando, le tue app e il tuo codice interagiranno con la risorsa live (istanza del database, bucket di archiviazione, funzione e così via).

Dimostrazione

Un progetto Firebase demo non ha una configurazione Firebase reale né risorse live. Di solito si accede a questi progetti tramite codelab o altri tutorial.

Gli ID progetto per i progetti demo hanno il prefisso demo- .

Quando lavori con progetti Firebase demo, le tue app e il tuo codice interagiscono solo con gli emulatori. Se la tua app tenta di interagire con una risorsa per la quale non è in esecuzione un emulatore, il codice avrà esito negativo.

Ti consigliamo di utilizzare progetti demo ove possibile. I vantaggi includono:

  • Configurazione più semplice, poiché puoi eseguire gli emulatori senza mai creare un progetto Firebase
  • Maggiore sicurezza, poiché se il codice richiama accidentalmente risorse (di produzione) non emulate, non vi è alcuna possibilità di modifica, utilizzo e fatturazione dei dati
  • Migliore supporto offline, poiché non è necessario accedere a Internet per scaricare la configurazione dell'SDK.

Installa e valuta un'estensione

Utilizzare l'emulatore di estensioni per valutare se un'estensione soddisfa le tue esigenze è semplice.

Supponiamo che tu sia interessato all'estensione Trigger Email ( firestore-send-email ), sebbene il seguente flusso di lavoro copra qualsiasi estensione. Se eseguito con emulatori locali, Trigger Email utilizzerà automaticamente gli emulatori Cloud Firestore e Cloud Functions.

Per valutare un'estensione localmente:

  1. Aggiungi l'estensione al manifest delle estensioni locali. Un manifest delle estensioni è un elenco di istanze di estensione e delle relative configurazioni.

    firebase ext:install --local firebase/firestore-send-email

    L'esecuzione del comando precedente ti chiederà di configurare la versione più recente dell'estensione firebase/firestore-send-email e di salvare la configurazione nel manifest, ma non distribuirà la configurazione nel tuo progetto. Per ulteriori informazioni, consulta Gestire la configurazione delle estensioni con i manifest

  2. Avvia Local Emulator Suite come faresti normalmente.

    firebase emulators:start

Ora, utilizzando l'istanza dell'estensione firestore-send-email elencata nel manifest, Local Emulator Suite scaricherà il codice sorgente di tale estensione in ~/.cache/firebase/extensions . Una volta scaricate le sorgenti, verrà avviata Local Emulator Suite e sarai in grado di attivare qualsiasi funzione attivata in background dell'estensione e connettere la tua app a Local Emulator Suite per testare la loro integrazione con la tua app.

Puoi utilizzare l'interfaccia utente di Emulator Suite per aggiungere dati alla raccolta di documenti email e configurare altre risorse backend, come richiesto dall'estensione Trigger Email.

In alternativa, per ambienti di test non interattivi come i flussi di lavoro di integrazione continua, puoi scrivere uno script di test per valutare l'estensione che, tra gli altri passaggi, popola i dati Cloud Firestore necessari e attiva le funzioni. Dovresti quindi richiamare Local Emulator Suite per eseguire lo script di test:

firebase emulators:exec my-test.sh

In che modo il test con l'emulatore di estensioni differisce dalla produzione

L'emulatore di estensioni ti consente di testare le estensioni in un modo che corrisponda strettamente all'esperienza di produzione. Tuttavia, ci sono alcune differenze rispetto al comportamento produttivo.

Cloud IAM

Firebase Emulator Suite non tenta di replicare o rispettare alcun comportamento correlato a IAM durante l'esecuzione. Gli emulatori aderiscono alle regole di sicurezza Firebase fornite, ma nelle situazioni in cui verrebbe normalmente utilizzato IAM, ad esempio per impostare Cloud Functions che richiamano l'account del servizio e quindi le autorizzazioni, l'emulatore non è configurabile e utilizzerà l'account disponibile a livello globale sul computer dello sviluppatore, simile all'esecuzione diretta di uno script locale.

Limitazione del tipo di attivazione

Attualmente, Firebase Local Emulator Suite supporta solo funzioni attivate da richieste HTTP, attivatori di eventi personalizzati Eventarc per estensioni e funzioni attivate da eventi in background per Cloud Firestore, Realtime Database, Cloud Storage per Firebase, Autenticazione e Pub/Sub. Per valutare le estensioni che utilizzano altri tipi di funzioni attivate, devi installare la tua estensione in un progetto Firebase di prova.

E dopo?