Men-debug aplikasi Google Chat

Sebagai developer aplikasi Google Chat, Anda mungkin perlu men-debug kode untuk menguji perubahan atau memecahkan masalah yang kompleks. Proses debug aplikasi Chat dapat dilakukan dengan berbagai cara, bergantung pada arsitektur aplikasi, fungsi aplikasi, cara aplikasi di-deploy, dan preferensi Anda.

Halaman ini menjelaskan cara men-debug aplikasi Chat HTTP menggunakan ngrok, yang merupakan platform masuk terpadu yang dapat Anda gunakan untuk menguji lingkungan pengembangan lokal. Dalam panduan ini, Anda akan menguji perubahan kode di lingkungan lokal dan memecahkan masalah di lingkungan jarak jauh.

Catatan: Jika aplikasi Chat Anda dibuat dengan Google Apps Script, gunakan kode berikut:

• Menguji deployment
• Menggunakan debugger dan titik henti sementara

Men-debug dari lingkungan pengembangan lokal

Di bagian ini, Anda berinteraksi dengan aplikasi Chat yang dijalankan di lingkungan lokal.

Gambar 1. Men-debug di lingkungan pengembangan lokal.

Workshop

Node.js

Python

Java

Prasyarat

Node.js

• Versi terbaru node dan npm diinstal di lingkungan lokal Anda.

• Versi terbaru nodemon diinstal di lingkungan lokal Anda, yang digunakan untuk tujuan pemuatan ulang otomatis:

  npm install -g nodemon

• Aplikasi Chat HTTP yang dikonfigurasi untuk pesan. Anda dapat mengikuti bagian Prasyarat, Menyiapkan lingkungan, dan Memublikasikan aplikasi ke Google Chat dalam Panduan memulai. Satu-satunya perbedaan adalah Anda perlu menetapkan Nama aplikasi ke Debug App dan URL endpoint HTTP ke apa pun seperti http://example.com.

• IDE yang disiapkan di lingkungan lokal Anda yang dapat melakukan debug. Kami menggunakan Visual Studio Code IDE dan fitur proses debug defaultnya dalam panduan ini untuk tujuan ilustrasi.

• Git diinstal di lingkungan lokal Anda.

• Akun ngrok.

Python

• Versi terbaru python3 diinstal di lingkungan lokal Anda.
• Versi terbaru pip dan virtualenv yang diinstal di lingkungan lokal Anda, masing-masing digunakan untuk mengelola paket Python dan lingkungan virtual.
• Aplikasi HTTP Chat yang dikonfigurasikan untuk fitur pesan. Anda dapat mengikuti bagian Prasyarat, Menyiapkan lingkungan, dan Memublikasikan aplikasi ke Google Chat dalam Panduan memulai. Satu-satunya perbedaan adalah Anda perlu menetapkan App name ke Debug App dan URL endpoint HTTP ke apa pun seperti http://example.com.
• IDE yang disiapkan di lingkungan lokal Anda yang dapat di-debug. Kami menggunakan IDE Visual Studio Code dan fitur proses debug defaultnya dalam panduan ini untuk tujuan ilustrasi.
• Git diinstal di lingkungan lokal Anda.
• Akun ngrok.
• Versi terbaru gcloud diinstal dan diinisialisasi di lingkungan lokal Anda.

Java

• Versi stabil terbaru Java SE 11's JDK yang diinstal di lingkungan lokal Anda.
• Versi terbaru Apache Maven diinstal di lingkungan lokal Anda, digunakan untuk mengelola project Java.
• Aplikasi Chat HTTP yang dikonfigurasi untuk pesan. Anda dapat mengikuti bagian Prasyarat, Menyiapkan lingkungan, dan Memublikasikan aplikasi ke Google Chat pada Panduan memulai. Satu-satunya perbedaan adalah Anda perlu menetapkan Nama aplikasi ke Debug App dan URL endpoint HTTP ke apa pun seperti http://example.com.
• IDE yang disiapkan di lingkungan lokal Anda yang dapat melakukan proses debug. Kami menggunakan IDE Visual Studio Code dan fitur proses debug defaultnya dalam panduan ini untuk tujuan ilustrasi.
• Git diinstal di lingkungan lokal Anda.
• Akun ngrok.
• Versi terbaru gcloud diinstal dan diinisialisasi di lingkungan lokal Anda.

Membuat layanan localhost tersedia secara publik

Anda harus menghubungkan lingkungan lokal ke internet agar aplikasi Chat dapat mengaksesnya. Aplikasi ngrok digunakan untuk mengalihkan permintaan HTTP yang dibuat ke URL publik ke lingkungan lokal Anda.

1. Di browser di lingkungan lokal, login ke akun ngrok Anda.
2. Instal aplikasi dan siapkan authtoken di lingkungan lokal Anda.
3. Buat domain statis di akun ngrok Anda, yang dirujuk sebagai NGROK_STATIC_DOMAIN dalam petunjuk panduan ini.

Mengonfigurasi aplikasi Chat

Konfigurasikan aplikasi Chat untuk mengirim semua permintaan HTTP-nya ke domain statis Anda.

1. Di konsol Google Cloud, buka halaman Google Chat API:

   Buka halaman Google Chat API

2. Klik tab Configuration.

3. Buka Fitur interaktif > Setelan koneksi dan tetapkan nilai kolom teks URL endpoint HTTP ke:

   https://NGROK_STATIC_DOMAIN
   

   Ganti NGROK_STATIC_DOMAIN dengan domain statis di akun ngrok Anda.

4. Klik Simpan.

Gambar 2. Aplikasi Chat mengirim semua permintaan HTTP-nya ke domain statis. Layanan publik ngrok berfungsi sebagai jembatan antara aplikasi Chat dan kode aplikasi yang dieksekusi secara lokal.

Menguji aplikasi Chat

Anda dapat men-deploy, mengonfigurasi, menguji, men-debug, dan memuat ulang secara otomatis aplikasi Chat.

Catatan: Aplikasi Chat dijalankan dengan Framework Cloud Functions dalam contoh untuk Python dan Java serta dengan Framework Express dalam contoh untuk Node.js.

Node.js

1. Clone repositori googleworkspace/google-chat-samples dari GitHub ke lingkungan lokal Anda yang berisi kode aplikasi yang akan dieksekusi:

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

2. Dari IDE Visual Studio Code yang diinstal di lingkungan lokal Anda, lakukan hal berikut:

   1. Di jendela baru, buka folder google-chat-samples/node/basic-app.

   2. Konfigurasikan aplikasi agar debug pemuatan ulang otomatis dengan menambahkan dua skrip dalam file package.json:

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

   3. Dari direktori utama, instal aplikasi:

      npm install

   4. Buat dan konfigurasikan peluncuran bernama Debug Watch yang memicu skrip debug-watch dengan membuat file .vscode/launch.json di direktori utama:

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

   5. Tambahkan titik henti sementara yang menjeda pemrosesan permintaan HTTP dalam file index.js, dan mulai jalankan dan lakukan proses debug dengan konfigurasi Debug Watch yang ditambahkan sebelumnya. Aplikasi kini berjalan dan memproses permintaan HTTP di port 9000.

      

      Gambar 3. Aplikasi berjalan dan memproses permintaan HTTP di port 9000.

3. Luncurkan aplikasi ngrok di lingkungan lokal Anda:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Ganti NGROK_STATIC_DOMAIN dengan domain statis di akun ngrok Anda. Semua permintaan kini dialihkan ke lingkungan lokal dan port yang digunakan oleh aplikasi.

   

   Gambar 4. Terminal dengan server ngrok yang berjalan dan mengalihkan.

4. Antarmuka web juga dimulai di localhost oleh aplikasi ngrok. Anda dapat memantau semua aktivitas dengan membukanya di browser.

   

   Gambar 5. Antarmuka web yang dihosting oleh aplikasi ngrok yang tidak menampilkan permintaan HTTP.

5. Uji aplikasi Chat Anda dengan mengirimkan pesan langsung:

   • Buka Google Chat.

     Buka Google Chat

   • Klik Chat baru .

   • Dalam dialog, masukkan nama aplikasi Chat Anda.

   • Di hasil penelusuran, temukan aplikasi Chat Anda, klik Tambahkan > Chat.

   • Di ruang pesan langsung, ketik Hello, lalu tekan enter. Aplikasi Chat Anda tidak dibalas karena sedang di-debug secara aktif.

6. Pada Visual Studio Code di lingkungan lokal, Anda dapat melihat bahwa eksekusi dijeda pada titik henti sementara yang ditetapkan.

   

   Gambar 6. Eksekusi dijeda pada titik henti sementara yang ditetapkan.

