Votre première fonction : Node.js

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

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

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

Structure du guide

  1. Créer un projet GCP avec le SDK Cloud
  2. Créer une fonction
  3. Spécifier des dépendances
  4. Déployer votre fonction
  5. Tester la fonction

Créer un projet GCP avec le SDK Cloud

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activer les API Cloud Functions and Cloud Build.

    Activer les API

  5. Installez et initialisez le SDK Cloud.
  6. Mettez à jour et installez les composants gcloud :
    gcloud components update
  7. 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 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')}!`);
    };

    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 gérées avec npm et exprimées dans un fichier de métadonnées appelé package.json.

  1. Créez un fichier package.json dans le répertoire helloworld, manuellement ou à l'aide de la commande suivante :

    npm init
    
  2. Ajoutez la dépendance de la fonction (dans ce cas le package escape-html) au fichier package.json, manuellement ou à l'aide de la commande suivante :

    npm install escape-html
    

    Le fichier package.json doit contenir une section comme suit :

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

    Si vous créez votre fichier package.json manuellement, vous pouvez y copier le contenu suivant :

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

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 --runtime nodejs12 --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
    

    Elle devrait se présenter comme 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

Utiliser l'outil de ligne de commande

Les journaux des fonctions Cloud sont visibles dans l'UI de Cloud Logging et via l'outil de ligne de commande gcloud.

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

gcloud functions logs read helloHttp

La sortie 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 des fonctions Cloud Functions depuis Cloud Console.