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. O Pacote de emuladores locais do Firebase permite executar versões locais desses serviços na sua máquina de desenvolvimento para desenvolver apps com rapidez e segurança.

Pré-requisitos

• Um editor simples, como Visual Studio Code, Atom ou Sublime Text
• Node.js 10.0.0 ou mais recente (para instalar o Node.js, use o nvm e, 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ê executará e depurará um app de compras on-line simples que é alimentado por vários serviços do Firebase:

• Cloud Firestore: um banco de dados NoSQL globalmente escalonável e sem servidor 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 ativar o desenvolvimento local.

Você também vai aprender a:

• Como conectar seu app ao conjunto 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 criar uma função do Firebase acionada por eventos do Firestore e como criar testes de integração que são executados no pacote do emulador.

2. Configurar

Fazer o download do código-fonte

Neste codelab, você começa com uma versão do exemplo do Fire Store quase concluída. Portanto, a primeira coisa que você precisa 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 pelo restante deste codelab:

$ cd emulators-codelab/codelab-initial-state

Agora, instale as dependências para executar o código. Se você estiver em uma conexão de Internet mais 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 conjunto de emuladores faz parte da CLI (interface de linha de comando) do Firebase, 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. Esse codelab deve funcionar 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-se ao seu projeto do Firebase

Se você não tiver um projeto do Firebase, crie um novo projeto no Console do Firebase. Anote o ID do projeto escolhido, porque você vai precisar dele mais tarde.

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 a seguir 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

O resultado deve ser parecido com 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.

Quando a mensagem Todos os emuladores iniciados aparecer, o app estará pronto para uso.

À parte: o que acabou de acontecer?

• 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 detectou 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                             │
└────────────────┴────────────────┴─────────────────────────────────┘

Agora é hora de conectar o código de front-end ao emulador, e não à produção. Abra o arquivo public/js/homepage.js e encontre a função onDocumentReady. Podemos ver que o código acessa as instâncias padrão do Firestore e do Auth:

public/js/homepage.js (link em inglês)

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

Vamos atualizar os objetos db e auth para apontar 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 (veiculada pelo emulador do Hosting), o cliente do Firestore também apontará para o emulador local, e não para um banco de dados de produção.

Abrir o 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 com a flag --import.

4. Execute o aplicativo

Abrir o app

No navegador da Web, acesse http://127.0.0.1:5000. Você verá o The Fire Store sendo executado localmente em 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 com a alteração de dados reais.

5. Depurar o app

Encontre o bug

Certo, vamos dar uma olhada no console do desenvolvedor do Chrome. Pressione Control+Shift+J (Windows, Linux, Chrome OS) ou Command+Option+J (Mac) para ver o erro no console:

Parece que ocorreu um erro no método addToCart. Vamos dar uma olhada. Onde tentamos acessar algo chamado uid nesse método e por que seria null? Agora, o método ficará assim em 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);
  }

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 (link em inglês)

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

    // ...
  }

Testar o app

Agora, recarregue a página e clique em Adicionar ao carrinho. Você verá um erro melhor desta vez:

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

Observação: para fins de demonstração, esse aplicativo usa exclusivamente Autenticação anônima. A autenticação anônima atribui a cada usuário de sessão um ID que o identifica exclusivamente para o back-end. Ele permite 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 várias sessões e dispositivos, é necessário converter os usuários da autenticação anônima para outro método de login.

No entanto, os números não parecem estar corretos:

Não se preocupe, vamos corrigir esse bug em breve. Primeiro, vamos ver 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 seu 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 conferir 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) Função do Cloud acionada

A função do Cloud calculateCart detecta eventos de gravação (criação, atualização ou exclusão) ocorridos com itens do carrinho usando o gatilho onWrite, que pode ser encontrado 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 no Firestore: administrador

A função calculateCart lê todos os itens no carrinho e soma a quantidade e o preço total, depois atualiza o documento "carrinho" 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 alterações no carrinho. Ela 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 criar testes de unidade que usam os emuladores do Firebase.
• Como usar os emuladores do Firebase para depurar suas regras de segurança.

7. Crie 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 de leitura e gravação. O Pacote de emuladores é uma ótima maneira de prototipar essas regras.

No editor, abra o arquivo emulators-codelab/codelab-initial-state/firestore.rules. Temos três seções principais em 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 somente as operações válidas sejam aprovadas e que não haja vazamento de informações sensíveis.

Durante este 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 todo o acesso necessário, mas não mais. 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;
    }
  }
}

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

• As regras são negadas por padrão. Se uma operação não corresponder a nenhuma das regras definidas no arquivo de regras, o acesso será negado.
• O modo bloqueado, ou de produção, transforma essa negação implícita em uma negação explícita, combinando todos os documentos e negando 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/. Os emuladores ainda podem estar em execução das etapas anteriores. Caso contrário, inicie os emuladores novamente:

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

Quando os emuladores estiverem em execução, será possível realizar testes localmente.

Executar os testes

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

Primeiro, vá para o diretório de funções (vamos continuar aqui pelo restante do codelab):

$ cd functions

Agora, execute os testes do Mocha no diretório de funções e role até a parte de cima 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ê observa o progresso em mais testes para medir o progresso.

9. Proteger o acesso ao carrinho

As duas primeiras falhas são "carrinho de compras" que testam 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 (em inglês)

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 só permitem acesso de leitura e gravação do proprietário do carrinho.

Para verificar os dados recebidos e a autenticação do usuário, usamos dois objetos 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 usar o Firebase Authentication, o objeto request.auth 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 de criação, resource.data é sempre null, porque o documento ainda não existe.
• request.resource: representa o documento do Firestore com as alterações que o usuário quer gravar. Portanto, para uma solicitação de criação, 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 que está executando o emulador:

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ê tem acesso seguro 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 leiam e gravem no carrinho, eles não podem ler ou gravar itens individuais. 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 funcionam em cascata nas subcoleções

• Por padrão, as regras de um documento não são aplicadas em cascata aos documentos em 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 todos os documentos recursivamente: match /{cartId=**} (faça isso com cuidado).

Esse é um estado corrompido para os usuários.

Volte à interface da Web, que está sendo executada em http://127.0.0.1:5000,, e tente adicionar algo ao seu carrinho. Você recebe 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

Esses dois testes confirmam que os usuários só podem adicionar ou ler itens do próprio carrinho:

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

Assim, podemos criar uma regra que permite o acesso se o usuário atual tiver o mesmo UID do ownerUID no documento do carrinho. Como não é necessário especificar regras diferentes para create, update, delete, você pode usar 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 condição 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 é possível usar um recurso ou fazer uma chamada de recebimento?

• É 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 de novo. Role até o topo da saída e confira se mais testes são 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 ele será resolvido em algumas etapas.

14. Verifique o fluxo "adicionar ao carrinho" novamente

Volte ao front-end da Web (http://127.0.0.1:5000) e adicione um item ao carrinho. Essa é uma etapa importante para confirmar se 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. Por isso, tente adicionar algo ao carrinho.

Resumo

Bom trabalho! Você acabou de melhorar a segurança do app, uma etapa essencial para deixá-lo pronto para produção. Se fosse um app de produção, poderíamos adicionar esses testes ao nosso pipeline de integração contínua. Isso nos daria confiança de que daqui para frente os dados de nosso carrinho de compras terão esses controles de acesso, mesmo se outros estiverem modificando as regras.

Mas espere, tem mais!

se continuar, você 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 queremos testar esse código também.

O pacote de emuladores facilita o teste do Cloud Functions, mesmo em 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, ele está marcado 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 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 do projeto do Firebase real:

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

Se você esqueceu o ID do projeto, ele pode ser encontrado nas configurações do projeto no Console do Firebase:

16. Como fazer testes de funções

Como este teste valida a interação entre o Cloud Firestore e o Cloud Functions, ele envolve mais configuração do que os testes dos codelabs anteriores. Vamos fazer este teste e ter uma ideia do que ele espera.

Observação: os snippets de código abaixo ajudam você a ler e entender o código que já está escrito. Nesta etapa, você não precisa mudar o app.

Criar um carrinho

O Cloud Functions é executado em um ambiente de servidor confiável e pode usar a autenticação da 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 as expectativas do teste

Use onSnapshot() para registrar um listener para qualquer mudança 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, a função 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 itemCount e os totalPrice esperados. Em caso afirmativo, a função fez seu trabalho.

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

Os emuladores ainda podem estar sendo executados nos 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 você ainda tenha essa opção aberta nos testes de regras de segurança.

$ cd functions

Agora, execute os testes de unidade. Você vai encontrar cinco 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, parece ser um erro de tempo limite. Isso acontece porque o teste está esperando a função ser atualizada corretamente, mas isso nunca acontece. Agora, estamos prontos para escrever a função para satisfazer o teste.

18. Escrever uma 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. Confira como a função está atualmente:

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

items Subcoleção

Inicialize uma nova constante, itemsSnap, para ser a subcoleção items. Em seguida, itere 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, defina como padrão 1. Em seguida, adicione a quantidade ao total em execução de itemCount. Por fim, adicione o preço do item multiplicado pela quantidade ao total atual 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 a geração de registros para ajudar a depurar os 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 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 alterações nas funções automaticamente. Todos os testes vão ser 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 Storefront

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ê viu 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 é executado nos emuladores locais, personalizou regras de segurança para proteger os dados e testou as regras de segurança usando os emuladores locais.