Codelab da Web do AngularFire

1. Visão geral

Neste codelab, você vai aprender a usar o AngularFire para criar aplicativos da Web implementando e implantando um cliente de chat com os produtos e serviços do Firebase.

Um app de chat em que os usuários estão discutindo o Firebase

O que você vai aprender

  • Crie um app da Web usando o Angular e o Firebase.
  • Sincronize dados usando o Cloud Firestore e o Cloud Storage para Firebase.
  • Autenticar os usuários usando o Firebase Authentication.
  • Implante seu app da Web no Firebase App Hosting.
  • Enviar notificações com o Firebase Cloud Messaging
  • Colete os dados de desempenho do seu app da Web.

Pré-requisitos

  • Uma conta no GitHub
  • A capacidade de fazer upgrade do seu projeto do Firebase para o plano de preços Blaze
  • O ambiente de desenvolvimento integrado/editor de texto de sua escolha, como o WebStorm, o Sublime ou o VS Code
  • O gerenciador de pacotes npm, que geralmente vem com o Node.js
  • Um terminal/console
  • Um navegador de sua escolha, como o Chrome
  • O exemplo de código do codelab (confira a próxima etapa do codelab para saber como acessar o código).

2. Acessar o exemplo de código

Crie um repositório do GitHub

A origem do codelab pode ser encontrada em https://github.com/firebase/codelab-friendlychat-web. O repositório contém projetos de exemplo para várias plataformas. No entanto, este codelab usa apenas o diretório angularfire-start.

Copie a pasta angularfire-start para seu próprio repositório:

  1. Usando um terminal, crie uma nova pasta no computador e mude para o novo diretório:
    mkdir codelab-friendlyeats-web

cd codelab-friendlyeats-web
  2. Use o pacote npm giget para buscar apenas a pasta angularfire-start:
    npx giget@latest gh:firebase/codelab-friendlychat-web/angularfire-start#master . --install
  3. Acompanhar as alterações localmente com o git:
    git init

git add .

git commit -m "codelab starting point"

git branch -M main
  4. Crie um novo repositório do GitHub: https://github.com/new. Dê o nome que quiser.
    1. O GitHub vai fornecer um novo URL do repositório que se parece com https://github.com/[user-name]/[repository-name].git ou git@github.com:[user-name]/[repository-name].git. Copie este URL.
  5. Envie as mudanças locais para o novo repositório do GitHub. Execute o comando a seguir, substituindo o URL do repositório pelo marcador de posição your-repository-url.
    git remote add origin your-repository-url

git push -u origin main
  6. O código inicial vai aparecer no seu repositório do GitHub.

3. Criar e configurar um projeto do Firebase

Criar um projeto do Firebase

  1. Faça login no console do Firebase.
  2. No console do Firebase, clique em Adicionar projeto e nomeie o projeto como FriendlyChat. Lembre-se do ID do projeto do Firebase.
  3. Desmarque a opção Ativar o Google Analytics neste projeto.
  4. Clique em Criar projeto.

O aplicativo que você vai criar usa produtos do Firebase disponíveis para apps da Web:

  • Firebase Authentication: permite que os usuários façam login no app com facilidade.
  • Cloud Firestore: é usado para salvar dados estruturados na nuvem e receber notificações instantâneas quando os dados são alterados.
  • Cloud Storage para Firebase: é usado para salvar arquivos na nuvem.
  • Firebase App Hosting para criar, hospedar e exibir o app.
  • Firebase Cloud Messaging: é usado para enviar notificações push e exibir notificações pop-up do navegador.
  • Monitoramento de desempenho do Firebase para coletar dados de performance do usuário do seu app.

Alguns desses produtos necessitam de configuração especial ou precisam ser ativados usando o Console do Firebase.

Fazer upgrade do plano de preços do Firebase

Para usar o Firebase App Hosting e o Cloud Storage para Firebase, seu projeto do Firebase precisa estar no plano de preços de pagamento por uso (Blaze), ou seja, vinculado a uma conta do Cloud Billing.

  • Uma conta do Cloud Billing exige uma forma de pagamento, como cartão de crédito.
  • Se você ainda não conhece o Firebase e o Google Cloud, confira se tem qualificação para receber um crédito de US$300 e uma conta de teste sem custo financeiro do Cloud Billing.
  • Se você estiver fazendo este codelab como parte de um evento, pergunte ao organizador se há créditos do Cloud disponíveis.

Para fazer upgrade do seu projeto para o plano Blaze, siga estas etapas:

  1. No console do Firebase, selecione Fazer upgrade do seu plano.
  2. Selecione o plano Blaze. Siga as instruções na tela para vincular uma conta do Cloud Billing ao seu projeto.
    Se você precisou criar uma conta do Cloud Billing como parte desse upgrade, talvez seja necessário voltar ao fluxo de upgrade no console do Firebase para concluir o upgrade.

