Catch up on everything we announced at this year's Firebase Summit. Learn more

Conecta tu app al emulador de Cloud Firestore

Antes de conectar tu app al emulador de Cloud Firestore, asegúrate de comprender el flujo de trabajo general de Firebase Local Emulator Suite y de instalar y configurar Local Emulator Suite y revisar los comandos de su CLI.

Elige un proyecto de Firebase

Firebase Local Emulator Suite emula los productos para un solo proyecto de Firebase.

A fin de seleccionar el proyecto que quieres usar, ejecuta firebase use en la CLI en tu directorio de trabajo antes de iniciar los emuladores. También puedes pasar la marca --project a cada comando del emulador.

Local Emulator Suite admite la emulación de proyectos reales y de demostración en Firebase.

Tipo de proyecto Características Uso con emuladores
Real

Los proyectos de Firebase reales son aquellos que creaste y configuraste (probablemente mediante Firebase console).

Los proyectos reales tienen recursos activos, como instancias de bases de datos, buckets de almacenamiento, funciones o cualquier otro recurso que hayas configurado para ese proyecto de Firebase.

Cuando trabajas con proyectos reales de Firebase, puedes ejecutar emuladores para cualquiera de los productos compatibles o todos.

Si se trata de un producto que no estás emulando, tus apps y código interactuarán con los recursos activos (instancias de bases de datos, bucket de almacenamiento, función, etcétera).

Demostración

Los proyectos de demostración de Firebase no tienen una configuración real de Firebase ni recursos activos. Por lo general, se accede a estos proyectos mediante Codelabs o algún otro instructivo.

Los ID de proyectos de los proyectos de demostración tienen el prefijo demo-.

Cuando trabajas con proyectos de demostración, tus apps y código interactúan solo con emuladores. Si tu app intenta interactuar con un recurso para el cual no se está ejecutando un emulador, ese código fallará.

Te recomendamos que uses proyectos de demostración siempre que sea posible. Estos son algunos de los beneficios:

  • Configuración más sencilla, ya que puedes ejecutar los emuladores sin crear un proyecto de Firebase
  • Mayor seguridad, ya que, si tu código invoca de forma accidental recursos no emulados (de producción), no hay probabilidad de que se modifiquen los datos, el uso ni la facturación
  • Mejor soporte sin conexión, ya que no es necesario acceder a Internet para descargar la configuración del SDK

Instrumenta la app para que se comunique con los emuladores

SDK para plataformas de Android y Apple, y la Web

Configura la app o las clases de prueba para interactuar con Cloud Firestore de la siguiente manera.

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);
Swift
let settings = Firestore.firestore().settings
settings.host = "localhost:8080"
settings.isPersistenceEnabled = false
settings.isSSLEnabled = false
Firestore.firestore().settings = settings

Web versión 9

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

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, 'localhost', 8080);

Web versión 8

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("localhost", 8080);
}
Web
// Initialize your Web app as described in the Get started for Web
// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("localhost", 8080);
}

No se necesita ninguna configuración adicional para probar las Cloud Functions que se activan con eventos de Firestore en el emulador. Cuando se ejecutan los emuladores de Firestore y Cloud Functions, funcionan automáticamente en conjunto.

SDK de Admin

Los SDK de Firebase Admin se conectan automáticamente al emulador de Cloud Firestore cuando se configura la variable de entorno FIRESTORE_EMULATOR_HOST de la siguiente manera:

export FIRESTORE_EMULATOR_HOST="localhost:8080"

Si tu código se ejecuta en el emulador de Cloud Functions, se establecerán automáticamente el ID del proyecto y otras opciones de configuración cuando llames a initalizeApp.

Cuando te conectes al emulador de Cloud Firestore desde cualquier otro entorno, deberás especificar un ID de proyecto. Puedes pasar un ID de proyecto a initializeApp directamente o configurar la variable de entorno GCLOUD_PROJECT. Ten en cuenta que no necesitas usar el ID real de tu proyecto de Firebase, ya que el emulador de Cloud Firestore aceptará cualquier ID de proyecto que tenga un formato válido.

SDK de Admin de Node.js
admin.initializeApp({ projectId: "your-project-id" });
Variable de entorno
export GCLOUD_PROJECT="your-project-id"

Borra la base de datos entre pruebas

