Alertar os testadores sobre as novas versões do app com o SDK do Firebase App Distribution para iOS: Codelab

1. Visão geral

Este é o codelab "Como integrar o SDK do Firebase App Distribution no seu app iOS". Neste codelab, você vai adicionar o SDK do App Distribution ao seu app para mostrar alertas aos testadores quando novos builds estiverem disponíveis para download. Você vai aprender a usar uma configuração básica e uma personalizada para que os testadores façam login e recebam atualizações. Em seguida, você vai enviar uma nova versão para o App Distribution e acionar um novo alerta de build no app.

O que você vai aprender

  • Como usar o App Distribution para distribuir um app de pré-lançamento para testadores
  • Como integrar o SDK do App Distribution para iOS ao seu app
  • Como alertar um testador quando houver um novo build de pré-lançamento pronto para instalação
  • Como personalizar o SDK para atender às suas necessidades específicas de teste

Pré-requisitos

  • Xcode 12 (ou mais recente)
  • CocoaPods 1.9.1 (ou mais recente)
  • Uma conta de desenvolvedor da Apple para distribuição ad hoc
  • Um dispositivo físico com iOS para testes O app simulador do iOS funciona para a maior parte do codelab, mas os simuladores não podem fazer o download de versões.

Como você usará este tutorial?

Apenas leitura Leitura e exercícios

Como você classificaria sua experiência com a criação de apps iOS?

Iniciante Intermediário Proficiente

2. Criar projeto do console do Firebase

Adicionar um novo projeto do Firebase

  1. Faça login no Firebase.
  2. No Console do Firebase, clique em "Adicionar projeto" e nomeie o projeto como "Firebase Codelab".

Você não precisa ativar o Google Analytics neste projeto.

  1. Clique em Criar projeto.

Adicionar app ao Firebase

Siga a documentação para registrar seu app com o Firebase. Usar "com.google.firebase.codelab.AppDistribution.<your_name>" como o ID do pacote do iOS.

Quando solicitado, faça o download do arquivo GoogleService-Info.plist do projeto. Você precisará dele mais tarde.

3. Fazer o download do projeto de exemplo

Faça o download do código

Comece clonando o projeto de exemplo.

git clone git@github.com:googlecodelabs/firebase-appdistribution-ios.git

Se o git não estiver instalado, você também pode fazer o download do projeto de exemplo na página do GitHub ou clicando neste link.

Fazer o download das dependências e abrir o projeto no Xcode

  1. Abra o Podfile no mesmo diretório.
cd firebase-appdistribution-ios/start
Open Podfile
  1. Adicione a seguinte linha ao podfile:

Podfile (link em inglês)

pod 'Firebase/AppDistribution'

Execute pod update no diretório do projeto e abra o projeto no Xcode.

pod install --repo-update
xed .

Atualizar o identificador de pacote para corresponder ao seu app do Firebase

No menu à esquerda, clique duas vezes em AppDistributionExample. Em seguida, localize a guia Geral e altere o identificador do pacote para corresponder ao identificador do pacote do seu app do Firebase, que pode ser encontrado nas configurações do projeto. Ele precisa ser "com.google.firebase.codelab.AppDistribution.<your_name>".

Adicionar o Firebase ao app

Localize o arquivo GoogleService-Info.plist salvo anteriormente no seu sistema de arquivos e arraste-o para a raiz do projeto Xcode. Você também pode fazer o download desse arquivo a qualquer momento na página de configurações do projeto.

3cf9290805e7fdab.png

No arquivo AppDistributionExample/AppDelegate.swift, importe o Firebase na parte de cima do arquivo.

AppDistributionExample/AppDelegate.swift (link em inglês)

import Firebase

E no método didFinishLaunchingWithOptions, adicione uma chamada para configurar o Firebase.

AppDistributionExample/AppDelegate.swift

FirebaseApp.configure()

4. Configurar novos alertas de build no app com o SDK do App Distribution

Nesta etapa, você vai adicionar o SDK do Firebase App Distribution ao seu app e mostrar alertas no app para os testadores quando novos builds estiverem disponíveis para instalação. Para isso, verifique se você ativou a API Firebase App Tester para seu projeto "Firebase Codelab" (no console do Google Cloud). Você precisa fazer login com a mesma conta e selecionar o projeto correto no menu suspenso na parte de cima.

