Desarrollo local con Firebase Emulator Suite

1. Antes de comenzar

Las herramientas de backend sin servidores como Cloud Firestore y Cloud Functions son muy fáciles de usar, pero pueden ser difíciles de probar. Firebase Local Emulator Suite te permite ejecutar versiones locales de estos servicios en tu máquina de desarrollo para que puedas desarrollar tu app con rapidez y seguridad.

Requisitos previos

• Un editor simple, como Visual Studio Code, Atom o Sublime Text
• Node.js 10.0.0 o una versión posterior (para instalar Node.js, usa nvm y ejecuta node --version para verificar tu versión).
• Java 7 o superior (para instalar Java, sigue estas instrucciones y comprueba la versión, ejecuta java -version)

Actividades

En este codelab, ejecutarás y depurarás una app simple de compras en línea que cuenta con la tecnología de varios servicios de Firebase:

• Cloud Firestore: Es una base de datos NoSQL escalable a nivel global, sin servidores y con capacidades en tiempo real.
• Cloud Functions: Un código de backend sin servidores que se ejecuta en respuesta a eventos o solicitudes HTTP.
• Firebase Authentication: Es un servicio de autenticación administrado que se integra en otros productos de Firebase.
• Firebase Hosting: Hosting rápido y seguro para apps web.

Conectarás la app a Emulator Suite para habilitar el desarrollo local.

También aprenderás a hacer lo siguiente:

• Cómo conectar tu app a Emulator Suite y cómo se conectan los distintos emuladores
• Cómo funcionan las reglas de seguridad de Firebase y cómo probarlas en un emulador local
• Cómo escribir una función de Firebase que se active mediante eventos de Firestore y cómo escribir pruebas de integración que se ejecuten en Emulator Suite

2. Configurar

Obtén el código fuente

En este codelab, comenzarás con una versión de la muestra de The Fire Store que está casi completa, por lo que lo primero que debes hacer es clonar el código fuente:

$ git clone https://github.com/firebase/emulators-codelab.git

Luego, ve al directorio del codelab, en el que trabajarás durante el resto de este codelab:

$ cd emulators-codelab/codelab-initial-state

Ahora, instala las dependencias para poder ejecutar el código. Si tienes una conexión a Internet lenta, es posible que este proceso demore unos minutos:

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

# Move back into the previous directory
$ cd ../

Cómo obtener Firebase CLI

Emulator Suite forma parte de Firebase CLI (interfaz de línea de comandos), que se puede instalar en tu máquina con el siguiente comando:

$ npm install -g firebase-tools

A continuación, confirma que tienes la versión más reciente de la CLI. Este codelab debería funcionar con la versión 9.0.0 o una posterior, pero las versiones posteriores incluyen más correcciones de errores.

$ firebase --version
9.6.0

Conéctate a tu proyecto de Firebase

Si no tienes un proyecto de Firebase, crea uno nuevo en Firebase console. Toma nota del ID del proyecto que elijas, ya que lo necesitarás más adelante.

Ahora debemos conectar este código a tu proyecto de Firebase. Primero, ejecuta el siguiente comando para acceder a Firebase CLI:

$ firebase login

Luego, ejecuta el siguiente comando para crear un alias para el proyecto. Reemplaza $YOUR_PROJECT_ID por el ID del proyecto de Firebase.

$ firebase use $YOUR_PROJECT_ID

Ya está todo listo para ejecutar la app.

3. Ejecuta los emuladores

En esta sección, ejecutarás la app de manera local. Esto significa que es momento de iniciar Emulator Suite.

Cómo iniciar los emuladores

Desde el directorio del código fuente del codelab, ejecuta el siguiente comando para iniciar los emuladores:

$ firebase emulators:start --import=./seed

Deberías ver algunos resultados como este:

$ firebase emulators:start --import=./seed
i  emulators: Starting emulators: auth, functions, firestore, hosting
⚠  functions: The following emulators are not running, calls to these services from the Functions emulator will affect production: database, pubsub
i  firestore: Importing data from /Users/samstern/Projects/emulators-codelab/codelab-initial-state/seed/firestore_export/firestore_export.overall_export_metadata
i  firestore: Firestore Emulator logging to firestore-debug.log
i  hosting: Serving hosting files from: public
✔  hosting: Local server: http://127.0.0.1:5000
i  ui: Emulator UI logging to ui-debug.log
i  functions: Watching "/Users/samstern/Projects/emulators-codelab/codelab-initial-state/functions" for Cloud Functions...
✔  functions[calculateCart]: firestore function initialized.

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://127.0.0.1:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at 127.0.0.1:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

Una vez que veas el mensaje All Emulators started, la app estará lista para usarse.

Apartado: ¿Qué acaba de suceder?

• Cada emulador se inició en 127.0.0.1 y cada uno se ejecuta en un puerto diferente.
• El emulador de Firestore importó datos del directorio seed, que se proporciona para simplificar este codelab.
• El emulador de Functions detectó la función calculateCart y notificó al emulador de Firestore.
• El emulador de Functions ahora está revisando el directorio functions para detectar cambios de código.

Conecta la aplicación web a los emuladores

Con base en la tabla de los registros, podemos ver que el emulador de Cloud Firestore escucha en el puerto 8080 y el emulador de Authentication escucha en el puerto 9099.

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘

Conecta tu código de frontend al emulador en lugar de a la producción. Abre el archivo public/js/homepage.js y busca la función onDocumentReady. Podemos ver que el código accede a las instancias estándar de Firestore y Auth:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

Actualicemos los objetos db y auth para que apunten a los emuladores locales:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

  // ADD THESE LINES
  if (location.hostname === "127.0.0.1") {
    console.log("127.0.0.1 detected!");
    auth.useEmulator("http://127.0.0.1:9099");
    db.useEmulator("127.0.0.1", 8080);
  }

Cuando la app se ejecuta en tu máquina local (a través del emulador de Hosting), el cliente de Firestore también apunta al emulador local en lugar de a una base de datos de producción.

Abre EmulatorUI

En tu navegador web, ve a http://127.0.0.1:4000/. Deberías ver la IU de Emulator Suite.

Haz clic para ver la IU del emulador de Firestore. La colección items ya contiene datos debido a los datos importados con la marca --import.

4. Ejecuta la app

Abre la app

En tu navegador web, navega a http://127.0.0.1:5000 y deberías ver que Fire Store se ejecuta localmente en tu máquina.

Usa la app

Elige un artículo en la página principal y haz clic en Add to Cart. Lamentablemente, verás el siguiente error:

Corrijamos ese error. Dado que todo se está ejecutando en los emuladores, podemos experimentar y no preocuparnos por afectar los datos reales.

5. Cómo depurar la app

Encuentra el error

Veamos la consola para desarrolladores de Chrome. Presiona Control+Shift+J (Windows, Linux, ChromeOS) o Command+Option+J (Mac) para ver el error en la consola:

Parece que se produjo un error en el método addToCart. Veamos eso. ¿Dónde intentamos acceder a algo llamado uid en ese método y por qué sería null? Por el momento, el método se ve de la siguiente manera en public/js/homepage.js:

public/js/homepage.js

  addToCart(id, itemData) {
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

Resultados No hemos accedido a la app. Según los documentos de Firebase Authentication, cuando no hemos accedido, auth.currentUser es null. Agreguemos una verificación para ello:

public/js/homepage.js

  addToCart(id, itemData) {
    // ADD THESE LINES
    if (this.auth.currentUser === null) {
      this.showError("You must be signed in!");
      return;
    }

    // ...
  }

Prueba la app

Ahora, actualiza la página y haz clic en Add to Cart. Deberías obtener un error más agradable esta vez:

Sin embargo, si haces clic en Sign In en la barra de herramientas superior y, luego, vuelves a hacer clic en Add to Cart, verás que el carrito se actualizó.

Nota: Con fines de demostración, esta aplicación usa exclusivamente Autenticación anónima. La autenticación anónima asigna a cada usuario de la sesión un ID que lo identifica de forma única en el backend. Permite crear una experiencia de integración sin que los usuarios deban crear una cuenta permanente de inmediato. En las aplicaciones de producción, para guardar los datos del usuario en distintas sesiones y dispositivos, deberás convertir a los usuarios de la autenticación anónima en otro método de acceso.

Sin embargo, parece que los números no son correctos:

No te preocupes, corregiremos ese error pronto. Primero, analicemos en detalle lo que sucedió cuando agregaste un artículo a tu carrito.

6. Activadores de funciones locales

Si haces clic en Add to Cart, se iniciará una cadena de eventos que involucra múltiples emuladores. En los registros de Firebase CLI, deberías ver algo similar a los siguientes mensajes después de agregar un artículo a tu carrito:

i  functions: Beginning execution of "calculateCart"
i  functions: Finished "calculateCart" in ~1s

Hubo cuatro eventos clave que produjeron esos registros y la actualización de la IU que observaste:

Nota: No necesitas actualizar tu app con los siguientes fragmentos de código. El código ya está incluido en la app. Los fragmentos de código de esta sección solo se presentan para ayudarte a comprender los cuatro eventos clave.

1) Escritura de Firestore: Cliente

Se agregará un documento nuevo a la colección /carts/{cartId}/items/{itemId}/ de Firestore. Puedes ver este código en la función addToCart dentro de public/js/homepage.js:

public/js/homepage.js

  addToCart(id, itemData) {
    // ...
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

2) Cloud Function activada

La Cloud Function calculateCart detecta cualquier evento de escritura (crear, actualizar o borrar) que ocurre con los elementos del carrito mediante el activador onWrite, que puedes ver en functions/index.js:

functions/index.js

exports.calculateCart = functions.firestore
    .document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    }
);

3) Firestore Write: Administrador

La función calculateCart lee todos los artículos del carrito y suma la cantidad total y el precio. Luego, actualiza el documento "carrito" con los nuevos totales (consulta cartRef.update(...) más arriba).

4) Lectura de Firestore: Cliente

El frontend web está suscrito para recibir actualizaciones sobre los cambios en el carrito. Recibe una actualización en tiempo real después de que la Cloud Function escribe los nuevos totales y actualiza la IU, como se puede ver en public/js/homepage.js:

public/js/homepage.js

this.cartUnsub = cartRef.onSnapshot(cart => {
   // The cart document was changed, update the UI
   // ...
});

Resumen

¡Buen trabajo! Solo debes configurar una app completamente local que use tres emuladores de Firebase diferentes para realizar pruebas completamente locales.

Espera, hay más calcomanías. En la próxima sección, aprenderás lo siguiente:

• Cómo escribir pruebas de unidades que usan los emuladores de Firebase
• Cómo usar los emuladores de Firebase para depurar tus reglas de seguridad

7. Crea reglas de seguridad personalizadas para tu app

Nuestra app web lee y escribe datos, pero hasta ahora no nos preocupamos en absoluto por la seguridad. Cloud Firestore usa un sistema llamado “Reglas de seguridad” para declarar quién tiene acceso para leer y escribir datos. Emulator Suite es una excelente manera de crear prototipos de estas reglas.

En el editor, abre el archivo emulators-codelab/codelab-initial-state/firestore.rules. Verás que tenemos tres secciones principales en nuestras reglas:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

En este momento, cualquier persona puede leer y escribir datos en nuestra base de datos. Queremos asegurarnos de que solo se produzcan las operaciones válidas y de no filtrar ninguna información sensible.

Durante este codelab, siguiendo el principio de privilegio mínimo, bloquearemos todos los documentos y agregaremos acceso gradualmente hasta que todos los usuarios tengan todo el acceso que necesitan, pero no más. Actualicemos las dos primeras reglas para denegar el acceso estableciendo la condición en false:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

Apartado: ¿Qué sucede si no hay declaraciones de coincidencias para una operación?

