Créer et déployer une fonction Cloud Run HTTP à l'aide de Node.js (1re génération)

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud Run à l'aide de l'environnement d'exécution Node.js. Il existe deux types de fonctions Cloud Run :

  • Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
  • Les fonctions déclenchées par des événements, qui vous permettent de gérer les événements depuis votre infrastructure cloud tels que les messages sur un sujet Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

L'exemple montre comment créer une fonction HTTP simple.

Avant de commencer

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

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

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Functions and Cloud Build APIs.

    Enable the APIs

    5.

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

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Functions and Cloud Build APIs.

    Enable the APIs

    8.
  8. Installez et initialisez la gcloud CLI.
  9. Mettez à jour et installez les composants gcloud : 
    gcloud components update
  10. Préparez votre environnement de développement.

    Accéder au guide de configuration de Node.js

Créer une fonction

  1. Créez un répertoire sur votre système local pour le code de fonction :

    Linux ou Mac OS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

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

  2. Créez un fichier index.js dans le répertoire helloworld avec le contenu suivant :

    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')}!`);
});

    Cet exemple de fonction utilise un nom fourni dans la requête HTTP et renvoie un message d'accueil. Lorsqu'aucun nom n'est fourni, il renvoie le message "Hello World!".

Spécifier des dépendances

Dans Node.js, les dépendances sont stockées dans un fichier appelé package.json. Vous pouvez créer ce fichier manuellement ou à l'aide de la commande npm.

  • Pour créer votre fichier de dépendance package.json à l'aide de npm, exécutez les commandes suivantes:

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

  • Si vous préférez créer votre fichier package.json manuellement, créez un fichier package.json dans le répertoire helloworld avec le contenu suivant:

    {
  "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"
  }
}

Déployer la fonction

Pour déployer la fonction avec un déclencheur HTTP, exécutez la commande suivante dans le répertoire helloworld :

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

L'option --allow-unauthenticated vous permet d'accéder à la fonction sans authentification. Pour exiger une authentification, omettez cette option.

Tester la fonction

  1. Une fois le déploiement de la fonction terminé, notez la propriété httpsTrigger.url ou recherchez-la à l'aide de la commande suivante :

    gcloud functions describe helloHttp

    La fonction devrait ressembler à ceci :

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

  2. Accédez à cette URL dans votre navigateur. Un message de type "Hello World!" doit s'afficher.

    Essayez de transmettre un nom dans la requête HTTP, par exemple à l'aide de l'URL suivante :

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

    Le message "Hello NAME!" doit s'afficher.

Afficher les journaux

Les journaux Cloud Run Functions sont visibles à l'aide de Google Cloud CLI et de l'interface utilisateur de Cloud Logging.

Utiliser l'outil de ligne de commande

Pour afficher les journaux de votre fonction à l'aide de gcloud CLI, exécutez la commande logs read suivie du nom de la fonction :

gcloud functions logs read helloHttp

Le résultat doit ressembler à ceci :

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

Utiliser le tableau de bord Logging

Vous pouvez également consulter les journaux Cloud Run Functions depuis la console Google Cloud.