Adicionar um app da Web do Firebase ao projeto

  1. Clique no ícone da Web 58d6543a156e56f9.png para criar um app da Web do Firebase.
  2. Registre o app com o apelido Friendly Chat. Não marque a caixa ao lado de Também configurar o Firebase Hosting para este app. Clique em Registrar app.
  3. Na próxima etapa, você vai encontrar um objeto de configuração. Você não precisa dele agora. Clique em Continuar para o Console.

Captura de tela do registro do app da Web

Configurar o Authentication

Para permitir que os usuários façam login no app da Web com as próprias Contas do Google, use o método de login do Google.

  1. No console do Firebase, navegue até Autenticação.
  2. Clique em Começar.
  3. Na coluna Outros provedores, clique em Google > Ativar.
  4. Na caixa de texto Nome voltado ao público do projeto, digite um nome fácil de lembrar, como My Next.js app.
  5. No menu suspenso E-mail de suporte do projeto, selecione seu endereço de e-mail.
  6. Clique em Salvar.

Configurar o Cloud Firestore

O app da Web usa o Cloud Firestore para salvar e receber novas mensagens de chat.

Confira como configurar o Cloud Firestore no seu projeto do Firebase:

  1. No painel à esquerda do Console do Firebase, expanda Build e selecione Banco de dados do Firestore.
  2. Clique em Criar banco de dados.
  3. Deixe o ID do banco de dados definido como (default).
  4. Selecione um local para o banco de dados e clique em Próxima.
    No caso de apps reais, escolha um local próximo aos usuários.
  5. Clique em Iniciar no modo de teste. Leia o aviso sobre as regras de segurança.
    Mais adiante neste codelab, você vai adicionar regras de segurança para proteger seus dados. Não distribua ou exponha um aplicativo publicamente sem adicionar regras de segurança ao seu banco de dados.
  6. Clique em Criar.

Configurar o Cloud Storage para Firebase

O app da Web usa o Cloud Storage para Firebase para armazenar, fazer upload e compartilhar fotos.

Confira como configurar o Cloud Storage para Firebase no seu projeto do Firebase:

  1. No painel à esquerda do Console do Firebase, expanda Build e selecione Armazenamento.
  2. Clique em Começar.
  3. Selecione um local para o bucket do Storage padrão.
    Os buckets em US-WEST1, US-CENTRAL1 e US-EAST1 podem aproveitar o nível "Sempre sem custo financeiro" do Google Cloud Storage. Os buckets em todos os outros locais seguem os preços e o uso do Google Cloud Storage.
  4. Clique em Iniciar no modo de teste. Leia o aviso sobre as regras de segurança.
    Mais adiante neste codelab, você vai adicionar regras de segurança para proteger seus dados. Não distribua ou exponha um aplicativo publicamente sem adicionar regras de segurança ao bucket do Storage.
  5. Clique em Criar.

4. Instalar a interface de linha de comando do Firebase

A interface de linha de comando (CLI) do Firebase permite usar o Firebase Hosting para disponibilizar seu app da Web localmente e implantar no projeto do Firebase.

  1. Instale a CLI executando o seguinte comando do npm:
npm -g install firebase-tools@latest
  1. Verifique se a CLI foi instalada corretamente executando o seguinte comando:
firebase --version

A CLI do Firebase precisa estar na versão vv13.9.0 ou mais recente.

  1. Autorize a CLI do Firebase executando o seguinte comando:
firebase login

Você configurou o modelo de app da Web para extrair a configuração do Firebase Hosting do diretório local do app (o repositório que você clonou anteriormente no codelab). No entanto, para extrair a configuração, é necessário associar o app ao projeto do Firebase.

  1. Confira se a linha de comando está acessando o diretório angularfire-start local do seu app.
  2. Para associar o app ao projeto do Firebase, execute o seguinte comando:
firebase use --add
  1. Quando solicitado, selecione o ID do projeto e atribua um alias ao projeto do Firebase.

O alias é útil se você tiver vários ambientes (produção, preparo etc.). No entanto, neste codelab, basta usar o alias default.

  1. Siga as outras instruções na linha de comando.

5. Instalar o AngularFire

Antes de executar o projeto, verifique se você configurou o Angular CLI e o AngularFire.

  1. Em um console, execute o seguinte comando:
npm install -g @angular/cli
  1. Em seguida, em um console do diretório angularfire-start, execute o seguinte comando da CLI do Angular:
ng add @angular/fire

Isso vai instalar todas as dependências necessárias para seu projeto.

  1. Quando solicitado, desmarque ng deploy -- hosting com a barra de espaço. Selecione os seguintes recursos com as teclas de seta e a barra de espaço:
    • Authentication
    • Firestore
    • Cloud Messaging
    • Cloud Storage
  2. Pressione enter e siga as instruções restantes.
  3. Crie uma confirmação com a mensagem "Install AngularFire" e envie para seu repositório do GitHub.

6. Criar um back-end do App Hosting

