Premiers pas : écrire, tester et déployer vos premières fonctions


Pour commencer à utiliser Cloud Functions, suivez ce tutoriel, qui commence par les tâches de configuration requises, puis explique comment créer, tester et déployer deux fonctions associées :

  • Une fonction "add message" qui expose une URL qui accepte une valeur textuelle et l'écrit dans Cloud Firestore.
  • Une fonction "mettre en majuscules" qui se déclenche lors d'une écriture Cloud Firestore et transforme le texte en majuscules.

Nous avons choisi Cloud Firestore et des fonctions JavaScript déclenchées par HTTP pour cet exemple, en partie parce que ces déclencheurs en arrière-plan peuvent être testés de manière approfondie via Firebase Local Emulator Suite. Cet ensemble d'outils est également compatible avec Realtime Database, Pub/Sub, Auth et les déclencheurs appelables HTTP. D'autres types de déclencheurs en arrière-plan, tels que Remote Config, TestLab et les déclencheurs Analytics, peuvent tous être testés de manière interactive à l'aide d'ensembles d'outils non décrits sur cette page.

Les sections suivantes de ce tutoriel décrivent les étapes requises pour compiler, tester et déployer l'exemple. Si vous préférez simplement exécuter le code et l'inspecter, passez à la section Examiner l'exemple de code complet.

Créer un projet Firebase

  1. Dans la console Firebase, cliquez sur Ajouter un projet.

    • Pour ajouter des ressources Firebase à un projet Google Cloud existant, saisissez son nom ou sélectionnez-le dans le menu déroulant.

    • Pour créer un projet, saisissez son nom. Vous pouvez également modifier l'ID de projet affiché sous le nom du projet.

  2. Si vous y êtes invité, lisez et acceptez les Conditions d'utilisation de Firebase.

  3. Cliquez sur Continuer.

  4. (Facultatif) Configurez Google Analytics pour votre projet afin de bénéficier d'une expérience optimale avec l'un des produits Firebase suivants:

    Sélectionnez un compte Google Analytics existant ou créez-en un.

    Si vous créez un compte, sélectionnez votre zone géographique Analytics pour les rapports, puis acceptez les paramètres de partage des données et les conditions d'utilisation de Google Analytics pour votre projet.

  5. Cliquez sur Créer un projet (ou sur Ajouter Firebase si vous utilisez un projet Google Cloud existant).

Firebase provisionne automatiquement des ressources pour votre projet Firebase. Une fois le processus terminé, vous êtes redirigé vers la page de présentation de votre projet Firebase dans la console Firebase.

Configurer Node.js et la CLI Firebase

Vous aurez besoin d'un environnement Node.js pour écrire des fonctions et de la CLI Firebase pour les déployer dans l'environnement d'exécution Cloud Functions. Pour installer Node.js et npm, il est recommandé d'utiliser l'outil Node Version Manager.

Une fois Node.js et npm installés, installez la CLI Firebase à l'aide de la méthode de votre choix. Pour installer la CLI via npm, utilisez:

npm install -g firebase-tools

Cette action installe la commande Firebase disponible dans le monde entier. Si la commande échoue, vous devrez peut-être modifier les autorisations npm. Pour effectuer la mise à jour vers la dernière version de firebase-tools, réexécutez la même commande.

Initialisez votre projet

Lorsque vous initialisez le SDK Firebase pour Cloud Functions, vous créez un projet vide contenant des dépendances et quelques exemples de code minimal, et vous choisissez TypeScript ou JavaScript pour composer des fonctions. Pour les besoins de ce tutoriel, vous devrez également initialiser Cloud Firestore.

Pour initialiser votre projet :

  1. Exécutez firebase login pour vous connecter via le navigateur et authentifier la CLI Firebase.
  2. Accédez au répertoire de votre projet Firebase.
  3. Exécutez firebase init firestore. Pour ce tutoriel, vous pouvez accepter les valeurs par défaut lorsque vous êtes invité à spécifier des règles Firestore et des fichiers d'index. Si vous n'avez pas encore utilisé Cloud Firestore dans ce projet, vous devez également sélectionner un mode de démarrage et un emplacement pour Firestore, comme décrit dans la section Premiers pas avec Cloud Firestore.
  4. Exécutez firebase init functions. La CLI vous invite à choisir un codebase existant ou à en initialiser et à en nommer un. Lorsque vous débutez, un codebase unique à l'emplacement par défaut est suffisant. Par la suite, à mesure que votre implémentation se développera, vous souhaiterez peut-être organiser les fonctions dans du codebase.

  5. La CLI propose deux options de prise en charge des langues :

    Pour ce tutoriel, sélectionnez JavaScript.

  6. La CLI vous permet d'installer des dépendances avec npm. Vous pouvez refuser cette option si vous souhaitez gérer les dépendances d'une autre manière. Toutefois, si vous le faites, vous devrez exécuter npm install avant d'émuler ou de déployer vos fonctions.

