Crea e implementa una función de Cloud Run de HTTP con Node.js (1ª gen.)

En esta guía, aprenderás a escribir una función de Cloud Run con el entorno de ejecución de Node.js. Existen dos tipos de funciones de Cloud Run:

• El primero, una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
• El segundo, una función basada en eventos que se usa para controlar eventos de la infraestructura de nube, como mensajes en un tema de Pub/Sub o cambios en un bucket de Cloud Storage.

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Más información: Para obtener más detalles, lee sobre las funciones de HTTP y las funciones basadas en eventos.

Antes de comenzar

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.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

1. Instala e inicializa la gcloud CLI.
2. Instala y actualiza los componentes de gcloud:

   gcloud components update

Nota: ¿Necesitas un símbolo del sistema? Puedes usar Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que incluye la Google Cloud CLI, por lo que no es necesario que la instales. La Google Cloud CLI también viene preinstalada en las máquinas virtuales de Google Compute Engine.
3. Prepara tu entorno de desarrollo.

   Ir a la guía de configuración de Node.js

Crea una función

1. Crea un directorio en tu sistema local para el código de la función:

   Linux o MacOS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Crea un archivo index.js en el directorio helloworld con el contenido siguiente:

   const functions = require('@google-cloud/functions-framework');
   const escapeHtml = require('escape-html');
   
   /**
    * Responds to an HTTP request using data from the request body parsed according
    * to the "content-type" header.
    *
    * @param {Object} req Cloud Function request context.
    * @param {Object} res Cloud Function response context.
    */
   functions.http('helloHttp', (req, res) => {
     res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
   });

   Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o “Hello World!” cuando no se proporciona ningún nombre.

   Nota: Cloud Run Functions busca funciones que se puedan implementar en index.js de forma predeterminada. Usa la marca --source cuando implementes la función a través de gcloud para especificar un directorio diferente que contenga un archivo index.js.

Especifica las dependencias

Las dependencias en Node.js se almacenan en un archivo llamado package.json. Puedes crear este archivo de forma manual o con el comando npm.

• Para crear tu archivo de dependencia package.json con npm, ejecuta los comandos siguientes:

  npm init
  npm install c8 gaxios mocha sinon supertest wait-port --save-dev
  npm install @google-cloud/functions-framework escape-html
  

• Si prefieres compilar tu archivo package.json de forma manual, crea un archivo package.json en el directorio helloworld con el contenido siguiente:

  {
    "name": "nodejs-docs-samples-functions-hello-world-http",
    "version": "0.0.1",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "unit-test": "c8 mocha -p -j 2 test/index.test.js test/*unit*test.js test/*integration*test.js --timeout=6000 --exit",
      "system-test": "c8 mocha -p -j 2 test/*system*test.js --timeout=600000 --exit",
      "all-test": "npm run unit-test && npm run system-test",
      "test": "npm -- run unit-test"
    },
    "dependencies": {
      "@google-cloud/functions-framework": "^3.1.0",
      "escape-html": "^1.0.3"
    },
    "devDependencies": {
      "c8": "^10.0.0",
      "gaxios": "^6.0.0",
      "mocha": "^10.0.0",
      "sinon": "^18.0.0",
      "supertest": "^7.0.0",
      "wait-port": "^1.0.4"
    }
  }
  

  Nota: Las bibliotecas cliente de Node.js están disponibles para una variedad de productos de Google Cloud y se pueden instalar como dependencias. Consulta la lista aquí.
Más información: Para obtener más detalles, lee acerca de cómo especificar dependencias.

Implementa la función

Ejecuta el comando siguiente en el directorio helloworld para implementar la función con un activador HTTP:

gcloud functions deploy helloHttp --no-gen2 --runtime nodejs22 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated permite acceder a la función sin autenticación. Para solicitar la autenticación, omite la marca.

Más información: Para obtener más detalles, lee acerca de la implementación de Cloud Run Functions.

Prueba la función

1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el comando siguiente:

   gcloud functions describe helloHttp
   

   Se verá de la siguiente manera:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp

2. Visita esta URL en tu navegador. Deberías ver el mensaje “Hello, World!”.

   Intenta pasar un nombre en la solicitud HTTP, por ejemplo, mediante la siguiente URL:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

   Deberías ver el mensaje “Hello, NAME!”.

Visualiza registros

Los registros de Cloud Run Functions pueden consultar a través de la Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de la función con la gcloud CLI, usa el comando logs read seguido del nombre de la función:

gcloud functions logs read helloHttp

El resultado debe parecerse al siguiente:

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Nota: Por lo general, hay una demora ligera entre el momento en que se crean las entradas de registro y el momento en que se muestran en Cloud Logging.

Usa el panel de Logging

También puedes ver los registros de Cloud Run Functions desde la consola deGoogle Cloud .

Más información: Para obtener más detalles, lee sobre cómo escribir y visualizar los registros, además de responder a ellos.