Nesta seção, você vai configurar um back-end do App Hosting para monitorar uma ramificação no repositório do Git.

Ao final desta seção, você terá um back-end do App Hosting conectado ao repositório no GitHub, que vai recriar e lançar automaticamente uma nova versão do app sempre que você enviar um novo commit para a ramificação main.

  1. Acesse a página "App Hosting" no console do Firebase:

Estado zero do console do App Hosting, com um botão "Começar"

  1. Clique em "Começar" para iniciar o fluxo de criação do back-end. Configure o back-end da seguinte maneira:
  2. Siga as instruções na primeira etapa para conectar o repositório do GitHub que você criou anteriormente.
  3. Defina as configurações de implantação:
    1. Manter o diretório raiz como /
    2. Defina a ramificação ativa como main
    3. Ativar os lançamentos automáticos
  4. Nomeie o back-end como friendlychat-codelab.
  5. Em "Criar ou associar um app da Web do Firebase", selecione o app que você configurou anteriormente no menu suspenso "Selecionar um app da Web do Firebase".
  6. Clique em "Concluir e implantar". Depois de um momento, você vai ser direcionado a uma nova página com o status do novo back-end do App Hosting.
  7. Quando a implantação for concluída, clique no domínio sem custo financeiro em "Domínios". Isso pode levar alguns minutos para começar a funcionar devido à propagação do DNS.

Você implantou o app da Web inicial. Sempre que você enviar uma nova confirmação para a ramificação main do repositório do GitHub, um novo build e lançamento serão iniciados no console do Firebase, e seu site será atualizado automaticamente após a conclusão do lançamento.

Estado zero do console do App Hosting, com um botão "Começar"

Você vai ver a tela de login do app FriendlyChat, que ainda não está funcionando.

No momento, o app não pode fazer nada, mas com sua ajuda, isso vai mudar em breve.

Agora vamos criar um app de chat em tempo real.

7. Importar e configurar o Firebase

Configurar o Firebase

Você vai precisar configurar o SDK do Firebase para informar qual projeto do Firebase você está usando.

  1. Acesse as Configurações do projeto no Console do Firebase.
  2. No card "Seus apps", selecione o apelido do app que precisa de um objeto de configuração.
  3. Selecione "Config" no painel do snippet do SDK do Firebase.

Um arquivo de ambiente /angularfire-start/src/environments/environment.ts foi gerado para você.

  1. Copie o snippet do objeto de configuração e adicione-o a angularfire-start/src/firebase-config.js.

environment.ts

export const environment = {
  firebase: {
    apiKey: "API_KEY",
    authDomain: "PROJECT_ID.firebaseapp.com",
    projectId: "PROJECT_ID",
    storageBucket: "PROJECT_ID.firebasestorage.app",
    messagingSenderId: "SENDER_ID",
    appId: "APP_ID",
  },
};

Conferir a configuração do AngularFire

Os recursos selecionados no console foram adicionados automaticamente ao arquivo /angularfire-start/src/app/app.config.ts. Isso permite que seu app use os recursos e as funcionalidades do Firebase.

8. Configurar o login do usuário

O AngularFire está pronto para uso, porque foi importado e inicializado em app.config.ts. Agora você vai implementar o login do usuário usando o Firebase Authentication.

Adicione um domínio autorizado

O Firebase Authentication só permite logins de uma lista definida de domínios que você controla. Adicione o domínio de hospedagem de apps sem custo financeiro à lista de domínios:

  1. Navegue até Hospedagem de apps.
  2. Copie o domínio do seu back-end.
  3. Navegue até Configurações de autenticação.
  4. Escolha a guia Domínios autorizados.
  5. Clique em Adicionar domínio e cole o domínio do back-end do App Hosting.

Autenticar seus usuários com o Login do Google

No app, quando um usuário clica no botão Fazer login com o Google, a função login é acionada. Neste codelab, você vai autorizar o Firebase a usar o Google como provedor de identidade. Você vai usar um pop-up, mas vários outros métodos estão disponíveis no Firebase.

  1. No subdiretório /src/app/services/, abra chat.service.ts.
  2. Encontre a função login.
  3. Substitua a função inteira por este código:

chat.service.ts

// Signs-in Friendly Chat.
login() {
    signInWithPopup(this.auth, this.provider).then((result) => {
        const credential = GoogleAuthProvider.credentialFromResult(result);
        this.router.navigate(['/', 'chat']);
        return credential;
    })
}

A função logout é acionada quando o usuário clica no botão Sair.

  1. Volte para o arquivo src/app/services/chat.service.ts.
  2. Encontre a função logout.
  3. Substitua a função inteira por este código:

chat.service.ts

// Logout of Friendly Chat.
logout() {
    signOut(this.auth).then(() => {
        this.router.navigate(['/', 'login'])
        console.log('signed out');
    }).catch((error) => {
        console.log('sign out error: ' + error);
    })
}

Acompanhar o estado da autenticação