Une fois ces commandes terminées, la structure de votre projet se présente comme suit:

myproject
 +- .firebaserc    # Hidden file that helps you quickly switch between
 |                 # projects with `firebase use`
 |
 +- firebase.json  # Describes properties for your project
 |
 +- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # main source file for your Cloud Functions code
      |
      +- node_modules/ # directory where your dependencies (declared in
                       # package.json) are installed

Le fichier package.json créé lors de l'initialisation contient une clé importante: "engines": {"node": "16"}. Cette valeur spécifie votre version de Node.js pour l'écriture et le déploiement de fonctions. Vous pouvez sélectionner d'autres versions compatibles.

Importer les modules requis et initialiser une application

Une fois les tâches de configuration terminées, vous pouvez ouvrir le répertoire source et commencer à ajouter du code, comme décrit dans les sections suivantes. Pour cet exemple, votre projet doit importer les modules Cloud Functions et SDK Admin à l'aide des instructions de nœud require. Ajoutez des lignes comme celles-ci à votre fichier index.js :

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();
index.js

Ces lignes chargent les modules firebase-functions et firebase-admin, et initialisent une instance d'application admin à partir de laquelle des modifications Cloud Firestore peuvent être apportées. Lorsque la prise en charge du SDK Admin est disponible, comme c'est le cas pour FCM, Authentication et Firebase Realtime Database, il offre un moyen efficace d'intégrer Firebase à l'aide de Cloud Functions.

La CLI Firebase installe automatiquement les SDK Firebase et Firebase pour les modules Node Cloud Functions lorsque vous initialisez votre projet. Pour ajouter des bibliothèques tierces à votre projet, vous pouvez modifier package.json et exécuter npm install. Pour en savoir plus, consultez la section Gérer les dépendances.

Ajouter la fonction addMessage()

Pour la fonction addMessage(), ajoutez les lignes suivantes à index.js:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});
index.js

La fonction addMessage() est un point de terminaison HTTP. Toute requête envoyée au point de terminaison génère des objets Request et Response de style ExpressJS transmis au rappel onRequest().

Les fonctions HTTP sont synchrones (comme les fonctions appelables). Vous devez donc envoyer une réponse aussi rapidement que possible et différer le travail à l'aide de Cloud Firestore. La fonction HTTP addMessage() transmet une valeur textuelle au point de terminaison HTTP et l'insère dans la base de données sous le chemin /messages/:documentId/original.

Ajouter la fonction makeUppercase()

Pour la fonction makeUppercase(), ajoutez les lignes suivantes à index.js:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

La fonction makeUppercase() s'exécute lorsque Cloud Firestore est écrit. La fonction ref.set définit le document à écouter. Pour des raisons de performances, vous devez être aussi précis que possible.

Les accolades (par exemple, {documentId}) entourent les "paramètres", des caractères génériques qui exposent leurs données correspondantes dans le rappel.

Cloud Firestore déclenche le rappel onCreate() chaque fois que de nouveaux messages sont ajoutés.

Les fonctions basées sur les événements telles que les événements Cloud Firestore sont asynchrones. La fonction de rappel doit renvoyer une null, un objet ou une promesse. Si vous ne renvoyez rien, la fonction expire, signale une erreur et est réessayée. Consultez Sync, Async et Promises.

Émuler l'exécution de vos fonctions

Firebase Local Emulator Suite vous permet de compiler et de tester des applications sur votre ordinateur local au lieu de les déployer dans un projet Firebase. Nous vous recommandons vivement d'effectuer des tests en local pendant le développement, en partie parce qu'ils réduisent le risque d'erreurs de codage susceptibles d'entraîner des coûts dans un environnement de production (par exemple, une boucle infinie).

