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

Node.js

Python

Java

Node.js

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

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

  npm install -g nodemon
  

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

• ローカル環境内でセットアップされ、デバッグ可能な IDE。このガイドでは、説明の便宜上、Visual Studio Code IDE とそのデフォルトのデバッグ機能を使用しています。

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

• ngrok アカウント。

Python

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

Node.js

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

   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 アプリによってローカルホスト上でウェブ インターフェースが開始されます。ブラウザで開くことで、すべてのアクティビティをモニタリングできます。

   

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

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

   • Google Chat を開きます。

     Google Chat にアクセス

   • [チャットを新規作成] add をクリックします。

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

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

   • ダイレクト メッセージ スペースで、「Hello」と入力して enter キーを押します。Chat アプリはデバッグ中のため、応答しません。

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

   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 ファイルを作成し、仮想環境 env のデバッグモードのポート 9000 でモジュール functions-framework からアプリケーションをトリガーする Debug Watch という名前の起動を構成します。

      {
          "version": "0.2.0",
          "configurations": [{
              "type": "python",
              "request": "launch",
              "name": "Debug Watch",
              "python": "${workspaceFolder}/env/bin/python3",
              "module": "functions_framework",
              "args": [
                  "--target", "hello_chat",
                  "--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 アプリによってローカルホスト上でウェブ インターフェースが開始されます。ブラウザで開くことで、すべてのアクティビティをモニタリングできます。

   

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

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

   • Google Chat を開きます。

     Google Chat にアクセス

   • [チャットを新規作成] add をクリックします。

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

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

   • ダイレクト メッセージ スペースで、「Hey!」と入力して enter キーを押します。Chat アプリはデバッグ中のため、応答しません。

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 でアプリケーション HelloChat をローカルで実行するように Maven プロジェクトを構成します。

      ...
      <plugin>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>function-maven-plugin</artifactId>
          <version>0.11.0</version>
          <configuration>
              <functionTarget>HelloChat</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. HelloChat.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 アプリによってローカルホスト上でウェブ インターフェースが開始されます。ブラウザで開くことで、すべてのアクティビティをモニタリングできます。

   

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

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

   • Google Chat を開きます。

     Google Chat にアクセス

   • [チャットを新規作成] add をクリックします。

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

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

   • ダイレクト メッセージ スペースで、「Hey!」と入力して enter キーを押します。Chat アプリはデバッグ中のため、応答しません。

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

   

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

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

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

   

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

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

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

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