Para atualizar a interface de acordo, você precisa de uma maneira de verificar se o usuário está conectado ou desconectado. O AngularFire fornece uma função para receber um observável que é atualizado sempre que o estado de autenticação muda. Isso já foi implementado, mas vale a pena dar uma olhada.

  1. Volte para o arquivo src/app/services/chat.service.ts.
  2. Encontre a atribuição de variável user$.

chat.service.ts

// observable that is updated when the auth state changes
user$ = user(this.auth);

O código acima chama a função user do AngularFire, que retorna um usuário observável. Ele será acionado sempre que o estado de autenticação mudar (quando o usuário fizer login ou sair). Os componentes de modelos do Angular no FriendlyChat usam essa observação para atualizar a interface e redirecionar, mostrar o usuário na navegação do cabeçalho e assim por diante.

Testar o login no app

  1. Crie uma confirmação com a mensagem "Adicionando a autenticação do Google" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.
  3. No app da Web, atualize a página e faça login usando o botão de login e sua Conta do Google. Se você receber uma mensagem de erro informando auth/operation-not-allowed, verifique se ativou o Login do Google como provedor de autenticação no console do Firebase.
  4. Depois de fazer login, sua foto do perfil e o nome de usuário vão aparecer: angularfire-3.png

9. Grave mensagens no Cloud Firestore

Nesta seção, você vai gravar alguns dados no Cloud Firestore para preencher a IU do app. Isso pode ser feito manualmente com o Console do Firebase, mas você vai fazer isso no próprio app para demonstrar uma gravação básica do Cloud Firestore.

Modelo de dados

Os dados do Cloud Firestore são divididos em coleções, documentos, campos e subcoleções. Você vai armazenar cada mensagem do chat como um documento em uma coleção de nível superior chamada messages.

688d7bc5fb662b57.png

Adicionar mensagens ao Cloud Firestore

Para armazenar as mensagens de chat escritas pelos usuários, use o Cloud Firestore.

Nesta seção, você vai adicionar a funcionalidade para que os usuários escrevam novas mensagens no banco de dados. Quando o usuário clica no botão ENVIAR, o snippet de código abaixo é acionado. Ele adiciona um objeto de mensagem com o conteúdo dos campos da mensagem à sua instância do Cloud Firestore na coleção messages. O método add() adiciona um novo documento com um ID gerado automaticamente à coleção.

  1. Volte para o arquivo src/app/services/chat.service.ts.
  2. Encontre a função addMessage.
  3. Substitua a função inteira por este código:

chat.service.ts

// Adds a text or image message to Cloud Firestore.
addMessage = async (
  textMessage: string | null,
  imageUrl: string | null,
): Promise<void | DocumentReference<DocumentData>> => {
  // ignore empty messages
  if (!textMessage && !imageUrl) {
    console.log(
      "addMessage was called without a message",
      textMessage,
      imageUrl,
    );
    return;
  }

  if (this.currentUser === null) {
    console.log("addMessage requires a signed-in user");
    return;
  }

  const message: ChatMessage = {
    name: this.currentUser.displayName,
    profilePicUrl: this.currentUser.photoURL,
    timestamp: serverTimestamp(),
    uid: this.currentUser?.uid,
  };

  textMessage && (message.text = textMessage);
  imageUrl && (message.imageUrl = imageUrl);

  try {
    const newMessageRef = await addDoc(
      collection(this.firestore, "messages"),
      message,
    );
    return newMessageRef;
  } catch (error) {
    console.error("Error writing new message to Firebase Database", error);
    return;
  }
};

Testar o envio de mensagens

  1. Crie uma confirmação com a mensagem "Post new chats to Firestore" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.
  3. Atualize o FriendlyChat. Após o login, digite uma mensagem como "Olá!" e clique em ENVIAR. Isso vai gravar a mensagem no Cloud Firestore. No entanto, você ainda não vai encontrar os dados no seu app da Web real, porque ainda é necessário implementar a recuperação dos dados (próxima seção do codelab).
  4. Você pode ver a mensagem recém-adicionada no Console do Firebase. Abra a interface do Pacote de emuladores. Na seção Build, clique em Banco de dados do Firestore (ou clique aqui). Você vai encontrar a coleção messages com a mensagem recém-adicionada:

6812efe7da395692.png

10. Leia mensagens

Sincronizar mensagens

Para ler mensagens no app, adicione um observável que será acionado quando os dados mudarem e crie um elemento da interface que mostre novas mensagens.

Você vai adicionar um código que detecta mensagens recém-adicionadas do app. Nesse código, você vai recuperar o instantâneo da coleção messages. Você vai mostrar apenas as últimas 12 mensagens do chat para evitar um histórico muito longo no carregamento.

  1. Volte para o arquivo src/app/services/chat.service.ts.
  2. Encontre a função loadMessages.
  3. Substitua a função inteira por este código:

chat.service.ts

