测试和调试 HTTP Google Workspace 插件

作为 Google Workspace 插件开发者，您可能需要调试代码，以测试更改效果或排查复杂的问题。调试 Google Workspace 插件可以通过多种不同的方式完成，具体取决于您应用的架构、用途、部署方式以及您自己的偏好。

本页介绍了如何使用 ngrok 调试 HTTP Google Workspace 插件。ngrok 是一个统一的入站平台，可用于测试本地开发环境。在本指南中，您将在本地环境中测试代码更改，并排查远程环境中的问题。

通过本地开发环境进行调试

在本部分中，您将与在本地环境中执行的 Google Workspace 插件进行互动。

图 1. 在本地开发环境中调试。

前提条件

Node.js

• 在本地环境中安装的最新版 node 和 npm。

• 在本地环境中安装的最新版 nodemon，用于自动重新加载：

  npm install -g nodemon

• Google Cloud 项目。您可以按照快速入门指南的前提条件和设置环境部分中的说明操作。

• 要在本地环境中调试的 Google Workspace 插件代码。在本指南中，我们使用了 GitHub 代码库 googleworkspace/add-ons-samples 中的代码示例 3p-resources 中的预览链接功能，以作说明之用。

• 在本地环境中设置的可以调试的 IDE。在本指南中，我们使用 Visual Studio Code IDE 及其默认的调试功能来进行说明。

• ngrok 账号。

• 在本地环境中安装并初始化了最新版本的 gcloud。

Python

• 在本地环境中安装了最新版本的 python3。
• 在本地环境中安装的最新版本 pip 和 virtualenv，它们分别用于管理 Python 软件包和虚拟环境。
• Google Cloud 项目。您可以按照快速入门指南的前提条件和设置环境部分中的说明操作。
• 要在本地环境中调试的 Google Workspace 插件代码。在本指南中，我们使用了 GitHub 代码库 googleworkspace/add-ons-samples 中的代码示例 3p-resources 中的预览链接功能，以作说明之用。
• 在本地环境中设置的可以调试的 IDE。在本指南中，我们使用 Visual Studio Code IDE 及其默认的调试功能来进行说明。
• ngrok 账号。
• 在本地环境中安装并初始化了最新版本的 gcloud。

Java

• 在本地环境中安装的最新稳定版 Java SE 11's JDK。
• 在本地环境中安装的最新版本 Apache Maven，用于管理 Java 项目。
• Google Cloud 项目。您可以按照快速入门指南的前提条件和设置环境部分中的说明操作。
• 要在本地环境中调试的 Google Workspace 插件代码。在本指南中，我们使用 GitHub 代码库 googleworkspace/add-ons-samples 中的代码示例 3p-resources 中的预览链接功能来进行说明。
• 在本地环境中设置的可以调试的 IDE。在本指南中，我们使用 Visual Studio Code IDE 及其默认的调试功能来进行说明。
• ngrok 账号。
• 在本地环境中安装并初始化了最新版本的 gcloud。

公开 localhost 服务

您需要将本地环境连接到互联网，以便 Google Workspace 插件可以访问该环境。ngrok 应用用于将发送到公共网址的 HTTP 请求重定向到您的本地环境。

1. 在本地环境的浏览器中，登录您的 ngrok 账号。
2. 在本地环境中安装应用并设置 authtoken。
3. 在 ngrok 账号中创建一个静态网域，本指南中的说明中将其称为 NGROK_STATIC_DOMAIN。

创建和安装插件部署

1. 配置 Google Workspace 插件，将其所有 HTTP 请求发送到您的静态网域。您的部署文件应如下所示：

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

   将 NGROK_STATIC_DOMAIN 替换为 ngrok 账号中的静态网域。

2. 设置要使用的 Google Cloud 项目：

   gcloud config set project PROJECT_ID

3. 获取用于应用默认凭据的新用户凭据：

   gcloud auth application-default login

   将 PROJECT_ID 替换为应用的 Google Cloud 项目的 项目 ID。

4. 创建部署：

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

   将 DEPLOYMENT_FILE_PATH 替换为部署文件的路径。

5. 安装部署：

   gcloud workspace-add-ons deployments install manageSupportCases

图 2. Google Workspace 插件会将其所有 HTTP 请求发送到静态网域。ngrok 公共服务充当 Google Workspace 插件与本地执行的应用代码之间的桥梁。

测试 Google Workspace 插件

您可以在本地部署、测试、调试和自动重新加载 Google Workspace 加载项。

注意 ：示例中的 Google Workspace 插件是使用 Cloud Functions 框架执行的。

Node.js

1. 在本地环境中安装的 Visual Studio Code IDE 中，执行以下操作：

   1. 在新窗口中，打开文件夹 add-ons-samples/node/3p-resources。

   2. 在 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. 在根目录中，安装应用：

      npm install

   4. 在根目录中创建 .vscode/launch.json 文件，以创建和配置名为 Debug Watch 的启动，该启动会触发脚本 debug-watch：

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

   5. 添加一个断点，用于暂停 index.js 文件中的 HTTP 请求处理，并使用之前添加的 Debug Watch 配置开始运行和调试。该应用现在正在运行，并在端口 9000 上监听 HTTP 请求。

      

      图 3. 应用正在运行，并监听端口 9000 上的 HTTP 请求。

2. 在本地环境中启动 ngrok 应用：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   将 NGROK_STATIC_DOMAIN 替换为 ngrok 账号中的静态网域。现在，所有请求都会重定向到您的本地环境和应用使用的端口。

   

   图 4. 运行并重定向 ngrok 服务器的终端。

3. ngrok 应用还会在您的 localhost 上启动一个 Web 界面，您可以在浏览器中打开该界面以监控所有活动。

   

   图 5. ngrok 应用托管的 Web 界面，其中未显示任何 HTTP 请求。

4. 使用测试人员账号在新的 Google 文档中预览支持请求网址，以测试您的 Google Workspace 插件：

   • 创建新的 Google 文档。

     新建 Google 文档

   • 输入以下链接，然后按 enter：

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

   • 点击该链接。

5. 在本地环境的 Visual Studio Code 中，您可以看到执行在设置的断点处暂停。

   

   图 6. 执行会在设置的断点处暂停。

6. 如果您在 Google Workspace 插件超时之前从 Visual Studio Code 的调试程序恢复执行，Google Workspace 插件会从缓存中在 Google 文档中显示链接预览。

7. 您可以在本地环境中通过 ngrok 应用托管的 Web 界面查看 HTTP 请求和响应日志。

   

   图 7. 来自 ngrok 应用托管的 Web 界面的 HTTP 请求。

8. 如需更改应用行为，请将 index.js 的 51 内嵌 Case 替换为 Case:。保存文件后，nodemon 会自动使用更新后的源代码重新加载应用，而 Visual Studio Code 会保持调试模式。

   

   图 8. 应用正在运行，并在端口 9000 上监听 HTTP 请求，同时加载了代码更改。

9. 这次，您不必点击链接并在新建的 Google 文档中等待几秒钟，而是可以选择本地环境中由 ngrok 应用托管的 Web 界面上记录的最后一个 HTTP 请求，然后点击 Replay。与上次一样，您的 Google Workspace 插件没有回复，因为它正在积极调试中。

10. 从 Visual Studio Code 的调试程序恢复执行后，您可以从本地环境中由 ngrok 应用托管的 Web 界面中看到，该应用会生成包含更新版预览卡片的响应。

Python

1. 在本地环境中安装的 Visual Studio Code IDE 中，执行以下操作：

   1. 在新窗口中，打开文件夹 add-ons-samples/python/3p-resources/create_link_preview。

   2. 为 Python env 创建一个新的虚拟环境并将其激活：

      virtualenv env
      source env/bin/activate

   3. 在虚拟环境中使用 pip 安装所有项目依赖项：

      pip install -r requirements.txt

   4. 在根目录中创建 .vscode/launch.json 文件，并配置一个名为 Debug Watch 的启动，以便在虚拟环境 env 上通过调试模式在端口 9000 上的模块 functions-framework 触发应用：

      {
          "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. 添加一个断点，用于暂停 main.py 文件中的 HTTP 请求处理，并使用之前添加的 Debug Watch 配置开始运行和调试。该应用现在正在运行，并在端口 9000 上监听 HTTP 请求。

      

      图 3. 应用正在运行，并监听端口 9000 上的 HTTP 请求。

2. 在本地环境中启动 ngrok 应用：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   将 NGROK_STATIC_DOMAIN 替换为 ngrok 账号中的静态网域。现在，所有请求都会重定向到您的本地环境和应用使用的端口。

   

   图 4. 运行并重定向 ngrok 服务器的终端。

3. ngrok 应用还会在您的 localhost 上启动一个 Web 界面，您可以在浏览器中打开该界面以监控所有活动。

   

   图 5. ngrok 应用托管的 Web 界面，其中未显示任何 HTTP 请求。

4. 使用测试人员账号在新的 Google 文档中预览支持请求网址，以测试您的 Google Workspace 插件：

   • 创建新的 Google 文档。

     新建 Google 文档

   • 输入以下链接，然后按 enter：

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

   • 点击该链接。

5. 在本地环境的 Visual Studio Code 中，您可以看到执行在设置的断点处暂停。

   

   图 6. 执行会在设置的断点处暂停。

6. 如果您在 Google Workspace 插件超时之前从 Visual Studio Code 的调试程序恢复执行，Google Workspace 插件会从缓存中在 Google 文档中显示链接预览。

7. 您可以在本地环境中通过 ngrok 应用托管的 Web 界面查看 HTTP 请求和响应日志。

   

   图 7. 来自 ngrok 应用托管的 Web 界面的 HTTP 请求。

8. 如需更改应用行为，请将 main.py 文件中的 Case 替换为 Case: 内嵌 56。保存文件后，Visual Studio Code 会自动使用更新后的源代码重新加载应用，并保持调试模式。

   

   图 8. 应用正在运行，并在端口 9000 上监听 HTTP 请求，同时加载了代码更改。

9. 这次，您不必点击链接并在新建的 Google 文档中等待几秒钟，而是可以选择本地环境中由 ngrok 应用托管的 Web 界面上记录的最后一个 HTTP 请求，然后点击 Replay。与上次一样，您的 Google Workspace 插件没有回复，因为它正在积极调试中。

10. 从 Visual Studio Code 的调试程序恢复执行后，您可以从本地环境中由 ngrok 应用托管的 Web 界面中看到，该应用会生成包含更新版预览卡片的响应。

Java

1. 在本地环境中安装的 Visual Studio Code IDE 中，执行以下操作：

   1. 在新窗口中，打开文件夹 add-ons-samples/java/3p-resources。

   2. 在 pom.xml 文件中添加 Cloud Functions 框架构建插件 function-maven-plugin，以便配置 Maven 项目在本地端口 9000 上运行应用 CreateLinkPreview：

      ...
      <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. 现在，您可以在本地调试模式下启动它：

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

   4. 在根目录中创建文件 .vscode/launch.json，并配置一个名为 Remote Debug Watch 的启动，将其附加到之前使用端口 8000 启动的应用：

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

   5. 添加一个断点，用于暂停 CreateLinkPreview.java 文件中的 HTTP 请求处理，并使用之前添加的 Remote Debug Watch 配置开始附加和调试。现在，该应用正在运行并监听端口 9000 上的 HTTP 请求。

      

      图 3：应用正在运行并监听端口 9000 上的 HTTP 请求。

2. 在本地环境中启动 ngrok 应用：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   将 NGROK_STATIC_DOMAIN 替换为 ngrok 账号中的静态网域。现在，所有请求都会重定向到您的本地环境和应用使用的端口。

   

   图 4. 运行并重定向 ngrok 服务器的终端。

3. ngrok 应用还会在您的 localhost 上启动一个 Web 界面，您可以在浏览器中打开该界面以监控所有活动。

   

   图 5. ngrok 应用托管的 Web 界面，其中未显示任何 HTTP 请求。

4. 使用测试人员账号在新的 Google 文档中预览支持请求网址，以测试您的 Google Workspace 插件：

   • 创建新的 Google 文档。

     新建 Google 文档

   • 输入以下链接，然后按 enter：

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

   • 点击该链接。

5. 在本地环境的 Visual Studio Code 中，您可以看到执行在设置的断点处暂停。

   

   图 6. 执行会在设置的断点处暂停。

6. 如果您在 Google Workspace 插件超时之前从 Visual Studio Code 的调试程序恢复执行，Google Workspace 插件会从缓存中在 Google 文档中显示链接预览。

7. 您可以在本地环境中通过 ngrok 应用托管的 Web 界面查看 HTTP 请求和响应日志。

   

   图 7. 来自 ngrok 应用托管的 Web 界面的 HTTP 请求。

8. 如需更改应用行为，请将 CreateLinkPreview.java 文件的 78 内嵌 Case 替换为 Case:，重启 mvnDebug 进程，然后重新启动 Remote Debug Watch 以重新附加并重新开始调试。

9. 这次，您不必点击链接并在新建的 Google 文档中等待几秒钟，而是可以选择本地环境中由 ngrok 应用托管的 Web 界面上记录的最后一个 HTTP 请求，然后点击 Replay。与上次一样，您的 Google Workspace 插件没有回复，因为它正在积极调试中。

10. 从 Visual Studio Code 的调试程序恢复执行后，您可以从本地环境中由 ngrok 应用托管的 Web 界面中看到，该应用会生成包含更新版预览卡片的响应。

从远程环境调试

在本部分中，您将与在远程环境中执行的 Google Workspace 插件进行互动。

图 9. 从远程环境进行调试。

前提条件

• 您的 Google Workspace 插件已部署和安装。
• 在远程环境中运行的应用，在给定端口上启用了调试程序，在本指南的说明中被称为 REMOTE_DEBUG_PORT。
• 您的本地环境可以 ssh 到远程环境。
• 在本地环境中设置的可以调试的 IDE。在本指南中，我们使用 Visual Studio Code IDE 及其默认的调试功能来进行说明。

连接本地环境和远程环境

在您要从中发起调试客户端连接的本地环境中，设置 SSH 隧道：

ssh -L LOCAL_DEBUG_PORT:localhost:REMOTE_DEBUG_PORT REMOTE_USERNAME@REMOTE_ADDRESS

替换以下内容：

• LOCAL_DEBUG_PORT：本地环境中的调试端口。
• REMOTE_USERNAME：远程环境中的用户名。
• REMOTE_ADDRESS：远程环境的地址。
• REMOTE_DEBUG_PORT：远程环境中的调试端口。

本地环境中的调试端口现在已与远程环境中的调试端口相关联。

开始调试

在本地环境中安装的 Visual Studio Code IDE 中，执行以下操作：

1. 在新窗口中，打开应用的源代码。

2. 在根目录中创建 .vscode/launch.json 文件，并配置一个名为 Debug Remote 的启动，将其附加到本地环境中的调试端口：

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

   将 LOCAL_DEBUG_PORT 替换为本地环境中的调试端口。

3. 在应用的源代码中添加一个用于暂停 HTTP 请求处理的断点，然后使用之前添加的 Debug Remote 配置开始运行和调试。

与已安装的 Google Workspace 插件互动。您的 Google Workspace 插件没有回复，因为它正在 Visual Studio Code IDE 中进行调试。

相关主题

了解如何查询错误日志。