Utiliser l'émulateur Firestore en local

La Google Cloud CLI fournit un émulateur local en mémoire pour Firestore, que vous pouvez utiliser pour tester votre application. Vous pouvez utiliser l'émulateur avec toutes les bibliothèques clientes Firestore. Vous ne devez utiliser l'émulateur que pour les tests en local.

N'utilisez pas l'émulateur pour les déploiements de production. Étant donné que l'émulateur ne stocke les données que dans la mémoire, il ne les conserve pas lors des exécutions.

Installer l'émulateur

Pour installer l'émulateur Firestore, installez et mettez à jour la gcloud CLI:

Installer gcloud CLI.
Mettez à jour votre installation de gcloud CLI pour obtenir les dernières fonctionnalités:
```
gcloud components update
```

Exécuter l'émulateur

Exécutez la commande suivante pour démarrer l'émulateur :
```
gcloud emulators firestore start
```
L'émulateur imprime l'hôte et le numéro de port sur lequel il s'exécute.

Par défaut, l'émulateur tente d'utiliser 127.0.0.1:8080. Pour lier l'émulateur à un hôte et à un port spécifiques, utilisez l'option facultative --host-port, en remplaçant HOST et PORT:
```
gcloud emulators firestore start --host-port=HOST:PORT
```
Saisissez Control + C pour arrêter l'émulateur. L'émulateur peut également être arrêté avec une requête POST sur /shutdown. Exemple :
```
curl -d '' HOST:PORT/shutdown
```

Se connecter à l'émulateur

La manière dont vous vous connectez à l'émulateur dépend du type de bibliothèque cliente, de bibliothèque cliente du serveur ou de SDK Web/mobile.

Bibliothèques clientes de serveur

Pour connecter une bibliothèque cliente de serveur Firestore (C#, Go, Java, Node.js, PHP, Python et Ruby), définissez la variable d'environnement FIRESTORE_EMULATOR_HOST. Lorsque cette variable d'environnement est définie, les bibliothèques clientes du serveur se connectent automatiquement à l'émulateur.

export FIRESTORE_EMULATOR_HOST="HOST:PORT"

Plates-formes Android, Apple et SDK Web

Les exemples suivants montrent comment connecter les plates-formes Android, Apple et les SDK Web à l'émulateur Firestore:

Android

// 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

Swift

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

Version Web 9

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

Version Web 8

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

L'émulateur Firestore efface le contenu de la base de données à l'arrêt. Étant donné que le cache hors connexion du SDK Firestore n'est pas automatiquement effacé, vous pouvez désactiver la persistance locale dans la configuration de l'émulateur pour éviter les écarts entre la base de données émulée et les caches locaux. Dans le SDK Web, la persistance est désactivée par défaut.

Effacer les données de l'émulateur

L'émulateur Firestore inclut un point de terminaison REST permettant de supprimer toutes les données qu'il contient. Vous pouvez utiliser ce point de terminaison pour effacer les données entre les tests sans arrêter l'émulateur.

Pour supprimer toutes les données dans l'émulateur, effectuez une opération HTTP DELETE sur le point de terminaison suivant, en remplaçant HOST et PORT par l'hôte et le port que vous avez sélectionnés, et en remplaçant PROJECT_ID par votre propre ID de projet:

http://HOST:PORT/emulator/v1/projects/PROJECT_ID/databases/(default)/documents

Ajustez l'hôte et le port si l'émulateur n'utilise pas 127.0.0.1:8080. Votre code doit attendre la confirmation REST que la suppression s'est terminée ou a échoué.

Vous pouvez effectuer cette opération à partir du shell à l'aide de la commande curl:

$ curl -v -X DELETE "http://HOST:PORT/emulator/v1/projects/PROJECT_ID/databases/(default)/documents"

En quoi l'émulateur Firestore diffère-t-il de la production ?

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

Transactions

L'émulateur n'implémente pas 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 mettre du temps à traiter les requêtes d'écriture. Dans certains cas, les verrouillages peuvent mettre jusqu'à 30 secondes à se déverrouiller. Envisagez d'ajuster les délais avant expiration des tests en conséquence, si nécessaire.

Index

L'émulateur ne suit pas les index composites et exécute toutes les requêtes valides à la place. Veillez à tester votre application sur une instance Firestore réelle pour déterminer les index dont vous avez besoin.

Limites

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