// Loads chat message history and listens for upcoming ones.
loadMessages = () => {
  // Create the query to load the last 12 messages and listen for new ones.
  const recentMessagesQuery = query(collection(this.firestore, 'messages'), orderBy('timestamp', 'desc'), limit(12));
  // Start listening to the query.
  return collectionData(recentMessagesQuery);
}

Para detectar as mensagens no banco de dados, crie uma consulta em uma coleção. Use a função collection para especificar em qual coleção estão os dados que você quer detectar. No código acima, você está detectando as mudanças na coleção messages, onde as mensagens de chat são armazenadas. Você também está aplicando um limite detectando apenas as últimas 12 mensagens usando limit(12) e classificando as mensagens por data usando orderBy('timestamp', 'desc') para encontrar as 12 mensagens mais recentes.

A função collectionData usa snapshots. A função de retorno de chamada será acionada quando houver alterações nos documentos que correspondam à consulta. Isso pode acontecer se uma mensagem for excluída, modificada ou adicionada. Leia mais sobre isso na documentação do Cloud Firestore.

Testar a sincronização de mensagens

  1. Crie uma confirmação com a mensagem "Mostrar novos chats na interface" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.
  3. Atualize o FriendlyChat. As mensagens que você criou anteriormente no banco de dados vão aparecer na interface do FriendlyChat (veja abaixo). Sinta-se à vontade para escrever novas mensagens. Elas vão aparecer instantaneamente.
  4. (Opcional) Tente excluir, modificar ou adicionar manualmente novas mensagens diretamente na seção Firestore do pacote do Emulator. As alterações vão aparecer na interface.

Parabéns! Você está lendo documentos do Cloud Firestore no seu app.

angularfire-2.png

11. Adicionar recursos de IA

Você vai usar a IA do Google para adicionar recursos de assistência úteis ao app de chat.

Gerar uma chave de API da IA do Google

  1. Acesse o Google AI Studio e clique em Criar chave de API.
  2. Selecione o projeto do Firebase que você criou para este codelab. A solicitação é para um projeto do Google Cloud, mas todo projeto do Firebase é um projeto do Google Cloud.
  3. Clique em Criar uma chave de API em um projeto atual.
  4. Copiar a chave de API resultante

Instalar uma extensão

Essa extensão implanta uma função de nuvem que é acionada sempre que um novo documento é adicionado à coleção messages no Firestore. A função vai chamar o Gemini e gravar a resposta no campo response do documento.

  1. Clique em Instalar no console do Firebase na página da extensão Criar um chatbot com a API Gemini.
  2. Siga as instruções. Na etapa Configurar a extensão, defina os seguintes valores de parâmetro:
    • Provedor da API Gemini: Google AI
    • Chave de API da IA do Google: cole a chave que você criou anteriormente e clique em Criar secret.
    • Caminho da coleção do Firestore: messages
    • Campo de comando: text
    • Campo de resposta: response
    • Campo de ordenação: timestamp
    • Contexto: Keep your answers short, informal, and helpful. Use emojis when possible.
  3. Clique em instalar extensão.
  4. Aguarde a instalação da extensão terminar

Testar o recurso de IA

O FriendlyChat já tem um código para ler respostas da extensão de IA. Basta enviar uma nova mensagem de chat para testar.

  1. Abra o FriendlyChat e envie uma mensagem.
  2. Depois de um momento, uma resposta vai aparecer ao lado da sua mensagem. Ela tem uma nota ✨ ai generated no final para deixar claro que foi criada com IA generativa, não um usuário real.

12. Enviar imagens

Agora você vai adicionar um recurso de compartilhamento de imagens.

O Cloud Firestore é bom para armazenar dados estruturados, mas o Cloud Storage é mais adequado para arquivos. O Cloud Storage para Firebase é um serviço de armazenamento de arquivos/blobs que você vai usar para armazenar todas as imagens compartilhadas por um usuário usando nosso app.

Salve imagens no Cloud Storage

Para este codelab, você já adicionou um botão que aciona uma caixa de diálogo do seletor de arquivos. Depois que um arquivo é selecionado, a função saveImageMessage é chamada, e você pode receber uma referência do arquivo selecionado. A função saveImageMessage faz o seguinte:

  1. cria uma mensagem de chat com um "marcador" no feed de chat para que os usuários vejam uma animação referente ao carregamento enquanto você faz upload da imagem;
  2. Faz upload do arquivo de imagem no Cloud Storage para este caminho: /<uid>/<file_name>
  3. gera um URL legível publicamente para o arquivo de imagem;
  4. atualiza a mensagem de chat com o URL do arquivo de imagem recém-enviado no lugar da imagem temporária de carregamento.

Agora, adicione a funcionalidade para enviar uma imagem:

  1. Volte para o arquivo src/chat.service.ts.
  2. Encontre a função saveImageMessage.
  3. Substitua a função inteira por este código:

chat.service.ts

