En este tutorial se explica cómo crear un flujo de trabajo de traducción que espere tu intervención (el humano en el bucle) y que conecte una base de datos de Firestore, dos funciones de Cloud Run, la API Cloud Translation y una página web que use el SDK de Firebase para actualizarse en tiempo real.
Con los flujos de trabajo, puedes admitir un endpoint de retrollamada (o webhook) que espera a que lleguen solicitudes HTTP a ese endpoint y reanuda la ejecución del flujo de trabajo más adelante. En este caso, el flujo de trabajo espera a que rechaces o valides la traducción de un texto, pero también podría esperar a que se complete un proceso externo. Para obtener más información, consulta Esperar usando retrollamadas.
Arquitectura
En este tutorial se crea una aplicación web que te permite hacer lo siguiente:
- En la página web de traducción, escribe el texto que quieras traducir del inglés al francés. Haz clic en Traducir.
- Desde la página web, se llama a una función de Cloud Run que inicia la ejecución del flujo de trabajo. El texto que se va a traducir se pasa como parámetro tanto a la función como al flujo de trabajo.
- El texto se guarda en una base de datos de Cloud Firestore. Se llama a la API Cloud Translation. La traducción devuelta se almacena en la base de datos. La aplicación web se implementa mediante Firebase Hosting y se actualiza en tiempo real para mostrar el texto traducido.
- En el paso
create_callback
del flujo de trabajo se crea una URL de endpoint de retrollamada, que también se guarda en la base de datos de Firestore. En la página web ahora se muestran los botones Validar y Rechazar. - El flujo de trabajo se ha pausado y espera una solicitud HTTP POST explícita a la URL del endpoint de retrollamada.
- Puedes validar o rechazar la traducción. Al hacer clic en un botón, se llama a una segunda función de Cloud Run, que a su vez llama al endpoint de retrollamada creado por el flujo de trabajo y le transmite el estado de aprobación.
El flujo de trabajo reanuda su ejecución y guarda el estado de aprobación
true
ofalse
en la base de datos de Firestore.
En este diagrama se muestra un resumen del proceso:
Objetivos
- Despliega una aplicación web.
- Crea una base de datos de Firestore para almacenar las solicitudes de traducción.
- Despliega funciones de Cloud Run para ejecutar el flujo de trabajo.
- Despliega y ejecuta un flujo de trabajo para orquestar todo el proceso.
Costes
En este documento, se utilizan los siguientes componentes facturables de Google Cloud:
Para generar una estimación de costes basada en el uso previsto,
utiliza la calculadora de precios.
Antes de empezar
Es posible que las restricciones de seguridad definidas por tu organización te impidan completar los siguientes pasos. Para obtener información sobre cómo solucionar problemas, consulta el artículo Desarrollar aplicaciones en un entorno limitado Google Cloud .
- 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.
-
Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.
-
Para inicializar gcloud CLI, ejecuta el siguiente comando:
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.
-
-
Verify 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.
-
Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.
-
Para inicializar gcloud CLI, ejecuta el siguiente comando:
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.
-
-
Verify 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 - Actualiza los componentes de Google Cloud CLI:
gcloud components update
- Inicia sesión con tu cuenta:
gcloud auth login
- Define el ID del proyecto y la ubicación predeterminada que se usarán en este tutorial:
export GOOGLE_CLOUD_PROJECT=PROJECT_ID export REGION=REGION gcloud config set workflows/location ${REGION}
Haz los cambios siguientes:
PROJECT_ID
: tu ID de proyecto Google Cloud . Puedes encontrar el ID de tu proyecto en la página Bienvenido de la consola de Google Cloud .REGION
: la ubicación de los flujos de trabajo admitidos que elijas.
Crea un directorio llamado
callback-translation
con los subdirectoriosinvokeTranslationWorkflow
,translationCallbackCall
ypublic
:mkdir -p ~/callback-translation/{invokeTranslationWorkflow,translationCallbackCall,public}
Cambia al directorio
invokeTranslationWorkflow
:cd ~/callback-translation/invokeTranslationWorkflow
Crea un archivo de texto con el nombre
index.js
que contenga el siguiente código de Node.js:Crea un archivo de texto con el nombre
package.json
que contenga los siguientes metadatosnpm
:Despliega la función con un activador HTTP y permite el acceso sin autenticar:
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
La función puede tardar unos minutos en implementarse. También puedes usar la interfaz de funciones de Cloud Run en la Google Cloud consola para desplegar la función.
Una vez que se haya implementado la función, puede confirmar la propiedad
httpsTrigger.url
:gcloud functions describe invokeTranslationWorkflow
Anota la URL que se devuelve para poder usarla en un paso posterior.
Cambia al directorio
translationCallbackCall
:cd ../translationCallbackCall
Crea un archivo de texto con el nombre
index.js
que contenga el siguiente código de Node.js:Crea un archivo de texto con el nombre
package.json
que contenga los siguientes metadatosnpm
:Despliega la función con un activador HTTP y permite el acceso sin autenticar:
gcloud functions deploy translationCallbackCall \ --region=${REGION} \ --runtime nodejs14 \ --entry-point=translationCallbackCall \ --trigger-http \ --allow-unauthenticated
La función puede tardar unos minutos en implementarse. También puedes usar la interfaz de funciones de Cloud Run en la Google Cloud consola para desplegar la función.
Una vez que se haya implementado la función, puede confirmar la propiedad
httpsTrigger.url
:gcloud functions describe translationCallbackCall
Anota la URL que se devuelve para poder usarla en un paso posterior.
Cambia al directorio
callback-translation
:cd ..
Crea un archivo de texto con el nombre
translation-validation.yaml
y el siguiente contenido:Después de crear el flujo de trabajo, puedes implementarlo, pero no lo ejecutes:
gcloud workflows deploy translation_validation --source=translation-validation.yaml
Cambia al directorio
public
:cd public
Crea un archivo de texto llamado
index.html
que contenga el siguiente marcado HTML. En un paso posterior, modificará el archivoindex.html
y añadirá las secuencias de comandos del SDK de Firebase.Crea un archivo de texto con el nombre
script.js
que contenga el siguiente código JavaScript:Edita el archivo
script.js
y sustituye los marcadores de posiciónUPDATE_ME
por las URLs de las funciones de Cloud Run que has anotado anteriormente.En el método
translateBtn.addEventListener
, sustituyeconst fnUrl = UPDATE_ME;
por:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/invokeTranslationWorkflow";
En la función
callCallbackUrl
, sustituyeconst fnUrl = UPDATE_ME;
por:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/translationCallbackCall";
Crea un archivo de texto con el nombre
style.css
que contenga los siguientes estilos en cascada:-
En la consola de Firebase, haga clic en Crear un proyecto y, a continuación, seleccione su proyecto de Google Cloud en el menú desplegable para añadir recursos de Firebase a ese proyecto.
-
Haz clic en Continuar hasta que veas la opción de añadir Firebase.
-
Saltar la configuración de Google Analytics en tu proyecto.
-
Haz clic en Añadir Firebase.
En el centro de la página de descripción general del proyecto, haga clic en el icono Web (</>) para iniciar el flujo de trabajo de configuración.
Introduce un nombre para tu aplicación.
Solo tú puedes verla en la consola de Firebase.
Por ahora, no configures Firebase Hosting.
Haz clic en Registrar aplicación y continúa en la consola.
En la sección Desarrollo de la consola de Firebase, haz clic en Base de datos de Firestore.
Es posible que tengas que ampliar el panel de navegación de la izquierda para ver la sección Crear.
En el panel de Cloud Firestore, haz clic en Crear base de datos.
Selecciona Iniciar en modo de prueba con una regla de seguridad como la siguiente:
rules_version = '2'; service cloud.firestore { match /databases/{database}/documents { match /{document=**} { allow read, write; } } }
Después de leer la renuncia de responsabilidad sobre las reglas de seguridad, haz clic en Siguiente.
Define la ubicación en la que se almacenarán tus datos de Cloud Firestore. Puedes aceptar el valor predeterminado o elegir una región cercana.
Haz clic en Habilitar para aprovisionar Firestore.
- Para inicializar Firebase en tu aplicación, debes proporcionar la configuración del proyecto de Firebase de tu aplicación.
- En la consola de Firebase, vaya a Configuración del proyecto .
- En el panel Tus aplicaciones, selecciona tu aplicación.
- En el panel Configuración del SDK, selecciona CDN para cargar las bibliotecas del SDK de Firebase desde la CDN.
- Copia el fragmento en el archivo
index.html
, en la parte inferior de la etiqueta<body>
, y sustituye los valores de los marcadores de posiciónXXXX
.
Instala el SDK de JavaScript de Firebase.
Si aún no tienes un archivo
package.json
, crea uno ejecutando el siguiente comando desde el directoriocallback-translation
:npm init
Instala el paquete
firebase
npm y guárdalo en el archivopackage.json
ejecutando el siguiente comando:npm install firebase
En el directorio
callback-translation
, ejecuta el siguiente comando:firebase init
Selecciona la opción
Configure files for Firebase Hosting and (optionally) set up GitHub Action deploys
.Elige usar un proyecto y escribe su ID.
Acepta
public
como directorio raíz público predeterminado.Elige configurar una aplicación de una sola página.
Saltarse la configuración de compilaciones y despliegues automáticos con GitHub.
En la petición
File public/index.html already exists. Overwrite?
, escribe No.Cambia al directorio
public
:cd public
Desde el directorio
public
, ejecuta el siguiente comando para implementar tu proyecto en tu sitio:firebase deploy --only hosting
En el directorio
public
, ejecuta el siguiente comando:firebase serve
Abre tu aplicación web en la URL local devuelta (normalmente,
http://localhost:5000
).Escribe un texto en inglés y haz clic en Traducir.
Debería aparecer una traducción del texto al francés.
Ahora puede hacer clic en Validar o en Rechazar.
En la base de datos de Firestore, puedes verificar el contenido. Debería ser similar a lo siguiente:
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."
El estado
approved
estrue
ofalse
en función de si valida o rechaza la traducción.- 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.
Elimina la configuración predeterminada de la CLI de gcloud que has añadido durante la configuración del tutorial:
gcloud config unset workflows/location
Elimina el flujo de trabajo que has creado en este tutorial:
gcloud workflows delete WORKFLOW_NAME
Elimina las funciones de Cloud Run que has creado en este tutorial:
gcloud functions delete FUNCTION_NAME
También puedes eliminar funciones de Cloud Run desde la Google Cloud consola.
Desplegar la primera función de Cloud Run
Esta función de Cloud Run inicia la ejecución del flujo de trabajo. El texto que se va a traducir se pasa como parámetro tanto a la función como al flujo de trabajo.
Desplegar la segunda función de Cloud Run
Esta función de Cloud Run envía una solicitud HTTP POST al endpoint de retrollamada creado por el flujo de trabajo y le transfiere un estado de aprobación que refleja si la traducción se ha validado o rechazado.
Desplegar el flujo de trabajo
Un flujo de trabajo se compone de una serie de pasos descritos mediante la sintaxis de Workflows, que se puede escribir en formato YAML o JSON. Esta es la definición del flujo de trabajo. Después de crear un flujo de trabajo, debes implementarlo para que esté disponible.
Crear una aplicación web
Crea una aplicación web que llame a una función de Cloud Functions que inicie la ejecución del flujo de trabajo. La página web se actualiza en tiempo real para mostrar el resultado de la solicitud de traducción.
Añade Firebase a tu aplicación web
En este tutorial, la página HTML, la secuencia de comandos de JavaScript y la hoja de estilo CSS se implementan como recursos estáticos mediante Firebase Hosting, pero se pueden alojar en cualquier lugar y servir de forma local en tu propio ordenador para hacer pruebas.
Crear un proyecto de Firebase
Antes de añadir Firebase a tu aplicación, debes crear un proyecto de Firebase al que conectarla.
Firebase aprovisiona automáticamente los recursos de tu proyecto de Firebase. Cuando se complete el proceso, se le dirigirá a la página de resumen de su proyecto en la consola de Firebase.
Registrar tu aplicación en Firebase
Una vez que tengas un proyecto de Firebase, puedes añadirle tu aplicación web.
Habilitar Cloud Firestore
La aplicación web usa Cloud Firestore para recibir y guardar datos. Deberás habilitar Cloud Firestore.
Añadir el SDK de Firebase e inicializar Firebase
Firebase proporciona bibliotecas de JavaScript para la mayoría de los productos de Firebase. Antes de usar Firebase Hosting, debe añadir los SDKs de Firebase a su aplicación web.
Inicializar y desplegar un proyecto
Para conectar los archivos de tu proyecto local con tu proyecto de Firebase, debes inicializarlo. Después, puedes desplegar tu aplicación web.
Probar la aplicación web de forma local
Firebase Hosting te permite ver y probar los cambios de forma local
e interactuar con los recursos del proyecto de backend emulado. Cuando usas firebase serve
,
tu aplicación interactúa con un backend emulado para tu contenido y configuración de hosting,
pero con tu backend real para todos los demás recursos del proyecto. En este tutorial, puedes usar firebase serve
, pero no se recomienda si vas a hacer pruebas más exhaustivas.
¡Enhorabuena! Has creado un flujo de trabajo de traducción con intervención humana que usa retrollamadas de Workflows.
Limpieza
Si has creado un proyecto para este tutorial, elimínalo. Si has usado un proyecto y quieres conservarlo sin los cambios que se han añadido en este tutorial, elimina los recursos creados para el tutorial.
Eliminar el proyecto
La forma más fácil de evitar que te cobren es eliminar el proyecto que has creado para el tutorial.
Para ello, sigue las instrucciones que aparecen a continuación: