Conecte seu aplicativo ao emulador de autenticação

Antes de usar o emulador de autenticação com seu aplicativo, certifique-se de entender o fluxo de trabalho geral do Firebase Local Emulator Suite e de instalar e configurar o Local Emulator Suite e revisar os comandos da CLI .

Este tópico pressupõe que você já esteja familiarizado com o desenvolvimento de soluções do Firebase Authentication para produção. Se necessário, revise a documentação da sua combinação de plataforma e técnica de autenticação .

O que posso fazer com o emulador de autenticação?

O emulador Authentication fornece emulação local de alta fidelidade dos serviços do Firebase Authentication, fornecendo grande parte da funcionalidade encontrada no Firebase Authentication de produção . Emparelhado com as plataformas Apple, Android e SDKs Web Firebase, o emulador permite:

• Crie, atualize e gerencie contas de usuário emuladas para testar e-mail/senha, número de telefone/SMS, SMS multifator e autenticação de provedor de identidade de terceiros (por exemplo, Google)
• Visualize e edite usuários emulados
• Protótipos de sistemas de autenticação de token personalizados
• Verifique as mensagens relacionadas à autenticação na guia Logs da interface do usuário do emulador.

Escolha um projeto do Firebase

O Firebase Local Emulator Suite emula produtos para um único projeto do Firebase.

Para selecionar o projeto a ser usado, antes de iniciar os emuladores, na CLI, execute firebase use em seu diretório de trabalho. Ou você pode passar o sinalizador --project para cada comando do emulador.

O Local Emulator Suite oferece suporte à emulação de projetos reais do Firebase e projetos de demonstração .

Recomendamos que você use projetos de demonstração sempre que possível. Os benefícios incluem:

• Configuração mais fácil, pois você pode executar os emuladores sem nunca criar um projeto do Firebase
• Segurança mais forte, pois se o seu código invocar acidentalmente recursos não emulados (produção), não há chance de alteração de dados, uso e cobrança
• Melhor suporte offline, pois não há necessidade de acessar a internet para baixar sua configuração do SDK.

Instrumente seu aplicativo para falar com o emulador

SDKs para Android, iOS e Web

Configure sua configuração no aplicativo ou classes de teste para interagir com o emulador de autenticação da seguinte maneira.

FirebaseAuth.getInstance().useEmulator("10.0.2.2", 9099);

Auth.auth().useEmulator(withHost:"localhost", port:9099)

import { getAuth, connectAuthEmulator } from "firebase/auth";

const auth = getAuth();
connectAuthEmulator(auth, "http://localhost:9099");
auth_emulator_connect.js

const auth = firebase.auth();
auth.useEmulator("http://localhost:9099");
emulator-suite.js

Nenhuma configuração adicional é necessária para criar protótipos e testar interações entre Authentication e Cloud Functions ou Firebase Security Rules para Cloud Firestore ou Realtime Database. Quando o emulador de autenticação é configurado e outros emuladores estão em execução, eles trabalham juntos automaticamente.

SDKs de administrador

Os SDKs Admin do Firebase se conectam automaticamente ao emulador de autenticação quando a variável de ambiente FIREBASE_AUTH_EMULATOR_HOST é definida.

export FIREBASE_AUTH_EMULATOR_HOST="localhost:9099"

Observe que o emulador do Cloud Functions reconhece automaticamente o emulador de autenticação para que você possa pular esta etapa ao testar integrações entre o Cloud Functions e os emuladores de autenticação. A variável de ambiente será definida automaticamente para o SDK Admin no Cloud Functions.

Com a variável de ambiente definida, os SDKs Admin do Firebase aceitarão tokens de ID não assinados e cookies de sessão emitidos pelo emulador de autenticação (por meio dos métodos verifyIdToken e createSessionCookie , respectivamente) para facilitar o desenvolvimento e os testes locais. Certifique-se de não definir a variável de ambiente em produção.

Se você quiser que o código do SDK Admin se conecte a um emulador compartilhado em execução em outro ambiente, será necessário especificar o mesmo ID do projeto definido usando a Firebase CLI . Você pode passar um ID de projeto para initializeApp diretamente ou definir a variável de ambiente GCLOUD_PROJECT .

