Connecter votre application à l'émulateur Cloud Firestore

Avant de connecter votre application à l'émulateur Cloud Firestore, assurez-vous de comprendre le workflow global de Firebase Local Emulator Suite, d'installer et de configurer Local Emulator Suite, et de consulter ses commandes de CLI.

Choisir un projet Firebase

Firebase Local Emulator Suite émule les produits d'un seul projet Firebase.

Pour sélectionner le projet à utiliser, avant de démarrer les émulateurs, exécutez firebase use dans votre répertoire de travail dans la CLI. Vous pouvez également transmettre l'option --project à chaque commande de l'émulateur.

Local Emulator Suite est compatible avec l'émulation de projets Firebase réels et de projets de démonstration.

Nous vous recommandons d'utiliser des projets de démonstration dans la mesure du possible. Voici quelques-uns de ses avantages :

• Configuration plus simple, car vous pouvez exécuter les émulateurs sans jamais créer de projet Firebase
• Sécurité renforcée : si votre code appelle accidentellement des ressources non émulées (production), il n'y a aucun risque de modification des données, d'utilisation et de facturation.
• Meilleure compatibilité hors connexion, car il n'est pas nécessaire d'accéder à Internet pour télécharger la configuration de votre SDK.

Instrumenter votre application pour communiquer avec les émulateurs

Au démarrage, l'émulateur Cloud Firestore crée une base de données par défaut et une base de données nommée pour chaque configuration firestore de votre fichier firebase.json.

Les bases de données nommées sont également créées implicitement en réponse à tout appel d'API REST ou de SDK à l'émulateur qui fait référence à une base de données spécifique. Ces bases de données créées implicitement fonctionnent avec des règles ouvertes.

Pour travailler de manière interactive avec vos bases de données par défaut et nommées dans Emulator Suite UI, mettez à jour l'URL dans la barre d'adresse de votre navigateur pour sélectionner la base de données par défaut ou une base de données nommée.

• Par exemple, pour parcourir les données de votre instance par défaut, remplacez l'URL par localhost:4000/firestore/default/data.
• Pour parcourir une instance nommée ecommerce, passez à localhost:4000/firestore/ecommerce/data.

Démarrer l'émulateur dans une édition spécifique

L'émulateur démarrera dans l'édition spécifiée dans la section firestore.edition de votre fichier firebase.json. Vous pouvez également spécifier une édition dans la section emulators.firestore.edition de votre firebase.json. Les valeurs valides pour l'édition sont standard et enterprise. Si vous spécifiez edition dans les deux configurations, emulators.firestore.edition est prioritaire.

    {
      ...
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json",
        "edition": "enterprise"
      },
      "emulators": {
        "firestore": {
          "port": 8080,
          "edition": "enterprise" // Takes precedence over `firestore.edition`
        }
      },
      ...
    }

SDK Android, plates-formes Apple et Web

Configurez vos classes de configuration ou de test dans l'application pour interagir avec Cloud Firestore comme suit. Notez que dans les exemples suivants, le code de l'application se connecte à la base de données du projet par défaut. Pour obtenir des exemples impliquant des bases de données Cloud Firestore supplémentaires en plus de la base de données par défaut, consultez le guide pour plusieurs bases de données.

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val firestore = Firebase.firestore
firestore.useEmulator("10.0.2.2", 8080)

firestore.firestoreSettings = firestoreSettings {
    isPersistenceEnabled = false
}
EmulatorSuite.kt

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);
EmulatorSuite.java

let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings
ViewController.swift

FirebaseFirestore db = FirebaseFirestore.DefaultInstance;
// Connects to the Firestore Emulator running on port 8080
db.Settings.Host = "127.0.0.1:8080";
db.Settings.SslEnabled = false;

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
fs_emulator_connect.js

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("127.0.0.1", 8080);
}
emulator-suite.js

Aucune configuration supplémentaire n'est requise pour tester les fonctions Cloud déclenchées par des événements Firestore à l'aide de l'émulateur. Lorsque les émulateurs Firestore et Cloud Functions sont tous deux en cours d'exécution, ils fonctionnent automatiquement ensemble.

Admin SDK s

Les Firebase Admin SDK se connectent automatiquement à l'émulateur Cloud Firestore lorsque la variable d'environnement FIRESTORE_EMULATOR_HOST est définie :

export FIRESTORE_EMULATOR_HOST="127.0.0.1:8080"

Si votre code s'exécute dans l'émulateur Cloud Functions, l'ID de votre projet et les autres configurations sont automatiquement définis lors de l'appel de initializeApp.

Si vous souhaitez que votre code Admin SDK se connecte à un émulateur partagé s'exécutant dans un autre environnement, vous devez spécifier le même ID de projet que celui que vous avez défini à l'aide de la CLI Firebase. Vous pouvez transmettre un ID de projet directement à initializeApp ou définir la variable d'environnement GCLOUD_PROJECT.

admin.initializeApp({ projectId: "your-project-id" });

export GCLOUD_PROJECT="your-project-id"

API REST Cloud Firestore

L'émulateur Cloud Firestore fournit un point de terminaison REST pour interagir avec votre base de données. Tous les appels d'API REST doivent être effectués vers le point de terminaison http://localhost:8080/v1.

Le chemin d'accès complet d'un appel REST suit le modèle suivant :

http://localhost:8080/v1/projects/{project_id}/databases/{database_id}/documents/{document_path}

Par exemple, pour lister tous les documents de la collection users du projet my-project-id, vous pouvez utiliser curl :

curl -X GET "http://localhost:8080/v1/projects/my-project-id/databases/(default)/documents/users"

Effacer votre base de données entre les tests

