Tu primera función: 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 función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • Una función en segundo plano que usas para controlar eventos de tu infraestructura de 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.

Estructura de la guía

  1. Crea un proyecto de GCP mediante el SDK de Cloud
  2. Crea una función
  3. Especifica dependencias
  4. Implementa la función
  5. Prueba la función

Crea un proyecto de GCP mediante el SDK de Cloud

  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 Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyecto

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

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

    Habilita las API

  5. Instala e inicializa el SDK de Cloud.
  6. Instala y actualiza componentes de gcloud:
    gcloud components update
  7. 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 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 siguiente contenido:

    const escapeHtml = require('escape-html');
    
    /**
     * HTTP Cloud Function.
     *
     * @param {Object} req Cloud Function request context.
     *                     More info: https://expressjs.com/en/api.html#req
     * @param {Object} res Cloud Function response context.
     *                     More info: https://expressjs.com/en/api.html#res
     */
    exports.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.

Especifica dependencias

Las dependencias en Node.js se administran con npm y se expresan en un archivo de metadatos llamado package.json.

  1. Crea un archivo package.json en el directorio helloworld de forma manual o mediante de la ejecución del comando:

    npm init
    
  2. Agrega la dependencia de la función; en este caso, el paquete escape-html a tu archivo package.json de forma manual o mediante la ejecución del comando:

    npm install escape-html
    

    Tu archivo package.json debe contener una sección como la siguiente:

    {
      ...
      "dependencies": {
        "escape-html": "^1.0.3"
      }
      ...
    }
    

    Si creas tu archivo package.json de forma manual, puedes copiar en él el siguiente contenido:

    {
      "name": "nodejs-docs-samples-functions-hello-world",
      "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": ">=12.0.0"
      },
      "scripts": {
        "unit-test": "mocha test/index.test.js test/*unit*test.js test/*integration*test.js --timeout=2000 --exit",
        "system-test": "mocha test/*system*test.js --timeout=600000 --exit",
        "all-test": "npm run unit-test && npm run system-test",
        "test": "npm -- run all-test"
      },
      "dependencies": {
        "@google-cloud/debug-agent": "^5.0.0",
        "escape-html": "^1.0.3"
      },
      "devDependencies": {
        "@google-cloud/functions-framework": "^1.1.1",
        "@google-cloud/pubsub": "^2.0.0",
        "@google-cloud/storage": "^5.0.0",
        "child-process-promise": "^2.2.1",
        "express": "^4.16.3",
        "mocha": "^8.0.0",
        "moment": "^2.24.0",
        "promise-retry": "^2.0.0",
        "proxyquire": "^2.1.0",
        "request": "^2.88.0",
        "requestretry": "^5.0.0",
        "sinon": "^10.0.0",
        "supertest": "^6.0.0",
        "uuid": "^8.0.0"
      }
    }
    

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 nodejs12 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Omítela para exigir autenticación.

Prueba la función

  1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala mediante la ejecución del 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!”

Ver registros

Usa la herramienta de línea de comandos

Los registros de Cloud Functions se pueden ver en la IU de Cloud Logging y mediante la herramienta de línea de comandos de gcloud.

Para visualizar los registros de tu función con la herramienta 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 Cloud Console.