Guía de inicio rápido: Crea e implementa una Cloud Function HTTP con Node.js

Crea e implementa una Cloud Function HTTP con Node.js

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

  • Una es la función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • La otra es una función controlada por eventos que se usa para manejar los eventos de la infraestructura de tu nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

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

Antes de comenzar

  1. 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.

  2. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  4. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

    5.

  5. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  7. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

    8.
  8. Instala e inicializa gcloud CLI
  9. Instala y actualiza componentes de gcloud: 
    gcloud components update
  10. 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 función:

    Linux o Mac OS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

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

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

    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.

Especificar 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 de npm.

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

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

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

    {
  "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": "^8.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "sinon": "^16.0.0",
    "supertest": "^6.0.0",
    "wait-port": "^1.0.4"
  }
}

Implementa la función

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

gcloud functions deploy helloHttp --runtime nodejs20 --trigger-http --allow-unauthenticated

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

Prueba la función

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

    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 los registros

Los registros de Cloud Functions pueden verse con Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de tu función con la CLI de gcloud, 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

Usa el panel de Logging

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