Desenvolvimento local com o Pacote de emuladores do Firebase

1. Antes de começar

As ferramentas de back-end sem servidor, como o Cloud Firestore e o Cloud Functions, são muito fáceis de usar, mas podem ser difíceis de testar. Com o Pacote de emuladores locais do Firebase, é possível executar versões locais desses serviços na sua máquina de desenvolvimento para criar o app de forma rápida e segura.

Pré-requisitos

• Um editor simples, como o Visual Studio Code, o Atom ou o Sublime Text.
• Node.js 10.0.0 ou mais recente (para instalar o Node.js, use o nvm; para verificar sua versão, execute node --version)
• Java 7 ou mais recente (para instalar o Java, use estas instruções; para verificar sua versão, execute java -version)

Atividades deste laboratório

Neste codelab, você vai executar e depurar um app simples de compras on-line que usa vários serviços do Firebase:

• Cloud Firestore: um banco de dados NoSQL sem servidor, escalonável globalmente e com recursos em tempo real.
• Cloud Functions: um código de back-end sem servidor que é executado em resposta a eventos ou solicitações HTTP.
• Firebase Authentication: um serviço de autenticação gerenciado que se integra a outros produtos do Firebase.
• Firebase Hosting: hospedagem rápida e segura para apps da Web.

Você vai conectar o app ao Pacote de emuladores para permitir o desenvolvimento local.

Você também vai aprender a:

• Como conectar seu app ao Pacote de emuladores e como os vários emuladores são conectados.
• Como as Regras de Segurança do Firebase funcionam e como testar as Regras de Segurança do Firestore em um emulador local.
• Como escrever uma Firebase Function que é acionada por eventos do Firestore e como escrever testes de integração que são executados no Pacote de emuladores.

2. Configurar

Acessar o código-fonte

Neste codelab, você vai começar com uma versão quase completa do exemplo do Fire Store. Portanto, a primeira coisa a fazer é clonar o código-fonte:

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

Em seguida, acesse o diretório do codelab, onde você vai trabalhar no restante deste codelab:

$ cd emulators-codelab/codelab-initial-state

Agora, instale as dependências para executar o código. Se a conexão de Internet estiver lenta, isso pode levar um ou dois minutos:

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

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

Instalar a CLI do Firebase

O Pacote de emuladores faz parte da CLI do Firebase (interface de linha de comando), que pode ser instalada na sua máquina com o seguinte comando:

$ npm install -g firebase-tools

Em seguida, confirme se você tem a versão mais recente da CLI. Este codelab funciona com a versão 9.0.0 ou mais recente, mas as versões mais recentes incluem mais correções de bugs.

$ firebase --version
9.6.0

Conectar ao seu projeto do Firebase

Criar um projeto do Firebase

1. Faça login no console do Firebase usando sua Conta do Google.
2. Clique no botão para criar um novo projeto e insira um nome (por exemplo, Emulators Codelab).
   

   Esse nome de projeto é usado como um nome de exibição nas interfaces do Firebase, e o Firebase cria automaticamente um ID do projeto exclusivo com base nesse nome de projeto. Se quiser, clique no ícone Editar agora para definir o ID do projeto que preferir, mas não é possível mudar esse ID depois da criação do projeto.

   Anote o ID do projeto, porque você vai precisar dele mais tarde para identificar seu projeto do Firebase na CLI do Firebase. Se você esquecer o ID, poderá encontrá-lo mais tarde nas Configurações do projeto.

3. Clique em Continuar.
4. Se solicitado, leia e aceite os Termos do Firebase e clique em Continuar.
5. (Opcional) Ative a assistência de IA no console do Firebase (chamada de "Gemini no Firebase").
6. Neste codelab, você não precisa do Google Analytics. Portanto, desative essa opção.
7. Clique em Criar projeto, aguarde o provisionamento do projeto e clique em Continuar.

Conectar o código ao projeto do Firebase

Agora precisamos conectar esse código ao seu projeto do Firebase. Primeiro, execute o seguinte comando para fazer login na CLI do Firebase:

$ firebase login

Em seguida, execute o comando abaixo para criar um alias de projeto. Substitua $YOUR_PROJECT_ID pelo ID do seu projeto do Firebase.

$ firebase use $YOUR_PROJECT_ID

Agora está tudo pronto para executar o app.

3. Executar os emuladores

Nesta seção, você vai executar o app localmente. Isso significa que é hora de inicializar o Pacote de emuladores.

Iniciar os emuladores