7. Saat melanjutkan eksekusi dari debugger Visual Studio Code sebelum Google Chat kehabisan waktu, aplikasi Chat membalas Your message : Hello.

8. Anda dapat memeriksa log permintaan dan respons HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda.

   

   Gambar 7. Permintaan HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok.

9. Untuk mengubah perilaku aplikasi, ganti Your message dengan Here was your message 35 inline dari index.json. Saat Anda menyimpan file, nodemon akan otomatis memuat ulang aplikasi dengan kode sumber yang diperbarui dan Visual Studio Code tetap dalam mode debug.

   

   Gambar 8. Aplikasi berjalan dan memproses permintaan HTTP pada port 9000 dengan perubahan kode yang dimuat.

10. Kali ini, alih-alih mengirim pesan kedua Hello di ruang, Anda dapat memilih permintaan HTTP terakhir yang dicatat di antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda, lalu mengklik Replay. Sama seperti terakhir kali, aplikasi Chat Anda tidak membalas karena sedang di-debug secara aktif.

11. Saat melanjutkan eksekusi dari debugger Visual Studio Code, Anda dapat melihat dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal bahwa aplikasi menghasilkan respons dengan versi pesan Here was your message : Hello yang diperbarui.

Python

1. Dapatkan kredensial pengguna baru untuk digunakan untuk Kredensial Default Aplikasi:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   Ganti PROJECT_ID dengan project ID untuk project Cloud aplikasi.

2. Clone repositori googleworkspace/google-chat-samples dari GitHub ke lingkungan lokal Anda, yang berisi kode aplikasi:

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

3. Dari IDE Visual Studio Code yang diinstal di lingkungan lokal Anda, lakukan hal berikut:

   1. Di jendela baru, buka folder google-chat-samples/python/avatar-app.

   2. Buat lingkungan virtual baru untuk Python env lalu aktifkan:

      virtualenv env
      source env/bin/activate

   3. Instal semua dependensi project menggunakan pip di lingkungan virtual:

      pip install -r requirements.txt

   4. Buat file .vscode/launch.json di direktori root dan konfigurasi peluncuran bernama Debug Watch yang memicu aplikasi dari modul functions-framework di port 9000 dalam mode debug di lingkungan 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. Tambahkan titik henti sementara yang menjeda pemrosesan permintaan HTTP dalam file main.py, dan mulai jalankan dan lakukan proses debug dengan konfigurasi Debug Watch yang ditambahkan sebelumnya. Aplikasi kini berjalan dan memproses permintaan HTTP di port 9000.

      

      Gambar 3. Aplikasi berjalan dan memproses permintaan HTTP di port 9000.

4. Luncurkan aplikasi ngrok di lingkungan lokal Anda:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Ganti NGROK_STATIC_DOMAIN dengan domain statis di akun ngrok Anda. Semua permintaan kini dialihkan ke lingkungan lokal dan port yang digunakan oleh aplikasi.

   

   Gambar 4. Terminal dengan server ngrok yang berjalan dan mengalihkan.

5. Antarmuka web juga dimulai di localhost oleh aplikasi ngrok. Anda dapat memantau semua aktivitas dengan membukanya di browser.

   

   Gambar 5. Antarmuka web yang dihosting oleh aplikasi ngrok yang tidak menampilkan permintaan HTTP.

6. Uji aplikasi Chat Anda dengan mengirimkan pesan langsung:

   • Buka Google Chat.

     Buka Google Chat

   • Klik Chat baru .

   • Dalam dialog, masukkan nama aplikasi Chat Anda.

   • Di hasil penelusuran, temukan aplikasi Chat Anda, klik Add > Chat.

   • Di ruang pesan langsung, ketik Hey! dan tekan enter. Aplikasi Chat Anda tidak membalas karena sedang di-debug secara aktif.

7. Di Visual Studio Code di lingkungan lokal, Anda dapat melihat bahwa eksekusi dijeda pada titik henti sementara yang ditetapkan.

   

   Gambar 6. Eksekusi dijeda pada titik henti sementara yang ditetapkan.

8. Saat Anda melanjutkan eksekusi dari debugger Visual Studio Code sebelum Google Chat habis waktu tunggunya, aplikasi Chat akan membalas dengan nama dan gambar avatar Anda dalam pesan.