• Las reglas se rechazan de forma predeterminada. Si una operación no coincide con ninguna de las reglas definidas en el archivo de reglas, se denegará el acceso.
• El modo bloqueado (o modo de producción) convierte esa denegación implícita en una denegación explícita mediante la búsqueda de coincidencias con todos los documentos y la denegación de todo el acceso.

8. Ejecuta los emuladores y pruebas

Cómo iniciar los emuladores

En la línea de comandos, asegúrate de estar en emulators-codelab/codelab-initial-state/. Es posible que aún se estén ejecutando los emuladores de los pasos anteriores. De lo contrario, vuelve a iniciar los emuladores:

$ firebase emulators:start --import=./seed

Una vez que se estén ejecutando los emuladores, puedes ejecutar pruebas de forma local.

Ejecuta las pruebas

En la línea de comandos en una pestaña nueva de la terminal del directorio emulators-codelab/codelab-initial-state/

Primero, ve al directorio de funciones (nos quedaremos aquí durante el resto del codelab):

$ cd functions

Ahora, ejecuta las pruebas Mocha en el directorio de funciones y desplázate hasta la parte superior del resultado:

# Run the tests
$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    1) can be created and updated by the cart owner
    2) can be read only by the cart owner

  shopping cart items
    3) can be read only by the cart owner
    4) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  0 passing (364ms)
  1 pending
  4 failing

En este momento, tenemos cuatro errores. A medida que creas el archivo de reglas, puedes medir el progreso viendo más pruebas aprobadas.

9. Acceso seguro al carrito

Los primeros dos errores son las pruebas del "carrito de compras" que comprueban lo siguiente:

• Los usuarios solo pueden crear y actualizar sus propios carritos
• Los usuarios solo pueden leer sus propios carritos

functions/test.js

  it('can be created and updated by the cart owner', async () => {
    // Alice can create her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Bob can't create Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Alice can update her own cart with a new total
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").update({
      total: 1
    }));

    // Bob can't update Alice's cart with a new total
    await firebase.assertFails(bobDb.doc("carts/alicesCart").update({
      total: 1
    }));
  });

  it("can be read only by the cart owner", async () => {
    // Setup: Create Alice's cart as admin
    await admin.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    });

    // Alice can read her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").get());

    // Bob can't read Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").get());
  });

Hagamos que estas pruebas sean exitosas. En el editor, abre el archivo de reglas de seguridad, firestore.rules, y actualiza las sentencias dentro de match /carts/{cartID}:

firestore.rules

rules_version = '2';
service cloud.firestore {
    // UPDATE THESE LINES
    match /carts/{cartID} {
      allow create: if request.auth.uid == request.resource.data.ownerUID;
      allow read, update, delete: if request.auth.uid == resource.data.ownerUID;
    }

    // ...
  }
}

Estas reglas ahora solo permiten el acceso de lectura y escritura por parte del propietario del carrito.

Para verificar los datos entrantes y la autenticación del usuario, usamos dos objetos que están disponibles en el contexto de cada regla:

• El objeto request contiene datos y metadatos sobre la operación que se intenta ejecutar.
• Si un proyecto de Firebase usa Firebase Authentication, el objeto request.auth describe al usuario que realiza la solicitud.

¿Cuáles son las diferencias clave entre resource y request.resource****?

• resource: Representa el documento de Firestore en cuestión antes de la solicitud actual. Por lo tanto, para una solicitud create, resource.data siempre es null porque el documento aún no existe.
• request.resource: Representa el documento de Firestore con los cambios que el usuario desea escribir. Por lo tanto, para una solicitud create, request.resource.data contiene el documento propuesto.

10. Prueba el acceso al carrito

Emulator Suite actualiza las reglas automáticamente cada vez que se guarda firestore.rules. Para confirmar que el emulador tenga las reglas actualizadas, busca el mensaje Rules updated en la pestaña que ejecuta el emulador:

Vuelve a ejecutar las pruebas y verifica que las dos primeras pruebas ahora sean exitosas:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    1) can be read only by the cart owner
    2) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items

  2 passing (482ms)
  1 pending
  2 failing