La version de production de Firestore ne fournit aucune méthode de SDK de plate-forme pour vider la base de données, mais l'émulateur Firestore vous fournit un point de terminaison REST spécialement conçu à cet effet. Il peut être appelé à partir d'une étape de configuration/suppression du framework de test, d'une classe de test ou du shell (par exemple, avec curl) avant le lancement d'un test. Vous pouvez utiliser cette approche comme alternative à l'arrêt du processus de l'émulateur.

Dans une méthode appropriée, effectuez une opération HTTP DELETE en fournissant votre ID de projet Firebase, par exemple firestore-emulator-example, au point de terminaison suivant :

"http://localhost:8080/emulator/v1/projects/firestore-emulator-example/databases/(default)/documents"

Naturellement, votre code doit attendre la confirmation REST que le vidage est terminé ou a échoué.

Vous pouvez effectuer cette opération à partir du shell :

// Shell alternative…
$ curl -v -X DELETE "http://localhost:8080/emulator/v1/projects/firestore-emulator-example/databases/(default)/documents"

Après avoir implémenté une étape comme celle-ci, vous pouvez séquencer vos tests et déclencher vos fonctions en ayant l'assurance que les anciennes données seront purgées entre les exécutions et que vous utilisez une nouvelle configuration de test de référence.

Importer et exporter des données

Les émulateurs de base de données et Cloud Storage for Firebase vous permettent d'exporter des données à partir d'une instance d'émulateur en cours d'exécution. Définissez un ensemble de données de référence à utiliser dans vos tests unitaires ou vos workflows d'intégration continue, puis exportez-le pour le partager avec l'équipe.

firebase emulators:export ./dir

Dans les tests, au démarrage de l'émulateur, importez les données de référence.

firebase emulators:start --import=./dir

Vous pouvez demander à l'émulateur d'exporter les données lors de l'arrêt, soit en spécifiant un chemin d'exportation, soit en utilisant simplement le chemin d'accès transmis à l'option --import.

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

Ces options d'importation et d'exportation de données fonctionnent également avec la commande firebase emulators:exec. Pour en savoir plus, consultez la documentation de référence sur les commandes de l'émulateur.

Visualiser l'activité des règles de sécurité

Lorsque vous travaillez sur des boucles de prototypage et de test, vous pouvez utiliser les outils de visualisation et les rapports fournis par Local Emulator Suite.

Utiliser l'outil de surveillance des requêtes

L'émulateur Cloud Firestore vous permet de visualiser les requêtes client dans Emulator Suite UI, y compris le traçage d'évaluation pour Firebase Security Rules.

Ouvrez l'onglet Firestore > Requêtes pour afficher la séquence d'évaluation détaillée de chaque requête.

Visualiser les rapports d'évaluation des règles

Lorsque vous ajoutez des règles de sécurité à votre prototype, vous pouvez les déboguer à l'aide des outils de débogage Local Emulator Suite.

Après avoir exécuté une suite de tests, vous pouvez accéder à des rapports sur la couverture des tests qui montrent comment chacune de vos règles de sécurité a été évaluée.

Pour obtenir les rapports, interrogez un point de terminaison exposé sur l'émulateur pendant son exécution. Pour une version adaptée aux navigateurs, utilisez l'URL suivante :

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html

Cette opération casse vos règles en expressions et sous-expressions que vous pouvez survoler avec la souris pour obtenir plus d'informations, y compris le nombre d'évaluations et les valeurs renvoyées. Pour la version JSON brute de ces données, incluez l'URL suivante dans votre requête :

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage

Ici, la version HTML du rapport met en évidence les évaluations qui génèrent des erreurs de valeur non définie et de valeur nulle :

Différences entre l'émulateur Cloud Firestore et la production

L'émulateur Cloud Firestore tente de reproduire fidèlement le comportement du service de production, avec quelques limites notables.

Compatibilité avec plusieurs bases de données pour Cloud Firestore

Actuellement, Emulator Suite UI permet de créer, modifier et supprimer de manière interactive une base de données par défaut, de surveiller les requêtes et de visualiser la sécurité, mais pas pour les bases de données nommées supplémentaires.

Toutefois, l'émulateur crée une base de données nommée en fonction de la configuration de votre fichier firebase.json et implicitement en réponse aux appels d'API REST ou du SDK.

Transactions

L'émulateur n'implémente pas actuellement tous les comportements de transaction observés en production. Lorsque vous testez des fonctionnalités qui impliquent plusieurs écritures simultanées dans un document, l'émulateur peut être lent à traiter les requêtes d'écriture. Dans certains cas, la libération des verrous peut prendre jusqu'à 30 secondes. Si nécessaire, ajustez les délais avant expiration des tests en conséquence.

Index

L'émulateur ne suit pas les index composites et exécute n'importe quelle requête valide. Veillez à tester votre application sur une instance Cloud Firestore réelle pour déterminer les index dont vous aurez besoin.

Limites

L'émulateur n'applique pas toutes les limites appliquées en production. Par exemple, l'émulateur peut autoriser des transactions qui seraient rejetées par le service de production, car elles sont trop volumineuses. Assurez-vous de bien connaître les limites documentées et de concevoir votre application de manière à les éviter de manière proactive.

Et maintenant ?

• Pour obtenir une sélection de vidéos et des exemples détaillés, suivez la playlist de formation sur les émulateurs Firebase.
• Étudiez des cas d'utilisation avancés impliquant le test des règles de sécurité et le SDK Firebase Test : Tester les règles de sécurité (Firestore).
• Étant donné que les fonctions déclenchées sont une intégration typique avec Cloud Firestore, apprenez-en plus sur l'émulateur Cloud Functions for Firebase sur la page Exécuter des fonctions localement.