9. Anda dapat memeriksa log permintaan dan respons HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda.

   

   Gambar 7. Permintaan HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok.

10. Untuk mengubah perilaku aplikasi, ganti Hello dengan Hey inline 51 dari file main.py. Saat Anda menyimpan file, Visual Studio Code akan otomatis memuat ulang aplikasi dengan kode sumber yang diperbarui dan tetap dalam mode debug.

    

    Gambar 8. Aplikasi berjalan dan memproses permintaan HTTP di port 9000 dengan perubahan kode yang dimuat.

11. Kali ini, daripada mengirim pesan kedua Hey! dalam ruang, Anda dapat memilih permintaan HTTP terakhir yang dicatat ke dalam log di antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda, lalu mengklik Replay. Sama seperti sebelumnya, aplikasi Chat Anda tidak membalas karena sedang di-debug secara aktif.

12. Saat melanjutkan eksekusi dari debugger Visual Studio Code, Anda dapat melihat dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal bahwa aplikasi menghasilkan respons dengan versi pesan yang diperbarui.

Java

1. Dapatkan kredensial pengguna baru untuk digunakan pada Kredensial Default Aplikasi:

   gcloud config set project PROJECT_ID
   gcloud auth application-default login

   Ganti PROJECT_ID dengan project ID untuk project Cloud aplikasi.

2. Clone repositori googleworkspace/google-chat-samples dari GitHub di lingkungan lokal Anda, yang berisi kode aplikasi:

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

3. Dari IDE Visual Studio Code yang diinstal di lingkungan lokal Anda, lakukan hal berikut:

   1. Di jendela baru, buka folder google-chat-samples/java/avatar-app.

   2. Konfigurasikan project Maven untuk menjalankan aplikasi App di port 9000 secara lokal dengan menambahkan plugin build Cloud Functions Framework function-maven-plugin dalam file 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. Sekarang Anda dapat meluncurkannya secara lokal dalam mode debug:

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

   4. Buat file .vscode/launch.json di direktori root dan konfigurasi peluncuran bernama Remote Debug Watch yang dilampirkan ke aplikasi yang sebelumnya diluncurkan dengan port 8000:

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

   5. Tambahkan titik henti sementara yang menjeda pemrosesan permintaan HTTP dalam file App.java, dan mulai lampirkan dan debug dengan konfigurasi Remote Debug Watch yang ditambahkan sebelumnya. Aplikasi sekarang berjalan dan memproses permintaan HTTP pada port 9000.

      

      Gambar 3. aplikasi sedang berjalan dan memproses permintaan HTTP pada port 9000.

4. Luncurkan aplikasi ngrok di lingkungan lokal Anda:

   ngrok http --domain=NGROK_STATIC_DOMAIN 9000

   Ganti NGROK_STATIC_DOMAIN dengan domain statis di akun ngrok Anda. Semua permintaan kini dialihkan ke lingkungan lokal dan port yang digunakan oleh aplikasi.

   

   Gambar 4. Terminal dengan server ngrok yang berjalan dan mengalihkan.

5. Antarmuka web juga dimulai di localhost oleh aplikasi ngrok. Anda dapat memantau semua aktivitas dengan membukanya di browser.

   

   Gambar 5. Antarmuka web yang dihosting oleh aplikasi ngrok yang tidak menampilkan permintaan HTTP.

6. Uji aplikasi Chat Anda dengan mengirimkan pesan langsung:

   • Buka Google Chat.

     Buka Google Chat

   • Klik Chat baru .

   • Dalam dialog, masukkan nama aplikasi Chat Anda.

   • Di hasil penelusuran, temukan aplikasi Chat Anda, klik Add > Chat.

   • Di ruang pesan langsung, ketik Hey! dan tekan enter. Aplikasi Chat Anda tidak membalas karena sedang di-debug secara aktif.

7. Di Visual Studio Code di lingkungan lokal, Anda dapat melihat bahwa eksekusi dijeda pada titik henti sementara yang ditetapkan.

   

   Gambar 6. Eksekusi dijeda pada titik henti sementara yang ditetapkan.

8. Saat Anda melanjutkan eksekusi dari debugger Visual Studio Code sebelum Google Chat habis waktu tunggunya, aplikasi Chat akan membalas dengan nama dan gambar avatar Anda dalam pesan.