¡Muy bien! Ahora tienes acceso seguro a los carritos de compras. Pasemos a la siguiente prueba fallida.

11. Verifica el flujo de “Agregar al carrito” en la IU.

En este momento, aunque los propietarios de carritos leen y escriben en su carrito, no pueden leer ni escribir artículos individuales en su carrito. Esto se debe a que, si bien los propietarios tienen acceso al documento del carrito, no tienen acceso a la subcolección de artículos del carrito.

Apartado: Las reglas no se transmiten en cascada sobre las subcolecciones

• De forma predeterminada, las reglas de un documento no se transmiten en cascada a los documentos de una subcolección.
• Es común querer reglas un poco diferentes para los documentos de una subcolección.
• Si quieres que los documentos de una subcolección tengan exactamente las mismas reglas, puedes usar la sintaxis glob para hacer coincidir todos los documentos de manera recursiva: match /{cartId=**} (haz esto con cuidado).

Este es un estado incorrecto para los usuarios.

Regresa a la IU web, que se ejecuta en http://127.0.0.1:5000,, y trata de agregar algo al carrito. Recibes un error Permission Denied, visible en la consola de depuración, porque aún no otorgamos a los usuarios acceso a los documentos creados en la subcolección items.

12. Permitir el acceso a los elementos del carrito

Estas dos pruebas confirman que los usuarios solo pueden agregar artículos a su propio carrito o leerlos desde allí:

  it("can be read only by the cart owner", async () => {
    // Alice can read items in her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/milk").get());

    // Bob can't read items in alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/milk").get())
  });

  it("can be added only by the cart owner",  async () => {
    // Alice can add an item to her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));

    // Bob can't add an item to alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));
  });

Entonces, podemos escribir una regla que permita el acceso si el usuario actual tiene el mismo UID que el ownerUID en el documento del carrito. Dado que no es necesario especificar reglas diferentes para create, update, delete, puedes usar una regla write, que se aplica a todas las solicitudes que modifican datos.

Actualiza la regla de los documentos de la subcolección de elementos. La get del condicional está leyendo un valor de Firestore; en este caso, el ownerUID en el documento del carrito.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ...

    // UPDATE THESE LINES
    match /carts/{cartID}/items/{itemID} {
      allow read, write: if get(/databases/$(database)/documents/carts/$(cartID)).data.ownerUID == request.auth.uid;
    }

    // ...
  }
}

Apartado: ¿Cuándo puedes usar un recurso o realizar una llamada de llamada?

• Puedes usar el objeto resource cuando los datos requeridos formen parte del documento actual que se está leyendo o escribiendo.
• Si necesitas datos fuera del documento actual, usa una sentencia get. Ten en cuenta que estas operaciones se consideran en tu factura de Firestore.

13. Probar el acceso a los artículos del carrito

Ahora podemos volver a ejecutar la prueba. Desplázate hasta la parte superior del resultado y verifica que se aprueben más pruebas:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    ✓ can be read only by the cart owner (111ms)
    ✓ can be added only by the cart owner


  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  4 passing (401ms)
  1 pending

¡Genial! Ahora todas nuestras pruebas son exitosas. Tenemos una prueba pendiente, pero lo abordaremos en unos pocos pasos.

14. Vuelve a verificar el flujo “agregar al carrito”

Regresa al frontend web ( http://127.0.0.1:5000) y agrega un artículo al carrito. Este es un paso importante para confirmar que nuestras pruebas y reglas coinciden con la funcionalidad que requiere el cliente. (Recuerda que la última vez que probamos la IU, los usuarios no pudieron agregar artículos a su carrito).

El cliente vuelve a cargar automáticamente las reglas cuando se guarda el firestore.rules. Intenta agregar algo al carrito.

Resumen

¡Buen trabajo! Acabas de mejorar la seguridad de tu app, un paso esencial para prepararla para la producción. Si se tratara de una app de producción, podríamos agregar estas pruebas a nuestra canalización de integración continua. Esto nos da la confianza en el futuro de que los datos del carrito de compras tendrán estos controles de acceso, incluso si otros están modificando las reglas.

Espera, ¡hay más!

Si continúas, aprenderás lo siguiente:

• Cómo escribir una función activada por un evento de Firestore
• Cómo crear pruebas que funcionen en varios emuladores

15. Configura las pruebas de Cloud Functions

Hasta ahora, nos enfocamos en el frontend de la aplicación web y en las reglas de seguridad de Firestore. Sin embargo, esta app también usa Cloud Functions para mantener actualizado el carrito del usuario, por lo que también queremos probar ese código.

Emulator Suite facilita probar Cloud Functions, incluso las funciones que usan Cloud Firestore y otros servicios.

En el editor, abre el archivo emulators-codelab/codelab-initial-state/functions/test.js y desplázate hasta la última prueba del archivo. En este momento, está marcado como pendiente:

//  REMOVE .skip FROM THIS LINE
describe.skip("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

Para habilitar la prueba, quita .skip de modo que se vea de la siguiente manera:

describe("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

A continuación, busca la variable REAL_FIREBASE_PROJECT_ID en la parte superior del archivo y cámbiala por el ID de tu proyecto de Firebase real:

// CHANGE THIS LINE
const REAL_FIREBASE_PROJECT_ID = "changeme";

Si olvidaste el ID del proyecto, puedes encontrarlo en la configuración del proyecto de Firebase console:

16. Explora las pruebas de Functions

Debido a que esta prueba valida la interacción entre Cloud Firestore y Cloud Functions, implica más configuración que las pruebas de los codelabs anteriores. Analicemos esta prueba para tener una idea de lo que se espera.

Nota: Los siguientes fragmentos de código tienen como objetivo ayudarte a leer y comprender el código que ya está escrito. En este paso, no tienes que cambiar la app en absoluto.

Cómo crear un carrito

Cloud Functions se ejecuta en un entorno de servidor confiable y puede usar la autenticación de cuenta de servicio que usa el SDK de Admin . Primero, inicializa una app con initializeAdminApp en lugar de initializeApp. Luego, crea una DocumentReference para el carrito al que agregaremos artículos y, luego, inicializaremos el carrito:

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    ...
  });

Activa la función

Luego, agrega documentos a la subcolección items de nuestro documento del carrito para activar la función. Agrega dos elementos para asegurarte de probar la suma que se produce en la función.

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    await aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    await aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });

    ...
    });
  });

Establece las expectativas de la prueba

Usa onSnapshot() a fin de registrar un objeto de escucha para cualquier cambio en el documento del carrito. onSnapshot() muestra una función a la que puedes llamar para cancelar el registro del objeto de escucha.

¿Por qué escuchar el documento del carrito en lugar de un documento de la subcolección de elementos?

Aunque la función se activa mediante operaciones de escritura en la subcolección items, la función actualiza el documento del carrito. Ese es un efecto secundario de la escritura inicial que queremos probar.

Para esta prueba, suma dos elementos que cuestan USD 9.98 juntos. Luego, verifica si el carrito tiene los itemCount y totalPrice esperados. Si es así, entonces la función hizo su trabajo.

it("should sum the cost of their items", (done) => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });
    
    // Listen for every update to the cart. Every time an item is added to
    // the cart's subcollection of items, the function updates `totalPrice`
    // and `itemCount` attributes on the cart.
    // Returns a function that can be called to unsubscribe the listener.
    await new Promise((resolve) => {
      const unsubscribe = aliceCartRef.onSnapshot(snap => {
        // If the function worked, these will be cart's final attributes.
        const expectedCount = 2;
        const expectedTotal = 9.98;
  
        // When the `itemCount`and `totalPrice` match the expectations for the
        // two items added, the promise resolves, and the test passes.
        if (snap.data().itemCount === expectedCount && snap.data().totalPrice == expectedTotal) {
          // Call the function returned by `onSnapshot` to unsubscribe from updates
          unsubscribe();
          resolve();
        };
      });
    });
   });
 });

17. Ejecuta las pruebas

Es posible que aún se estén ejecutando los emuladores de las pruebas anteriores. De lo contrario, inicia los emuladores. Desde la línea de comandos, ejecuta

$ firebase emulators:start --import=./seed

Abre una pestaña nueva de la terminal (deja los emuladores en ejecución) y ve al directorio de funciones. Es posible que aún lo tengas abierto desde las pruebas de reglas de seguridad.

$ cd functions

Ahora, ejecuta las pruebas de unidades. Deberías ver un total de 5 pruebas:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (82ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (42ms)

  shopping cart items
    ✓ items can be read by the cart owner (40ms)
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    1) should sum the cost of their items

  4 passing (2s)
  1 failing

Si observas la falla específica, parece ser un error de tiempo de espera. Esto se debe a que la prueba espera a que la función se actualice correctamente, pero nunca lo hace. Ahora, tenemos todo listo para escribir la función que satisfaga la prueba.

18. Escribe una función

Para corregir esta prueba, debes actualizar la función en functions/index.js. Aunque parte de esta función está escrita, no está completa. Así se ve la función actualmente:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 125.98;
      let itemCount = 8;
      try {
        
        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

La función configura correctamente la referencia del carrito, pero, en lugar de calcular los valores de totalPrice y itemCount, los actualiza a valores codificados.

Recupere e itere a través de

Subcolección items

Inicializa una constante nueva, itemsSnap, para que sea la subcolección items. Luego, itera por todos los documentos de la colección.

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }


      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        // ADD LINES FROM HERE
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
        })
        // TO HERE
       
        return cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

Cómo calcular totalPrice y itemCount

Primero, inicialicemos los valores de totalPrice y itemCount en cero.

Luego, agrega la lógica a nuestro bloque de iteración. Primero, verifica que el artículo tenga un precio. Si el elemento no tiene una cantidad especificada, esta se establece de forma predeterminada en 1. Luego, agrega la cantidad al total acumulado de itemCount. Por último, agrega el precio del artículo multiplicado por la cantidad por el total acumulado de totalPrice:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      try {
        // CHANGE THESE LINES
        let totalPrice = 0;
        let itemCount = 0;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          // ADD LINES FROM HERE
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = itemData.quantity ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
          // TO HERE
        })

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

También puedes agregar registros para ayudar a depurar estados de éxito y error:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 0;
      let itemCount = 0;
      try {
        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = (itemData.quantity) ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
        });

        await cartRef.update({
          totalPrice,
          itemCount
        });

        // OPTIONAL LOGGING HERE
        console.log("Cart total successfully recalculated: ", totalPrice);
      } catch(err) {
        // OPTIONAL LOGGING HERE
        console.warn("update error", err);
      }
    });

19. Volver a ejecutar las pruebas

En la línea de comandos, asegúrate de que los emuladores sigan ejecutándose y vuelve a ejecutar las pruebas. No es necesario que reinicies los emuladores, ya que detectan cambios en las funciones automáticamente. Deberías ver todas las pruebas aprobadas:

$ npm test
> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (306ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (59ms)

  shopping cart items
    ✓ items can be read by the cart owner
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    ✓ should sum the cost of their items (800ms)


  5 passing (1s)

¡Muy bien!

20. Pruébalo con la IU de Storefront

Para la prueba final, regresa a la app web ( http://127.0.0.1:5000/) y agrega un artículo al carrito.

Confirma que el carrito se actualice con el total correcto. Fantástico.

Resumen

Viste un caso de prueba complejo entre Cloud Functions para Firebase y Cloud Firestore. Escribiste una Cloud Function para realizar la prueba. También confirmaste que la nueva funcionalidad funciona en la IU. Lo hiciste todo de forma local y ejecutaste los emuladores en tu propia máquina.

También creaste un cliente web que se ejecuta con los emuladores locales, personalizaste las reglas de seguridad para proteger los datos y probaste estas reglas con los emuladores locales.