Google Chat アプリをデバッグする

Google Chat アプリのデベロッパーは、変更をテストしたり、複雑な問題のトラブルシューティングを行ったりするために、コードをデバッグする必要がある場合があります。Chat アプリのデバッグは、アプリのアーキテクチャ、アプリの機能、アプリのデプロイ方法、設定に応じて、さまざまな方法で行うことができます。

このページでは、ngrok を使用して HTTP Chat アプリをデバッグする方法について説明します。ngrok は、ローカル開発環境のテストに使用できる統合 Ingress プラットフォームです。このガイドでは、ローカル環境でコード変更をテストし、リモート環境で問題のトラブルシューティングを行います。

注: Chat 用アプリが Google Apps Script で作成されている場合は、代わりに以下を使用してください。

• デプロイをテストする
• デバッガとブレークポイントを使用する

ローカル開発環境からデバッグする

このセクションでは、ローカル環境で実行される Chat アプリを操作します。

図 1. ローカル開発環境でデバッグする。

ワークショップ

Node.js

Python

Java

前提条件

Node.js

• ローカル環境にインストールされている node と npm の最新バージョン。

• ローカル環境にインストールされている最新バージョンの nodemon。自動再読み込みに使用されます。

  npm install -g nodemon

• メッセージ用に構成された HTTP Chat アプリ。クイックスタート ガイドの前提条件、環境の設定、Google Chat にアプリを公開するのセクションに沿って操作します。唯一の違いは、アプリ名を Debug App に、HTTP エンドポイント URL を http://example.com などに設定する必要があることです。

• ローカル環境に設定され、デバッグが可能な IDE。このガイドでは、説明をわかりやすくするために、Visual Studio Code IDE とそのデフォルトのデバッグ機能を使用します。

• Git をローカル環境にインストールします。

• ngrok アカウント。

Python

• ローカル環境に最新バージョンの python3 がインストールされている。
• ローカル環境にインストールされている pip と virtualenv の最新バージョン。Python パッケージと仮想環境の管理に使用されます。
• メッセージング用に構成された HTTP Chat アプリ。クイックスタート ガイドの前提条件、環境の設定、Google Chat にアプリを公開するのセクションに沿って操作します。唯一の違いは、アプリ名を Debug App に、HTTP エンドポイント URL を http://example.com などに設定する必要があることです。
• ローカル環境に設定され、デバッグが可能な IDE。このガイドでは、説明をわかりやすくするために、Visual Studio Code IDE とそのデフォルトのデバッグ機能を使用します。
• ローカル環境に Git がインストールされている。
• ngrok アカウント。
• 最新バージョンの gcloud がローカル環境にインストールされ、初期化されている。

Java

• ローカル環境にインストールされている Java SE 11's JDK の最新の安定版。
• ローカル環境にインストールされている最新バージョンの Apache Maven。Java プロジェクトの管理に使用されます。
• メッセージ用に構成された HTTP Chat アプリ。クイックスタート ガイドの前提条件、環境を設定する、アプリを Google Chat に公開するの説明に従って操作します。唯一の違いは、アプリ名を Debug App に、HTTP エンドポイント URL を http://example.com などに設定する必要があることです。
• ローカル環境に設定され、デバッグが可能な IDE。このガイドでは、説明をわかりやすくするために Visual Studio Code IDE とそのデフォルトのデバッグ機能を使用します。
• ローカル環境に Git がインストールされている。
• ngrok アカウント。
• 最新バージョンの gcloud がローカル環境にインストールされ、初期化されている。

localhost サービスを一般公開する

Chat アプリがローカル環境にアクセスできるように、ローカル環境をインターネットに接続する必要があります。ngrok アプリケーションは、公開 URL に対して行われた HTTP リクエストをローカル環境にリダイレクトするために使用されます。

1. ローカル環境のブラウザで、ngrok アカウントにログインします。
2. アプリをインストールして、ローカル環境で authtoken を設定します。
3. ngrok アカウントで静的ドメインを作成します。このガイドの手順では NGROK_STATIC_DOMAIN と表記します。

Chat アプリを構成する

すべての HTTP リクエストを静的ドメインに送信するように Chat アプリを構成します。

1. Google Cloud コンソールで、Google Chat API ページを開きます。

   Google Chat API ページに移動

2. [構成] タブをクリックします。

3. [インタラクティブ機能] > [接続設定] に移動し、テキスト フィールド [HTTP エンドポイント URL] の値を次のように設定します。

   https://NGROK_STATIC_DOMAIN
   

   NGROK_STATIC_DOMAIN は、ngrok アカウントの静的ドメインに置き換えます。

4. [保存] をクリックします。

図 2. Chat アプリは、すべての HTTP リクエストを静的ドメインに送信します。ngrok パブリック サービスは、Chat アプリとローカルで実行されるアプリケーション コードの間のブリッジとして機能します。

Chat アプリをテストする

Chat アプリをローカルにデプロイ、構成、テスト、デバッグ、自動リロードできます。

注: Chat アプリは、Python と Java の例では Cloud Functions Framework で実行され、Node.js の例では Express Framework で実行されます。

Node.js

1. googleworkspace/google-chat-samples リポジトリのクローンを GitHub からローカル環境に作成します。このリポジトリには、実行するアプリケーションのコードが含まれています。

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

2. ローカル環境にインストールされている Visual Studio Code IDE で、次の操作を行います。

   1. 新しいウィンドウで、フォルダ google-chat-samples/node/basic-app を開きます。

   2. package.json ファイルに 2 つのスクリプトを追加して、自動再読み込みデバッグ用にアプリケーションを構成します。

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

   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 リクエストをリッスンしています。

3. ローカル環境で ngrok アプリケーションを起動します。

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   NGROK_STATIC_DOMAIN は、ngrok アカウントの静的ドメインに置き換えます。すべてのリクエストがローカル環境とアプリで使用されるポートにリダイレクトされるようになりました。

   

   図 4. ngrok サーバーが稼働してリダイレクトしているターミナル。

4. ngrok アプリケーションによって localhost でウェブ インターフェースも起動されます。ブラウザで開くと、すべてのアクティビティをモニタリングできます。

   

   図 5. ngrok アプリケーションがホストするウェブ インターフェース。HTTP リクエストは表示されていません。

5. ダイレクト メッセージを送信して Chat アプリをテストします。

   • Google Chat を開きます。

     Google Chat にアクセス

   • [新しいチャット] をクリックします。

   • ダイアログに Chat 用アプリの名前を入力します。

   • 検索結果で Chat アプリを見つけて、[追加] > [Chat] をクリックします。

   • ダイレクト メッセージのスペースに「Hello」と入力して enter を押します。チャット アプリがアクティブにデバッグされているため、返信しません。

6. ローカル環境の Visual Studio Code で、設定されたブレークポイントで実行が停止されていることがわかります。

   

   図 6. 実行は、設定されたブレークポイントで一時停止します。

7. Google Chat のタイムアウト前に Visual Studio Code のデバッガから実行を再開すると、Chat アプリは Your message : Hello を返します。

8. HTTP リクエストとレスポンスのログは、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースから確認できます。

   

   図 7. ngrok アプリケーションがホストするウェブ インターフェースからの HTTP リクエスト。

9. アプリケーションの動作を変更するには、Your message を index.json の Here was your message インライン 35 に置き換えます。ファイルを保存すると、nodemon は更新されたソースコードでアプリケーションを自動的に再読み込みし、Visual Studio Code はデバッグモードのままになります。

   

   図 8. アプリケーションが実行され、コード変更が読み込まれたポート 9000 で HTTP リクエストをリッスンしています。

10. 今回は、スペースに 2 つ目のメッセージ Hello を送信する代わりに、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースに記録された最後の HTTP リクエストを選択し、[Replay] をクリックします。前回と同様に、Chat アプリはデバッグ中であるため、返信しません。

11. Visual Studio Code のデバッガから実行を再開すると、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースから、アプリケーションが更新されたバージョンのメッセージ Here was your message : Hello を含むレスポンスを生成していることを確認できます。

Python

1. アプリケーションのデフォルト認証情報に使用する新しいユーザー認証情報を取得します。

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   PROJECT_ID は、アプリの Cloud プロジェクトのプロジェクト ID に置き換えます。

2. アプリケーション コードを含む googleworkspace/google-chat-samples リポジトリのクローンを GitHub からローカル環境に作成します。

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

3. ローカル環境にインストールされている Visual Studio Code IDE で、次の操作を行います。

   1. 新しいウィンドウで、フォルダ google-chat-samples/python/avatar-app を開きます。

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

   5. main.py ファイルに HTTP リクエストの処理を一時停止するブレークポイントを追加し、前に追加した Debug Watch 構成を使用して実行とデバッグを開始します。これで、アプリケーションが実行され、ポート 9000 で HTTP リクエストがリッスンされます。

      

      図 3. アプリケーションが実行され、ポート 9000 で HTTP リクエストをリッスンしています。

4. ローカル環境で ngrok アプリケーションを起動します。

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   NGROK_STATIC_DOMAIN は、ngrok アカウントの静的ドメインに置き換えます。すべてのリクエストがローカル環境とアプリで使用されるポートにリダイレクトされるようになりました。

   

   図 4. ngrok サーバーが稼働してリダイレクトしているターミナル。

5. ngrok アプリケーションによって localhost でウェブ インターフェースも起動されます。ブラウザで開くと、すべてのアクティビティをモニタリングできます。

   

   図 5. ngrok アプリケーションがホストするウェブ インターフェース。HTTP リクエストは表示されていません。

6. ダイレクト メッセージを送信して Chat アプリをテストします。

   • Google Chat を開きます。

     Google Chat にアクセス

   • [新しいチャット] をクリックします。

   • ダイアログに Chat 用アプリの名前を入力します。

   • 検索結果で Chat アプリを見つけ、[追加] > [Chat] をクリックします。

   • ダイレクト メッセージのスペースに「Hey!」と入力して enter を押します。チャット アプリがアクティブにデバッグされているため、返信しません。

7. ローカル環境の Visual Studio Code を見ると、設定されたブレークポイントで実行が一時停止していることがわかります。

   

   図 6. 設定されたブレークポイントで実行を一時停止します。

8. Google Chat がタイムアウトする前に Visual Studio Code のデバッガから実行を再開すると、Chat アプリはメッセージ内にあなたの名前とアバターの画像を返します。

9. HTTP リクエストとレスポンスのログは、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースから確認できます。

   

   図 7. ngrok アプリケーションがホストするウェブ インターフェースからの HTTP リクエスト。

10. アプリケーションの動作を変更するには、Hello を main.py ファイルの Hey インライン 51 に置き換えます。ファイルを保存すると、Visual Studio Code は更新されたソースコードでアプリケーションを自動的に再読み込みし、デバッグモードのままになります。

    

    図 8. アプリケーションが実行され、コード変更が読み込まれたポート 9000 で HTTP リクエストをリッスンしています。

11. 今回は、スペースで 2 番目のメッセージ Hey! を送信する代わりに、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースに記録された最後の HTTP リクエストを選択し、[Replay] をクリックします。前回と同様に、Chat アプリはデバッグ中であるため、返信しません。

12. Visual Studio Code のデバッガから実行を再開すると、ローカル環境の ngrok アプリケーションによってホストされているウェブ インターフェースから、更新されたバージョンのメッセージを含むレスポンスがアプリケーションが生成していることを確認できます。

Java

1. アプリケーションのデフォルト認証情報に使用する新しいユーザー認証情報を取得します。

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   PROJECT_ID は、アプリの Cloud プロジェクトのプロジェクト ID に置き換えます。

2. ローカル環境の GitHub から googleworkspace/google-chat-samples リポジトリのクローンを作成します。このリポジトリには、アプリケーション コードが含まれています。

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

3. ローカル環境にインストールされている Visual Studio Code IDE で、次の操作を行います。

   1. 新しいウィンドウで、フォルダ google-chat-samples/java/avatar-app を開きます。

   2. pom.xml ファイルに Cloud Functions Framework ビルド プラグイン function-maven-plugin を追加して、ポート 9000 でアプリケーション App をローカルで実行するように Maven プロジェクトを構成します。

      ...
      <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. これで、デバッグモードでローカルに起動できます。

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

   4. ルート ディレクトリに .vscode/launch.json というファイルを作成し、ポート 8000 で以前に起動したアプリケーションにアタッチする Remote Debug Watch という名前の起動を構成します。

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

   5. App.java ファイルで HTTP リクエスト処理を一時停止するブレークポイントを追加し、前に追加した Remote Debug Watch 構成を使用してアタッチとデバッグを開始します。これで、アプリケーションが実行され、ポート 9000 で HTTP リクエストをリッスンするようになりました。

      

      図 3. アプリケーションが実行され、ポート 9000 で HTTP リクエストをリッスンしています。

4. ローカル環境で ngrok アプリケーションを起動します。

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   NGROK_STATIC_DOMAIN は、ngrok アカウントの静的ドメインに置き換えます。すべてのリクエストがローカル環境とアプリで使用されるポートにリダイレクトされるようになりました。

   

   図 4. ngrok サーバーが稼働してリダイレクトしているターミナル。

5. ngrok アプリケーションによって localhost でウェブ インターフェースも起動されます。ブラウザで開くと、すべてのアクティビティをモニタリングできます。

   

   図 5. ngrok アプリケーションがホストするウェブ インターフェース。HTTP リクエストは表示されていません。

6. ダイレクト メッセージを送信して Chat アプリをテストします。

   • Google Chat を開きます。

     Google Chat に移動

   • [新しいチャット] をクリックします。

   • ダイアログに Chat 用アプリの名前を入力します。

   • 検索結果で Chat アプリを見つけ、[追加] > [Chat] をクリックします。

   • ダイレクト メッセージのスペースに「Hey!」と入力して enter を押します。チャット アプリがアクティブにデバッグされているため、返信しません。

7. ローカル環境の Visual Studio Code を見ると、設定されたブレークポイントで実行が一時停止していることがわかります。

   

   図 6. 設定されたブレークポイントで実行を一時停止します。

8. Google Chat がタイムアウトする前に Visual Studio Code のデバッガから実行を再開すると、Chat アプリはメッセージ内にあなたの名前とアバターの画像を返します。

9. HTTP リクエストとレスポンスのログは、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースから確認できます。

   

   図 7. ngrok アプリケーションがホストするウェブ インターフェースからの HTTP リクエスト。

10. アプリケーションの動作を変更するには、Hello を App.java ファイルの 55 インライン Hey に置き換え、mvnDebug プロセスを再起動します。Remote Debug Watch を再起動してデバッグを再接続して再起動します。

11. 今回は、スペースで 2 番目のメッセージ Hey! を送信する代わりに、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースに記録された最後の HTTP リクエストを選択し、[Replay] をクリックします。前回と同様に、Chat アプリはアクティブにデバッグされているため、応答しません。

12. Visual Studio Code のデバッガから実行を再開すると、ローカル環境の ngrok アプリケーションがホストするウェブ インターフェースで、アプリケーションが更新されたバージョンのメッセージを含むレスポンスを生成していることを確認できます。

リモート環境からデバッグする

このセクションでは、リモート環境で実行される Chat アプリを操作します。

図 9. リモート環境からデバッグする。

前提条件

• Chat アプリのダイレクト メッセージ スペース。クイックスタート ガイドのChat アプリをテストするセクションに沿って、Chat アプリを検索して開始できます。
• 特定のポートでデバッガが有効になっているリモート環境で実行されているアプリケーション。このガイドの手順では 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 構成を使用して実行とデバッグを開始します。

Chat アプリのダイレクト メッセージ スペースで、テストする内容を入力して enter キーを押します。Visual Studio Code IDE でデバッグがアクティブに行われるため、Chat アプリが返信しません。

関連トピック

• エラーログを有効にしてクエリする方法を学習する。
• 「アプリが応答しない」、「Google Chat API は Google Workspace ユーザーのみが使用できます」、「ユーザーをスペースから除外できます」などの Google Chat アプリのエラーを修正する方法をご確認ください。
• カード メッセージ、ダイアログ、リンク プレビューがレンダリングされない、または想定どおりに機能しないなどのカードエラーを修正する方法をご確認ください。