// Saves a new message containing an image in Firestore.
// This first saves the image in Firebase storage.
saveImageMessage = async(file: any) => {
  try {
    // 1 - Add a message with a loading icon that will get updated with the shared image.
    const messageRef = await this.addMessage(null, this.LOADING_IMAGE_URL);

    // 2 - Upload the image to Cloud Storage.
    const filePath = `${this.auth.currentUser?.uid}/${file.name}`;
    const newImageRef = ref(this.storage, filePath);
    const fileSnapshot = await uploadBytesResumable(newImageRef, file);

    // 3 - Generate a public URL for the file.
    const publicImageUrl = await getDownloadURL(newImageRef);

    // 4 - Update the chat message placeholder with the image's URL.
    messageRef ?
    await updateDoc(messageRef, {
      imageUrl: publicImageUrl,
      storageUri: fileSnapshot.metadata.fullPath
    }): null;
  } catch (error) {
    console.error('There was an error uploading a file to Cloud Storage:', error);
  }
}

Testar o envio de imagens

  1. Crie uma confirmação com a mensagem "Adicionar a capacidade de postar imagens" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.
  3. Atualize o FriendlyChat. Depois de fazer login, clique no botão de upload de imagem no canto inferior esquerdo angularfire-4.png e selecione um arquivo de imagem usando o seletor de arquivos. Se você está procurando uma imagem, fique à vontade para usar esta bela foto de uma xícara de café.
  4. Uma nova mensagem vai aparecer na interface do app com a imagem selecionada: angularfire-2.png

Se você tentar adicionar uma imagem sem fazer login, vai aparecer uma mensagem de erro informando que é necessário fazer login para adicionar imagens.

13. Mostrar notificações

Agora você vai adicionar suporte a notificações no navegador. O app vai notificar os usuários quando novas mensagens forem postadas no chat. O Firebase Cloud Messaging (FCM) é uma solução de mensagens entre plataformas que permite a entrega confiável de mensagens e notificações sem custos.

Adicionar o service worker do FCM

O app da Web precisa de um service worker que receba e mostre as notificações da Web.

O provedor de mensagens já deve ter sido configurado quando o AngularFire foi adicionado. Verifique se o código a seguir existe na seção de importações de /angularfire-start/src/app/app.config.ts.

provideMessaging(() => {
    return getMessaging();
}),

app/app.config.ts

O service worker simplesmente precisa carregar e inicializar o SDK do Firebase Cloud Messaging, que é responsável por mostrar as notificações.

Acessar os tokens de dispositivo do FCM

Quando as notificações são ativadas em um dispositivo ou navegador, você recebe um token de dispositivo. Esse token é usado para enviar uma notificação a um dispositivo ou navegador específico.

Quando o usuário faz login, você chama a função saveMessagingDeviceToken. É nesse momento que você vai receber o token do dispositivo do FCM do navegador e salvá-lo no Cloud Firestore.

chat.service.ts

  1. Encontre a função saveMessagingDeviceToken.
  2. Substitua a função inteira por este código:

chat.service.ts

// Saves the messaging device token to Cloud Firestore.
saveMessagingDeviceToken= async () => {
    try {
      const currentToken = await getToken(this.messaging);
      if (currentToken) {
        console.log('Got FCM device token:', currentToken);
        // Saving the Device Token to Cloud Firestore.
        const tokenRef = doc(this.firestore, 'fcmTokens', currentToken);
        await setDoc(tokenRef, { uid: this.auth.currentUser?.uid });
 
        // This will fire when a message is received while the app is in the foreground.
        // When the app is in the background, firebase-messaging-sw.js will receive the message instead.
        onMessage(this.messaging, (message) => {
          console.log(
            'New foreground notification from Firebase Messaging!',
            message.notification
          );
        });
      } else {
        // Need to request permissions to show notifications.
        this.requestNotificationsPermissions();
      }
    } catch(error) {
      console.error('Unable to get messaging token.', error);
    };
}

No entanto, esse código não vai funcionar inicialmente. Para que o app consiga recuperar o token do dispositivo, o usuário precisa conceder ao app a permissão para mostrar notificações (a próxima etapa do codelab).

Solicitar permissões para mostrar notificações

Quando o usuário ainda não concedeu ao app a permissão para mostrar notificações, você não vai receber um token do dispositivo. Nesse caso, chame o método requestPermission(), que vai mostrar uma caixa de diálogo do navegador solicitando essa permissão ( em navegadores compatíveis).

8b9d0c66dc36153d.png

  1. Volte para o arquivo src/app/services/chat.service.ts.
  2. Encontre a função requestNotificationsPermissions.
  3. Substitua a função inteira por este código:

chat.service.ts

// Requests permissions to show notifications.
requestNotificationsPermissions = async () => {
    console.log('Requesting notifications permission...');
    const permission = await Notification.requestPermission();
    
    if (permission === 'granted') {
      console.log('Notification permission granted.');
      // Notification permission granted.
      await this.saveMessagingDeviceToken();
    } else {
      console.log('Unable to get permission to notify.');
    }
}

Acessar o token do dispositivo

  1. Crie uma confirmação com a mensagem "Adicionar a capacidade de postar imagens" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.
  3. Atualize o FriendlyChat. Depois de fazer login, a caixa de diálogo de permissão de notificações vai aparecer: bd3454e6dbfb6723.png
  4. Clique em Permitir.
  5. Abra o console JavaScript do seu navegador. A seguinte mensagem vai aparecer: Got FCM device token: cWL6w:APA91bHP...4jDPL_A-wPP06GJp1OuekTaTZI5K2Tu
  6. Copie o token do dispositivo. Você vai precisar dele na próxima etapa do codelab.

Enviar uma notificação para o dispositivo

Agora que você tem o token do dispositivo, pode enviar uma notificação.

  1. Abra a guia Cloud Messaging do Console do Firebase.
  2. Clique em "Nova notificação".
  3. Insira um título e um texto de notificação.
  4. No lado direito da tela, clique em "Enviar uma mensagem de teste".
  5. Insira o token do dispositivo copiado do console JavaScript do navegador e clique no sinal de adição ("+").
  6. Clique em "testar".

Se o app estiver em primeiro plano, a notificação vai aparecer no console JavaScript.

Se o app estiver em segundo plano, uma notificação vai aparecer no navegador, como neste exemplo:

de79e8638a45864c.png

14. Regras de segurança do Cloud Firestore

Conferir as regras de segurança do banco de dados

O Cloud Firestore usa uma linguagem de regras específica para definir direitos de acesso, segurança e validações de dados.

Ao configurar o projeto do Firebase no início deste codelab, você optou por usar as regras de segurança padrão do "Modo de teste" para não restringir o acesso ao repositório de dados. No Console do Firebase, na guia Regras da seção Banco de dados, é possível visualizar e modificar essas regras.

No momento, você vai encontrar as regras padrão, que não restringem o acesso ao repositório de dados. Isso significa que qualquer usuário pode ler e gravar em qualquer coleção no seu repositório de dados.

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write;
    }
  }
}

Você vai atualizar as regras para restringir as coisas usando as seguintes regras:

firestore.rules

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    // Messages:
    //   - Anyone can read.
    //   - Authenticated users can add and edit messages.
    //   - Validation: Check name is same as auth token and text length below 300 char or that imageUrl is a URL.
    //   - Deletes are not allowed.
    match /messages/{messageId} {
      allow read;
      allow create, update: if request.auth != null
                    && request.resource.data.name == request.auth.token.name
                    && (request.resource.data.text is string
                      && request.resource.data.text.size() <= 300
                      || request.resource.data.imageUrl is string
                      && request.resource.data.imageUrl.matches('https?://.*'));
      allow delete: if false;
    }
    // FCM Tokens:
    //   - Anyone can write their token.
    //   - Reading list of tokens is not allowed.
    match /fcmTokens/{token} {
      allow read: if false;
      allow write;
    }
  }
}

As regras de segurança vão ser atualizadas automaticamente no pacote do emulador.

Conferir as regras de segurança do Cloud Storage

O Cloud Storage para Firebase usa uma linguagem de regras específica para definir direitos de acesso, segurança e validações de dados.

Ao configurar o projeto do Firebase no início deste codelab, você optou por usar a regra de segurança padrão do Cloud Storage, que permite o uso do Cloud Storage somente por usuários autenticados. No Console do Firebase, na guia Regras da seção Armazenamento, é possível visualizar e modificar regras. Você vai encontrar a regra padrão que permite que qualquer usuário conectado leia e grave arquivos no bucket de armazenamento.

rules_version = '2';

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

Você vai atualizar as regras para fazer o seguinte:

  • permitir que cada usuário grave somente nas pastas específicas deles;
  • Permitir que qualquer pessoa leia do Cloud Storage
  • verificar se os arquivos enviados são imagens;
  • restringir o tamanho das imagens que podem ser enviadas a no máximo 5 MB.

Isso pode ser implementado usando as seguintes regras:

storage.rules

rules_version = '2';

// Returns true if the uploaded file is an image and its size is below the given number of MB.
function isImageBelowMaxSize(maxSizeMB) {
  return request.resource.size < maxSizeMB * 1024 * 1024
      && request.resource.contentType.matches('image/.*');
}

service firebase.storage {
  match /b/{bucket}/o {
    match /{userId}/{messageId}/{fileName} {
      allow write: if request.auth != null && request.auth.uid == userId && isImageBelowMaxSize(5);
      allow read;
    }
  }
}

15. Parabéns!

Você usou o Firebase para criar um aplicativo da Web de chat em tempo real.

O que você aprendeu

  • Firebase App Hosting
  • Firebase Authentication
  • Cloud Firestore
  • Firebase SDK para Cloud Storage
  • Firebase Cloud Messaging
  • Monitoramento de desempenho do Firebase

Próximas etapas

Saiba mais