Configurar alertas no app

O SDK do App Distribution oferece duas maneiras de configurar alertas de build no app para os testadores: uma configuração básica de alerta, que vem com uma caixa de diálogo de login pré-criada para exibição aos testadores, e uma configuração de alerta avançada, que permite personalizar a própria interface do usuário (IU).

Vamos começar com a configuração básica de alertas. Use checkForUpdate para mostrar uma caixa de diálogo "Ativar alertas" pré-criada para testadores que ainda não ativaram os alertas e, em seguida, verificar se há um novo build disponível. Para ativar os alertas, os testadores fazem login em uma conta que tem acesso ao app no App Distribution. Quando chamado, o método gera a seguinte sequência:

  1. Verifica se um testador ativou alertas. Caso contrário, mostra uma caixa de diálogo predefinida que solicita que o usuário faça login no App Distribution com a Conta do Google.

A ativação de alertas é um processo único no dispositivo de teste e persiste entre as atualizações do app. Os alertas permanecem ativados no dispositivo de teste até que o app seja desinstalado ou até que o método signOutTester seja chamado. Para mais informações, consulte a documentação de referência do método (Swift ou Objective-C).

  1. Verifica se há builds recém-disponibilizados para a instalação do testador. Retorna um objeto release ou um erro.

Você pode incluir checkForUpdate a qualquer momento no app. Por exemplo, é possível solicitar que os testadores instalem builds recém-disponibilizados na inicialização incluindo checkForUpdate no view tamanho desejado (em inglês) do UIViewController.

No arquivo AppDistributionViewController.swift, importe o Firebase na parte de cima do arquivo.

AppDistributionViewController.swift

import Firebase

Abra AppDistributionExample/AppDistributionViewController.swift e copie as linhas para o método viewDidAppear desta forma:

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    checkForUpdate()
 }

Agora, vamos implementar o método checkForUpdate().

AppDistributionViewController.swift (em inglês)

  private func checkForUpdate() {
    AppDistribution.appDistribution().checkForUpdate(completion: { [self] release, error in
      var uiAlert: UIAlertController

      if error != nil {
        uiAlert = UIAlertController(title: "Error", message: "Error Checking for update! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
      } else if release == nil {
        uiAlert = UIAlertController(title: "Check for Update", message: "No releases found!!", preferredStyle: .alert)
        uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default))
      } else {
        guard let release = release else { return }

        let title = "New Version Available"
        let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
        uiAlert = UIAlertController(title: title, message: message, preferredStyle: .alert)

        uiAlert.addAction(UIAlertAction(title: "Update", style: UIAlertAction.Style.default) {
          _ in
          UIApplication.shared.open(release.downloadURL)
        })
        uiAlert.addAction(UIAlertAction(title: "Cancel", style: UIAlertAction.Style.cancel) {
          _ in
        })
      }
      self.present(uiAlert, animated: true, completion: nil)
    })
  }

5. Criar e convidar testadores para fazer o download do app

Nesta etapa, você vai criar seu app e testar a implementação distribuindo o build para os testadores usando o Console do Firebase.

Criar seu app

Quando estiver tudo pronto para distribuir uma versão de pré-lançamento do app para os testadores, selecione "Qualquer dispositivo iOS (arm64)". como destino da versão, e Produto->Arquivo. Depois que o arquivo for criado, crie uma distribuição assinada com o perfil de distribuição para desenvolvedores.

98d8eb042c36a685.png

b2e9ccff91d761c1.png

8e815564f64d2d39.png

Quando o build é concluído, ele salva um arquivo IPA e alguns arquivos de registro na pasta especificada. Você distribui o arquivo IPA para os testadores nas etapas a seguir.

Se você tiver problemas para criar o app, consulte os documentos de assinatura de código da Apple para conferir as etapas de solução de problemas.

Distribuir seu app para testadores

Para distribuir seu app para os testadores, faça upload do arquivo IPA usando o Console do Firebase:

  1. Abra a página "App Distribution" do Console do Firebase. Selecione seu projeto do Firebase quando solicitado.
  2. Pressione Começar.

e4671bd304ecfe47.png

  1. Na página "Versões", selecione o app que você quer distribuir no menu suspenso.

