對 HTTP Google Workspace 外掛程式進行測試及偵錯

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。

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. 建立並設定名為 Debug Watch 的啟動程序，方法是在根目錄中建立 .vscode/launch.json 檔案，藉此觸發 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 要求。

      

2. 在本機環境中啟動 ngrok 應用程式：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   將 NGROK_STATIC_DOMAIN 替換為 ngrok 帳戶中的靜態網域。所有要求現在都會重新導向至本機環境和應用程式使用的通訊埠。

   

3. 應用程式也會在 localhost 上啟動網頁介面。ngrok您可以在瀏覽器中開啟這份報表，監控所有活動。

   

4. 使用測試人員帳戶在新的 Google 文件中預覽案件網址，測試 Google Workspace 外掛程式：

   • 建立 Google 文件。

     建立 Google 文件

   • 輸入下列連結，然後按下 enter 鍵：

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

   • 並按一下連結。

5. 在您本機環境的 Visual Studio Code 中，您會看到執行作業在設定的中斷點暫停。

   

6. 如果在 Google Workspace 外掛程式逾時前，從 Visual Studio Code 偵錯工具繼續執行作業，Google Workspace 外掛程式會從快取在 Google 文件中顯示連結預覽。

7. 您可以透過本機環境中 ngrok 應用程式代管的網頁介面，查看 HTTP 要求和回應記錄。

   

8. 如要變更應用程式行為，請在 index.js 的第 51 行將 Case 替換為 Case:。儲存檔案時，nodemon 會自動重新載入應用程式，並使用更新後的原始碼，Visual Studio Code 則會維持偵錯模式。

   

9. 這次，您不必點選連結並在新 Google 文件中等待幾秒，而是可以選取本機環境中由 ngrok 應用程式代管的網頁介面上記錄的最後一個 HTTP 要求，然後點選 Replay。與上次相同，由於 Google Workspace 外掛程式正在偵錯，因此不會回覆。

10. 從 Visual Studio Code 偵錯工具繼續執行時，您可以在本機環境中由 ngrok 應用程式代管的網頁介面中看到，應用程式會使用更新後的預覽資訊卡版本產生回應。

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 中，以偵錯模式從 functions-framework 模組觸發應用程式，並使用 9000 埠：

      {
          "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 要求。

      

2. 在本機環境中啟動 ngrok 應用程式：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   將 NGROK_STATIC_DOMAIN 替換為 ngrok 帳戶中的靜態網域。所有要求現在都會重新導向至本機環境和應用程式使用的通訊埠。

   

3. 應用程式也會在 localhost 上啟動網頁介面。ngrok在瀏覽器中開啟活動記錄，即可監控所有活動。

   

4. 使用測試人員帳戶在新的 Google 文件中預覽案件網址，測試 Google Workspace 外掛程式：

   • 建立 Google 文件。

     建立 Google 文件

   • 輸入下列連結，然後按下 enter 鍵：

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

   • 並按一下連結。

5. 在您本機環境的 Visual Studio Code 中，您會看到執行作業在設定的中斷點暫停。

   

6. 如果在 Google Workspace 外掛程式逾時前，從 Visual Studio Code 偵錯工具繼續執行作業，Google Workspace 外掛程式會從快取在 Google 文件中顯示連結預覽。

7. 您可以透過本機環境中 ngrok 應用程式代管的網頁介面，查看 HTTP 要求和回應記錄。

   

8. 如要變更應用程式行為，請在 main.py 檔案的第 56 行中，將 Case 替換為 Case:。儲存檔案時，Visual Studio Code 會自動重新載入應用程式，並使用更新後的原始碼，同時維持偵錯模式。

   

9. 這次，您不必點選連結並在新 Google 文件中等待幾秒，而是可以選取本機環境中由 ngrok 應用程式代管的網頁介面上記錄的最後一個 HTTP 要求，然後點選 Replay。與上次相同，由於 Google Workspace 外掛程式正在偵錯，因此不會回覆。

10. 從 Visual Studio Code 偵錯工具繼續執行時，您可以在本機環境中由 ngrok 應用程式代管的網頁介面中看到，應用程式會使用更新後的預覽資訊卡版本產生回應。

Java

1. 在您本機環境中安裝的 Visual Studio Code IDE 中，執行下列操作：

   1. 在新視窗中開啟資料夾 add-ons-samples/java/3p-resources。

   2. 設定 Maven 專案，在本機上透過 9000 埠執行 CreateLinkPreview 應用程式，方法是在 pom.xml 檔案中新增 Cloud Functions Framework 建構外掛程式 function-maven-plugin：

      ...
      <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 要求。

      

2. 在本機環境中啟動 ngrok 應用程式：

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   將 NGROK_STATIC_DOMAIN 替換為 ngrok 帳戶中的靜態網域。所有要求現在都會重新導向至本機環境和應用程式使用的通訊埠。

   

3. 應用程式也會在 localhost 上啟動網頁介面。ngrok在瀏覽器中開啟活動記錄，即可監控所有活動。

   

4. 使用測試人員帳戶在新的 Google 文件中預覽案件網址，測試 Google Workspace 外掛程式：

   • 建立 Google 文件。

     建立 Google 文件

   • 輸入下列連結，然後按下 enter 鍵：

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

   • 並按一下連結。

5. 在您本機環境的 Visual Studio Code 中，您會看到執行作業在設定的中斷點暫停。

   

6. 如果在 Google Workspace 外掛程式逾時前，從 Visual Studio Code 偵錯工具繼續執行作業，Google Workspace 外掛程式會從快取在 Google 文件中顯示連結預覽。

7. 您可以透過本機環境中 ngrok 應用程式代管的網頁介面，查看 HTTP 要求和回應記錄。

   

8. 如要變更應用程式行為，請在 CreateLinkPreview.java 檔案的第 78 行將 Case 替換為 Case:，重新啟動 mvnDebug 程序，然後重新啟動 Remote Debug Watch，重新附加並重新啟動偵錯。

9. 這次，您不必點選連結並在新 Google 文件中等待幾秒，而是可以選取本機環境中由 ngrok 應用程式代管的網頁介面上記錄的最後一個 HTTP 要求，然後點選 Replay。與上次相同，由於 Google Workspace 外掛程式正在偵錯，因此不會回覆。

10. 從 Visual Studio Code 偵錯工具繼續執行時，您可以在本機環境中由 ngrok 應用程式代管的網頁介面中看到，應用程式會使用更新後的預覽資訊卡版本產生回應。