Depurar apps do Google Chat

Node.js

Python

Java

Node.js

• As versões mais recentes de node e npm instaladas no seu ambiente local.

• A versão mais recente do nodemon instalada no seu ambiente local é usada para recarga automática:

  npm install -g nodemon

• Um app de chat HTTP configurado para mensagens. Siga as seções Pré-requisitos, Configurar o ambiente e Publicar o app no Google Chat do Guia de início rápido. As únicas diferenças são que você precisa definir o nome do app como Debug App e o URL do endpoint HTTP como qualquer coisa, como http://example.com.

• Um ambiente de desenvolvimento integrado configurado no seu ambiente local que pode depurar. Usamos o Visual Studio Code IDE e os recursos de depuração padrão dele neste guia para fins de ilustração.

• Git instalado no ambiente local.

• Uma conta do ngrok.

Python

• A versão mais recente do python3 instalada no ambiente local.
• A versão mais recente do pip e virtualenv instaladas no seu ambiente local são usadas para gerenciar pacotes Python e ambientes virtuais, respectivamente.
• Um app de chat HTTP configurado para mensagens. Siga as seções Pré-requisitos, Configurar o ambiente e Publicar o app no Google Chat do Guia de início rápido. As únicas diferenças são que você precisa definir o nome do app como Debug App e o URL do endpoint HTTP como qualquer coisa, como http://example.com.
• Um ambiente de desenvolvimento integrado configurado no seu ambiente local que pode depurar. Usamos o Visual Studio Code IDE e os recursos de depuração padrão dele neste guia para fins de ilustração.
• Git instalado no ambiente local.
• Uma conta do ngrok.
• Ter a versão mais recente do gcloud instalada e inicializada no ambiente local.

Java

• A versão estável mais recente do Java SE 11's JDK instalada no seu ambiente local.
• A versão mais recente do Apache Maven instalada no ambiente local, é usada para gerenciar projetos Java.
• Um app de chat HTTP configurado para mensagens. Siga as seções Pré-requisitos, Configurar o ambiente e Publicar o app no Google Chat do Guia de início rápido. As únicas diferenças são que você precisa definir o nome do app como Debug App e o URL do endpoint HTTP como qualquer coisa, como http://example.com.
• Um ambiente de desenvolvimento integrado configurado no seu ambiente local que pode depurar. Usamos o Visual Studio Code IDE e os recursos de depuração padrão dele neste guia para fins de ilustração.
• Git instalado no ambiente local.
• Uma conta do ngrok.
• Ter a versão mais recente do gcloud instalada e inicializada no ambiente local.

Node.js

1. Clone o repositório googleworkspace/google-chat-samples do GitHub para seu ambiente local. Ele contém o código do aplicativo a ser executado:

   git clone https://github.com/googleworkspace/google-chat-samples.git

2. No ambiente de desenvolvimento integrado Visual Studio Code instalado no ambiente local, faça o seguinte:

   1. Em uma nova janela, abra a pasta google-chat-samples/node/basic-app.

   2. Configure o aplicativo para depuração de recarga automática adicionando dois scripts no arquivo package.json:

      {
          ...
          "scripts": {
              ...
              "debug": "node --inspect index.js",
              "debug-watch": "nodemon --watch ./ --exec npm run debug"
          }
          ...
      }
      

   3. No diretório raiz, instale o aplicativo:

      npm install

   4. Crie e configure uma inicialização com o nome Debug Watch que aciona o script debug-watch criando o arquivo .vscode/launch.json no diretório raiz:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "node",
              "request": "launch",
              "name": "Debug Watch",
              "cwd": "${workspaceRoot}",
              "runtimeExecutable": "npm",
              "runtimeArgs": ["run-script", "debug-watch"]
          }]
      }
      

   5. Adicione um ponto de interrupção que pausa o processamento da solicitação HTTP no arquivo index.js e inicie a execução e depuração com a configuração Debug Watch adicionada antes. O aplicativo agora está em execução e detectando solicitações HTTP na porta 9000.

      

      Figura 3. O aplicativo está em execução e detectando solicitações HTTP na porta 9000.

3. Inicie o aplicativo ngrok no seu ambiente local:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Substitua NGROK_STATIC_DOMAIN pelo domínio estático na sua conta ngrok. Agora, todas as solicitações são redirecionadas para o ambiente local e a porta usada pelo aplicativo.

   

   Figura 4. O terminal com o servidor ngrok em execução e redirecionamento.

4. Uma interface da Web também é iniciada no host local pelo aplicativo ngrok. É possível monitorar todas as atividades abrindo-o em um navegador.

   

   Figura 5. A interface da Web hospedada pelo aplicativo ngrok não mostra solicitações HTTP.

