Collega la tua app all'emulatore di database in tempo reale

Prima di connettere la tua app all'emulatore Realtime Database, assicurati di comprendere il flusso di lavoro generale di Firebase Local Emulator Suite , di installare e configurare Local Emulator Suite e di rivedere i suoi comandi CLI .

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.

Strumenti la tua app per comunicare con gli emulatori

Piattaforme Android, Apple e SDK Web

Imposta la configurazione in-app o le classi di prova per interagire con Realtime Database come segue.

Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val database = Firebase.database
database.useEmulator("10.0.2.2", 9000)
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseDatabase database = FirebaseDatabase.getInstance();
database.useEmulator("10.0.2.2", 9000);
Veloce
    // In almost all cases the ns (namespace) is your project ID.
let db = Database.database(url:"http://127.0.0.1:9000?ns=YOUR_DATABASE_NAMESPACE")

Web modular API

import { getDatabase, connectDatabaseEmulator } from "firebase/database";

const db = getDatabase();
if (location.hostname === "localhost") {
  // Point to the RTDB emulator running on localhost.
  connectDatabaseEmulator(db, "127.0.0.1", 9000);
} 

Web namespaced API

var db = firebase.database();
if (location.hostname === "localhost") {
  // Point to the RTDB emulator running on localhost.
  db.useEmulator("127.0.0.1", 9000);
} 

Non è necessaria alcuna configurazione aggiuntiva per testare le funzioni Cloud attivate dagli eventi di Realtime Database utilizzando l'emulatore. Quando gli emulatori Realtime Database e Cloud Functions sono entrambi in esecuzione, funzionano automaticamente insieme.

SDK di amministrazione

Gli SDK di Firebase Admin si connettono automaticamente all'emulatore Realtime Database quando è impostata la variabile di ambiente FIREBASE_DATABASE_EMULATOR_HOST :

export FIREBASE_DATABASE_EMULATOR_HOST="127.0.0.1:9000"

Se il tuo codice è in esecuzione all'interno dell'emulatore Cloud Functions, l'ID progetto e altre configurazioni verranno impostati automaticamente quando si chiama initializeApp .

Se desideri che il tuo codice Admin SDK si connetta a un emulatore condiviso in esecuzione in un altro ambiente, dovrai specificare lo stesso ID progetto che hai impostato utilizzando la CLI Firebase . Puoi passare un ID progetto per inizializzare direttamente initializeApp o impostare la variabile di ambiente GCLOUD_PROJECT .

SDK di amministrazione Node.js
admin.initializeApp({ projectId: "your-project-id" });
Variabile d'ambiente
export GCLOUD_PROJECT="your-project-id"

Cancella il tuo database tra un test e l'altro

Per svuotare il Realtime Database tra le attività, è possibile cancellare il riferimento al database. È possibile utilizzare questo approccio come alternativa al semplice arresto del processo di emulazione.

Kotlin+KTX
// With a DatabaseReference, write null to clear the database.
database.reference.setValue(null)
Java
// With a DatabaseReference, write null to clear the database.
database.getReference().setValue(null);
Veloce
// With a DatabaseReference, write nil to clear the database.
    Database.database().reference().setValue(nil);

Web modular API

import { getDatabase, ref, set } from "firebase/database";

// With a database Reference, write null to clear the database.
const db = getDatabase();
set(ref(db), null);

Web namespaced API

// With a database Reference, write null to clear the database.
firebase.database().ref().set(null);

Naturalmente, il tuo codice dovrebbe attendere la conferma che il flush è terminato o non è riuscito utilizzando le funzionalità di gestione degli eventi asincroni della tua piattaforma.

Dopo aver implementato un passaggio come questo, puoi mettere in sequenza i tuoi test e attivare le tue funzioni con la certezza che i vecchi dati verranno eliminati tra un'esecuzione e l'altra e che stai utilizzando una nuova configurazione di test di base.

Importare ed esportare dati

Il database e gli emulatori Cloud Storage for Firebase consentono di esportare dati da un'istanza dell'emulatore in esecuzione. Definisci un set di dati di base da utilizzare nei test unitari o nei flussi di lavoro di integrazione continua, quindi esportalo per condividerlo con il team.

firebase emulators:export ./dir

Nei test, all'avvio dell'emulatore, importa i dati di base.

firebase emulators:start --import=./dir

È possibile indicare all'emulatore di esportare i dati allo spegnimento, specificando un percorso di esportazione o semplicemente utilizzando il percorso passato al flag --import .

firebase emulators:start --import=./dir --export-on-exit

Queste opzioni di importazione ed esportazione dei dati funzionano anche con il comando firebase emulators:exec . Per ulteriori informazioni, fare riferimento al riferimento ai comandi dell'emulatore .

Visualizza l'attività delle regole di sicurezza

Mentre lavori su prototipi e cicli di test, puoi utilizzare gli strumenti di visualizzazione e i report forniti da Local Emulator Suite.

Visualizza le valutazioni delle regole

Quando aggiungi regole di sicurezza al tuo prototipo, puoi eseguirne il debug con gli strumenti di Local Emulator Suite.

Dopo aver eseguito una serie di test, puoi accedere ai report sulla copertura dei test che mostrano come è stata valutata ciascuna delle tue regole. Per ottenere i report, esegui una query su un endpoint esposto sull'emulatore mentre è in esecuzione. Per una versione ottimizzata per il browser, utilizzare il seguente URL:

http://localhost:9000/.inspect/coverage?ns=<database_name>

Ciò suddivide le regole in espressioni e sottoespressioni su cui puoi passare il mouse per ulteriori informazioni, incluso il numero di esecuzioni e i valori restituiti. Per la versione JSON non elaborata di questi dati, includi il seguente URL nella query:

http://localhost:9000/.inspect/coverage.json?ns=<database_name>

E dopo?