Pour émuler vos fonctions:

  1. Exécutez firebase emulators:start et recherchez l'URL de Emulator Suite UI dans la sortie. Par défaut, il s'agit de localhost:4000, mais il peut être hébergé sur un autre port de votre machine. Saisissez cette URL dans votre navigateur pour ouvrir Emulator Suite UI.

  2. Vérifiez la sortie de la commande firebase emulators:start pour l'URL de la fonction HTTP addMessage(). Il ressemble à http://localhost:5001/MY_PROJECT/us-central1/addMessage, à l'exception des points suivants:

    1. MY_PROJECT sera remplacé par l'ID de votre projet.
    2. Le port peut être différent sur votre ordinateur local.

  3. Ajoutez la chaîne de requête ?text=uppercaseme à la fin de l'URL de la fonction. L'URL doit ressembler à ceci : http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. Si vous le souhaitez, vous pouvez remplacer le message "uppercaseme" par un message personnalisé.

  4. Créez un message en ouvrant l'URL dans un nouvel onglet de votre navigateur.

  5. Affichez les effets des fonctions dans Emulator Suite UI:

    1. Dans l'onglet Journaux, vous devriez voir de nouveaux journaux indiquant que les fonctions addMessage() et makeUppercase() ont été exécutées :

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Dans l'onglet Firestore, vous devriez voir un document contenant votre message d'origine ainsi que sa version en majuscules (s'il s'agissait à l'origine de "uppercaseme", vous verrez "UPPERCASEME").

Déployer des fonctions dans un environnement de production

Une fois que vos fonctions fonctionnent comme vous le souhaitez dans l'émulateur, vous pouvez les déployer, les tester et les exécuter dans l'environnement de production. N'oubliez pas que pour pouvoir déployer l'environnement d'exécution recommandé Node.js 14, votre projet doit bénéficier du forfait Blaze. Consultez les tarifs de Cloud Functions.

Pour terminer le tutoriel, déployez vos fonctions, puis exécutez addMessage() pour déclencher makeUppercase().

  1. Exécutez la commande suivante pour déployer vos fonctions :

     firebase deploy --only functions

    Après avoir exécuté cette commande, la CLI Firebase affiche l'URL de tous les points de terminaison de fonction HTTP. Dans votre terminal, une ligne semblable à la suivante devrait s'afficher:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage

    L'URL contient votre ID de projet ainsi qu'une région pour la fonction HTTP. Même si vous n'avez pas besoin de vous en préoccuper pour le moment, certaines fonctions HTTP de production doivent spécifier une emplacement pour réduire la latence réseau.

    Si vous rencontrez des erreurs d'accès telles que "Impossible d'autoriser l'accès au projet", essayez de vérifier la création d'alias du projet.

  2. À l'aide de l'URL addMessage() générée par la CLI, ajoutez un paramètre de requête textuelle, puis ouvrez-la dans un navigateur:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo

    La fonction s'exécute et redirige le navigateur vers la console Firebase à l'emplacement de la base de données où la chaîne de texte est stockée. Cet événement d'écriture déclenche makeUppercase(), qui écrit une version en majuscules de la chaîne.

Après avoir déployé et exécuté des fonctions, vous pouvez afficher les journaux dans la console Google Cloud. Si vous devez supprimer des fonctions en développement ou en production, utilisez la CLI Firebase.

En production, vous souhaiterez peut-être optimiser les performances des fonctions et contrôler les coûts en définissant un nombre minimal et maximal d'instances à exécuter. Pour en savoir plus sur ces options d'exécution, consultez la page Contrôler le comportement du scaling.

Examiner l'exemple de code complet

Voici le functions/index.js terminé contenant les fonctions addMessage() et makeUppercase(). Ces fonctions vous permettent de transmettre un paramètre à un point de terminaison HTTP qui écrit une valeur dans Cloud Firestore, puis la transforme en mettant en majuscule tous les caractères de la chaîne.

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });
index.js

Étapes suivantes

Dans cette documentation, vous découvrirez comment gérer les fonctions pour Cloud Functions, ainsi que comment gérer tous les types d'événements compatibles avec Cloud Functions.

Pour en savoir plus sur Cloud Functions, vous pouvez également :