Conecte su aplicación y comience a crear prototipos

Antes de comenzar con Firebase Local Emulator Suite, asegúrese de haber creado un proyecto de Firebase, haber configurado su entorno de desarrollo y seleccionado e instalado los SDK de Firebase para su plataforma de acuerdo con los temas de Introducción a Firebase para su plataforma: Apple , Android . o Web .

Prototipo y prueba

Local Emulator Suite contiene varios emuladores de productos, como se describe en Introducción a Firebase Local Emulator Suite . Puede realizar prototipos y realizar pruebas con emuladores individuales, así como con combinaciones de emuladores, como mejor le parezca, correspondientes a los productos de Firebase que esté utilizando en producción.

Interacción entre la base de datos de Firebase y los emuladores de funciones
Emuladores de funciones de base de datos y nube como parte del paquete de emuladores locales completo .

En este tema, para presentar el flujo de trabajo de Local Emulator Suite, supongamos que está trabajando en una aplicación que utiliza una combinación típica de productos: una base de datos de Firebase y funciones de nube activadas por operaciones en esa base de datos.

Después de inicializar localmente su proyecto de Firebase, el ciclo de desarrollo con Local Emulator Suite normalmente tendrá tres pasos:

  1. Funciones de prototipo de forma interactiva con los emuladores y la interfaz de usuario de Emulator Suite.

  2. Si está utilizando un emulador de base de datos o el emulador de Cloud Functions, realice un paso único para conectar su aplicación a los emuladores.

  3. Automatice sus pruebas con emuladores y scripts personalizados.

Inicializar localmente un proyecto de Firebase

Asegúrese de instalar la CLI o actualizarla a su última versión .

curl -sL firebase.tools | bash

Si aún no lo ha hecho, inicialice el directorio de trabajo actual como un proyecto de Firebase, siguiendo las instrucciones en pantalla para especificar que está usando Cloud Functions y Cloud Firestore o Realtime Database :

firebase init

El directorio de su proyecto ahora contendrá archivos de configuración de Firebase, un archivo de definición de reglas de seguridad de Firebase para la base de datos, un directorio functions que contiene el código de funciones de la nube y otros archivos de soporte.

Prototipar de forma interactiva

Local Emulator Suite está diseñado para permitirle crear rápidamente prototipos de nuevas funciones, y la interfaz de usuario integrada de Suite es una de sus herramientas de creación de prototipos más útiles. Es un poco como tener la consola Firebase ejecutándose localmente.

Con la interfaz de usuario de Emulator Suite, puede iterar el diseño de una base de datos, probar diferentes flujos de datos que involucran funciones de la nube, evaluar los cambios en las reglas de seguridad, verificar los registros para confirmar cómo se están desempeñando sus servicios back-end y más. Luego, si desea comenzar de nuevo, simplemente borre su base de datos y comience de nuevo con una nueva idea de diseño.

Todo está disponible cuando inicias Local Emulator Suite con:

firebase emulators:start

Para crear un prototipo de nuestra aplicación hipotética, configuremos y probemos una función básica en la nube para modificar las entradas de texto en una base de datos, y creemos y completemos esa base de datos en la interfaz de usuario de Emulator Suite para activarla.

  1. Cree una función en la nube activada por escrituras en la base de datos editando el archivo functions/index.js en el directorio de su proyecto. Reemplace el contenido del archivo existente con el siguiente fragmento. Esta función detecta cambios en los documentos de la colección messages , convierte el contenido del campo original de un documento a mayúsculas y almacena el resultado en el campo uppercase de ese documento.
  2.   const functions = require('firebase-functions');
    
      exports.makeUppercase = functions.firestore.document('/messages/{documentId}')
          .onCreate((snap, context) => {
            const original = snap.data().original;
            console.log('Uppercasing', context.params.documentId, original);
            const uppercase = original.toUpperCase();
            return snap.ref.set({uppercase}, {merge: true});
          });
      
  3. Inicie Local Emulator Suite con firebase emulators:start . Se inician Cloud Functions y los emuladores de bases de datos, configurados automáticamente para interoperar.
  4. Vea la interfaz de usuario en su navegador en http://localhost:4000 . El puerto 4000 es el predeterminado para la interfaz de usuario, pero verifique los mensajes del terminal emitidos por Firebase CLI. Tenga en cuenta el estado de los emuladores disponibles. En nuestro caso, se ejecutarán los emuladores Cloud Functions y Cloud Firestore.
    Mi imagen
  5. En la interfaz de usuario, en la pestaña Firestore > Datos , haga clic en Iniciar colección y siga las instrucciones para crear un nuevo documento en una colección messages , con el nombre de campo original y el valor test . Esto activa nuestra función de nube. Observe que en breve aparece un nuevo campo uppercase , poblado con la cadena "PRUEBA".
    Mi imagenMi imagen
  6. En la pestaña Firestore > Solicitudes , examine las solicitudes realizadas a su base de datos emulada, incluidas todas las evaluaciones de las reglas de seguridad de Firebase realizadas como parte del cumplimiento de esas solicitudes.
  7. Verifique la pestaña Registros para confirmar que su función no tuvo errores al actualizar la base de datos.

Puede iterar fácilmente entre el código de función de la nube y las ediciones interactivas de la base de datos hasta obtener el flujo de datos que busca, sin tocar el código de acceso a la base de datos en la aplicación, ni volver a compilar y ejecutar conjuntos de pruebas.

Conecta tu aplicación a los emuladores

Cuando haya logrado un buen progreso con la creación de prototipos interactivos y se haya decidido por un diseño, estará listo para agregar el código de acceso a la base de datos a su aplicación utilizando el SDK apropiado. Seguirá usando la pestaña de la base de datos y, para las funciones, la pestaña Registros en la interfaz de usuario de Emulator Suite para confirmar que el comportamiento de su aplicación es correcto.

Recuerde que Local Emulator Suite es una herramienta de desarrollo local. Las escrituras en sus bases de datos de producción no activarán funciones que esté creando prototipos localmente.

Para pasar a que su aplicación realice escrituras en la base de datos, deberá apuntar sus clases de prueba o configuración en la aplicación al emulador de Cloud Firestore.

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 firestore = Firebase.firestore
firestore.useEmulator("10.0.2.2", 8080)

firestore.firestoreSettings = firestoreSettings {
    isPersistenceEnabled = false
}
Java
// 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);
Rápido
let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings

Web modular API

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

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

Web namespaced API

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

Automatiza tus pruebas con scripts personalizados

Ahora vamos al último paso general del flujo de trabajo. Una vez que haya creado el prototipo de su función en la aplicación y parezca prometedora en todas sus plataformas, puede pasar a la implementación y prueba finales. Para pruebas unitarias y flujos de trabajo de CI, puede iniciar emuladores, ejecutar pruebas con script y apagar emuladores en una sola llamada con el comando exec :

firebase emulators:exec "./testdir/test.sh"

Explora emuladores individuales con más profundidad

Ahora que ha visto cómo se ve el flujo de trabajo básico del lado del cliente, puede continuar con detalles sobre los emuladores individuales en la Suite, incluido cómo usarlos para el desarrollo de aplicaciones del lado del servidor:

¿Qué sigue?

Asegúrese de leer los temas relacionados con emuladores específicos vinculados anteriormente. Entonces: