Cómo depurar apps de Google Chat

Como desarrollador de apps de Google Chat, es posible que debas depurar código para probar cambios o solucionar problemas complejos. Cómo depurar apps de Chat se puede hacer de muchas maneras diferentes según la arquitectura de tu app, hace la app, cómo se implementa y tus preferencias.

En esta página, se explica cómo depurar una app de chat HTTP con ngrok, una plataforma de entrada unificada que puedes usar para probar entornos de desarrollo de aplicaciones. En esta guía, probarás cambios de código en una instancia y solucionar problemas en un entorno remoto.

Cómo depurar desde un entorno de desarrollo local

En esta sección, interactuarás con la app de Chat que que se ejecuta en tu entorno local.

Cómo depurar desde el desarrollo local
medio ambiente

Figura 1: Depura en un entorno de desarrollo local.

Taller

Node.js

Python

Java

Requisitos previos

Node.js

Python

Java

Haz que el servicio localhost esté disponible de forma pública

Debes conectar tu entorno local a Internet para que el la app de Chat podrá acceder a ella. Se usa la aplicación ngrok para redireccionar las solicitudes HTTP realizadas a una URL pública a tu entorno local.

  1. En un navegador de tu entorno local, accede a tu cuenta de ngrok.
  2. Instala la aplicación y configura tu authtoken en tu entorno local entorno.
  3. Crea un dominio estático en tu ngrok cuenta, se hace referencia a ella como NGROK_STATIC_DOMAIN en las instrucciones de esta guía.

Configura la app de Chat

Configura la app de Chat para que envíe todas sus solicitudes HTTP a tu dominio estático.

  1. En la consola de Google Cloud, abre la página de la API de Google Chat:

    Ir a la página de la API de Google Chat

  2. Haz clic en la pestaña Configuración.

  3. Ve a Funciones interactivas > Configuración de la conexión y establece el valor del campo de texto URL de la aplicación de la siguiente manera:

    https://NGROK_STATIC_DOMAIN
    

    Reemplaza NGROK_STATIC_DOMAIN por el dominio estático en tu cuenta de ngrok.

  4. Haz clic en Guardar.

La app de Chat envía todas sus solicitudes HTTP al
dominio estático

Figura 2: La app de Chat envía todas sus solicitudes HTTP al dominio estático. El servicio público de ngrok actúa como un puente entre los App de Chat y el código de la aplicación que se ejecuta de forma local.

Prueba la app de Chat

De forma local, puedes implementar, configurar, probar, depurar y volver a cargar automáticamente tus App de Chat

Node.js

  1. Clona el repositorio googleworkspace/google-chat-samples desde GitHub a tu entorno local, contiene el código de la aplicación que se ejecutar:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  2. Desde el IDE de Visual Studio Code instalado en tu entorno local, haz lo siguiente: haz lo siguiente:

    1. En una ventana nueva, abre la carpeta. google-chat-samples/node/basic-app
    2. Configura la aplicación para la depuración de recarga automática agregando dos secuencias de comandos en el archivo package.json:

      {
          ...
          "scripts": {
              ...
              "debug": "node --inspect index.js",
              "debug-watch": "nodemon --watch ./ --exec npm run debug"
          }
          ...
      }
      
    3. Desde el directorio raíz, instala la aplicación:

      npm install
      
    4. Crea y configura un lanzamiento llamado Debug Watch que active la función de secuencia de comandos debug-watch creando el archivo .vscode/launch.json en directorio raíz:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "node",
              "request": "launch",
              "name": "Debug Watch",
              "cwd": "${workspaceRoot}",
              "runtimeExecutable": "npm",
              "runtimeArgs": ["run-script", "debug-watch"]
          }]
      }
      
    5. Agrega un punto de interrupción que detenga el procesamiento de solicitudes HTTP en la index.js y comenzar a ejecutar y la depuración con el Se agregó la configuración de Debug Watch antes. Ahora la aplicación ejecuta y escucha solicitudes HTTP en el puerto 9000.

      La aplicación se ejecuta y escucha solicitudes HTTP en el
puerto “9000”

      Figura 3: La aplicación se ejecuta y escucha HTTP de estado en el puerto 9000.

  3. Inicia la aplicación ngrok en tu entorno local:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Reemplaza NGROK_STATIC_DOMAIN por el dominio estático en tu cuenta de ngrok. Todas las solicitudes se redireccionarán a la instancia y el puerto que usa la aplicación.

    La terminal con el servidor “ngrok” en ejecución y
redireccionamiento

    Figura 4: La terminal con el servidor ngrok en ejecución y redireccionando.

  4. ngrok también inicia una interfaz web en tu localhost. puedes supervisar todas las actividades abriéndola en un navegador.

    La interfaz web alojada por la aplicación “ngrok” sin HTTP
solicitudes

    Figura 5: La interfaz web que aloja la aplicación ngrok que no muestra solicitudes HTTP.

  5. Para probar tu app de Chat, envíale un mensaje mensaje:

    • Abre Google Chat.

      Ir a Google Chat

    • Haz clic en New chat .

    • En el cuadro de diálogo, ingresa el nombre de tu App de Chat

    • En los resultados de la búsqueda, busca tu app de Chat Haz clic en Agregar >. Chat.

    • En el espacio del mensaje directo, escribe Hello y presiona enter. Tu La app de Chat no responde porque se está depurados activamente.

  6. En el Visual Studio Code de tu entorno local, puedes ver que se pausó la ejecución en el punto de interrupción que se estableció.

    La ejecución se pausó en el punto de interrupción que se
establecer

    Figura 6: Se pausó la ejecución en el punto de interrupción que se estableció.

  7. Cuando reanudas la ejecución desde el depurador de Visual Studio Code antes de que Google Chat agote el tiempo de espera de la app de Chat respuestas Your message : Hello.

  8. Puedes verificar los registros de solicitud y respuesta HTTP desde la interfaz web alojada por la aplicación ngrok en tu entorno local.

    La solicitud HTTP de la interfaz web alojada por “ngrok”
aplicación

    Figura 7: La solicitud HTTP de la interfaz web alojada por el ngrok.

  9. Para cambiar el comportamiento de la aplicación, reemplaza Your message por Here was your message intercalado 35 de index.json. Al guardar el archivo, nodemon vuelve a cargar automáticamente la aplicación con el el código fuente actualizado y Visual Studio Code permanecen en modo de depuración.

    La aplicación se ejecuta y escucha solicitudes HTTP en el puerto.
“9000” con el cambio de código
cargado

    Figura 8: La aplicación se ejecuta y detecta solicitudes HTTP. en el puerto 9000 con el cambio de código cargado

  10. Esta vez, en lugar de enviar un segundo mensaje Hello en el espacio, solo puede seleccionar la última solicitud HTTP registrada en la interfaz web alojada por la aplicación ngrok en tu entorno local y haz clic en Replay. Al igual que la última vez, la app de Chat no responde porque se están depurando activamente.

  11. Cuando reanudas la ejecución desde el depurador de Visual Studio Code Desde la interfaz web que aloja la aplicación ngrok en tu entorno local con el que la aplicación genera una respuesta la versión actualizada del mensaje Here was your message : Hello

Python

  1. Adquiere nuevas credenciales de usuario para utilizarlas en Configuración predeterminada de la aplicación Credenciales:

    gcloud config set project PROJECT_ID
    gcloud auth application-default login
    

    Reemplaza PROJECT_ID por el ID del proyecto para el proyecto de Cloud de la app.

  2. Clona el repositorio googleworkspace/google-chat-samples desde GitHub a tu entorno local, contiene el siguiente código de la aplicación:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  3. Desde el IDE de Visual Studio Code instalado en tu entorno local, haz lo siguiente: haz lo siguiente:

    1. En una ventana nueva, abre la carpeta. google-chat-samples/python/avatar-app
    2. Crea un entorno virtual nuevo para env de Python y actívalo:

      virtualenv env
      source env/bin/activate
      
    3. Instala todas las dependencias del proyecto usando pip en el entorno:

      pip install -r requirements.txt
      
    4. Crea el archivo .vscode/launch.json en el directorio raíz. configurar un lanzamiento llamado Debug Watch que active la aplicación del módulo functions-framework en el puerto 9000, en modo de depuración en el entorno 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. Agrega un punto de interrupción que detenga el procesamiento de solicitudes HTTP en la main.py y comenzar a ejecutar y la depuración con el Se agregó la configuración de Debug Watch antes. Ahora la aplicación ejecuta y escucha solicitudes HTTP en el puerto 9000.

      La aplicación se ejecuta y escucha solicitudes HTTP en el
puerto “9000”

      Figura 3: La aplicación se ejecuta y escucha HTTP de estado en el puerto 9000.

  4. Inicia la aplicación ngrok en tu entorno local:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Reemplaza NGROK_STATIC_DOMAIN por el dominio estático en tu cuenta de ngrok. Todas las solicitudes se redireccionarán a la instancia y el puerto que usa la aplicación.

    La terminal con el servidor “ngrok” en ejecución y
redireccionamiento

    Figura 4: La terminal con el servidor ngrok en ejecución y redireccionando.

  5. ngrok también inicia una interfaz web en tu localhost. puedes supervisar todas las actividades abriéndola en un navegador.

    La interfaz web alojada por la aplicación “ngrok” sin HTTP
solicitudes

    Figura 5: La interfaz web que aloja la aplicación ngrok que no muestra solicitudes HTTP.

  6. Para probar tu app de Chat, envíale un mensaje mensaje:

    • Abre Google Chat.

      Ir a Google Chat

    • Haz clic en New chat .

    • En el cuadro de diálogo, ingresa el nombre de tu App de Chat

    • En los resultados de la búsqueda, busca tu app de Chat Haz clic en Agregar >. Chat.

    • En el espacio del mensaje directo, escribe Hey! y presiona enter. Tu La app de Chat no responde porque se está depurados activamente.

  7. En el Visual Studio Code de tu entorno local, puedes ver que se pausó la ejecución en el punto de interrupción que se estableció.

    La ejecución se pausó en el punto de interrupción que se
establecer

    Figura 6: Se pausó la ejecución en el punto de interrupción que se estableció.

  8. Cuando reanudas la ejecución desde el depurador de Visual Studio Code antes de que Google Chat agote el tiempo de espera de la app de Chat respuestas con tu nombre y foto de avatar en el mensaje.

  9. Puedes verificar los registros de solicitud y respuesta HTTP desde la interfaz web alojada por la aplicación ngrok en tu entorno local.

    La solicitud HTTP de la interfaz web alojada por “ngrok”
aplicación

    Figura 7: La solicitud HTTP de la interfaz web alojada por el ngrok.

  10. Para cambiar el comportamiento de la aplicación, reemplaza Hello por Hey intercalado. 51 del archivo main.py. Cuando guardes el archivo, Visual Studio Code vuelve a cargar automáticamente la aplicación con el código fuente actualizado y permanece en modo de depuración.

    La aplicación se ejecuta y escucha solicitudes HTTP en el puerto.
“9000” con el cambio de código
cargado

    Figura 8: La aplicación se ejecuta y detecta solicitudes HTTP. en el puerto 9000 con el cambio de código cargado

  11. Esta vez, en lugar de enviar un segundo mensaje Hey! en el espacio, solo puede seleccionar la última solicitud HTTP registrada en la interfaz web alojada por la aplicación ngrok en tu entorno local y haz clic en Replay. Al igual que la última vez, la app de Chat no responde porque se están depurando activamente.

  12. Cuando reanudas la ejecución desde el depurador de Visual Studio Code Desde la interfaz web que aloja la aplicación ngrok en tu entorno local con el que la aplicación genera una respuesta la versión actualizada del mensaje.

Java

  1. Adquiere nuevas credenciales de usuario para utilizarlas en Configuración predeterminada de la aplicación Credenciales:

    gcloud config set project PROJECT_ID
    gcloud auth application-default login
    

    Reemplaza PROJECT_ID por el ID del proyecto para el proyecto de Cloud de la app.

  2. Clona el repositorio googleworkspace/google-chat-samples desde GitHub en tu entorno local, contiene el siguiente código de la aplicación:

    git clone https://github.com/googleworkspace/google-chat-samples.git
    
  3. Desde el IDE de Visual Studio Code instalado en tu entorno local, haz lo siguiente: haz lo siguiente:

    1. En una ventana nueva, abre la carpeta. google-chat-samples/java/avatar-app
    2. Configura el proyecto de Maven para ejecutar la aplicación App en puerto 9000 de forma local agregando la compilación de Cloud Functions Framework el complemento function-maven-plugin en el archivo 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. Ahora puedes iniciarla de manera local en modo de depuración:

      mvnDebug function:run
      Preparing to execute Maven in debug mode
      Listening for transport dt_socket at address: 8000
      
    4. Crea el archivo .vscode/launch.json en el directorio raíz. configurar un lanzamiento llamado Remote Debug Watch que se conecte al aplicación iniciada anteriormente con el puerto 8000:

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "java",
              "request": "attach",
              "name": "Remote Debug Watch",
              "projectName": "http-function",
              "hostName": "localhost",
              "port": 8000
          }]
      }
      
    5. Agrega un punto de interrupción que detenga el procesamiento de solicitudes HTTP en la App.java y comenzar a adjuntar y la depuración con el Se agregó la configuración de Remote Debug Watch antes. La aplicación es que ahora se ejecutan y están a la escucha de solicitudes HTTP en el puerto 9000.

      La aplicación se ejecuta y escucha solicitudes HTTP en el
puerto “9000”

      Figura 3: La aplicación ejecuta y escucha HTTP de estado en el puerto 9000.

  4. Inicia la aplicación ngrok en tu entorno local:

    ngrok http --domain=NGROK_STATIC_DOMAIN 9000
    

    Reemplaza NGROK_STATIC_DOMAIN por el dominio estático en tu cuenta de ngrok. Todas las solicitudes se redireccionarán a la instancia y el puerto que usa la aplicación.

    La terminal con el servidor “ngrok” en ejecución y
redireccionamiento

    Figura 4: La terminal con el servidor ngrok en ejecución y redireccionando.

  5. ngrok también inicia una interfaz web en tu localhost. puedes supervisar todas las actividades abriéndola en un navegador.

    La interfaz web alojada por la aplicación “ngrok” sin HTTP
solicitudes

    Figura 5: La interfaz web que aloja la aplicación ngrok que no muestra solicitudes HTTP.

  6. Para probar tu app de Chat, envíale un mensaje mensaje:

    • Abre Google Chat.

      Ir a Google Chat

    • Haz clic en New chat .

    • En el cuadro de diálogo, ingresa el nombre de tu App de Chat

    • En los resultados de la búsqueda, busca tu app de Chat Haz clic en Agregar &gt;. Chat.

    • En el espacio del mensaje directo, escribe Hey! y presiona enter. Tu La app de Chat no responde porque se está depurados activamente.

  7. En el Visual Studio Code de tu entorno local, puedes ver que se pausó la ejecución en el punto de interrupción que se estableció.

    La ejecución se pausó en el punto de interrupción que se
establecer

    Figura 6: Se pausó la ejecución en el punto de interrupción que se estableció.

  8. Cuando reanudas la ejecución desde el depurador de Visual Studio Code antes de que Google Chat agote el tiempo de espera de la app de Chat respuestas con tu nombre y foto de avatar en el mensaje.

  9. Puedes verificar los registros de solicitud y respuesta HTTP desde la interfaz web alojada por la aplicación ngrok en tu entorno local.

    La solicitud HTTP de la interfaz web alojada por “ngrok”
aplicación

    Figura 7: La solicitud HTTP de la interfaz web alojada por el ngrok.

  10. Para cambiar el comportamiento de la aplicación, reemplaza Hello por Hey intercalado. 55 del archivo App.java, reinicia el proceso mvnDebug. reiniciar Remote Debug Watch para volver a conectarlo y reiniciarlo del contenedor.

  11. Esta vez, en lugar de enviar un segundo mensaje Hey! en el espacio, solo puede seleccionar la última solicitud HTTP registrada en la interfaz web alojada por la aplicación ngrok en tu entorno local y haz clic en Replay. Al igual que la última vez, la app de Chat no responde porque se están depurando activamente.

  12. Cuando reanudas la ejecución desde el depurador de Visual Studio Code Desde la interfaz web que aloja la aplicación ngrok en tu entorno local con el que la aplicación genera una respuesta la versión actualizada del mensaje.

Depurar desde un entorno remoto

En esta sección, interactuarás con la app de Chat que se ejecuta en un entorno remoto.

Depurar desde el dispositivo remoto
medio ambiente

Figura 9: Depurar desde un entorno remoto

Requisitos previos

  • Un espacio de mensaje directo con tu app de Chat Puedes sigue la sección Prueba tu app de Chat de la Guía de inicio rápido y busca tu de Google Chat para iniciar una.
  • Tu aplicación que se ejecuta en tu entorno remoto con el depurador habilitado en un puerto determinado, se denomina REMOTE_DEBUG_PORT en las instrucciones de esta guía.
  • Tu entorno local puede ssh a tu entorno remoto.
  • Un IDE configurado en tu entorno local que puede depurar. Usamos la Visual Studio Code IDE y su configuración predeterminada funciones de depuración de este con fines ilustrativos.

Conecta tus entornos locales y remotos

En tu entorno local desde el que quieres iniciar un cliente de depuración de red, configura un túnel SSH:

ssh -L LOCAL_DEBUG_PORT:localhost:REMOTE_DEBUG_PORT REMOTE_USERNAME@REMOTE_ADDRESS

Reemplaza lo siguiente:

  • LOCAL_DEBUG_PORT: Es el puerto de depuración en tu entorno local. en un entorno de nube.
  • REMOTE_USERNAME: Es el nombre de usuario en el entorno remoto.
  • REMOTE_ADDRESS: Es la dirección de tu entorno remoto.
  • REMOTE_DEBUG_PORT: Es el puerto de depuración del control remoto. en un entorno de nube.

El puerto de depuración en tu entorno local ahora está vinculado al puerto de depuración en tu en un entorno remoto.

Cómo iniciar la depuración

Desde el IDE de Visual Studio Code instalado en tu entorno local, haz lo siguiente: lo siguiente:

  1. En una ventana nueva, abre el código fuente de la app.
  2. Crea el archivo .vscode/launch.json en el directorio raíz y configura una Inicia con el nombre Debug Remote que se conecta al puerto de depuración en tu red local entorno:

    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
        }]
    }
    

    Reemplaza LOCAL_DEBUG_PORT por el puerto de depuración en tu entorno local.

  3. Agrega un punto de interrupción en el código fuente de tu app que detenga la solicitud HTTP. procesamiento y comenzar a ejecutar y depurando con la configuración Debug Remote que se agregó antes.

En el espacio de mensaje directo con tu app de Chat, escribe cualquier cosa que quieras probar y presiona enter. Tu La app de Chat no responde porque se está realizando depurado en el IDE de Visual Studio Code.