Testare e eseguire il debug dei componenti aggiuntivi di Google Workspace HTTP

In qualità di sviluppatore di componenti aggiuntivi di Google Workspace, potresti dover eseguire il debug del codice per testare le modifiche o risolvere problemi complessi. Il debug dei componenti aggiuntivi di Google Workspace può essere eseguito in molti modi diversi, a seconda dell'architettura dell'app, della sua funzionalità, del modo in cui viene implementata e delle tue preferenze.

Questa pagina spiega come eseguire il debug di un componente aggiuntivo HTTP di Google Workspace utilizzando ngrok, una piattaforma di ingresso unificata che puoi utilizzare per testare gli ambienti di sviluppo locale. In questa guida, testerai le modifiche al codice in un ambiente locale e risolverai i problemi in un ambiente remoto.

Eseguire il debug dall'ambiente di sviluppo locale

In questa sezione interagisci con il componente aggiuntivo di Google Workspace che viene eseguito nel tuo ambiente locale.

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

Prerequisiti

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 progetto Google Cloud. Puoi seguire le sezioni Prerequisiti e Configurare l'ambiente della guida rapida.

• Il codice del componente aggiuntivo di Google Workspace da eseguire il debug nell'ambiente locale. In questa guida utilizziamo le funzionalità di link di anteprima dell'esempio di codice3p-resources del repository GitHub googleworkspace/add-ons-samples a scopo illustrativo.

• 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.

• Un account ngrok.

• La versione più recente di gcloud installata e inizializzata nel tuo ambiente locale.

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 progetto Google Cloud. Puoi seguire le sezioni Prerequisiti e Configurare l'ambiente della guida rapida.
• Il codice del componente aggiuntivo di Google Workspace da eseguire il debug nell'ambiente locale. In questa guida utilizziamo le funzionalità di link di anteprima dell'esempio di codice3p-resources del repository GitHub googleworkspace/add-ons-samples a scopo illustrativo.
• 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.
• 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 progetto Google Cloud. Puoi seguire le sezioni Prerequisiti e Configurare l'ambiente della guida rapida.
• Il codice del componente aggiuntivo di Google Workspace da eseguire il debug nell'ambiente locale. In questa guida utilizziamo le funzionalità di link di anteprima dell'esempio di codice 3p-resources del repository GitHub googleworkspace/add-ons-samples a scopo illustrativo.
• 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.
• Un account ngrok.
• La versione più recente di gcloud installata e inizializzata nel tuo ambiente locale.

Rendi disponibile pubblicamente il servizio localhost

Devi connettere il tuo ambiente locale a internet in modo che il componente aggiuntivo Google Workspace possa accedervi. L'applicazione ngrok viene utilizzata 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 authtoken nel tuo ambiente locale.
3. Crea un dominio statico nel tuo account ngrok, a cui viene fatto riferimento come NGROK_STATIC_DOMAIN nelle istruzioni di questa guida.

Crea e installa il deployment del componente aggiuntivo

1. Configura il componente aggiuntivo di Google Workspace in modo che invii tutte le richieste HTTP al tuo dominio statico. Il file di deployment deve avere il seguente aspetto:

   {
     "oauthScopes": [
       "https://www.googleapis.com/auth/workspace.linkpreview",
       "https://www.googleapis.com/auth/workspace.linkcreate"
     ],
     "addOns": {
       "common": {
         "name": "Manage support cases",
         "logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png",
         "layoutProperties": {
           "primaryColor": "#dd4b39"
         }
       },
       "docs": {
         "linkPreviewTriggers": [
           {
             "runFunction": "NGROK_STATIC_DOMAIN",
             "patterns": [
               {
                 "hostPattern": "example.com",
                 "pathPrefix": "support/cases"
               },
               {
                 "hostPattern": "*.example.com",
                 "pathPrefix": "cases"
               },
               {
                 "hostPattern": "cases.example.com"
               }
             ],
             "labelText": "Support case",
             "localizedLabelText": {
               "es": "Caso de soporte"
             },
             "logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
           }
         ],
         "createActionTriggers": [
           {
             "id": "createCase",
             "labelText": "Create support case",
             "localizedLabelText": {
               "es": "Crear caso de soporte"
             },
             "runFunction": "$URL2",
             "logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
           }
         ]
       }
     }
   }
   

   Sostituisci NGROK_STATIC_DOMAIN con il dominio statico nel tuo account ngrok.

2. Imposta il progetto Google Cloud da utilizzare:

   gcloud config set project PROJECT_ID

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

   gcloud auth application-default login

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

4. Crea il deployment:

   gcloud workspace-add-ons deployments create manageSupportCases \
       --deployment-file=DEPLOYMENT_FILE_PATH

   Sostituisci DEPLOYMENT_FILE_PATH con il percorso del file di deployment.

5. Installa il deployment:

   gcloud workspace-add-ons deployments install manageSupportCases

Figura 2. Il componente aggiuntivo di Google Workspace invia tutte le richieste HTTP al dominio statico. Il servizio pubblico ngrok funge da ponte tra il plug-in Google Workspace e il codice dell'applicazione che viene eseguito localmente.

Testare il componente aggiuntivo di Google Workspace

Puoi eseguire il deployment, testare, eseguire il debug e ricaricare automaticamente il componente aggiuntivo Google Workspace a livello locale.

Nota: il componente aggiuntivo di Google Workspace viene eseguito con il Framework Cloud Functions negli esempi.

Node.js

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

   1. In una nuova finestra, apri la cartellaadd-ons-samples/node/3p-resources.

   2. Configura l'applicazione per l'esecuzione locale e il debug del ricaricamento automatico aggiungendo una dipendenza e due script nel file package.json:

      {
          ...
          "dependencies": {
            ...
            "@google-cloud/functions-framework": "^3.3.0"
          },
          "scripts": {
              ...
              "start": "npx functions-framework --target=createLinkPreview --port=9000",
              "debug-watch": "nodemon --watch ./ --exec npm start"
          }
          ...
      }
      

   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.

2. 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.

3. 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.

4. Testa il tuo componente aggiuntivo Google Workspace visualizzando l'anteprima dell'URL di una richiesta in un nuovo Documento Google con un account tester:

   • Crea un nuovo documento Google.

     Creare un nuovo documento Google

   • Digita il seguente link e premi enter:

     https://example.com/support/case/?name=Name1&description=Description1&priority=P1
     

   • Fai clic sul link.

5. 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.

6. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che i componenti aggiuntivi di Google Workspace scadano, il componente aggiuntivo di Google Workspace visualizza l'anteprima del link nel documento Google dalla cache.

7. 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.

8. Per modificare il comportamento dell'applicazione, sostituisci Case con Case: in linea 51 del index.js. 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.

9. Questa volta, invece di fare clic sul link e attendere qualche secondo in un nuovo documento Google, 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, il tuo componente aggiuntivo Google Workspace non risponde perché è in corso il debug.

10. 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 della scheda di anteprima.

Python

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

   1. In una nuova finestra, apri la cartellaadd-ons-samples/python/3p-resources/create_link_preview.

   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", "create_link_preview",
                  "--port", "9000",
                  "--debug"
              ]
          }]
      }
      

   5. Aggiungi un punto di interruzione che mette in pausa l'elaborazione della richiesta HTTP nel file main.py 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.

2. 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.

3. 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.

4. Testa il tuo componente aggiuntivo Google Workspace visualizzando l'anteprima dell'URL di una richiesta in un nuovo Documento Google con un account tester:

   • Crea un nuovo documento Google.

     Creare un nuovo documento Google

   • Digita il seguente link e premi enter:

     https://example.com/support/case/?name=Name1&description=Description1&priority=P1
     

   • Fai clic sul link.

5. 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.

6. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che i componenti aggiuntivi di Google Workspace scadano, il componente aggiuntivo di Google Workspace visualizza l'anteprima del link nel documento Google dalla cache.

7. 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.

8. Per modificare il comportamento dell'applicazione, sostituisci Case con Case: in linea 56 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.

9. Questa volta, invece di fare clic sul link e attendere qualche secondo in un nuovo documento Google, 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, il tuo componente aggiuntivo Google Workspace non risponde perché è in corso il debug.

10. 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 della scheda di anteprima.

Java

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

   1. In una nuova finestra, apri la cartellaadd-ons-samples/java/3p-resources.

   2. Configura il progetto Maven per eseguire l'applicazioneCreateLinkPreview sulla porta 9000 localmente aggiungendo il plug-in di compilazione del framework Cloud Functions function-maven-plugin nel filepom.xml:

      ...
      <plugin>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>function-maven-plugin</artifactId>
          <version>0.11.0</version>
          <configuration>
              <functionTarget>CreateLinkPreview</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 CreateLinkPreview.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.

2. 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.

3. 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.

4. Testa il tuo componente aggiuntivo Google Workspace visualizzando l'anteprima dell'URL di una richiesta in un nuovo Documento Google con un account tester:

   • Crea un nuovo documento Google.

     Creare un nuovo documento Google

   • Digita il seguente link e premi enter:

     https://example.com/support/case/?name=Name1&description=Description1&priority=P1
     

   • Fai clic sul link.

5. 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.

6. Quando riprendi l'esecuzione dal debugger di Visual Studio Code prima che i componenti aggiuntivi di Google Workspace scadano, il componente aggiuntivo di Google Workspace visualizza l'anteprima del link nel documento Google dalla cache.

7. 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.

8. Per modificare il comportamento dell'applicazione, sostituisci Case con Case: in linea 78 del file CreateLinkPreview.java, riavvia il processo mvnDebug e riavvia Remote Debug Watch per riattaccare e riavviare il debug.

9. Questa volta, invece di fare clic sul link e attendere qualche secondo in un nuovo documento Google, 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, il tuo componente aggiuntivo Google Workspace non risponde perché è in corso il debug.

10. 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 della scheda di anteprima.

Eseguire il debug dall'ambiente remoto

In questa sezione interagisci con il componente aggiuntivo di Google Workspace che viene eseguito in un ambiente remoto.

Figura 9. Esegui il debug dall'ambiente remoto.

Prerequisiti

• Il componente aggiuntivo di Google Workspace è stato implementato e installato.
• L'applicazione in esecuzione nell'ambiente remoto con il debugger attivato su una determinata porta è indicata come REMOTE_DEBUG_PORT nelle istruzioni di questa guida.
• Il tuo ambiente locale può ssh al tuo ambiente remoto.
• 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.

Connetti gli ambienti locali e remoti

Nell'ambiente locale da cui vuoi avviare una connessione del client di debug, configura 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 nell'ambiente locale.
• REMOTE_USERNAME: il nome utente nell'ambiente remoto.
• REMOTE_ADDRESS: l'indirizzo del tuo ambiente remoto.
• REMOTE_DEBUG_PORT: la porta di debug nell'ambiente remoto.

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

Avvia debug

Nell'IDE Visual Studio Code installato nel tuo ambiente locale, svolgi quanto segue:

1. In una nuova finestra, apri il codice sorgente dell'app.

2. Crea il file .vscode/launch.json nella directory principale e configura un lancio denominato Debug Remote che si connette alla porta di debug nel tuo ambiente locale:

   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 nel tuo ambiente locale.

3. Aggiungi un punto di interruzione nel codice sorgente dell'app che metta in pausa l'elaborazione della richiesta HTTP e avvia l'esecuzione e il debugging con la configurazione Debug Remote aggiunta in precedenza.

Interagire con il componente aggiuntivo di Google Workspace installato. Il componente aggiuntivo Google Workspace non risponde perché è in corso il suo debug nell'IDE Visual Studio Code.

Argomenti correlati

Scopri come eseguire query sui log degli errori.