No diretório de origem do codelab, execute o seguinte comando para iniciar os emuladores:

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

Você vai encontrar este tipo de saída:

$ 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.

Quando a mensagem All emulators started aparecer, o app estará pronto para uso.

Observação: o que aconteceu?

• Cada emulador foi iniciado em 127.0.0.1, e cada um está sendo executado em uma porta diferente.
• O emulador do Firestore importou dados do diretório seed, que é fornecido para simplificar este codelab.
• O emulador do Functions percebeu a função calculateCart e notificou o emulador do Firestore.
• O emulador do Functions agora está monitorando o diretório functions em busca de mudanças no código.

Conectar o app da Web aos emuladores

Com base na tabela nos registros, podemos ver que o emulador do Cloud Firestore está detectando na porta 8080 e o emulador do Authentication está detectando na porta 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                             │
└────────────────┴────────────────┴─────────────────────────────────┘

Vamos conectar o código do front-end ao emulador, em vez de à produção. Abra o arquivo public/js/homepage.js e encontre a função onDocumentReady. O código acessa as instâncias padrão do Firestore e do Auth:

public/js/homepage.js

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

Vamos atualizar os objetos db e auth para que apontem para os emuladores locais:

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);
  }

Agora, quando o app estiver em execução na sua máquina local (veiculado pelo emulador do Hosting), o cliente do Firestore também vai apontar para o emulador local, em vez de um banco de dados de produção.

Abra a EmulatorUI.

No navegador da Web, acesse http://127.0.0.1:4000/. A interface do Pacote de Emuladores vai aparecer.

Clique para ver a interface do emulador do Firestore. A coleção items já contém dados devido à importação de dados com a flag --import.

4. Executar o app

Abra o app

No navegador da Web, acesse http://127.0.0.1:5000. Você verá o Fire Store em execução localmente na sua máquina.

Usar o app

Escolha um item na página inicial e clique em Adicionar ao carrinho. Infelizmente, você vai encontrar o seguinte erro:

Vamos corrigir esse bug. Como tudo está sendo executado nos emuladores, podemos fazer testes sem nos preocupar em afetar dados reais.

5. Depurar o app

Encontrar o bug

Vamos conferir o console para desenvolvedores do Chrome. Pressione Control+Shift+J (Windows, Linux, Chrome OS) ou Command+Option+J (Mac) para ver o erro no console:

Parece que houve um erro no método addToCart. Vamos dar uma olhada. Onde tentamos acessar algo chamado uid nesse método e por que ele seria null? No momento, o método em public/js/homepage.js é assim:

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);
  }

Aha! Não fizemos login no app. De acordo com a documentação do Firebase Authentication, quando não fazemos login, auth.currentUser é null. Vamos adicionar uma verificação para isso:

public/js/homepage.js

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

    // ...
  }

Testar o app

Agora, atualize a página e clique em Adicionar ao carrinho. Desta vez, você vai receber um erro mais amigável:

No entanto, se você clicar em Fazer login na barra de ferramentas superior e depois em Adicionar ao carrinho novamente, o carrinho será atualizado.

Observação: para fins de demonstração, este aplicativo usa exclusivamente a autenticação anônima. A autenticação anônima atribui a cada usuário da sessão um ID que o identifica de forma exclusiva para o back-end. Com ele, é possível criar uma experiência de integração que não exige que os usuários criem uma conta permanente imediatamente. Em aplicativos de produção, para salvar dados do usuário em sessões e dispositivos, é necessário converter os usuários da autenticação anônima para outro método de login.

No entanto, parece que os números não estão corretos:

Não se preocupe, vamos corrigir esse bug em breve. Primeiro, vamos analisar o que realmente aconteceu quando você adicionou um item ao carrinho.

6. Gatilhos de funções locais

Clicar em Adicionar ao carrinho inicia uma cadeia de eventos que envolve vários emuladores. Nos registros da CLI do Firebase, você verá mensagens como as seguintes depois de adicionar um item ao carrinho:

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

Quatro eventos principais ocorreram para produzir esses registros e a atualização da interface que você observou:

Observação: não é necessário atualizar o app com os snippets de código abaixo. O código já está incluído no app. Os snippets de código nesta seção são apresentados apenas para ajudar você a entender os quatro eventos principais.

1) Gravação do Firestore: cliente

Um novo documento é adicionado à coleção /carts/{cartId}/items/{itemId}/ do Firestore. Você pode ver esse código na função 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 acionada

