Debug delle app Google Chat

In qualità di sviluppatore di app Google Chat, potresti dover eseguire il debug del codice per testare le modifiche o risolvere problemi complessi. Debug delle app di Chat può essere eseguito in molti modi diversi a seconda dell'architettura dell'app, di il deployment dell'app, le modalità di deployment e le tue preferenze.

In questa pagina viene spiegato come eseguire il debug di un'app di chat HTTP utilizzando ngrok, una piattaforma in entrata unificata che puoi utilizzare per testare di sviluppo software. In questa guida testerai le modifiche al codice in una regione dell'ambiente di lavoro e risolvere i problemi in un ambiente remoto.

Debug dall'ambiente di sviluppo locale

In questa sezione devi interagire con l'app di Chat che vengono eseguite nel tuo ambiente locale.

Debug dallo sviluppo locale
ambiente

Figura 1. Esegui il debug in un ambiente di sviluppo locale.

Officina

Node.js

Python

Java

Prerequisiti

Node.js

  • Versioni più recenti di node e npm installato nel tuo ambiente locale.
  • La versione più recente di nodemon installata nel tuo paese , viene utilizzato per il ricaricamento automatico:

    npm install -g nodemon
    
  • Un'app di chat HTTP configurata per i messaggi. Puoi seguire le sezioni Prerequisiti Imposta il dell'ambiente di rete, e pubblica l'app su Google Chat del Guida rapida. L'unico differenze è che devi impostare Nome app su Debug App e l'URL dell'app a un elemento, ad esempio http://example.com.

  • Un IDE configurato nel tuo ambiente locale in grado di eseguire il debug. Utilizziamo Visual Studio Code IDE e le sue impostazioni predefinite le funzionalità di debug in questa guida a scopo illustrativo.

  • Git installato nel tuo ambiente locale.

  • Un account ngrok.

Python

Java

Rendi il servizio localhost disponibile pubblicamente

Devi connettere il tuo ambiente locale a internet in modo che L'app Chat può accedervi. Applicazione ngrok in uso per reindirizzare le richieste HTTP effettuate a un URL pubblico al tuo ambiente locale.

  1. In un browser nel tuo ambiente locale, accedi al tuo account ngrok.
  2. Installa l'applicazione e configura il tuo authtoken nel tuo completamente gestito di Google Cloud.
  3. Crea un dominio statico nel tuo account ngrok, è indicato come NGROK_STATIC_DOMAIN nelle istruzioni di questa guida.

Configurare l'app Chat

Configurare l'app Chat per l'invio di tutte le sue richieste HTTP a il tuo dominio statico.

  1. Nella console Google Cloud, apri la pagina dell'API Google Chat:

    Vai alla pagina dell'API Google Chat

  2. Fai clic sulla scheda Configuration (Configurazione).

  3. Vai a Funzionalità interattive > Impostazioni di connessione e imposta il valore. del campo di testo URL applicazione a:

    https://NGROK_STATIC_DOMAIN
    

    Sostituisci NGROK_STATIC_DOMAIN con il dominio statico in il tuo account ngrok.

  4. Fai clic su Salva.

L'app Chat invia tutte le sue richieste HTTP al
dominio statico

Figura 2. L'app Chat invia tutte le sue richieste HTTP al dominio statico. Il servizio pubblico ngrok funge da collegamento tra App Chat e il codice dell'applicazione che viene eseguito a livello locale.

Testare l'app Chat

Puoi eseguire il deployment, configurare, testare, eseguire il debug e ricaricare automaticamente Chat.

Node.js

  1. Clona il repository googleworkspace/google-chat-samples da GitHub al tuo ambiente locale, contiene il codice dell'applicazione esegui:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  2. Dall'IDE Visual Studio Code installato nel tuo ambiente locale: segui questi passaggi:

    1. In una nuova finestra, apri la cartella google-chat-samples/node/basic-app.
    2. Configura l'applicazione per il debug del ricaricamento automatico aggiungendo due script nel file package.json:

      {
          ...
          "scripts": {
              ...
              "debug": "node --inspect index.js",
              "debug-watch": "nodemon --watch ./ --exec npm run debug"
          }
          ...
      }
      
    3. Installa l'applicazione dalla directory root:

      npm install
      
    4. Crea e configura un lancio denominato Debug Watch che attivi il script debug-watch creando il file .vscode/launch.json in nella directory radice:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "node",
              "request": "launch",
              "name": "Debug Watch",
              "cwd": "${workspaceRoot}",
              "runtimeExecutable": "npm",
              "runtimeArgs": ["run-script", "debug-watch"]
          }]
      }
      
    5. Aggiungi un punto di interruzione che metta in pausa l'elaborazione della richiesta HTTP nel index.js e iniziare a eseguire e il debug con Configurazione Debug Watch aggiunta prima. L'applicazione è ora in esecuzione e in ascolto delle richieste HTTP sulla porta 9000.

      L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sul
porta "9000"

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto del protocollo HTTP richieste sulla porta 9000.

  3. Avvia l'applicazione ngrok nel tuo ambiente locale:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Sostituisci NGROK_STATIC_DOMAIN con il dominio statico in il tuo account ngrok. Tutte le richieste vengono ora reindirizzate al tuo indirizzo e la porta usata dall'applicazione.

    Il terminale con il server "ngrok" in esecuzione e
reindirizzamento

    Figura 4. Il terminale con il server ngrok in esecuzione e reindirizzato.

  4. Il ngrok avvia anche un'interfaccia web sul tuo localhost applicazione, puoi monitorare tutte le attività aprendola in un browser.

    L'interfaccia web ospitata dall'applicazione "ngrok" che non mostra HTTP
richieste

    Figura 5. Interfaccia web ospitata dall'applicazione ngrok che non mostra richieste HTTP.

  5. Testa la tua app di Chat inviandole un link diretto messaggio:

    • Apri Google Chat.

      Vai a Google Chat

    • Fai clic su Nuova chat .

    • Nella finestra di dialogo, inserisci il nome del Chat.

    • Nei risultati di ricerca, trova l'app Chat. fai clic su Aggiungi > Chatta.

    • Nello spazio del messaggio diretto, digita Hello e premi enter. Il tuo L'app Chat non risponde perché sta di cui è stato eseguito il debug attivo.

  6. In Visual Studio Code nel tuo ambiente locale, puoi vedere che l'esecuzione è in pausa nel punto di interruzione impostato.

    L'esecuzione è in pausa nel punto di interruzione
imposta

    Figura 6. L'esecuzione è in pausa nel punto di interruzione impostato.

  7. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che Google Chat scada il timeout dell'app Chat risposte Your message : Hello.

  8. Puoi controllare i log delle richieste e delle risposte HTTP dall'interfaccia web ospitato dall'applicazione ngrok nel tuo ambiente locale.

    La richiesta HTTP dall'interfaccia web ospitata da "ngrok"
applicazione

    Figura 7. La richiesta HTTP dall'interfaccia web ospitata dal Applicazione ngrok.

  9. Per modificare il comportamento dell'applicazione, sostituisci Your message con Here was your message in linea 35 di index.json. Se salvi il file, nodemon ricarica automaticamente l'applicazione con aggiornato il codice sorgente e Visual Studio Code rimane in modalità di debug.

    L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta
"9000" con la modifica del codice
caricato

    Figura 8. L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta 9000 con la modifica del codice caricata.

  10. Questa volta, invece di inviare un secondo messaggio Hello nello spazio, è possibile selezionare l'ultima richiesta HTTP registrata nell'interfaccia web ospitata l'applicazione ngrok nel tuo ambiente locale e fai clic su Replay. Come l'ultima volta, l'app Chat non risponde perché è in fase di debug attivo.

  11. Quando riprendi l'esecuzione dal debugger di Visual Studio Code puoi vedere nell'interfaccia web ospitata dall'applicazione ngrok in del tuo ambiente locale con cui l'applicazione genera una risposta la versione aggiornata del messaggio Here was your message : Hello.

Python

  1. Acquisisci nuove credenziali utente da utilizzare per App predefinita Credenziali:

    gcloud config set project PROJECT_ID
    gcloud auth application-default login
    

    Sostituisci PROJECT_ID con ID progetto per il progetto Cloud dell'app.

  2. Clona il repository googleworkspace/google-chat-samples da GitHub al tuo ambiente locale, contiene il codice dell'applicazione:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  3. Dall'IDE Visual Studio Code installato nel tuo ambiente locale: segui questi passaggi:

    1. In una nuova finestra, apri la cartella google-chat-samples/python/avatar-app.
    2. Crea un nuovo ambiente virtuale per Python env e attivalo:

      virtualenv env
      source env/bin/activate
      
    3. Installa tutte le dipendenze del progetto utilizzando pip nella macchina virtuale questo ambiente:

      pip install -r requirements.txt
      
    4. Crea il file .vscode/launch.json nella directory principale e configura un lancio denominato Debug Watch che attiva l'applicazione dal modulo functions-framework sulla porta 9000 in modalità di debug sull'ambiente virtuale 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. Aggiungi un punto di interruzione che metta in pausa l'elaborazione della richiesta HTTP nel main.py e iniziare a eseguire e il debug con Configurazione Debug Watch aggiunta prima. L'applicazione è ora in esecuzione e in ascolto delle richieste HTTP sulla porta 9000.

      L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sul
porta "9000"

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto del protocollo HTTP richieste sulla porta 9000.

  4. Avvia l'applicazione ngrok nel tuo ambiente locale:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Sostituisci NGROK_STATIC_DOMAIN con il dominio statico in il tuo account ngrok. Tutte le richieste vengono ora reindirizzate al tuo indirizzo e la porta usata dall'applicazione.

    Il terminale con il server "ngrok" in esecuzione e
reindirizzamento

    Figura 4. Il terminale con il server ngrok in esecuzione e reindirizzato.

  5. Il ngrok avvia anche un'interfaccia web sul tuo localhost applicazione, puoi monitorare tutte le attività aprendola in un browser.

    L'interfaccia web ospitata dall'applicazione "ngrok" che non mostra HTTP
richieste

    Figura 5. Interfaccia web ospitata dall'applicazione ngrok che non mostra richieste HTTP.

  6. Testa la tua app di Chat inviandole un link diretto messaggio:

    • Apri Google Chat.

      Vai a Google Chat

    • Fai clic su Nuova chat .

    • Nella finestra di dialogo, inserisci il nome del Chat.

    • Nei risultati di ricerca, trova l'app Chat. fai clic su Aggiungi > Chatta.

    • Nello spazio del messaggio diretto, digita Hey! e premi enter. Il tuo L'app Chat non risponde perché è in corso di cui è stato eseguito il debug attivo.

  7. In Visual Studio Code nel tuo ambiente locale, puoi vedere che l'esecuzione è in pausa nel punto di interruzione impostato.

    L'esecuzione è in pausa nel punto di interruzione
imposta

    Figura 6. L'esecuzione è in pausa nel punto di interruzione impostato.

  8. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che Google Chat scada il timeout dell'app Chat risposte con il tuo nome e la tua immagine dell'avatar nel messaggio.

  9. Puoi controllare i log delle richieste e delle risposte HTTP dall'interfaccia web ospitato dall'applicazione ngrok nel tuo ambiente locale.

    La richiesta HTTP dall'interfaccia web ospitata da "ngrok"
applicazione

    Figura 7. La richiesta HTTP dall'interfaccia web ospitata dal Applicazione ngrok.

  10. Per modificare il comportamento dell'applicazione, sostituisci Hello con Hey in linea 51 del file main.py. Quando salvi il file, Visual Studio Code ricarica automaticamente l'applicazione con il codice sorgente aggiornato rimane in modalità di debug.

    L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta
"9000" con la modifica del codice
caricato

    Figura 8. L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta 9000 con la modifica del codice caricata.

  11. Questa volta, invece di inviare un secondo messaggio Hey! nello spazio, è possibile selezionare l'ultima richiesta HTTP registrata nell'interfaccia web ospitata l'applicazione ngrok nel tuo ambiente locale e fai clic su Replay. Come l'ultima volta, l'app Chat non risponde perché è in fase di debug attivo.

  12. Quando riprendi l'esecuzione dal debugger di Visual Studio Code puoi vedere nell'interfaccia web ospitata dall'applicazione ngrok in del tuo ambiente locale con cui l'applicazione genera una risposta la versione aggiornata del messaggio.

