Depurar seu aplicativo Teams

O Microsoft Teams Toolkit ajuda você a depurar e visualizar seu aplicativo do Microsoft Teams. Depuração é o processo de verificação, detecção e correção de problemas ou bugs para garantir que o programa seja executado com êxito no Teams.

Depurar seu aplicativo teams para Visual Studio Code

O Teams Toolkit na Microsoft Visual Studio Code automatiza o processo de depuração. Você pode detectar erros e corrigi-los, bem como visualizar o aplicativo teams. Você também pode personalizar as configurações de depuração para criar sua guia ou bot.

Durante o processo de depuração:

• O Teams Toolkit inicia automaticamente os serviços de aplicativo, inicia depuradores e carrega o aplicativo Teams.
• O Teams Toolkit verifica os pré-requisitos durante o processo de depuração em segundo plano.
• Seu aplicativo teams está disponível para visualização no cliente Web do Teams localmente após a depuração.
• Você também pode personalizar as configurações de depuração para usar seus pontos de extremidade de bot, certificado de desenvolvimento ou componente parcial de depuração para carregar seu aplicativo configurado.
• O Visual Studio Code permite depurar a guia, o bot, a extensão de mensagem e o Azure Functions.

Principais recursos de depuração do Teams Toolkit

O Kit de Ferramentas do Teams dá suporte aos seguintes recursos de depuração:

• Iniciar depuração
• Depuração de vários destinos
• Alternar pontos de interrupção
• Recarga dinâmica
• Parar a depuração
• Ferramenta de Teste de Aplicativo do Teams

O Teams Toolkit executa funções em segundo plano durante o processo de depuração, que incluem a verificação dos pré-requisitos necessários para depuração. Você pode ver o progresso do processo de verificação no canal de saída do Teams Toolkit. No processo de instalação, você pode registrar e configurar seu aplicativo do Teams.

Iniciar a depuração

Você pode pressionar F5 como uma única operação para iniciar a depuração. O Teams Toolkit começa a marcar pré-requisitos, registra Microsoft Entra aplicativo, aplicativo do Teams e registra bot, inicia serviços e inicia o navegador.

Depuração de vários destinos

O Kit de Ferramentas do Teams utiliza o recurso de depuração de vários destinos para depurar a guia, o bot, a extensão de mensagem e o Azure Functions ao mesmo tempo.

Alternar pontos de interrupção

Você pode alternar pontos de interrupção nos códigos-fonte das guias, bots, extensões de mensagens e do Azure Functions. Os pontos de interrupção são executados quando você interage com o aplicativo Teams em um navegador da Web. A imagem a seguir mostra o ponto de interrupção de alternância:

Recarga dinâmica

Você pode atualizar e salvar os códigos-fonte de guia, bot, extensão de mensagem e Azure Functions ao mesmo tempo ao depurar o aplicativo teams. O aplicativo recarrega e o depurador se recoloca nas linguagens de programação.

Parar a depuração

Ao concluir a depuração local, você pode selecionar Parar (Shift+F5) ou [Alt] Desconectar (Shift+F5) na barra de ferramentas de depuração flutuante para interromper todas as sessões de depuração e encerrar tarefas. A imagem a seguir mostra a ação parar a depuração:

Ferramenta de Teste de Aplicativo do Teams

A Ferramenta de Teste de Aplicativo do Teams torna a depuração de seus aplicativos baseados em bot sem esforço. Você pode conversar com seu bot e ver suas mensagens e cartões adaptáveis à medida que eles aparecem no Teams. Você não precisa de uma conta de desenvolvedor do Microsoft 365, túnel ou aplicativo do Teams e registro de bot para usar a Ferramenta de Teste. Para obter mais informações, consulte Ferramenta de Teste de Aplicativo do Teams.

Preparar para depuração

As seguintes etapas ajudam você a se preparar para a depuração:

Entrar no Microsoft 365

Se você já se inscreveu no Microsoft 365, entre no Microsoft 365. Para obter mais informações, confira Programa de desenvolvedor do Microsoft 365.

Alternar pontos de interrupção

Verifique se você pode alternar pontos de interrupção nos códigos-fonte de guias, bots, extensões de mensagem e Azure Functions. Para obter mais informações, consulte Alternância de pontos de interrupção.

Personalizar configurações de depuração

O Teams Toolkit permite personalizar as configurações de depuração para criar sua guia ou bot. Para obter mais informações sobre a lista completa de opções personalizáveis, consulte doc configurações de depuração.

Você também pode personalizar as configurações de depuração para seu aplicativo bot existente.

Saiba como usar um bot existente para depuração

O Teams Toolkit cria aplicativos Microsoft Entra para projetos com bot por padrão usando botAadApp/create a ação.

Para usar um bot existente, você pode definir BOT_ID e SECRET_BOT_PASSWORD entrar env/.env.local com seus próprios valores.

Use o seguinte exemplo de snippet de código para configurar um bot existente para depuração:

# env/.env.local

# Built-in environment variables
TEAMSFX_ENV=local

# Generated during provision, you can also add your own variables.
BOT_ID={YOUR_OWN_BOT_ID}
...

SECRET_BOT_PASSWORD={YOUR_OWN_BOT_PASSWORD}
...

Personalizar cenários

Aqui está uma lista de cenários de depuração que você pode usar:

Ignorar verificações de pré-requisito

>"prerequisites""Validate prerequisites""args">Em .vscode/tasks.json , atualize as verificações de pré-requisito que você deseja ignorar.

Use seu certificado de desenvolvimento

1. No teamsapp.local.yml, remova devCert da devTool/install ação (ou remova toda devTool/install a ação se ela contiver devCertapenas ).

2. Em teamsapp.local.yml, defina "SSL_CRT_FILE" e "SSL_KEY_FILE" em file/createOrUpdateEnvironmentFile ação para o caminho do arquivo de certificado e o caminho do arquivo de chave.

   # teamsapp.local.yml
   ...
     # Remove devCert or this whole action
     - uses: devTool/install
       with:
         # devCert:
     ...
     - uses: file/createOrUpdateEnvironmentFile
       with:
         target: ./.localSettings
         envs:
           ...
           # set your own cert values
           SSL_CRT_FILE: ...
           SSL_KEY_FILE: ...
   ...
   

Personalizar o comando de instalação do npm

Em teamsapp.local.yml, edição args da cli/runNpmCommand ação.

# teamsapp.local.yml
...
  - uses: cli/runNpmCommand
    with:
      # edit the npm command args
      args: install --no-audit
...

Modificar portas

• Bot

  1. "3978" Pesquise em todo o seu projeto e procure por aparições em tasks.json e index.js.

  2. Substitua-o pela porta.

     

• Tab

  1. "53000" Pesquise em todo o seu projeto e procure por aparições em teamsapp.local.yml e tasks.json.

  2. Substitua-o pela porta.

     

Usar seu próprio pacote de aplicativos

O Teams Toolkit por padrão cria um conjunto de ações para gerenciar o pacote de teamsApp aplicativos. Você pode atualizá-los teamsapp.local.yml para usar seu próprio pacote de aplicativos.

# teamsapp.local.yml
...
  - uses: teamsApp/create # Creates a Teams app
    ...
  - uses: teamsApp/validateManifest # Validate using manifest schema
    ...
  - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
    ...
  - uses: teamsApp/validateAppPackage # Validate app package using validation rules
    ...
  - uses: teamsApp/update # Apply the app manifest (previously called Teams app manifest) to an existing Teams app in Teams Developer Portal.
    ...
...

Use seu próprio túnel

"Start Teams App Locally"Em .vscode/tasks.json , você pode atualizar "Start Local tunnel".

# env/.env.local

# Built-in environment variables
TEAMSFX_ENV=local
...
BOT_DOMAIN={YOUR_OWN_TUNNEL_DOMAIN}
BOT_ENDPOINT={YOUR_OWN_TUNNEL_URL}
...

# env/.env.local

# Built-in environment variables
TEAMSFX_ENV=local
...
BOT_DOMAIN={YOUR_OWN_TUNNEL_DOMAIN}
BOT_ENDPOINT={YOUR_OWN_TUNNEL_URL}
...

Adicionar variáveis de ambiente

Você pode adicionar variáveis de ambiente ao arquivo .localConfigs para guias, bots, extensão de mensagem e para o Azure Functions. O Kit de Ferramentas do Teams carrega as variáveis de ambiente adicionadas para iniciar serviços durante a depuração local.

Observação

Certifique-se de iniciar uma nova depuração local depois de adicionar novas variáveis de ambiente, pois as variáveis de ambiente não dão suporte ao recarga quente.

Depurar componente parcial

O Kit de Ferramentas do Teams utiliza a depuração de vários destinos do Visual Studio Code para depurar a guia, o bot, a extensão de mensagem e o Azure Functions ao mesmo tempo. Você pode atualizar .vscode/launch.json e .vscode/tasks.json para depurar componente parcial. Se você quiser depurar a guia somente em uma guia mais bot com o projeto do Azure Functions, use as seguintes etapas:

1. Atualizar "Attach to Bot" e "Attach to Backend" depurar composto em .vscode/launch.json.

   {
       "name": "Debug in Teams (Edge)",
        "configurations": [
           "Attach to Frontend (Edge)",
           // "Attach to Bot",
           // "Attach to Backend"
           ],
           "preLaunchTask": "Start Teams App Locally",
           "presentation": {
               "group": "all",
               "order": 1
           },
           "stopAll": true
   
   }
   

2. Atualize "Start Backend" e "Start Bot" da tarefa Iniciar Tudo em .vscode/tasks.json.

   {
   
       "label": "Start application",
       "dependsOn": [
           "Start Frontend",
             // "Start Backend",
             // "Start Bot"
   
         ]
   
   }
   

Avançar

Depurar seu aplicativo localmente

Confira também

• Visão geral do Kit de Ferramentas do Teams
• Depurar processo em segundo plano
• Usar o Kit de Ferramentas do Teams para provisionar recursos de nuvem
• Implantar na nuvem
• Visualizar e personalizar manifesto do aplicativo