Créer et déployer une fonction Cloud HTTP avec Node.js

Créer et déployer une fonction Cloud HTTP à l'aide de Node.js

Ce document vous accompagne tout au long du processus de création d'une fonction HTTP Cloud Functions simple. Il s'agit de l'un des deux types de fonctions Cloud:

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

Pour en savoir plus, consultez les sections Écrire des fonctions HTTP et Écrire des fonctions pilotées par des événements.

Avant de commencer

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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

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

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

   Enable the APIs

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

   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

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

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging APIs.

   Enable the APIs

8. Installez et initialisez gcloud CLI.
Remarque : Vous avez besoin d'une invite de commande ? Vous pouvez utiliser Google Cloud Shell. Google Cloud Shell est un environnement de ligne de commande qui inclut Google Cloud CLI. Vous n'avez donc pas besoin de l'installer. Google Cloud CLI est également préinstallé sur les machines virtuelles Google Compute Engine.
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');
   
   // Register an HTTP function with the Functions Framework that will be executed
   // when you make an HTTP request to the deployed function's endpoint.
   functions.http('helloGET', (req, res) => {
     res.send('Hello World!');
   });

   Cet exemple de fonction renvoie un salut "Hello World!" à toutes les requêtes.

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. Vous pouvez créer ce fichier manuellement ou à l'aide de la commande npm.

• Pour créer votre fichier package.json à l'aide de la commande npm:

  1. Exécutez la commande npm init à partir du répertoire helloworld. Appuyez sur Enter pour accepter la réponse par défaut à ses questions.

     npm init
     

  2. Modifiez le fichier package.json pour ajouter une dépendance du framework des fonctions:

     "dependencies": {
       "@google-cloud/functions-framework": "^3.1.0"
     }
     

• Si vous préférez créer manuellement votre fichier package.json, copiez-y le contenu suivant:

{
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "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": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^8.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

De nombreuses bibliothèques clientes Node.js sont disponibles pour une utilisation avec les produits Google Cloud et peuvent être installées en tant que dépendances.

En savoir plus : Pour obtenir plus d'informations, consultez la page Spécifier des dépendances.

Créer et tester votre fonction localement

Pour tester votre fonction localement avant de la déployer, vous devez installer le framework des fonctions localement, puis l'exécuter.

1. Exécutez la commande suivante à partir du répertoire helloworld pour installer le framework des fonctions sur votre ordinateur local:

   npm install @google-cloud/functions-framework
   

2. Exécutez cette commande à partir du répertoire helloworld pour exécuter votre fonction localement:

   npx @google-cloud/functions-framework --target=helloGET
   

3. Testez votre fonction en accédant à http://localhost:8080 dans un navigateur ou en exécutant curl localhost:8080 à partir d'une autre fenêtre.

   Pour en savoir plus, consultez la section Envoyer des requêtes aux fonctions locales.

La fonction renvoie le message "Hello World!".

Déployer la fonction

Pour déployer votre fonction, exécutez la commande gcloud functions deploy dans le répertoire helloworld:

gcloud functions deploy hello-node-function \
  --gen2 \
  --runtime=nodejs20 \
  --region=REGION \
  --source=. \
  --entry-point=helloGET \
  --trigger-http \
  --allow-unauthenticated

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous souhaitez déployer votre fonction (par exemple, us-west1).

Votre exemple de fonction est déployé avec l'environnement d'exécution nodejs20 dans la région choisie.

L'option facultative --allow-unauthenticated vous permet d'accéder à votre fonction sans authentification.

En savoir plus : Pour obtenir plus d'informations, consultez la page Déployer des fonctions Cloud Functions.

Tester la fonction déployée

1. Une fois la fonction déployée, notez la propriété uri à partir du résultat de la commande gcloud functions deploy ou récupérez-la à l'aide de la commande suivante:

     gcloud functions describe hello-node-function \
       --region=REGION
   

   Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

2. Accédez à cette URL dans votre navigateur ou à l'aide de la commande curl suivante:

   curl FUNCTION_URL
   

   Remplacez FUNCTION_URL par la propriété uri que vous venez de récupérer.

   La fonction renvoie un message "Hello World!".

Afficher les journaux de votre fonction

Afficher les journaux à l'aide de l'outil de ligne de commande

Vous pouvez consulter les journaux de votre fonction à l'aide de l'interface utilisateur Cloud Logging ou de Google Cloud CLI.

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

    gcloud functions logs read \
      --gen2 \
      --region=REGION \
      --limit=10 \
      hello-node-function

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

Le résultat se présente comme suit :

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:42:24.956
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:42:01.692
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:47.711
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:46.542
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:27.390
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

Remarque : Un léger délai peut s'écouler entre l'affichage des entrées de journal dans Cloud Logging.

Afficher les journaux à l'aide du tableau de bord de journalisation

Pour afficher les journaux de votre fonction à l'aide du tableau de bord de journalisation, ouvrez la page Page de présentation de Cloud Functions et cliquez sur le nom de votre fonction dans la liste, puis sur l'onglet Journaux.

En savoir plus : Pour obtenir plus d'informations, accédez à la page Écrire, afficher des journaux et y répondre.