admin.initializeApp({ projectId: "your-project-id" });

export GCLOUD_PROJECT="your-project-id"

Tokens de ID

Por motivos de segurança, o emulador de autenticação emite tokens de ID não assinados , que são aceitos apenas por outros emuladores do Firebase ou pelo SDK Admin do Firebase quando configurado . Esses tokens serão rejeitados pelos serviços do Firebase de produção ou pelo SDK Admin do Firebase em execução no modo de produção (por exemplo, o comportamento padrão sem as etapas de configuração descritas acima).

Inicie o emulador

Você pode usar o emulador de autenticação interativamente por meio da interface do usuário do Emulator Suite e não interativamente por meio de sua interface REST local. As seções a seguir abrangem casos de uso interativos e não interativos.

Para iniciar o emulador de autenticação, sua interface REST e a IU do Emulator Suite, execute:

firebase emulators:start

E-mail emulado, link de e-mail e autenticação anônima

Para autenticação anônima , seu aplicativo pode exercer a lógica de entrada para sua plataforma ( iOS , Android , web ).

Para autenticação de e-mail/senha , você pode iniciar a prototipagem adicionando contas de usuário ao emulador de autenticação do seu aplicativo usando os métodos do SDK de autenticação ou usando a interface do usuário do Emulator Suite.

1. Na IU do Emulator Suite, clique na guia Autenticação .
2. Clique no botão Adicionar usuário .
3. Siga o assistente de criação de conta de usuário, preenchendo os campos de autenticação de e-mail.

Com um usuário de teste criado, seu aplicativo pode conectar e desconectar o usuário com a lógica do SDK para sua plataforma ( iOS , Android , web ).

Para testar a verificação/login de e-mail com fluxos de link de e-mail, o emulador imprime um URL no terminal no qual firebase emulators:start foi executado.

i  To verify the email address customer@ex.com, follow this link:
http://localhost:9099/emulator/action?mode=verifyEmail&lang=en&oobCode=XYZ123&apiKey=fake-api-key

Cole o link em seu navegador para simular o evento de verificação e verifique se a verificação foi bem-sucedida.

{
  "authEmulator": {
    "success": "The email has been successfully verified.",
    "email": "customer@example.com"
  }
}

Para testar redefinições de senha, o emulador imprime uma URL semelhante, incluindo um parâmetro newPassword (que você pode alterar conforme necessário), no terminal.

http://localhost:9099/emulator/action?mode=resetPassword&oobCode=XYZ!23&apiKey=fake-api-key&newPassword=YOUR_NEW_PASSWORD

Testes não interativos

Em vez de usar a interface do usuário do Emulator Suite ou o código do cliente para gerenciar contas de usuário de e-mail/senha, você pode escrever scripts de configuração de teste que chamam APIs REST para criar e excluir contas de usuário e buscar códigos de verificação de e-mail fora da banda para preencher a verificação de e-mail do emulador URL. Isso mantém a plataforma e o código de teste separados e permite que você teste de forma não interativa.

Para fluxos de teste de e-mail e senha não interativos, a sequência típica é a seguinte.

1. Crie usuários com o endpoint REST de inscrição de autenticação.
2. Faça login de usuários usando os e-mails e senhas para realizar testes.
3. Se aplicável aos seus testes, busque códigos de verificação de e-mail fora de banda disponíveis no ponto final REST específico do emulador .
4. Esvazie os registros do usuário com o endpoint REST específico do emulador para limpar os dados.

Autenticação de telefone/SMS emulada

Para autenticação por telefone, o emulador Auth não suporta:

• fluxos reCAPTCHA e APN. Uma vez configurados para interagir com o emulador, os SDKs do cliente desabilitam esses métodos de verificação de maneira semelhante à descrita para testes de integração ( iOS , Android , web ).
• Teste os números de telefone com códigos pré-configurados no Firebase console.

Caso contrário, em termos de código do cliente, o fluxo de autenticação por telefone/SMS é idêntico ao descrito para produção ( iOS , Android , web ).

Usando a IU do Emulator Suite:

1. Na IU do Emulator Suite, clique na guia Autenticação .
2. Clique no botão Adicionar usuário .
3. Siga o assistente de criação de conta de usuário, preenchendo os campos de autenticação do telefone.

No entanto, para fluxos de autenticação por telefone, o emulador NÃO acionará a entrega de nenhuma mensagem de texto, pois entrar em contato com uma operadora está fora do escopo e não é amigável para testes locais! Em vez disso, o emulador imprime o código que teria sido enviado via SMS para o mesmo terminal no qual você executou firebase emulators:start ; insira este código no aplicativo para simular os usuários verificando suas mensagens de texto.

Testes não interativos

Para testes de autenticação de telefone não interativos, use a API REST do emulador de autenticação para recuperar códigos SMS disponíveis. Observe que o código é diferente toda vez que você inicia o fluxo.

A sequência típica é a seguinte.

1. Ligue para a plataforma signInWithPhoneNumber para iniciar o processo de verificação.
2. Recupere o código de verificação usando o endpoint REST específico do emulador .
3. Ligue para confirmationResult.confirm(code) como de costume com o código de verificação.

SMS multifator

O emulador de autenticação oferece suporte à prototipagem e teste dos fluxos de autenticação multifator (MFA) do SMS disponíveis em produção para iOS , Android e Web .

Ao adicionar um usuário simulado ao emulador, você pode habilitar a MFA e configurar um ou mais números de telefone para os quais as mensagens SMS de segundo fator serão enviadas. As mensagens são enviadas para o mesmo terminal em que você executou firebase emulators:start e estão disponíveis na interface REST.

Autenticação de provedor de identidade de terceiros (IDP) emulado

O emulador de autenticação permite testar muitos fluxos de autenticação de terceiros em seus aplicativos iOS, Android ou Web sem alterações no código de produção. Para obter exemplos de fluxos de autenticação, consulte a documentação de várias combinações de provedores e plataformas que você pode usar em seu aplicativo .

De um modo geral, você pode usar o SDK do Firebase para autenticar de duas maneiras:

• Seu aplicativo permite que o SDK lide com todo o processo de ponta a ponta, incluindo todas as interações com provedores de IDP de terceiros para recuperar credenciais.
• Seu aplicativo recupera manualmente as credenciais de um provedor de terceiros usando o SDK dessa parte e passa essas credenciais para o SDK de autenticação.

Mais uma vez, verifique o link da documentação acima e certifique-se de estar familiarizado com o fluxo (gerenciado pelo SDK do Firebase versus recuperação manual de credenciais) que você deseja usar. O emulador de autenticação oferece suporte ao teste de qualquer abordagem.

Como testar fluxos de IDP orientados ao SDK do Firebase

Se seu aplicativo usa qualquer fluxo de ponta a ponta do SDK do Firebase, como OAuthProvider para login com Microsoft, GitHub ou Yahoo, para testes interativos, o emulador de autenticação veicula uma versão local da página de login correspondente para ajudá-lo a testar autenticação de aplicativos da Web que chamam o método signinWithPopup ou signInWithRedirect . Essa página de entrada servida localmente também aparece em aplicativos móveis, renderizados pela biblioteca de visualização da web da sua plataforma.

O emulador cria contas de usuário e credenciais de terceiros simuladas conforme necessário à medida que os fluxos prosseguem.

Como testar fluxos de IDP com recuperação manual de credenciais

Se você usar técnicas de entrada "manuais" e chamar o método signInWithCredentials da sua plataforma, como de costume, seu aplicativo solicitará uma entrada real de terceiros e recuperará as credenciais reais de terceiros.

Observe que o emulador só oferece suporte à autenticação signInWithCredential para credenciais recuperadas do Google Sign-In, Apple e outros provedores que usam tokens de ID implementados como JSON Web Tokens (JWTs). Tokens de acesso (por exemplo, aqueles fornecidos pelo Facebook ou Twitter, que não são JWTs) não são suportados. A próxima seção discute uma alternativa nesses casos.

Testes não interativos

Uma abordagem para testes não interativos é automatizar os cliques do usuário na página de entrada atendida pelo emulador. Para aplicativos da Web, use uma interface de controle como WebDriver. Para dispositivos móveis, use as ferramentas de teste de interface do usuário da sua plataforma, como Espresso ou Xcode.

Como alternativa, você pode atualizar seu código para usar signInWithCredential (por exemplo, em uma ramificação de código) e usar um fluxo de autenticação de token com tokens de ID simulados para contas em vez de credenciais reais.

1. Religar ou comentar a parte do seu código que recupera idTokens do IDP; isso elimina a necessidade de inserir nomes de usuário e senhas reais durante seus testes e alivia seus testes de cotas de API e limites de taxa no IDP.
2. Segundo, use uma string JSON literal no lugar do token para signInWithCredential . Usando o SDK da Web como exemplo, você pode alterar o código para:

firebase.auth().signInWithCredential(firebase.auth.GoogleAuthProvider.credential(
  '{"sub": "abc123", "email": "foo@example.com", "email_verified": true}'
));

Quando usado com o emulador, esse código autenticará com êxito um usuário com o e-mail foo@example.com no Google. Pense no subcampo como uma chave primária, que pode ser alterada para qualquer string, zombando do login de diferentes usuários. Você pode substituir firebase.auth.GoogleAuthProvider por, por exemplo, new firebase.auth.OAuthProvider('yahoo.com') ou qualquer outro ID de provedor que você queira simular.

Autenticação de token personalizado emulado

O emulador de autenticação manipula a autenticação com tokens da Web JSON personalizados usando chamadas para o método signInWithCustomToken em plataformas com suporte, conforme descrito na documentação de autenticação de produção .

Como o emulador de autenticação difere da produção

O emulador do Firebase Authentication simula muitos recursos do produto de produção. No entanto, como qualquer tipo de sistema de autenticação depende muito da segurança em vários níveis (dispositivo, provedores de terceiros, Firebase etc.), é difícil para o emulador recriar adequadamente todos os fluxos.

Cloud IAM

O Firebase Emulator Suite não tenta replicar ou respeitar nenhum comportamento relacionado ao IAM para execução. Os emuladores seguem as regras de segurança do Firebase fornecidas, mas em situações em que o IAM normalmente seria usado, por exemplo, para definir o Cloud Functions invocando a conta de serviço e, portanto, as permissões, o emulador não é configurável e usará a conta disponível globalmente na máquina do desenvolvedor. semelhante a executar um script local diretamente.

Fazer login via link de e-mail no celular

Como em plataformas móveis, o login por link de e-mail depende do Firebase Dynamic Links, todos esses links serão abertos na plataforma da Web (móvel).

Login de terceiros

Para fluxos de login de terceiros, o Firebase Authentication depende de credenciais seguras de provedores de terceiros, como Twitter e Github.

Credenciais reais de provedores OpenID Connect, como Google e Apple, são aceitas pelo emulador de autenticação. Não há suporte para credenciais de provedores não OpenID Connect.

Login de e-mail/SMS

Em aplicativos de produção, os fluxos de login de email e SMS envolvem uma operação assíncrona na qual o usuário verifica uma mensagem recebida e insere um código de login em uma interface de login. O emulador de autenticação não envia e-mails ou mensagens SMS, mas, conforme descrito acima , ele gera códigos de login e os envia para o terminal a ser usado nos testes.

O emulador não suporta a capacidade de definir números de telefone de teste com códigos de login fixos, como pode ser feito usando o console do Firebase.

Autenticação de token personalizado

O emulador de autenticação não valida a assinatura ou expiração de tokens personalizados. Isso permite que você use tokens artesanais e reutilize tokens indefinidamente em cenários de prototipagem e teste.

Limitação de taxa/anti-abuso

O emulador de autenticação não replica recursos de limitação de taxa de produção ou antiabuso.

Qual o proximo?

• Para ver um conjunto de vídeos selecionados e exemplos detalhados de instruções, siga a lista de reprodução de treinamento de emuladores do Firebase .

• Como as funções acionadas são uma integração típica com o Authentication, saiba mais sobre o emulador do Cloud Functions para Firebase em Executar funções localmente .