16. [Opcional] Aplicar com o App Check

O App Check do Firebase ajuda a proteger seus serviços contra tráfego indesejado e protege seu back-end contra abuso. Nesta etapa, você vai adicionar a validação de credenciais e bloquear clientes não autorizados com o App Check e o reCAPTCHA Enterprise.

Primeiro, você precisa ativar o App Check e o reCaptcha.

Ativar o reCAPTCHA Enterprise

  1. No console do Cloud, encontre e selecione reCAPTCHA Enterprise em "Segurança".
  2. Ative o serviço conforme solicitado e clique em Criar chave.
  3. Insira um nome de exibição conforme solicitado e selecione Site como o tipo de plataforma.
  4. Adicione os URLs implantados à Lista de domínios e verifique se a opção "Usar desafio da caixa de seleção" está desmarcada.
  5. Clique em Criar chave e armazene a chave gerada em um local seguro. Você vai precisar dele mais tarde nesta etapa.

Como ativar o App Check

  1. No Console do Firebase, localize a seção Build no painel à esquerda.
  2. Clique em Verificação de app e na guia Método de login para acessar a Verificação de app.
  3. Clique em Registrar e insira sua chave do reCaptcha Enterprise quando solicitado. Em seguida, clique em Salvar.
  4. Na visualização "APIs", selecione Armazenamento e clique em Aplicar. Faça o mesmo para o Cloud Firestore.

O App Check agora é obrigatório. Atualize o app e tente visualizar ou enviar mensagens de chat. Você vai receber a seguinte mensagem de erro:

Uncaught Error in snapshot listener: FirebaseError: [code=permission-denied]: Missing or insufficient permissions.

Isso significa que o App Check está bloqueando solicitações não validadas por padrão. Agora vamos adicionar a validação ao app.

Navegue até o arquivo environment.ts e adicione reCAPTCHAEnterpriseKey ao objeto environment.

export const environment = {
  firebase: {
    apiKey: 'API_KEY',
    authDomain: 'PROJECT_ID.firebaseapp.com',
    databaseURL: 'https://PROJECT_ID.firebaseio.com',
    projectId: 'PROJECT_ID',
    storageBucket: 'PROJECT_ID.firebasestorage.app',
    messagingSenderId: 'SENDER_ID',
    appId: 'APP_ID',
    measurementId: 'G-MEASUREMENT_ID',
  },
  reCAPTCHAEnterpriseKey: {
    key: "Replace with your recaptcha enterprise site key"
  },
};

Substitua o valor de key pelo seu token do reCaptcha Enterprise.

Em seguida, navegue até o arquivo app.config.ts e adicione as seguintes importações:

import { getApp } from '@angular/fire/app';
import {
  ReCaptchaEnterpriseProvider,
  initializeAppCheck,
  provideAppCheck,
} from '@angular/fire/app-check';

No mesmo arquivo app.config.ts, adicione a seguinte declaração de variável global:

declare global {
  var FIREBASE_APPCHECK_DEBUG_TOKEN: boolean;
}

@NgModule({ ...

Nas importações, adicione a inicialização do App Check com ReCaptchaEnterpriseProvider e defina isTokenAutoRefreshEnabled como true para permitir que os tokens sejam atualizados automaticamente.

imports: [
BrowserModule,
AppRoutingModule,
CommonModule,
FormsModule,
provideFirebaseApp(() => initializeApp(environment.firebase)),
provideAppCheck(() => {
const appCheck = initializeAppCheck(getApp(), {
  provider: new ReCaptchaEnterpriseProvider(
  environment.reCAPTCHAEnterpriseKey.key
  ),
  isTokenAutoRefreshEnabled: true,
  });
  if (location.hostname === 'localhost') {
    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
  }
  return appCheck;
}),

Para permitir testes locais, defina self.FIREBASE_APPCHECK_DEBUG_TOKEN como true. Quando você atualiza o app em localhost, um token de depuração é registrado no console, semelhante a:

App Check debug token: CEFC0C76-7891-494B-B764-349BDFD00D00. You will need to add it to your app's App Check settings in the Firebase console for it to work.

Agora, acesse a Visualização de apps do App Check no console do Firebase.

Clique no menu de contexto e selecione Gerenciar tokens de depuração.

Em seguida, clique em Adicionar token de depuração e cole o token de depuração do console conforme solicitado.

Navegue até o arquivo chat.service.ts e adicione a seguinte importação:

import { AppCheck } from '@angular/fire/app-check';

No mesmo arquivo chat.service.ts, injete o App Check com os outros serviços do Firebase.

export class ChatService {
appCheck: AppCheck = inject(AppCheck);
...
  1. Crie uma confirmação com a mensagem "Bloquear clientes não autorizados com o App Check" e envie para o repositório do GitHub.
  2. Abra a página "App Hosting" no Console do Firebase e aguarde a conclusão do novo lançamento.

Parabéns! A verificação do app agora deve estar funcionando.