9. Anda dapat memeriksa log permintaan dan respons HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda.

   

   Gambar 7. Permintaan HTTP dari antarmuka web yang dihosting oleh aplikasi ngrok.

10. Untuk mengubah perilaku aplikasi, ganti Hello dengan Hey inline 55 dari file App.java, mulai ulang proses mvnDebug, dan luncurkan ulang Remote Debug Watch untuk melampirkan kembali dan memulai ulang proses debug.

11. Kali ini, alih-alih mengirim pesan kedua Hey! di ruang, Anda dapat memilih permintaan HTTP terakhir yang dicatat di antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal Anda, lalu mengklik Replay. Sama seperti sebelumnya, aplikasi Chat Anda tidak membalas karena sedang di-debug secara aktif.

12. Saat melanjutkan eksekusi dari debugger Visual Studio Code, Anda dapat melihat dari antarmuka web yang dihosting oleh aplikasi ngrok di lingkungan lokal bahwa aplikasi menghasilkan respons dengan versi pesan yang diperbarui.

Men-debug dari lingkungan jarak jauh

Di bagian ini, Anda akan berinteraksi dengan aplikasi Chat yang dijalankan di lingkungan jarak jauh.

Gambar 9. Melakukan debug dari lingkungan jarak jauh.

Prasyarat

• Ruang pesan langsung dengan aplikasi Chat Anda. Anda dapat mengikuti bagian Menguji aplikasi Chat di Panduan memulai dan menelusuri aplikasi Chat untuk memulainya.
• Aplikasi Anda yang berjalan di lingkungan jarak jauh dengan debugger yang diaktifkan di port tertentu, dirujuk sebagai REMOTE_DEBUG_PORT dalam petunjuk panduan ini.
• Lingkungan lokal Anda dapat ssh ke lingkungan jarak jauh.
• IDE yang disiapkan di lingkungan lokal Anda yang dapat melakukan proses debug. Kita menggunakan IDE Visual Studio Code dan fitur proses debug defaultnya dalam panduan ini untuk tujuan ilustrasi.

Menghubungkan lingkungan lokal dan jarak jauh

Di lingkungan lokal tempat Anda ingin memulai koneksi klien debug, siapkan tunnel SSH:

ssh -L LOCAL_DEBUG_PORT:localhost:REMOTE_DEBUG_PORT REMOTE_USERNAME@REMOTE_ADDRESS

Ganti kode berikut:

• LOCAL_DEBUG_PORT: Port debug di lingkungan lokal Anda.
• REMOTE_USERNAME: Nama pengguna di lingkungan jarak jauh Anda.
• REMOTE_ADDRESS: Alamat lingkungan jarak jauh Anda.
• REMOTE_DEBUG_PORT: Port debug di lingkungan jarak jauh Anda.

Port debug di lingkungan lokal Anda kini ditautkan ke port debug di lingkungan jarak jauh Anda.

Memulai proses debug

Dari IDE Visual Studio Code yang diinstal di lingkungan lokal Anda, lakukan hal berikut:

1. Di jendela baru, buka kode sumber aplikasi Anda.

2. Buat file .vscode/launch.json di direktori utama dan konfigurasikan peluncuran bernama Debug Remote yang dilampirkan ke port debug di lingkungan lokal Anda:

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

   Ganti LOCAL_DEBUG_PORT dengan port debug di lingkungan lokal Anda.

3. Tambahkan titik henti sementara dalam kode sumber aplikasi Anda yang menjeda pemrosesan permintaan HTTP, dan mulai jalankan dan debug dengan konfigurasi Debug Remote yang ditambahkan sebelumnya.

Di ruang pesan langsung dengan aplikasi Chat, ketik apa pun yang ingin Anda uji, lalu tekan enter. Aplikasi Chat Anda tidak membalas karena sedang aktif di-debug di IDE Visual Studio Code.

Topik terkait

• Pelajari cara mengaktifkan dan membuat kueri log error.
• Pelajari cara memperbaiki error aplikasi Google Chat seperti "Aplikasi tidak merespons", "Google Chat API hanya tersedia untuk pengguna Google Workspace", atau "Pengguna dapat dikecualikan dari ruang".
• Pelajari cara memperbaiki error kartu seperti pesan kartu, dialog, atau pratinjau link yang tidak dirender atau berfungsi seperti yang diharapkan.