8a3da2939b9746f4.png

  1. Arraste o arquivo IPA do seu aplicativo ao console para fazer o upload.
  2. Quando o upload for concluído, especifique os grupos de testadores e os testadores individuais que devem receber o build. Adicione seu e-mail para receber o convite. Em seguida, adicione notas ao build. Consulte Gerenciar testadores para saber mais sobre como criar grupos de testadores.

de63e3c3c64f909e.png

  1. Clique em "Distribuir" para disponibilizar o build para os testadores.

b6e75dc216fc3731.png

Participar como testador da versão

No Console do Firebase, agora é possível conferir os testadores adicionados na versão do app.

eb61c6be96ff3a11.png

Como você incluiu seu endereço de e-mail, vai receber um e-mail do Firebase App Distribution convidando você para testar o app. Agora você é o primeiro testador. Continue a seção abaixo para se inscrever como testador no dispositivo de teste.

Registrar o dispositivo de teste

Primeiro, é necessário registrar seu dispositivo de teste para fazer o download e testar uma versão ad hoc.

  1. No dispositivo de teste iOS, abra o e-mail enviado pelo Firebase App Distribution e toque no link "Vamos começar". Abra o link no Safari.
  2. No app da Web do testador do Firebase App Distribution que aparece, faça login com sua Conta do Google e toque em Aceitar convite.

4d1af345ef944620.png

Agora você confere o lançamento para o qual recebeu um convite.

  1. Toque em Registrar dispositivo para compartilhar seu UDID com o Firebase e atualizar o perfil de provisionamento do seu app mais tarde.

fd141215e54a938d.png

  1. Siga as instruções e acesse as configurações para fazer o download do perfil e compartilhar seu UDID.

Agora, quando você voltar ao App Distribution, a versão estará marcada como "Dispositivo registrado":

fe93d649dfa25877.png

O UDID do testador foi compartilhado com o desenvolvedor. Agora, cabe ao desenvolvedor criar uma nova versão do app para o testador.

Conferir as informações do testador no console

Na visualização do desenvolvedor no Console do Firebase, o testador vai aparecer como "Aceito" na versão:

1bef6f182c1c58f9.png

Você também vai receber um e-mail como desenvolvedor se o dispositivo que ele está usando ainda não estiver incluído no perfil de provisionamento. Isso notificará o novo UDID que você precisa adicionar. Você também tem a opção de exportar todos os UDIDs como um arquivo de texto.

  1. Para exportar todos os UDIDs, abra a guia "Testadores e Guia "Grupos".

2745d49a6abc47fe.png

  1. Clique em "Exportar UDIDs da Apple".

cb45477f8cc436ba.png

O arquivo precisa conter o UDID do seu dispositivo de teste.

Device ID            Device Name                            Device Platform
1234567890     tester.app.distribtuion@gmail.com - iPhone SE 2nd Gen        ios

Quando receber um desses e-mails, atualize o UDID no seu perfil de provisionamento e distribua um novo build para seus testadores seguindo estas etapas:

  1. Adicione os dispositivos ao seu portal para desenvolvedores da Apple.
  • Opção 1: importe os UDIDs do dispositivo como um arquivo CSV. Na guia "Testadores e grupos" do painel "App Distribution", selecione "Todos os testadores" e clique em "Exportar UDIDs da Apple" para fazer o download de um arquivo CSV. Em seguida, importe o arquivo para sua conta de desenvolvedor da Apple usando a opção "Registrar vários dispositivos". Consulte a documentação da Apple para saber mais. Sua conta de desenvolvedor da Apple pode permitir apenas a importação de um número limitado de dispositivos por ano.
  • Opção 2: colete e insira os UDIDs por e-mail. Na página Adicionar dispositivos do portal para desenvolvedores da Apple, registre o novo UDID especificado no e-mail recebido.

ffb74294e68ee1c8.png

  1. Adicione os dispositivos registrados ao seu perfil de provisionamento.
  2. Faça o download do perfil de provisionamento e use-o para recriar seu aplicativo. Se você estiver criando a nova versão apenas para atualizar os dispositivos registrados, não atualize o número da versão ou a versão.
  3. Redistribua seu app no Console do Firebase ou na CLI. Se você já tiver distribuído um build com o mesmo número e versão, somente os usuários de dispositivos recém-registrados vão receber e-mails de notificação.

Faça o download da versão no dispositivo de teste

