Tutorial ini menunjukkan cara membuat alur kerja terjemahan yang menunggu input Anda—human in the loop—dan menghubungkan database Firestore, dua fungsi Cloud Run, Cloud Translation API, dan halaman web yang menggunakan Firebase SDK untuk diperbarui secara real time.
Dengan Alur Kerja, Anda dapat mendukung endpoint callback (atau webhook) yang menunggu permintaan HTTP tiba di endpoint tersebut, melanjutkan eksekusi alur kerja pada waktu berikutnya. Dalam hal ini, alur kerja menunggu masukan Anda untuk menolak atau memvalidasi terjemahan beberapa teks, tetapi juga dapat menunggu proses eksternal. Untuk informasi selengkapnya, lihat Menunggu menggunakan callback.
Arsitektur
Tutorial ini membuat aplikasi web yang memungkinkan Anda melakukan hal berikut:
- Di halaman web terjemahan, masukkan teks yang ingin diterjemahkan dari bahasa Inggris ke bahasa Prancis. Klik Terjemahkan.
- Dari halaman web, fungsi Cloud Run dipanggil yang meluncurkan eksekusi alur kerja. Teks yang akan diterjemahkan diteruskan sebagai parameter ke fungsi dan alur kerja.
- Teks disimpan di database Cloud Firestore. Cloud Translation API dipanggil. Terjemahan yang ditampilkan disimpan dalam database. Aplikasi web di-deploy menggunakan Firebase Hosting dan diperbarui secara real time untuk menampilkan teks terjemahan.
- Langkah
create_callback
dalam alur kerja membuat URL endpoint callback yang juga disimpan di database Firestore. Halaman web kini menampilkan tombol Validasi dan Tolak. - Alur kerja kini dijeda dan menunggu permintaan HTTP POST eksplisit ke URL endpoint callback.
- Anda dapat memutuskan apakah akan memvalidasi atau menolak terjemahan. Mengklik tombol akan memanggil fungsi Cloud Run kedua yang pada gilirannya memanggil endpoint callback yang dibuat oleh alur kerja, yang meneruskan status persetujuan.
Alur kerja akan melanjutkan eksekusinya dan menyimpan status persetujuan
true
ataufalse
di database Firestore.
Diagram ini memberikan ringkasan prosesnya:
Tujuan
- Men-deploy aplikasi web.
- Buat database Firestore untuk menyimpan permintaan terjemahan.
- Deploy fungsi Cloud Run untuk menjalankan alur kerja.
- Men-deploy dan menjalankan alur kerja untuk mengatur seluruh proses.
Biaya
Dalam dokumen ini, Anda akan menggunakan komponen Google Cloud yang dapat ditagih berikut:
Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda,
gunakan kalkulator harga.
Sebelum memulai
Batasan keamanan yang ditentukan oleh organisasi mungkin mencegah Anda menyelesaikan langkah-langkah berikut. Untuk mengetahui informasi pemecahan masalah, lihat Mengembangkan aplikasi di lingkungan Google Cloud yang terbatas.
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the App Engine, Cloud Build, Cloud Run functions, Firestore, Translation, and Workflows APIs:
gcloud services enable appengine.googleapis.com
cloudbuild.googleapis.com cloudfunctions.googleapis.com firestore.googleapis.com translate.googleapis.com workflows.googleapis.com - Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the App Engine, Cloud Build, Cloud Run functions, Firestore, Translation, and Workflows APIs:
gcloud services enable appengine.googleapis.com
cloudbuild.googleapis.com cloudfunctions.googleapis.com firestore.googleapis.com translate.googleapis.com workflows.googleapis.com - Update komponen Google Cloud CLI:
gcloud components update
- Login menggunakan akun Anda:
gcloud auth login
- Tetapkan project ID dan lokasi default yang digunakan dalam tutorial ini:
export GOOGLE_CLOUD_PROJECT=PROJECT_ID export REGION=REGION gcloud config set workflows/location ${REGION}
Ganti kode berikut:
Men-deploy fungsi Cloud Run pertama
Fungsi Cloud Run ini meluncurkan eksekusi alur kerja. Teks yang akan diterjemahkan diteruskan sebagai parameter ke fungsi dan ke alur kerja.
Buat direktori bernama
callback-translation
dan dengan subdirektori bernamainvokeTranslationWorkflow
,translationCallbackCall
, danpublic
:mkdir -p ~/callback-translation/{invokeTranslationWorkflow,translationCallbackCall,public}
Ubah ke direktori
invokeTranslationWorkflow
:cd ~/callback-translation/invokeTranslationWorkflow
Buat file teks dengan nama file
index.js
yang berisi kode Node.js berikut:Buat file teks dengan nama file
package.json
yang berisi metadatanpm
berikut:Deploy fungsi dengan pemicu HTTP dan izinkan akses yang tidak diautentikasi:
gcloud functions deploy invokeTranslationWorkflow \ --region=${REGION} \ --runtime nodejs14 \ --entry-point=invokeTranslationWorkflow \ --set-env-vars PROJECT_ID=${GOOGLE_CLOUD_PROJECT},CLOUD_REGION=${REGION},WORKFLOW_NAME=translation_validation \ --trigger-http \ --allow-unauthenticated
Fungsi mungkin memerlukan waktu beberapa menit untuk di-deploy. Atau, Anda dapat menggunakan antarmuka fungsi Cloud Run di Konsol Google Cloud untuk men-deploy fungsi tersebut.
Setelah fungsi di-deploy, Anda dapat mengonfirmasi properti
httpsTrigger.url
:gcloud functions describe invokeTranslationWorkflow
Catat URL yang ditampilkan agar Anda dapat menggunakannya di langkah berikutnya.
Men-deploy fungsi Cloud Run kedua
Fungsi Cloud Run ini membuat permintaan POST HTTP ke endpoint callback yang dibuat oleh alur kerja, yang meneruskan status persetujuan yang mencerminkan apakah terjemahan divalidasi atau ditolak.
Ubah ke direktori
translationCallbackCall
:cd ../translationCallbackCall
Buat file teks dengan nama file
index.js
yang berisi kode Node.js berikut:Buat file teks dengan nama file
package.json
yang berisi metadatanpm
berikut:Deploy fungsi dengan pemicu HTTP dan izinkan akses yang tidak diautentikasi:
gcloud functions deploy translationCallbackCall \ --region=${REGION} \ --runtime nodejs14 \ --entry-point=translationCallbackCall \ --trigger-http \ --allow-unauthenticated
Fungsi mungkin memerlukan waktu beberapa menit untuk di-deploy. Atau, Anda dapat menggunakan antarmuka fungsi Cloud Run di Konsol Google Cloud untuk men-deploy fungsi tersebut.
Setelah fungsi di-deploy, Anda dapat mengonfirmasi properti
httpsTrigger.url
:gcloud functions describe translationCallbackCall
Catat URL yang ditampilkan agar Anda dapat menggunakannya di langkah berikutnya.
Men-deploy alur kerja
Alur kerja terdiri dari serangkaian langkah yang dijelaskan menggunakan sintaksis Workflows, yang dapat ditulis dalam format YAML atau JSON. Ini adalah definisi alur kerja. Setelah membuat alur kerja, Anda men-deploynya agar tersedia untuk dieksekusi.
Ubah ke direktori
callback-translation
:cd ..
Buat file teks dengan nama file
translation-validation.yaml
dan dengan konten berikut:Setelah membuat alur kerja, Anda dapat men-deploynya, tetapi jangan jalankan alur kerja:
gcloud workflows deploy translation_validation --source=translation-validation.yaml
Membuat aplikasi web
Buat aplikasi web yang memanggil Cloud Function yang meluncurkan eksekusi alur kerja. Halaman web diperbarui secara real time untuk menampilkan hasil permintaan terjemahan.
Ubah ke direktori
public
:cd public
Buat file teks dengan nama file
index.html
yang berisi markup HTML berikut. (Pada langkah berikutnya, Anda akan mengubah fileindex.html
dan menambahkan skrip Firebase SDK.)Buat file teks dengan nama file
script.js
yang berisi kode JavaScript berikut:Edit file
script.js
, ganti placeholderUPDATE_ME
dengan URL fungsi Cloud Run yang Anda catat sebelumnya.Dalam metode
translateBtn.addEventListener
, ganticonst fnUrl = UPDATE_ME;
dengan:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/invokeTranslationWorkflow";
Di fungsi
callCallbackUrl
, ganticonst fnUrl = UPDATE_ME;
dengan:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/translationCallbackCall";
Buat file teks dengan nama file
style.css
yang berisi gaya cascading berikut:
Tambahkan Firebase ke aplikasi web Anda
Dalam tutorial ini, halaman HTML, skrip JavaScript, dan sheet gaya CSS di-deploy sebagai aset statis menggunakan Firebase Hosting, tetapi dapat dihosting di mana saja dan ditayangkan secara lokal di komputer Anda sendiri untuk tujuan pengujian.
Membuat project Firebase
Agar dapat menambahkan Firebase ke aplikasi, Anda perlu membuat project Firebase untuk terhubung ke aplikasi.
-
Di Firebase console, klik Create a project, lalu pilih project Google Cloud yang ada dari menu drop-down untuk menambahkan resource Firebase ke project tersebut.
-
Klik Lanjutkan hingga Anda melihat opsi untuk menambahkan Firebase.
-
Lewati penyiapan Google Analytics untuk project Anda.
-
Klik Add Firebase.
Firebase otomatis menyediakan resource untuk project Firebase Anda. Setelah selesai, Anda akan dibawa ke halaman ringkasan untuk project Anda di Firebase console.
Mendaftarkan aplikasi ke Firebase
Setelah memiliki project Firebase, Anda dapat menambahkan aplikasi web ke project tersebut.
Di bagian tengah halaman ringkasan project, klik ikon Web (</>) untuk meluncurkan alur kerja penyiapan.
Masukkan nama panggilan untuk aplikasi Anda.
Bagian ini hanya dapat dilihat oleh Anda di Firebase console.
Untuk saat ini, lewati penyiapan Firebase Hosting.
Klik Register app dan lanjutkan ke konsol.
Aktifkan Cloud Firestore
Aplikasi web menggunakan Cloud Firestore untuk menerima dan menyimpan data. Anda harus mengaktifkan Cloud Firestore.
Di bagian Build Firebase console, klik Firestore Database.
(Anda mungkin harus meluaskan panel navigasi kiri terlebih dahulu untuk melihat bagian Build.)
Di panel Cloud Firestore, klik Buat database.
Pilih Mulai dalam mode pengujian, menggunakan aturan keamanan seperti berikut:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /{document=**} { allow read, write; } } }
Klik Berikutnya setelah membaca pernyataan penyangkalan tentang aturan keamanan.
Tetapkan lokasi penyimpanan data Cloud Firestore Anda. Anda dapat menerima setelan default atau memilih region yang dekat dengan Anda.
Klik Aktifkan untuk menyediakan Firestore.
Menambahkan Firebase SDK dan melakukan inisialisasi Firebase
Firebase menyediakan library JavaScript untuk sebagian besar produk Firebase. Sebelum menggunakan Firebase Hosting, Anda harus menambahkan Firebase SDK ke aplikasi Web.
- Untuk menginisialisasi Firebase di aplikasi, Anda perlu memberikan konfigurasi project Firebase untuk aplikasi Anda.
- Di Firebase console, buka Project settings .
- Di panel Aplikasi Anda, pilih aplikasi Anda.
- Di panel SDK setup and configuration, untuk memuat library Firebase SDK dari CDN, pilih CDN.
- Salin cuplikan ke file
index.html
di bagian bawah tag<body>
, yang menggantikan nilai placeholderXXXX
.
Instal Firebase JavaScript SDK.
Jika Anda belum memiliki file
package.json
, buat file tersebut dengan menjalankan perintah berikut dari direktoricallback-translation
:npm init
Instal paket npm
firebase
dan simpan ke filepackage.json
Anda dengan menjalankan:npm install --save firebase
Melakukan inisialisasi dan men-deploy project
Untuk menghubungkan file project lokal ke project Firebase, Anda harus melakukan inisialisasi project. Kemudian, Anda dapat men-deploy aplikasi web.
Dari direktori
callback-translation
, jalankan perintah berikut:firebase init
Pilih opsi
Configure files for Firebase Hosting and (optionally) set up GitHub Action deploys
.Pilih untuk menggunakan project yang ada dan masukkan project ID Anda.
Terima
public
sebagai direktori root publik default.Pilih untuk mengonfigurasi aplikasi web satu halaman.
Lewati penyiapan build dan deployment otomatis dengan GitHub.
Pada perintah
File public/index.html already exists. Overwrite?
, ketik Tidak.Ubah ke direktori
public
:cd public
Dari direktori
public
, jalankan perintah berikut untuk men-deploy project ke situs Anda:firebase deploy --only hosting
Menguji aplikasi web secara lokal
Firebase Hosting memungkinkan Anda melihat dan menguji perubahan secara lokal serta berinteraksi dengan resource project backend yang diemulasikan. Saat menggunakan firebase serve
, aplikasi Anda berinteraksi dengan backend yang diemulasi untuk konten dan konfigurasi hosting, tetapi backend yang sebenarnya untuk semua resource project lainnya. Untuk tutorial ini, Anda
dapat menggunakan firebase serve
, tetapi tidak direkomendasikan saat melakukan pengujian
yang lebih ekstensif.
Dari direktori
public
, jalankan perintah berikut:firebase serve
Buka aplikasi web di URL lokal yang ditampilkan (biasanya
http://localhost:5000
).Masukkan beberapa teks dalam bahasa Inggris, lalu klik Terjemahkan.
Terjemahan teks dalam bahasa Prancis akan ditampilkan.
Sekarang Anda dapat mengklik Validasi atau Tolak.
Di database Firestore, Anda dapat memverifikasi kontennya. Tampilannya akan terlihat seperti berikut:
approved: true callback: "https://workflowexecutions.googleapis.com/v1/projects/26811016474/locations/us-central1/workflows/translation_validation/executions/68bfce75-5f62-445f-9cd5-eda23e6fa693/callbacks/72851c97-6bb2-45e3-9816-1e3dcc610662_1a16697f-6d90-478d-9736-33190bbe222b" text: "The quick brown fox jumps over the lazy dog." translation: "Le renard brun rapide saute par-dessus le chien paresseux."
Status
approved
adalahtrue
ataufalse
, bergantung pada apakah Anda memvalidasi atau menolak terjemahan.
Selamat! Anda telah membuat alur kerja terjemahan yang memerlukan interaksi manusia yang menggunakan callback Alur Kerja.
Pembersihan
Jika Anda membuat project baru untuk tutorial ini, hapus project tersebut. Jika Anda menggunakan project yang ada dan ingin mempertahankannya tanpa perubahan yang ditambahkan dalam tutorial ini, hapus resource yang dibuat untuk tutorial.
Menghapus project
Cara termudah untuk menghilangkan penagihan adalah dengan menghapus project yang Anda buat untuk tutorial.
Untuk menghapus project:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Menghapus resource tutorial
Hapus konfigurasi default gcloud CLI yang Anda tambahkan selama penyiapan tutorial:
gcloud config unset workflows/location
Menghapus alur kerja yang dibuat dalam tutorial ini:
gcloud workflows delete WORKFLOW_NAME
Hapus fungsi Cloud Run yang Anda buat dalam tutorial ini:
gcloud functions delete FUNCTION_NAME
Anda juga dapat menghapus fungsi Cloud Run dari Konsol Google Cloud.