Java

  1. Acquisisci nuove credenziali utente da utilizzare per App predefinita Credenziali:

    gcloud config set project PROJECT_ID
    gcloud auth application-default login
    

    Sostituisci PROJECT_ID con ID progetto per il progetto Cloud dell'app.

  2. Clona il repository googleworkspace/google-chat-samples da GitHub nel tuo ambiente locale, contiene il codice dell'applicazione:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  3. Dall'IDE Visual Studio Code installato nel tuo ambiente locale: segui questi passaggi:

    1. In una nuova finestra, apri la cartella google-chat-samples/java/avatar-app.
    2. Configura il progetto Maven su cui eseguire l'applicazione App porta 9000 in locale aggiungendo la build del framework di Cloud Functions plug-in function-maven-plugin nel file 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. Ora puoi avviarlo localmente in modalità di debug:

      mvnDebug function:run
      Preparing to execute Maven in debug mode
      Listening for transport dt_socket at address: 8000
      
    4. Crea il file .vscode/launch.json nella directory principale e configurare un lancio denominato Remote Debug Watch che si collega al dell'applicazione avviata in precedenza con la porta 8000:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "java",
              "request": "attach",
              "name": "Remote Debug Watch",
              "projectName": "http-function",
              "hostName": "localhost",
              "port": 8000
          }]
      }
      
    5. Aggiungi un punto di interruzione che metta in pausa l'elaborazione della richiesta HTTP nel App.java e inizia ad allegare e il debug con Configurazione Remote Debug Watch aggiunta prima. L'applicazione è ora in esecuzione e in ascolto delle richieste HTTP sulla porta 9000.

      L&#39;applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sul
porta &quot;9000&quot;

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto di HTTP richieste sulla porta 9000.

  4. Avvia l'applicazione ngrok nel tuo ambiente locale:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Sostituisci NGROK_STATIC_DOMAIN con il dominio statico in il tuo account ngrok. Tutte le richieste vengono ora reindirizzate al tuo indirizzo e la porta usata dall'applicazione.

    Il terminale con il server &quot;ngrok&quot; in esecuzione e
reindirizzamento

    Figura 4. Il terminale con il server ngrok in esecuzione e reindirizzato.

  5. Il ngrok avvia anche un'interfaccia web sul tuo localhost applicazione, puoi monitorare tutte le attività aprendola in un browser.

    L&#39;interfaccia web ospitata dall&#39;applicazione &quot;ngrok&quot; che non mostra HTTP
richieste

    Figura 5. Interfaccia web ospitata dall'applicazione ngrok che non mostra richieste HTTP.

  6. Testa la tua app di Chat inviandole un link diretto messaggio:

    • Apri Google Chat.

      Vai a Google Chat

    • Fai clic su Nuova chat .

    • Nella finestra di dialogo, inserisci il nome del Chat.

    • Nei risultati di ricerca, trova l'app Chat. fai clic su Aggiungi &gt; Chatta.

    • Nello spazio del messaggio diretto, digita Hey! e premi enter. Il tuo L'app Chat non risponde perché è in corso di cui è stato eseguito il debug attivo.

  7. In Visual Studio Code nel tuo ambiente locale, puoi vedere che l'esecuzione è in pausa nel punto di interruzione impostato.

    L&#39;esecuzione è in pausa nel punto di interruzione
imposta

    Figura 6. L'esecuzione è in pausa nel punto di interruzione impostato.

  8. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che Google Chat scada il timeout dell'app Chat risposte con il tuo nome e la tua immagine dell'avatar nel messaggio.

  9. Puoi controllare i log delle richieste e delle risposte HTTP dall'interfaccia web ospitato dall'applicazione ngrok nel tuo ambiente locale.

    La richiesta HTTP dall&#39;interfaccia web ospitata da &quot;ngrok&quot;
applicazione

    Figura 7. La richiesta HTTP dall'interfaccia web ospitata dal Applicazione ngrok.

  10. Per modificare il comportamento dell'applicazione, sostituisci Hello con Hey in linea 55 del file App.java, riavvia il processo mvnDebug e riavvia Remote Debug Watch per ricollegarlo e riavviarlo il debug.

  11. Questa volta, invece di inviare un secondo messaggio Hey! nello spazio, è possibile selezionare l'ultima richiesta HTTP registrata nell'interfaccia web ospitata l'applicazione ngrok nel tuo ambiente locale e fai clic su Replay. Come l'ultima volta, l'app Chat non risponde perché è in fase di debug attivo.

  12. Quando riprendi l'esecuzione dal debugger di Visual Studio Code puoi vedere nell'interfaccia web ospitata dall'applicazione ngrok in del tuo ambiente locale con cui l'applicazione genera una risposta la versione aggiornata del messaggio.

Debug da ambiente remoto

In questa sezione devi interagire con l'app di Chat che su un ambiente remoto.

Debug da remoto
ambiente

Figura 9. Debug da ambiente remoto.

Prerequisiti

  • Uno spazio di messaggi diretti con l'app Chat. Puoi segui la sezione Testa l'app Chat di Guida rapida e cerca il tuo app Chat per avviarne una.
  • L'applicazione in esecuzione nell'ambiente remoto con il debugger abilitato su una determinata porta, viene definito REMOTE_DEBUG_PORT nelle istruzioni di questa guida.
  • Il tuo ambiente locale può ssh nel tuo ambiente remoto.
  • Un IDE configurato nel tuo ambiente locale in grado di eseguire il debug. Utilizziamo Visual Studio Code IDE e le sue impostazioni predefinite di debug in questo a scopo illustrativo.

Connetti i tuoi ambienti locali e remoti

Nel tuo ambiente locale da cui vuoi avviare un client di debug per configurare un tunnel SSH:

ssh -L LOCAL_DEBUG_PORT:localhost:REMOTE_DEBUG_PORT REMOTE_USERNAME@REMOTE_ADDRESS

Sostituisci quanto segue:

  • LOCAL_DEBUG_PORT: la porta di debug nella libreria locale completamente gestito di Google Cloud.
  • REMOTE_USERNAME: il nome utente nell'ambiente remoto.
  • REMOTE_ADDRESS: l'indirizzo del tuo ambiente remoto.
  • REMOTE_DEBUG_PORT: la porta di debug del telecomando completamente gestito di Google Cloud.

La porta di debug nell'ambiente locale è ora collegata alla porta di debug nel tuo ambiente remoto.

Avvia debug

Dall'IDE Visual Studio Code installato nel tuo ambiente locale, procedi nel seguente modo: seguenti:

  1. In una nuova finestra, apri il codice sorgente della tua app.
  2. Crea il file .vscode/launch.json nella directory radice e configura un avviare Debug Remote che si collega alla porta di debug questo ambiente:

    Node.js

    {
        "version": "0.2.0",
        "configurations": [{
            "type": "node",
            "request": "attach",
            "name": "Debug Remote",
            "address": "127.0.0.1",
            "port": LOCAL_DEBUG_PORT
        }]
    }
    

    Python

    {
        "version": "0.2.0",
        "configurations": [{
            "type": "python",
            "request": "attach",
            "name": "Debug Remote",
            "connect": {
                "host": "127.0.0.1",
                "port": LOCAL_DEBUG_PORT
            }
        }]
    }
    

    Java

    {
        "version": "0.2.0",
        "configurations": [{
            "type": "java",
            "request": "attach",
            "name": "Debug Remote",
            "hostName": "127.0.0.1",
            "port": LOCAL_DEBUG_PORT
        }]
    }
    

    Sostituisci LOCAL_DEBUG_PORT con la porta di debug dell'ambiente locale.

  3. Aggiungi un punto di interruzione nel codice sorgente dell'app che mette in pausa la richiesta HTTP nell'elaborazione e iniziare a eseguire il debug con la configurazione Debug Remote aggiunta in precedenza.

Nello spazio dei messaggi diretti con l'app Chat, digita tutto ciò che vuoi testare e premi enter. Il tuo L'app Chat non risponde perché è in corso con debug nell'IDE Visual Studio Code.