En producción, Firestore no proporciona un método de SDK de plataforma para vaciar la base de datos, pero el emulador de Firestore sí proporciona un extremo de REST específico para estos fines que se puede llamar desde un framework de prueba o paso de setup/tearDown, así como desde una clase de prueba o la shell (como curl) antes de iniciar una prueba. Puedes usar este enfoque como alternativa al cierre de los procesos del emulador.

En un método adecuado, proporciona un ID de proyecto de Firebase para realizar una operación de HTTP DELETE (por ejemplo, firestore-emulator-example) al siguiente extremo:

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

Por supuesto, el código debe esperar la confirmación de REST de que el vaciado finalizó o falló.

Usa este código para realizar la operación desde la shell:

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

Después de implementar un paso como este, puedes secuenciar tus pruebas y activar tus funciones con la certeza de que se borrarán definitivamente los datos antiguos entre ejecuciones y que usarás una nueva configuración de prueba de referencia.

Importa y exporta datos

Los emuladores de base de datos y Cloud Storage te permiten exportar datos desde una instancia de emulador en ejecución. Define un conjunto de datos de referencia para usarlo en tus pruebas de unidades o flujos de trabajo de integración continua y, luego, expórtalo a fin de compartirlo con el equipo.

firebase emulators:export ./dir

Durante el inicio del emulador en las pruebas, importa los datos de referencia.

firebase emulators:start --import=./dir

Puedes indicarle al emulador que exporte datos durante el cierre, ya sea especificando una ruta de exportación o simplemente usando la ruta de acceso que se pasó a la marca --import.

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

Estas opciones de importación y exportación de datos también funcionan con el comando firebase emulators:exec. Para obtener más información, consulta la referencia de comandos de los emuladores.

Visualiza la actividad de las reglas de seguridad

A medida que trabajas con prototipos y bucles de prueba, puedes usar las herramientas de visualización y los informes que proporciona Local Emulator Suite.

Usa el Monitor de solicitudes

El emulador de Cloud Firestore te permite visualizar solicitudes de clientes en la IU de Emulator Suite, incluido el seguimiento de la evaluación de reglas de seguridad de Firebase.

Abre la pestaña Firestore > Solicitudes para ver la secuencia de evaluación detallada de cada solicitud.

El Monitor de solicitudes del emulador de Firestore, que muestra las evaluaciones de reglas de seguridad

Visualiza los informes de evaluación de reglas

A medida que agregas reglas de seguridad a tu prototipo, puedes depurarlas con las herramientas de depuración de Local Emulator Suite.

Luego de ejecutar un conjunto de pruebas, puedes acceder a los informes de cobertura de pruebas que muestran cómo se evaluaron las reglas de seguridad.

Para obtenerlos, consulta un extremo expuesto en el emulador mientras se ejecuta. Usa la siguiente URL para obtener una versión compatible con navegadores:

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

Esto divide tus reglas en expresiones y subexpresiones sobre las que puedes desplazar el mouse para obtener más información, como la cantidad de evaluaciones y los valores mostrados. Si quieres acceder a la versión JSON sin procesar de los datos, incluye la siguiente URL en la consulta:

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

Aquí, en la versión HTML del informe se destacan las evaluaciones que arrojan errores indefinidos y de valor nulo:

Diferencias entre el emulador de Cloud Firestore y el entorno de producción

El emulador de Cloud Firestore intenta replicar de la mejor forma posible el comportamiento del servicio de producción, salvo las excepciones que se indican a continuación.

Transacciones

En este momento, el emulador no implementa todos los comportamientos de transacciones que se ven en producción. Cuando pruebas funciones que implican varias escrituras simultáneas en un documento, es posible que el emulador tarde en completar las solicitudes de escritura. En algunos casos, los bloqueos pueden tardar hasta 30 segundos en liberarse. Te recomendamos ajustar los tiempos de espera de la prueba según sea necesario.

Índices

El emulador no realiza un seguimiento de los índices compuestos y, en su lugar, ejecutará cualquier consulta válida. Asegúrate de probar tu app con una instancia real de Cloud Firestore para determinar qué índices necesitarás.

Límites

El emulador no aplica todos los límites que se implementan en producción. Por ejemplo, es posible que el emulador permita transacciones que el servicio de producción rechazaría debido a su gran tamaño. Asegúrate de conocer los límites documentados y de diseñar tu app para evitarlos de forma proactiva.

Próximos pasos