5. Teste o app do Chat enviando uma mensagem direta:

   • Abra o Google Chat.

     Acessar o Google Chat

   • Clique em Novo chat add.

   • Na caixa de diálogo, insira o nome do app de chat.

   • Nos resultados da pesquisa, encontre o app de chat, clique em Adicionar > Chat.

   • No espaço da mensagem direta, digite Hello e pressione enter. O app de chat não responde porque está sendo ativamente depurado.

6. No Visual Studio Code no seu ambiente local, é possível ver que a execução é pausada no ponto de interrupção definido.

   

   Figura 6. A execução é pausada no ponto de interrupção definido.

7. Quando você retoma a execução do depurador de Visual Studio Code antes que o Google Chat expire, o app do Chat responde Your message : Hello.

8. É possível verificar os registros de solicitação e resposta HTTP na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local.

   

   Figura 7. A solicitação HTTP da interface da Web hospedada pelo aplicativo ngrok.

9. Para mudar o comportamento do aplicativo, substitua Your message por Here was your message 35 inline do index.json. Quando você salva o arquivo, o nodemon recarrega automaticamente o aplicativo com o código-fonte atualizado, e o Visual Studio Code permanece no modo de depuração.

   

   Figura 8. O aplicativo está em execução e detectando solicitações HTTP na porta 9000 com a mudança de código carregada.

10. Dessa vez, em vez de enviar uma segunda mensagem Hello no espaço, você pode selecionar a última solicitação HTTP registrada na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local e clicar em Replay. Assim como da última vez, o app de chat não responde porque está sendo depurado ativamente.

11. Quando você retoma a execução do depurador de Visual Studio Code, é possível conferir na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local que o aplicativo gera uma resposta com a versão atualizada da mensagem Here was your message : Hello.

Python

1. Consiga novas credenciais de usuário que serão usadas no Application Default Credentials:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   Substitua PROJECT_ID pelo ID do projeto do projeto do Cloud do app.

2. Clone o repositório googleworkspace/google-chat-samples do GitHub para o ambiente local, que contém o código do aplicativo:

   git clone https://github.com/googleworkspace/google-chat-samples.git

3. No ambiente de desenvolvimento integrado Visual Studio Code instalado no ambiente local, faça o seguinte:

   1. Em uma nova janela, abra a pasta google-chat-samples/python/avatar-app.

   2. Crie e ative um novo ambiente virtual para o Python env:

      virtualenv env
      source env/bin/activate

   3. Instale todas as dependências do projeto usando pip no ambiente virtual:

      pip install -r requirements.txt

   4. Crie o arquivo .vscode/launch.json no diretório raiz e configure uma inicialização com o nome Debug Watch que aciona o aplicativo do módulo functions-framework na porta 9000 no modo de depuração no ambiente virtual env:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "python",
              "request": "launch",
              "name": "Debug Watch",
              "python": "${workspaceFolder}/env/bin/python3",
              "module": "functions_framework",
              "args": [
                  "--target", "avatar_app",
                  "--port", "9000",
                  "--debug"
              ]
          }]
      }
      

   5. Adicione um ponto de interrupção que pausa o processamento da solicitação HTTP no arquivo main.py e inicie a execução e depuração com a configuração Debug Watch adicionada antes. O aplicativo agora está em execução e detectando solicitações HTTP na porta 9000.

      

      Figura 3. O aplicativo está em execução e detectando solicitações HTTP na porta 9000.

4. Inicie o aplicativo ngrok no seu ambiente local:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Substitua NGROK_STATIC_DOMAIN pelo domínio estático na sua conta ngrok. Agora, todas as solicitações são redirecionadas para o ambiente local e a porta usada pelo aplicativo.

   

   Figura 4. O terminal com o servidor ngrok em execução e redirecionamento.

5. Uma interface da Web também é iniciada no host local pelo aplicativo ngrok. É possível monitorar todas as atividades abrindo-o em um navegador.

   

   Figura 5. A interface da Web hospedada pelo aplicativo ngrok não mostra solicitações HTTP.

6. Teste o app do Chat enviando uma mensagem direta:

   • Abra o Google Chat.

     Acessar o Google Chat

   • Clique em Novo chat add.

   • Na caixa de diálogo, insira o nome do app de chat.

   • Nos resultados da pesquisa, encontre o app de chat, clique em Adicionar > Chat.

   • No espaço da mensagem direta, digite Hey! e pressione enter. Seu app de chat não responde porque está sendo ativamente depurado.

7. No Visual Studio Code no seu ambiente local, é possível ver que a execução é pausada no ponto de interrupção definido.

   

   Figura 6. A execução é pausada no ponto de interrupção definido.

8. Quando você retoma a execução do depurador de Visual Studio Code antes que o Google Chat expire, o app Chat responde com seu nome e a imagem do avatar na mensagem.

9. É possível verificar os registros de solicitação e resposta HTTP na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local.

   

   Figura 7. A solicitação HTTP da interface da Web hospedada pelo aplicativo ngrok.

10. Para mudar o comportamento do aplicativo, substitua Hello por Hey inline 51 do arquivo main.py. Quando você salva o arquivo, o Visual Studio Code recarrega automaticamente o aplicativo com o código-fonte atualizado e permanece no modo de depuração.

    

    Figura 8. O aplicativo está em execução e detectando solicitações HTTP na porta 9000 com a mudança de código carregada.

11. Dessa vez, em vez de enviar uma segunda mensagem Hey! no espaço, você pode selecionar a última solicitação HTTP registrada na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local e clicar em Replay. Assim como da última vez, seu app de chat não responde porque está sendo depurado ativamente.

12. Quando você retoma a execução do depurador de Visual Studio Code, é possível conferir na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local que o aplicativo gera uma resposta com a versão atualizada da mensagem.

Java

1. Consiga novas credenciais de usuário que serão usadas no Application Default Credentials:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   Substitua PROJECT_ID pelo ID do projeto do projeto do Cloud do app.

2. Clone o repositório googleworkspace/google-chat-samples do GitHub no seu ambiente local, que contém o código do aplicativo:

   git clone https://github.com/googleworkspace/google-chat-samples.git

3. No ambiente de desenvolvimento integrado Visual Studio Code instalado no ambiente local, faça o seguinte:

   1. Em uma nova janela, abra a pasta google-chat-samples/java/avatar-app.

   2. Configure o projeto do Maven para executar o aplicativo App na porta 9000 localmente adicionando o plug-in de build do Cloud Functions Framework function-maven-plugin no arquivo pom.xml:

      ...
      <plugin>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>function-maven-plugin</artifactId>
          <version>0.11.0</version>
          <configuration>
              <functionTarget>App</functionTarget>
              <port>9000</port>
          </configuration>
      </plugin>
      ...
      

   3. Agora você pode iniciá-lo localmente no modo de depuração:

      mvnDebug function:run
      Preparing to execute Maven in debug mode
      Listening for transport dt_socket at address: 8000

   4. Crie o arquivo .vscode/launch.json no diretório raiz e configure uma inicialização chamada Remote Debug Watch que se conecte ao aplicativo iniciado anteriormente com a porta 8000:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "java",
              "request": "attach",
              "name": "Remote Debug Watch",
              "projectName": "http-function",
              "hostName": "localhost",
              "port": 8000
          }]
      }
      

   5. Adicione um ponto de interrupção que pausa o processamento da solicitação HTTP no arquivo App.java e inicie a anexação e depuração com a configuração Remote Debug Watch adicionada anteriormente. O aplicativo está em execução e detectando solicitações HTTP na porta 9000.

      

      Figura 3.O aplicativo está em execução e detectando solicitações HTTP na porta 9000.

4. Inicie o aplicativo ngrok no seu ambiente local:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Substitua NGROK_STATIC_DOMAIN pelo domínio estático na sua conta ngrok. Agora, todas as solicitações são redirecionadas para o ambiente local e a porta usada pelo aplicativo.

   

   Figura 4. O terminal com o servidor ngrok em execução e redirecionamento.

5. Uma interface da Web também é iniciada no host local pelo aplicativo ngrok. É possível monitorar todas as atividades abrindo-o em um navegador.

   

   Figura 5. A interface da Web hospedada pelo aplicativo ngrok não mostra solicitações HTTP.

6. Teste o app do Chat enviando uma mensagem direta:

   • Abra o Google Chat.

     Acessar o Google Chat

   • Clique em Novo chat add.

   • Na caixa de diálogo, insira o nome do app de chat.

   • Nos resultados da pesquisa, encontre o app de chat, clique em Adicionar > Chat.

   • No espaço da mensagem direta, digite Hey! e pressione enter. O app de chat não responde porque está sendo ativamente depurado.

7. No Visual Studio Code no seu ambiente local, é possível ver que a execução é pausada no ponto de interrupção definido.

   

   Figura 6. A execução é pausada no ponto de interrupção definido.

8. Quando você retoma a execução do depurador de Visual Studio Code antes que o Google Chat expire, o app Chat responde com seu nome e a imagem do avatar na mensagem.

9. É possível verificar os registros de solicitação e resposta HTTP na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local.

   

   Figura 7. A solicitação HTTP da interface da Web hospedada pelo aplicativo ngrok.

10. Para mudar o comportamento do aplicativo, substitua Hello por Hey inline 55 do arquivo App.java, reinicie o processo mvnDebug e reinicie o Remote Debug Watch para reativar e reiniciar o depurador.

11. Dessa vez, em vez de enviar uma segunda mensagem Hey! no espaço, você pode selecionar a última solicitação HTTP registrada na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local e clicar em Replay. Assim como da última vez, seu app de chat não responde porque está sendo depurado ativamente.

12. Quando você retoma a execução do depurador de Visual Studio Code, é possível conferir na interface da Web hospedada pelo aplicativo ngrok no seu ambiente local que o aplicativo gera uma resposta com a versão atualizada da mensagem.