Debug delle app Google Chat

Node.js

Python

Java

Node.js

• Le versioni più recenti di node e npm installate nel tuo ambiente locale.

• La versione più recente di nodemon installata nel tuo ambiente locale, utilizzata per il ricaricamento automatico:

  npm install -g nodemon

• Un'app Chat HTTP configurata per la messaggistica. Puoi seguire le sezioni Prerequisiti, Configurare l'ambiente e Pubblicare l'app in Google Chat della Guida rapida. Le uniche differenze sono che devi impostare Nome app su Debug App e URL endpoint HTTP su un valore qualsiasi, ad esempio http://example.com.

• Un IDE configurato nel tuo ambiente locale che può eseguire il debug. In questa guida utilizziamo IDE Visual Studio Code e le sue funzionalità di debug predefinite a scopo illustrativo.

• Git installato nel tuo ambiente locale.

• Un account ngrok.

Python

• La versione più recente di python3 installata nel tuo ambiente locale.
• La versione più recente di pip e virtualenv installata nel ambiente locale, vengono utilizzati rispettivamente per gestire i pacchetti Python e gli ambienti virtuali.
• Un'app Chat HTTP configurata per la messaggistica. Puoi seguire le sezioni Prerequisiti, Configurare l'ambiente e Pubblicare l'app in Google Chat della Guida rapida. Le uniche differenze sono che devi impostare Nome app su Debug App e URL endpoint HTTP su un valore qualsiasi, ad esempio http://example.com.
• Un IDE configurato nel tuo ambiente locale che può eseguire il debug. In questa guida utilizziamo IDE Visual Studio Code e le sue funzionalità di debug predefinite a scopo illustrativo.
• Git installato nel tuo ambiente locale.
• Un account ngrok.
• La versione più recente di gcloud installata e inizializzata nel tuo ambiente locale.

Java

• La versione stabile più recente di Java SE 11's JDK installata nel tuo ambiente locale.
• La versione più recente di Apache Maven installata nel tuo ambiente locale, viene utilizzata per gestire i progetti Java.
• Un'app Chat HTTP configurata per la messaggistica. Puoi seguire le sezioni Prerequisiti, Configurare l'ambiente e Pubblicare l'app in Google Chat della Guida rapida. Le uniche differenze sono che devi impostare Nome app su Debug App e URL endpoint HTTP su un valore qualsiasi, ad esempio http://example.com.
• Un IDE configurato nel tuo ambiente locale che può eseguire il debug. In questa guida utilizziamo IDE Visual Studio Code e le sue funzionalità di debug predefinite a scopo illustrativo.
• Git installato nel tuo ambiente locale.
• Un account ngrok.
• La versione più recente di gcloud installata e inizializzata nel tuo ambiente locale.

Node.js

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

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

2. Nell'IDE Visual Studio Code installato nel tuo ambiente locale, segui questi passaggi:

   1. In una nuova finestra, apri la cartellagoogle-chat-samples/node/basic-app.

   2. Configura l'applicazione per il debug di ricarica automatica aggiungendo due script nel file package.json:

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

   3. Dalla directory principale, installa l'applicazione:

      npm install

   4. Crea e configura un lancio denominato Debug Watch che attiva lo script debug-watch creando il file .vscode/launch.json nella directory principale:

      {
          "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 file e avvia l'esecuzione e il debugging con la configurazione Debug Watch aggiunta in precedenza. Ora l'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta 9000.

      

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP 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 nel tuo account ngrok. Ora tutte le richieste vengono reindirizzate al tuo ambiente locale e alla porta utilizzata dall'applicazione.

   

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

4. L'applicazione ngrok avvia anche un'interfaccia web su localhost, che puoi monitorare in un browser.

   

   Figura 5. L'interfaccia web ospitata dall'applicazione ngrok non mostra richieste HTTP.

5. Prova l'app Chat inviandole un messaggio diretto:

   • Apri Google Chat.

     Vai a Google Chat

   • Fai clic su Nuova chat add.

   • Nella finestra di dialogo, inserisci il nome della tua app di chat.

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

   • Nello spazio dei messaggi diretti, digita Hello e premi enter. L'app Chat non risponde perché è in corso il debug attivo.

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

   

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

7. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che Google Chat scada, l'app Chat risponde Your message : Hello.

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

   

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

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

   

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

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

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

Python

1. Acquisisci nuove credenziali utente da utilizzare per le Credenziali predefinite dell'applicazione:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

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

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

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

3. Nell'IDE Visual Studio Code installato nel tuo ambiente locale, segui questi passaggi:

   1. In una nuova finestra, apri la cartellagoogle-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 nell'ambiente virtuale:

      pip install -r requirements.txt

   4. Crea il file .vscode/launch.json nella directory principale e configura un lancio denominato Debug Watch che attivi l'applicazione dal modulo functions-framework sulla porta 9000 in modalità di debug nell'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 file e avvia l'esecuzione e il debugging con la configurazione Debug Watch aggiunta in precedenza. Ora l'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP sulla porta 9000.

      

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP 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 nel tuo account ngrok. Ora tutte le richieste vengono reindirizzate al tuo ambiente locale e alla porta utilizzata dall'applicazione.

   

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

5. L'applicazione ngrok avvia anche un'interfaccia web su localhost, che puoi monitorare in un browser.

   

   Figura 5. L'interfaccia web ospitata dall'applicazione ngrok non mostra richieste HTTP.

6. Prova l'app Chat inviandole un messaggio diretto:

   • Apri Google Chat.

     Vai a Google Chat

   • Fai clic su Nuova chat add.

   • Nella finestra di dialogo, inserisci il nome della tua app di chat.

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

   • Nello spazio dei messaggi diretti, digita Hey! e premi enter. L'app Chat non risponde perché è in corso il debug attivo.

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

   

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

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

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

   

   Figura 7. La richiesta HTTP dall'interfaccia web ospitata dall'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 e rimane in modalità di debug.

    

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

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

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

Java

1. Acquisisci nuove credenziali utente da utilizzare per le Credenziali predefinite dell'applicazione:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   Sostituisci PROJECT_ID con l'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. Nell'IDE Visual Studio Code installato nel tuo ambiente locale, segui questi passaggi:

   1. In una nuova finestra, apri la cartellagoogle-chat-samples/java/avatar-app.

   2. Configura il progetto Maven in modo da eseguire l'applicazione App sulla porta 9000 in locale aggiungendo il plug-in di compilazione del framework Cloud Functions 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 configura un avvio denominato Remote Debug Watch che si connette all'applicazione lanciata 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 file e inizia ad attaccarti e eseguire il debugging con la configurazione Remote Debug Watch aggiunta in precedenza. Ora l'applicazione è in esecuzione e rimane in attesa delle richieste HTTP sulla porta 9000.

      

      Figura 3. L'applicazione è in esecuzione e rimane in ascolto delle richieste HTTP 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 nel tuo account ngrok. Ora tutte le richieste vengono reindirizzate al tuo ambiente locale e alla porta utilizzata dall'applicazione.

   

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

5. L'applicazione ngrok avvia anche un'interfaccia web su localhost, che puoi monitorare in un browser.

   

   Figura 5. L'interfaccia web ospitata dall'applicazione ngrok non mostra richieste HTTP.

6. Prova l'app Chat inviandole un messaggio diretto:

   • Apri Google Chat.

     Vai a Google Chat

   • Fai clic su Nuova chat add.

   • Nella finestra di dialogo, inserisci il nome della tua app di chat.

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

   • Nello spazio dei messaggi diretti, digita Hey! e premi enter. L'app Chat non risponde perché è in corso il debug attivo.

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

   

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

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

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

   

   Figura 7. La richiesta HTTP dall'interfaccia web ospitata dall'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 riattaccare e riavviare il debug.

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

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