A função do Cloud calculateCart detecta todos os eventos de gravação (criar, atualizar ou excluir) que acontecem com os itens do carrinho usando o gatilho onWrite, que pode ser visto em 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) Gravação do Firestore: administrador

A função calculateCart lê todos os itens no carrinho, soma a quantidade e o preço total e atualiza o documento "cart" com os novos totais (consulte cartRef.update(...) acima).

4) Leitura do Firestore: cliente

O front-end da Web está inscrito para receber atualizações sobre mudanças no carrinho. Ele recebe uma atualização em tempo real depois que a função do Cloud grava os novos totais e atualiza a interface, como mostrado em public/js/homepage.js:

public/js/homepage.js

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

Resumo

Bom trabalho! Você acabou de configurar um app totalmente local que usa três emuladores diferentes do Firebase para testes totalmente locais.

Ei, tem mais! Na próxima seção, você vai aprender:

• Como escrever testes de unidade que usam os emuladores do Firebase.
• Como usar os emuladores do Firebase para depurar suas regras de segurança.

7. Criar regras de segurança personalizadas para seu app

Nosso app da Web lê e grava dados, mas até agora não nos preocupamos com a segurança. O Cloud Firestore usa um sistema chamado "Regras de segurança" para declarar quem tem acesso para ler e gravar dados. O Pacote de emuladores é uma ótima maneira de criar protótipos dessas regras.

No editor, abra o arquivo emulators-codelab/codelab-initial-state/firestore.rules. Você vai notar que temos três seções principais nas nossas regras:

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;
    }
  }
}

No momento, qualquer pessoa pode ler e gravar dados no nosso banco de dados. Queremos garantir que apenas operações válidas sejam realizadas e que nenhuma informação sensível seja vazada.

Neste codelab, seguindo o princípio de privilégio mínimo, vamos bloquear todos os documentos e adicionar acesso gradualmente até que todos os usuários tenham o acesso necessário, mas não mais do que isso. Vamos atualizar as duas primeiras regras para negar o acesso definindo a condição como 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;
    }
  }
}

E se não houver instruções de correspondência para uma operação?

• As regras negam por padrão. Se uma operação não corresponder a nenhuma regra definida no arquivo de regras, o acesso será negado.
• O modo bloqueado, ou modo de produção, torna essa negação implícita uma negação explícita ao corresponder todos os documentos e negar todo o acesso.

8. Executar os emuladores e testes

Iniciar os emuladores

Na linha de comando, verifique se você está em emulators-codelab/codelab-initial-state/. Talvez os emuladores ainda estejam em execução nas etapas anteriores. Caso contrário, inicie os emuladores novamente:

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

Depois que os emuladores estiverem em execução, você poderá executar testes localmente neles.

Executar os testes

Na linha de comando em uma nova guia do terminal no diretório emulators-codelab/codelab-initial-state/:

Primeiro, acesse o diretório de funções (vamos ficar aqui pelo restante do codelab):

$ cd functions

Agora execute os testes do Mocha no diretório de funções e role até o topo da saída:

# 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

No momento, temos quatro falhas. Ao criar o arquivo de regras, você pode medir o progresso observando mais testes serem aprovados.

9. Acesso seguro ao carrinho

As duas primeiras falhas são os testes de "carrinho de compras", que verificam se:

• Os usuários só podem criar e atualizar os próprios carrinhos
• Os usuários só podem ler os próprios carrinhos

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());
  });

Vamos fazer com que esses testes sejam aprovados. No editor, abra o arquivo de regras de segurança, firestore.rules, e atualize as instruções em 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;
    }

    // ...
  }
}

Agora, essas regras permitem apenas o acesso de leitura e gravação pelo proprietário do carrinho.

Para verificar os dados recebidos e a autenticação do usuário, usamos dois objetos que estão disponíveis no contexto de cada regra:

• O objeto request contém dados e metadados sobre a operação que está sendo tentada.
• Se um projeto do Firebase estiver usando o Firebase Authentication, o objeto request.auth vai descrever o usuário que está fazendo a solicitação.

Quais são as principais diferenças entre o resource e o request.resource?

• resource: representa o documento do Firestore em questão antes da solicitação atual. Portanto, para uma solicitação create, resource.data é sempre null porque o documento ainda não existe.
• request.resource: representa o documento do Firestore com as mudanças que o usuário quer gravar. Portanto, para uma solicitação create, request.resource.data contém o documento proposto.

10. Testar o acesso ao carrinho

O Pacote de emuladores atualiza automaticamente as regras sempre que firestore.rules é salvo. Para confirmar que o emulador atualizou as regras, procure a mensagem Rules updated na guia em que ele está sendo executado:

Execute os testes novamente e verifique se os dois primeiros foram aprovados:

$ 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

Bom trabalho! Agora você protegeu o acesso aos carrinhos de compras. Vamos para o próximo teste com falha.

11. Verificar o fluxo "Adicionar ao carrinho" na interface

No momento, embora os proprietários de carrinhos possam ler e gravar no carrinho, eles não podem ler ou gravar itens individuais nele. Isso ocorre porque, embora os proprietários tenham acesso ao documento do carrinho, eles não têm acesso à subcoleção de itens do carrinho.

Observação: as regras não se aplicam em cascata às subcoleções

• Por padrão, as regras de um documento não são aplicadas em cascata aos documentos de uma subcoleção.
• É comum querer regras um pouco diferentes para documentos em uma subcoleção.
• Se você quiser que os documentos em uma subcoleção tenham exatamente as mesmas regras, use a sintaxe glob para corresponder a todos os documentos de forma recursiva: match /{cartId=**} (faça isso com cuidado).

Esse é um estado corrompido para os usuários.

Volte para a interface da Web, que está em execução em http://127.0.0.1:5000,, e tente adicionar algo ao carrinho. Você vai receber um erro Permission Denied, visível no console de depuração, porque ainda não concedemos aos usuários acesso aos documentos criados na subcoleção items.

12. Permitir acesso aos itens do carrinho

Estes dois testes confirmam que os usuários só podem adicionar itens ao próprio carrinho ou ler itens dele:

  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
    }));
  });

Portanto, podemos escrever uma regra que permita o acesso se o usuário atual tiver o mesmo UID que o ownerUID no documento do carrinho. Como não é necessário especificar regras diferentes para create, update, delete, use uma regra write, que se aplica a todas as solicitações que modificam dados.

Atualize a regra para os documentos na subcoleção de itens. O get na condicional está lendo um valor do Firestore, neste caso, o ownerUID no documento do carrinho.

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;
    }

    // ...
  }
}

Observação: quando você pode usar um recurso ou fazer uma chamada get?

• É possível usar o objeto resource quando os dados necessários fazem parte do documento atual que está sendo lido/gravado.
• Se você precisar de dados fora do documento atual, use uma instrução get. Essas operações são contabilizadas na sua fatura do Firestore.

13. Testar o acesso aos itens do carrinho

Agora podemos executar o teste novamente. Role até a parte de cima da saída e verifique se mais testes foram aprovados:

$ 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

Muito bem! Agora, todos os testes foram aprovados. Temos um teste pendente, mas vamos falar sobre isso em algumas etapas.

14. Verifique o fluxo "Adicionar ao carrinho" novamente

Volte para o front-end da Web (http://127.0.0.1:5000) e adicione um item ao carrinho. Essa é uma etapa importante para confirmar que nossos testes e regras correspondem à funcionalidade exigida pelo cliente. (Lembre-se de que, na última vez que testamos a interface, os usuários não conseguiram adicionar itens ao carrinho!)

O cliente recarrega automaticamente as regras quando o firestore.rules é salvo. Tente adicionar algo ao carrinho.

Resumo

Bom trabalho! Você acabou de melhorar a segurança do seu app, uma etapa essencial para prepará-lo para produção. Se este fosse um app de produção, poderíamos adicionar esses testes ao nosso pipeline de integração contínua. Isso nos daria a confiança de que nossos dados do carrinho de compras terão esses controles de acesso, mesmo que outras pessoas modifiquem as regras.

Mas espere, tem mais!

Se você continuar, vai aprender:

• Como escrever uma função acionada por um evento do Firestore
• Como criar testes que funcionam em vários emuladores.

15. Configurar testes do Cloud Functions

Até agora, nos concentramos no front-end do nosso app da Web e nas regras de segurança do Firestore. Mas esse app também usa o Cloud Functions para manter o carrinho do usuário atualizado, então também queremos testar esse código.

O Pacote de emuladores facilita o teste do Cloud Functions, até mesmo de funções que usam o Cloud Firestore e outros serviços.

No editor, abra o arquivo emulators-codelab/codelab-initial-state/functions/test.js e role até o último teste. No momento, ela está marcada como pendente:

//  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 ativar o teste, remova .skip para que ele fique assim:

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

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

Em seguida, encontre a variável REAL_FIREBASE_PROJECT_ID na parte de cima do arquivo e mude para o ID real do seu projeto do Firebase:

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

Se você esqueceu o ID do projeto, é possível encontrar o ID do Projeto do Firebase nas configurações do projeto no console do Firebase:

16. Analisar os testes do Functions

Como esse teste valida a interação entre o Cloud Firestore e o Cloud Functions, ele envolve mais configuração do que os testes nos codelabs anteriores. Vamos analisar esse teste e entender o que ele espera.

Observação: os snippets de código abaixo servem para ajudar você a ler e entender o código que já foi escrito. Nesta etapa, você não precisa mudar nada no app.

Criar um carrinho

O Cloud Functions é executado em um ambiente de servidor confiável e pode usar a autenticação de conta de serviço usada pelo SDK Admin . Primeiro, inicialize um app usando initializeAdminApp em vez de initializeApp. Em seguida, crie uma DocumentReference para o carrinho em que vamos adicionar itens e inicialize o carrinho:

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 });

    ...
  });

