En este instructivo, se muestra cómo crear un flujo de trabajo de traducción que espere tu entrada (la interacción humana) y que conecte una base de datos de Firestore, dos Cloud Functions, la API de Cloud Translation y una página web que use el SDK de Firebase para actualizar en tiempo real.
Con Workflows, puedes admitir un extremo de devolución de llamada (o webhook) que espera a que las solicitudes HTTP lleguen a ese extremo y reanuda la ejecución del flujo de trabajo más adelante. En este caso, el flujo de trabajo espera a que la entrada rechace o valide la traducción de algún texto, pero también podría esperar un proceso externo. Para obtener más información, consulta Espera con devoluciones de llamada.
Arquitectura
En este instructivo, se crea una app web que te permite hacer lo siguiente:
- En la página web de traducción, ingresa el texto que deseas traducir del inglés al francés. Haz clic en Traducir.
- Desde la página web, se llama a una función de Cloud Functions que inicia la ejecución del flujo de trabajo. El texto que se traducirá se pasa como parámetro a la función y al flujo de trabajo.
- El texto se guarda en una base de datos de Cloud Firestore. API de Cloud Translation. La traducción que se muestra se almacena en la base de datos. La app web se implementa mediante Firebase Hosting y se actualiza en tiempo real para mostrar el texto traducido.
- El paso
create_callback
del flujo de trabajo crea una URL de extremo de devolución de llamada 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 ahora está en pausa y espera una solicitud HTTP POST explícita a la URL del extremo de devolución de llamada.
- Puedes validar o rechazar la traducción. Cuando haces clic en un botón, se llama a una segunda Cloud Function que, a su vez, llama al extremo de devolución de llamada que creó el flujo de trabajo y pasa el estado de aprobación.
El flujo de trabajo reanuda su ejecución y guarda un estado de aprobación de
true
ofalse
en la base de datos de Firestore.
En este diagrama, se proporciona una descripción general del proceso:
Objetivos
- Implementar una app web
- Crear una base de datos de Firestore para almacenar solicitudes de traducción
- Implementar Cloud Functions para ejecutar el flujo de trabajo
- Implementar y ejecutar un flujo de trabajo para organizar todo el proceso
Costos
En este documento, usarás los siguientes componentes facturables de Google Cloud:
Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.
Antes de comenzar
Es posible que las restricciones de seguridad que define tu organización no te permitan completar los siguientes pasos. Para obtener información sobre la solución de problemas, consulta Desarrolla aplicaciones en un entorno de Google Cloud restringido.
- Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
- Instala Google Cloud CLI.
-
Para inicializar la CLI de gcloud, ejecuta el siguiente comando:
gcloud init
-
Crea o selecciona un proyecto de Google Cloud.
-
Crea un proyecto de Google Cloud:
gcloud projects create PROJECT_ID
Reemplaza
PROJECT_ID
por un nombre para el proyecto de Google Cloud que estás creando. -
Selecciona el proyecto de Google Cloud que creaste:
gcloud config set project PROJECT_ID
Reemplaza
PROJECT_ID
por el nombre del proyecto de Google Cloud.
-
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Habilita las APIs de App Engine, Cloud Build, Cloud Functions, Firestore, Translation, and Workflows :
gcloud services enable appengine.googleapis.com
cloudbuild.googleapis.com cloudfunctions.googleapis.com firestore.googleapis.com translate.googleapis.com workflows.googleapis.com - Instala Google Cloud CLI.
-
Para inicializar la CLI de gcloud, ejecuta el siguiente comando:
gcloud init
-
Crea o selecciona un proyecto de Google Cloud.
-
Crea un proyecto de Google Cloud:
gcloud projects create PROJECT_ID
Reemplaza
PROJECT_ID
por un nombre para el proyecto de Google Cloud que estás creando. -
Selecciona el proyecto de Google Cloud que creaste:
gcloud config set project PROJECT_ID
Reemplaza
PROJECT_ID
por el nombre del proyecto de Google Cloud.
-
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Habilita las APIs de App Engine, Cloud Build, Cloud Functions, Firestore, Translation, and Workflows :
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
- Accede con tu cuenta:
gcloud auth login
- Configura el ID del proyecto y la ubicación predeterminada que se usa en este instructivo:
export GOOGLE_CLOUD_PROJECT=PROJECT_ID export REGION=REGION gcloud config set workflows/location ${REGION}
Reemplaza lo siguiente:
PROJECT_ID
: tu ID del proyecto de Google Cloud. Puedes encontrar el ID del proyecto en la página Te damos la bienvenida de la consola de Google Cloud.REGION
: Es la ubicación de Workflows compatible que elijas.
Implementa la primera Cloud Function
Esta Cloud Function inicia la ejecución del flujo de trabajo. El texto que se traducirá se pasa como parámetro a la función y al flujo de trabajo.
Crea un directorio llamado
callback-translation
con subdirectorios llamadosinvokeTranslationWorkflow
,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 de archivo
index.js
que contenga el siguiente código de Node.js:Crea un archivo de texto con el nombre de archivo
package.json
que contenga los siguientes metadatosnpm
:Implementa la función con un activador HTTP y permite el acceso sin autenticación:
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 Cloud Functions en la consola de Google Cloud para implementar la función.
Una vez que se implementa la función, puedes confirmar la propiedad
httpsTrigger.url
:gcloud functions describe invokeTranslationWorkflow
Toma nota de la URL que se muestra para que puedas usarla en un paso posterior.
Implementa la segunda Cloud Function
Esta Cloud Function realiza una solicitud HTTP POST al extremo de devolución de llamada que crea el flujo de trabajo y pasa un estado de aprobación que refleja si la traducción se validó o se rechazó.
Cambia al directorio
translationCallbackCall
:cd ../translationCallbackCall
Crea un archivo de texto con el nombre de archivo
index.js
que contenga el siguiente código de Node.js:Crea un archivo de texto con el nombre de archivo
package.json
que contenga los siguientes metadatosnpm
:Implementa la función con un activador HTTP y permite el acceso sin autenticación:
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 Cloud Functions en la consola de Google Cloud para implementar la función.
Una vez que se implementa la función, puedes confirmar la propiedad
httpsTrigger.url
:gcloud functions describe translationCallbackCall
Toma nota de la URL que se muestra para que puedas usarla en un paso posterior.
Implementa el flujo de trabajo
Un flujo de trabajo está compuesto por una serie de pasos descritos con la sintaxis de Workflows, que se pueden 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 para su ejecución.
Cambia al directorio
callback-translation
:cd ..
Crea un archivo de texto con el nombre de archivo
translation-validation.yaml
y con 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
Crea tu app web
Crear una app web que llame a una Cloud Function 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.
Cambia al directorio
public
:cd public
Crea un archivo de texto con el nombre de archivo
index.html
que contenga el siguiente lenguaje de marcado HTML. En un paso posterior, modificarás el archivoindex.html
y agregarás las secuencias de comandos del SDK de Firebase.Crea un archivo de texto con el nombre de archivo
script.js
que contenga el siguiente código JavaScript:Edita el archivo
script.js
y reemplaza los marcadores de posiciónUPDATE_ME
por las URLs de Cloud Functions que anotaste antes.En el método
translateBtn.addEventListener
, reemplazaconst fnUrl = UPDATE_ME;
por lo siguiente:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/invokeTranslationWorkflow";
En la función
callCallbackUrl
, reemplazaconst fnUrl = UPDATE_ME;
por lo siguiente:
const fnUrl = "https://REGION-PROJECT_ID.cloudfunctions.net/translationCallbackCall";
Crea un archivo de texto con el nombre de archivo
style.css
que contenga los siguientes estilos en cascada:
Agregue Firebase a su aplicación web
En este instructivo, la página HTML, la secuencia de comandos de JavaScript y la hoja de estilo de CSS se implementan como recursos estáticos con Firebase Hosting, pero se pueden alojar en cualquier lugar y entregarse de forma local en tu propia máquina para realizar pruebas.
Crea un proyecto de Firebase
Antes de que puedas agregar Firebase a tu app, debes crear un proyecto de Firebase y conectarlo a ella.
-
En Firebase console, haz clic en Crear un proyecto y, luego, selecciona tu proyecto de Google Cloud existente en el menú desplegable para agregar recursos de Firebase a ese proyecto.
-
Haz clic en Continuar hasta que veas la opción para agregar Firebase.
-
Omite la configuración de Google Analytics para tu proyecto.
-
Haz clic en Agregar Firebase:
Firebase aprovisiona los recursos para tu proyecto de forma automática. Cuando finalice, verás la página de descripción general del proyecto en Firebase console.
Registra tu app en Firebase
Cuando tengas un proyecto de Firebase, podrás agregarle tu app web.
En el centro de la página de descripción general del proyecto, haz clic en el ícono de Web (</>) para iniciar el flujo de trabajo de configuración.
Ingresa un sobrenombre para la app.
Solo tú podrás verlo en Firebase console.
Omite la configuración de Firebase Hosting por ahora.
Haz clic en Registrar app y ve a la consola.
Habilite Cloud Firestore
La aplicación web usa Cloud Firestore para recibir y guardar datos. Deberás habilitar Cloud Firestore.
En la sección Compilación de Firebase console, haz clic en Base de datos de Firestore.
(es posible que primero debas expandir el panel de navegación izquierdo para ver la sección Build).
En el panel Cloud Firestore, haz clic en Crear base de datos.
Selecciona Comenzar 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; } } }
Haz clic en Siguiente después de leer la renuncia de responsabilidad sobre las reglas de seguridad.
Configura la ubicación en la que se almacenan tus datos de Cloud Firestore. Puedes aceptar el valor predeterminado o elegir una región cercana.
Haz clic en Habilitar para aprovisionar Firestore.
Agrega el SDK de Firebase y, luego, inicializa Firebase
Firebase proporciona bibliotecas de JavaScript para la mayoría de los productos de Firebase. Antes de usar Firebase Hosting, debes agregar los SDK de Firebase a tu app web.
- Para inicializar Firebase en tu app, debes proporcionar la configuración del proyecto de Firebase de tu app.
- En Firebase console, ve a Configuración del proyecto .
- En el panel Tus apps, selecciona tu app.
- En el panel Configuración del SDK, selecciona CDN para cargar las bibliotecas del SDK de Firebase desde la CDN.
- Copia el fragmento en tu archivo
index.html
en la parte inferior de la etiqueta<body>
y reemplaza los valores del marcador de posiciónXXXX
.
Instala el SDK de Firebase JavaScript.
Si aún no tienes un archivo
package.json
, ejecuta el siguiente comando desde el directoriocallback-translation
para crear uno:npm init
Instala el paquete de npm
firebase
y guárdalo en tu archivopackage.json
ejecutando lo siguiente:npm install --save firebase
Inicializa y, luego, implementa tu proyecto
Para conectar los archivos del proyecto local al proyecto de Firebase, debes inicializar el proyecto. Luego, puedes implementar tu app web.
Desde 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 existente y, luego, ingresa el ID del proyecto.
Acepta
public
como el directorio raíz público predeterminado.Opta por configurar una app de una sola página.
Omite la configuración de implementaciones y compilaciones automáticas con GitHub.
En el mensaje
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 el proyecto en el sitio:firebase deploy --only hosting
Prueba la app web de manera local
Firebase Hosting te permite ver y probar los cambios de forma local y, además, interactuar con los recursos del proyecto de backend emulado. Cuando usas firebase serve
,
tu app interactúa con un backend emulado para el contenido y la configuración de hosting,
pero con tu backend real para todos los demás recursos del proyecto. Para este instructivo, puedes usar firebase serve
, pero no se recomienda cuando se realizan pruebas más extensas.
Desde el directorio
public
, ejecuta el siguiente comando:firebase serve
Abre la aplicación web en la URL local que se muestra (por lo general,
http://localhost:5000
).Ingresa el texto en inglés y, luego, haz clic en Traducir.
Se debe mostrar una traducción del texto en francés.
Ahora puedes hacer clic en Validar o Rechazar.
En la base de datos de Firestore, puedes verificar el contenido. Debería parecerse 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
, dependiendo de si validas o rechazas la traducción.
¡Felicitaciones! Creaste un flujo de trabajo de traducción con interacción humana que usa devoluciones de llamada de Workflows.
Limpia
Si creaste un proyecto nuevo para este instructivo, bórralo. Si usaste un proyecto existente y deseas conservarlo sin los cambios que se agregaron en este instructivo, borra los recursos creados para el instructivo.
Borra el proyecto
La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.
Para borrar el proyecto, haz lo siguiente:
- En la consola de Google Cloud, ve a la página Administrar recursos.
- En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
- En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.
Elimina recursos de instructivos
Quita la configuración predeterminada de gcloud CLI que agregaste durante la configuración del instructivo:
gcloud config unset workflows/location
Borra el flujo de trabajo que se creó en este instructivo:
gcloud workflows delete WORKFLOW_NAME
Borra las funciones de Cloud Functions que creaste en este instructivo:
gcloud functions delete FUNCTION_NAME
También puedes borrar funciones de Cloud Functions en la consola de Google Cloud.