Agora a versão tem o UDID do dispositivo de teste para que ele possa fazer o download e instalar o app. O App Distribution envia um e-mail aos testadores quando o UDID deles é adicionado a uma nova versão.

a4049260bae2850b.png

  1. No dispositivo de teste, retorne ao app da Web do testador do App Distribution usando o link no e-mail ou o ícone na tela inicial do dispositivo.

Ao navegar até o app do codelab da UDID, você vai notar que a versão está pronta para download.

dad6d03b6ad78746.png

  1. Se você estiver usando um dispositivo físico, pressione "Download" e instale e execute o app.
  2. Quando o app for iniciado, você vai receber uma solicitação para ativar os alertas de novos builds. Selecione "Ativar".

6e3540a2900734e6.png

  1. Em seguida, você vai precisar fazer login. Clique em "Continuar.

82d90d7935bfaea0.png

  1. Faça login com sua conta de testador.

13bee1d03fa94ebf.png

  1. Você vai voltar para o app. Não será necessário fazer login nem aceitar alertas na próxima vez que você executar o app.

815d6757eb5f6327.png

Distribuir uma atualização para os testadores

  1. Atualize o número da versão para "2".

861aa63ebbc6ec54.png

  1. Selecione "Qualquer dispositivo iOS (arm64)". como destino da versão, e Produto->Arquivo. Depois que o arquivo for gerado, crie uma distribuição assinada com o perfil de distribuição de desenvolvimento.
  2. Quando o build é concluído, ele salva um arquivo IPA e alguns arquivos de registro na pasta especificada. Faça upload do novo IPA no Console do Firebase, adicione seu e-mail como testador novamente e distribua.

b6e75dc216fc3731.png

Alertas de build de teste

  1. Feche o app se ele estiver aberto. Reinicie o app.
  2. Quando o app for reiniciado, você vai receber um alerta "Nova versão disponível".

3bd532992df458e6.png

  1. Clique em "Atualizar" para receber a versão mais recente.
  2. Clique em "Instalar" na próxima tela.

3a761d8fa4b79d33.png

  1. Parabéns! Você conseguiu atualizar o app com os alertas integrados.

6. Personalizar o login do testador

Os métodos signInTester/signOutTester e isTesterSignedIn oferecem mais flexibilidade para personalizar a experiência de login do testador para corresponder melhor com a experiência do app.

O exemplo a seguir verifica se o testador já fez login na conta de testador do Firebase App Distribution. Assim, você pode optar por mostrar a IU de login apenas para testadores que ainda não fizeram login. Depois que o testador fizer login, você pode chamar checkForUpdate para verificar se tem acesso a um novo build.

Vamos desativar a verificação automática de atualizações no view DidAppea comentando a chamada checkForUpdate().

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    // checkForUpdate()
 }

Em vez disso, vamos chamar checkForUpdate() em checkForUpdateButtonClicked().

 @objc func checkForUpdateButtonClicked() {
    checkForUpdate()
 }

Agora, vamos implementar nosso método signInOutButtonClicked() que fará login do usuário se ele estiver desconectado ou fará logout do usuário se ele já estiver conectado.

AppDistributionViewController.swift (em inglês)

 @objc func signInOutButtonClicked() {
    if isTesterSignedIn() {
      AppDistribution.appDistribution().signOutTester()

      self.configureCheckForUpdateButton()
      self.configureSignInSignOutButton()
      self.configureSignInStatus()

    } else {
      AppDistribution.appDistribution().signInTester(completion: { error in
        if error == nil {
          self.configureCheckForUpdateButton()
          self.configureSignInSignOutButton()
          self.configureSignInStatus()
        } else {
          let uiAlert = UIAlertController(title: "Custom:Error", message: "Error during tester sign in! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
          uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default) {
            _ in
          })

          self.present(uiAlert, animated: true, completion: nil)
        }
      })
    }
  }

Por fim, vamos implementar o método isTesterSignedIn.

AppDistributionViewController.swift

 private func isTesterSignedIn() -> Bool {
    return AppDistribution.appDistribution().isTesterSignedIn
 }

Criar e testar a implementação

7. Parabéns!

Você criou o recurso "exibição de alertas no app" em um app usando o SDK do Firebase App Distribution para iOS.

O que vimos

  • Firebase App Distribution
  • SDK do Firebase App Distribution New Alerts para iOS

Próximas etapas

Saiba mais

Perguntas?

Informar problemas