Acionar a função

Em seguida, adicione documentos à subcoleção items do documento do carrinho para acionar a função. Adicione dois itens para testar a adição que acontece na função.

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 });

    ...
    });
  });

Definir expectativas de teste

Use onSnapshot() para registrar um listener para todas as mudanças no documento do carrinho. onSnapshot() retorna uma função que pode ser chamada para cancelar o registro do listener.

Por que detectar o documento do carrinho em vez de um documento na subcoleção de itens?

Embora a função seja acionada por operações de gravação na subcoleção items, ela atualiza o documento do carrinho. Esse é um efeito colateral da gravação inicial que queremos testar.

Para este teste, adicione dois itens que, juntos, custam US $9,98. Em seguida, verifique se o carrinho tem os valores esperados de itemCount e totalPrice. Se sim, a função fez o trabalho dela.

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. Executar os testes

Talvez os emuladores ainda estejam em execução por causa dos testes anteriores. Caso contrário, inicie os emuladores. Na linha de comando, execute

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

Abra uma nova guia do terminal (deixe os emuladores em execução) e acesse o diretório de funções. Talvez ele ainda esteja aberto por causa dos testes de regras de segurança.

$ cd functions

Agora execute os testes de unidade. Você verá 5 testes no total:

$ 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

Se você analisar a falha específica, ela parece ser um erro de tempo limite. Isso ocorre porque o teste está esperando que a função seja atualizada corretamente, mas isso nunca acontece. Agora, estamos prontos para escrever a função que vai atender ao teste.

18. Escrever função

Para corrigir esse teste, atualize a função em functions/index.js. Embora parte dessa função esteja escrita, ela não está completa. A função atual é assim:

// 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) {
      }
    });

A função está definindo corretamente a referência do carrinho, mas, em vez de calcular os valores de totalPrice e itemCount, ela os atualiza para valores fixados no código.

Buscar e iterar pelo

subcoleção items

Inicialize uma nova constante, itemsSnap, para ser a subcoleção items. Em seguida, faça uma iteração em todos os documentos da coleção.

// 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) {
      }
    });

Calcular totalPrice e itemCount

Primeiro, vamos inicializar os valores de totalPrice e itemCount como zero.

Em seguida, adicione a lógica ao nosso bloco de iteração. Primeiro, verifique se o item tem um preço. Se o item não tiver uma quantidade especificada, use o padrão 1. Em seguida, adicione a quantidade ao total acumulado de itemCount. Por fim, adicione o preço do item multiplicado pela quantidade ao 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) {
      }
    });

Também é possível adicionar registros para ajudar a depurar estados de sucesso e erro:

// 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. Executar os testes novamente

Na linha de comando, verifique se os emuladores ainda estão em execução e execute os testes novamente. Não é necessário reiniciar os emuladores, porque eles detectam as mudanças nas funções automaticamente. Você vai notar que todos os testes foram aprovados:

$ 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)

Bom trabalho!

20. Teste usando a interface da vitrine

Para o teste final, volte ao app da Web (http://127.0.0.1:5000/) e adicione um item ao carrinho.

Confirme se o carrinho é atualizado com o total correto. Ótimo.

Resumo

Você analisou um caso de teste complexo entre o Cloud Functions para Firebase e o Cloud Firestore. Você escreveu uma função do Cloud para que o teste fosse aprovado. Você também confirmou que a nova funcionalidade está funcionando na interface. Você fez tudo isso localmente, executando os emuladores na sua própria máquina.

Você também criou um cliente da Web que está sendo executado nos emuladores locais, adaptou as regras de segurança para proteger os dados e testou as regras de segurança usando os emuladores locais.