Commencez : écrivez, testez et déployez vos premières fonctions


Pour commencer avec Cloud Functions, essayez de suivre ce didacticiel, qui commence par les tâches de configuration requises et passe par la création, le test et le déploiement de deux fonctions associées :

  • Une fonction "ajouter un message" qui expose une URL qui accepte une valeur de texte et l'écrit dans Cloud Firestore.
  • Une fonction "mettre en majuscule" qui se déclenche sur une écriture Cloud Firestore et transforme le texte en majuscule.

Nous avons choisi Cloud Firestore et les 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 prend également en charge les déclencheurs appelables de base de données en temps réel, PubSub, Auth et HTTP. D'autres types de déclencheurs d'arrière-plan tels que les déclencheurs Remote Config, TestLab et Analytics peuvent tous être testés de manière interactive à l'aide d'ensembles d'outils non décrits dans cette page.

Les sections suivantes de ce didacticiel détaillent les étapes requises pour créer, tester et déployer l'exemple. Si vous préférez simplement exécuter le code et l'inspecter, passez à Review complete sample code .

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 de projet ou sélectionnez-le dans le menu déroulant.

    • Pour créer un nouveau projet, saisissez le nom du projet souhaité. Vous pouvez également éventuellement modifier l'ID du 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, ce qui vous permet d'avoir une expérience optimale avec l'un des produits Firebase suivants :

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

    Si vous créez un nouveau compte, sélectionnez votre emplacement de rapport Analytics , puis acceptez les paramètres de partage de données et les conditions Google Analytics pour votre projet.

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

Firebase fournit automatiquement des ressources pour votre projet Firebase. Une fois le processus terminé, vous serez 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 vous aurez besoin de l'interface de ligne de commande Firebase pour déployer des fonctions dans l'environnement d'exécution Cloud Functions. Pour installer Node.js et npm , Node Version Manager est recommandé.

Une fois que vous avez installé Node.js et npm, installez la CLI Firebase via votre méthode préférée. Pour installer la CLI via npm, utilisez :

npm install -g firebase-tools

Cela installe la commande firebase disponible dans le monde entier. Si la commande échoue, vous devrez peut-être modifier les autorisations npm . Pour mettre à 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 un exemple de code minimal, et vous choisissez TypeScript ou JavaScript pour composer des fonctions. Pour les besoins de ce didacticiel, 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 didacticiel, vous pouvez accepter les valeurs par défaut lorsque vous êtes invité à entrer des règles Firestore et des fichiers d'index. Si vous n'avez pas encore utilisé Cloud Firestore dans ce projet, vous devrez également sélectionner un mode de démarrage et un emplacement pour Firestore, comme décrit dans Premiers pas avec Cloud Firestore .
  4. Exécutez firebase init functions . La CLI vous invite à choisir une base de code existante ou à en initialiser et en nommer une nouvelle. Lorsque vous débutez, une seule base de code à l'emplacement par défaut est suffisante ; plus tard, au fur et à mesure que votre implémentation se développe, vous souhaiterez peut-être organiser les fonctions dans des bases de code .

  5. La CLI vous offre deux options pour la prise en charge de la langue :

    Pour ce didacticiel, sélectionnez JavaScript .

  6. La CLI vous donne la possibilité d'installer des dépendances avec npm. Vous pouvez refuser en toute sécurité si vous souhaitez gérer les dépendances d'une autre manière, mais si vous refusez, vous devrez exécuter npm install avant d'émuler ou de déployer vos fonctions.

Une fois ces commandes exécutées avec succès, la structure de votre projet ressemble à ceci :

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"} . Cela spécifie votre version de Node.js pour écrire et déployer des fonctions. Vous pouvez sélectionner d'autres versions prises en charge .

Importer les modules requis et initialiser une application

Après avoir terminé les tâches de configuration, 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 Admin SDK à l'aide des instructions Node 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. Partout où la prise en charge du SDK Admin est disponible, comme c'est le cas pour FCM, l'authentification et la base de données en temps réel Firebase, elle offre un moyen puissant d'intégrer Firebase à l'aide de Cloud Functions.

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

Ajouter la fonction addMessage()

Pour la fonction addMessage() , ajoutez ces lignes à 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 demande au point de terminaison entraîne la transmission d'objets Request et Response de style ExpressJS au rappel onRequest() .

Les fonctions HTTP sont synchrones (semblables aux fonctions appelables ), vous devez donc envoyer une réponse le plus rapidement possible et différer le travail à l'aide de Cloud Firestore. La fonction HTTP addMessage() transmet une valeur de texte 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 ces lignes à 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", les 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 événementielles telles que les événements Cloud Firestore sont asynchrones. La fonction de rappel doit renvoyer un null , un Object ou un Promise . Si vous ne retournez rien, la fonction expire, signalant une erreur, et est réessayée. Voir Sync, Async et Promesses .

Émulez l'exécution de vos fonctions

La suite d'émulateurs locaux Firebase vous permet de créer et de tester des applications sur votre ordinateur local au lieu de les déployer sur un projet Firebase. Les tests locaux pendant le développement sont fortement recommandés, en partie parce qu'ils réduisent le risque d'erreurs de codage qui pourraient potentiellement 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 vérifiez la sortie de l'URL de l'interface utilisateur Emulator Suite. Il est par défaut localhost:4000 , mais peut être hébergé sur un autre port de votre machine. Entrez cette URL dans votre navigateur pour ouvrir l'interface utilisateur d'Emulator Suite.

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

    1. MY_PROJECT sera remplacé par votre ID de 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. Cela devrait ressembler à : http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme . Facultativement, vous pouvez remplacer le message « majusculeme » par un message personnalisé.

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

  5. Affichez les effets des fonctions dans l'interface utilisateur d'Emulator Suite :

    1. Dans l'onglet Logs , vous devriez voir de nouveaux logs 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 la version majuscule de votre message (s'il était à l'origine "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. Gardez à l'esprit que pour déployer dans l'environnement d'exécution Node.js 14 recommandé, votre projet doit être sur le plan tarifaire Blaze . Consultez les tarifs de Cloud Functions .

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

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

     firebase deploy --only functions

    Après avoir exécuté cette commande, la CLI Firebase génère l'URL de tous les points de terminaison de fonction HTTP. Dans votre terminal, vous devriez voir une ligne comme celle-ci :

    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. Bien que vous n'ayez pas à vous en soucier maintenant, certaines fonctions HTTP de production doivent spécifier un emplacement pour minimiser la latence du réseau.

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

  2. À l'aide de l'URL addMessage() sortie par la CLI, ajoutez un paramètre de requête de texte et ouvrez-le dans un navigateur :

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

    La fonction 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 majuscule de la chaîne.

Après avoir déployé et exécuté des fonctions, vous pouvez afficher les journaux dans Google Cloud Console . 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 des nombres minimum et maximum d'instances à exécuter. Voir Contrôler le comportement de mise à l'échelle pour plus d'informations sur ces options d'exécution.

Examiner l'exemple de code complet

Voici le functions/index.js complété 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 majuscules 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

Prochaines étapes

Dans cette documentation, vous pouvez en savoir plus sur la gestion des fonctions pour Cloud Functions ainsi que sur la gestion de tous les types d'événements pris en charge par Cloud Functions.

Pour en savoir plus sur Cloud Functions, vous pouvez également procéder comme suit :