Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Gérer les fonctions

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Vous pouvez déployer, supprimer et modifier des fonctions à l'aide des commandes CLI Firebase ou en définissant des options d'exécution dans le code source de vos fonctions.

Déployer des fonctions

Pour déployer des fonctions, exécutez cette commande CLI Firebase :

firebase deploy --only functions

Par défaut, la CLI Firebase déploie toutes les fonctions dans index.js en même temps. Si votre projet contient plus de 5 fonctions, nous vous recommandons d'utiliser l'indicateur --only avec des noms de fonction spécifiques pour déployer uniquement les fonctions que vous avez modifiées. Le déploiement de fonctions spécifiques de cette manière accélère le processus de déploiement et vous aide à éviter de vous heurter à des quotas de déploiement. Par exemple:

firebase deploy --only functions:addMessage,functions:makeUppercase

Lors du déploiement d'un grand nombre de fonctions, vous pouvez dépasser le quota standard et recevoir des messages d'erreur HTTP 429 ou 500. Pour résoudre ce problème, déployez les fonctions par groupes de 10 ou moins.

Consultez la référence Firebase CLI pour la liste complète des commandes disponibles.

Par défaut, la CLI Firebase recherche dans le dossier functions/ le code source. Si vous préférez, vous pouvez organiser les fonctions dans des bases de code ou plusieurs ensembles de fichiers.

Supprimer les fonctions

Vous pouvez supprimer des fonctions précédemment déployées de ces manières :

  • explicitement dans la CLI Firebase avec functions:delete
  • explicitement dans Google Cloud Console .
  • implicitement en supprimant la fonction de index.js avant le déploiement.

Toutes les opérations de suppression vous invitent à confirmer avant de retirer la fonction de la production.

La suppression de fonction explicite dans la CLI Firebase prend en charge plusieurs arguments ainsi que des groupes de fonctions, et vous permet de spécifier une fonction s'exécutant dans une région particulière. En outre, vous pouvez remplacer l'invite de confirmation.

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction
# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1
# Delete more than one function
firebase functions:delete myFunction myOtherFunction
# Delete a specified functions group.
firebase functions:delete groupA
# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

Avec la suppression de fonction implicite, firebase deploy analyse index.js et supprime de la production toutes les fonctions qui ont été supprimées du fichier.

Modifier le nom, la région ou le déclencheur d'une fonction

Si vous renommez ou modifiez les régions ou le déclencheur pour les fonctions qui gèrent le trafic de production, suivez les étapes de cette section pour éviter de perdre des événements lors de la modification. Avant de suivre ces étapes, assurez-vous d'abord que votre fonction est idempotente , car la nouvelle version et l'ancienne version de votre fonction s'exécuteront en même temps pendant la modification.

Renommer une fonction

Pour renommer une fonction, créez une nouvelle version renommée de la fonction dans index.js , puis exécutez deux commandes de déploiement distinctes. La première commande déploie la fonction nouvellement nommée et la deuxième commande supprime la version précédemment déployée. Par exemple, si vous avez une fonction appelée webhook que vous souhaitez remplacer par webhookNew , révisez le code comme suit :

// before
const functions = require('firebase-functions');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

Exécutez ensuite les commandes suivantes pour déployer la nouvelle fonction :

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Modifier la région ou les régions d'une fonction

Si vous modifiez les régions spécifiées pour une fonction qui gère le trafic de production, vous pouvez éviter la perte d'événements en exécutant ces étapes dans l'ordre :

  1. Renommez la fonction et modifiez sa région ou ses régions comme vous le souhaitez.
  2. Déployez la fonction renommée, ce qui entraîne l'exécution temporaire du même code dans les deux ensembles de régions.
  3. Supprimer la fonction précédente.

Par exemple, si vous avez une fonction appelée webhook qui se trouve actuellement dans la région de fonctions par défaut de us-central1 , et que vous souhaitez la migrer vers asia-northeast1 , vous devez d'abord modifier votre code source pour renommer la fonction et réviser la région .

// before
const functions = require('firebase-functions');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

Déployez ensuite en exécutant :

firebase deploy --only functions:webhookAsia

Maintenant, deux fonctions identiques sont en cours d'exécution : webhook s'exécute dans us-central1 , et webhookAsia s'exécute dans asia-northeast1 .

Ensuite, supprimez webhook :

firebase functions:delete webhook

Maintenant, il n'y a qu'une seule fonction - webhookAsia , qui s'exécute dans asia-northeast1 .

Modifier le type de déclencheur d'une fonction

Au fur et à mesure que vous développez votre déploiement Cloud Functions pour Firebase, vous devrez peut-être modifier le type de déclencheur d'une fonction pour diverses raisons. Par exemple, vous voudrez peut-être :

  • Passez de l'événement de stockage hérité onChange à onFinalize , onDelete , onArchive et onMetadataUpdate . (En savoir plus à ce sujet dans le guide de mise à niveau bêta vers v1 ou v2 ).
  • Passez d'un type d'événement Firebase Realtime Database ou Cloud Firestore à un autre, tel que l'événement générique onWrite à l'événement granulaire onCreate .

Il n'est pas possible de modifier le type d'événement d'une fonction en modifiant simplement le code source et en exécutant firebase deploy . Pour éviter les erreurs, modifiez le type de déclencheur d'une fonction en suivant cette procédure :

  1. Modifiez le code source pour inclure une nouvelle fonction avec le type de déclencheur souhaité.
  2. Déployez la fonction, ce qui entraîne l'exécution temporaire de l'ancienne et de la nouvelle fonction.
  3. Supprimez explicitement l'ancienne fonction de la production à l'aide de la CLI Firebase.

Par exemple, si vous aviez une fonction objectChanged qui a le type d'événement onChange hérité et que vous souhaitez le changer en onFinalize , renommez d'abord la fonction et modifiez-la pour qu'elle ait le type d'événement onFinalize .

// before
const functions = require('firebase-functions');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

Exécutez ensuite les commandes suivantes pour créer d'abord la nouvelle fonction, avant de supprimer l'ancienne fonction :

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Définir les options d'exécution

Cloud Functions pour Firebase vous permet de sélectionner des options d'exécution telles que la version d'exécution de Node.js et le délai d'expiration par fonction, l'allocation de mémoire et les instances de fonction minimum/maximum.

En tant que meilleure pratique, ces options (sauf pour la version Node.js) doivent être définies sur un objet de configuration dans le code de la fonction. Cet objet RuntimeOptions est la source de vérité pour les options d'exécution de votre fonction et remplacera les options définies via toute autre méthode (telle que via la console Google Cloud ou la CLI gcloud).

Si votre workflow de développement implique la définition manuelle d'options d'exécution via la console Google Cloud ou l'interface de ligne de commande gcloud et que vous ne souhaitez pas que ces valeurs soient remplacées à chaque déploiement, définissez l'option preserveExternalChanges sur true . Avec cette option définie sur true , Firebase fusionne les options d'exécution définies dans votre code avec les paramètres de la version actuellement déployée de votre fonction avec la priorité suivante :

  1. L'option est définie dans le code des fonctions : écraser les modifications externes.
  2. L'option est définie sur RESET_VALUE dans le code des fonctions : remplacez les modifications externes par la valeur par défaut.
  3. L'option n'est pas définie dans le code des fonctions, mais est définie dans la fonction actuellement déployée : utilisez l'option spécifiée dans la fonction déployée.

L'utilisation de l'option preserveExternalChanges: true n'est pas recommandée dans la plupart des scénarios, car votre code ne sera plus la source complète de vérité pour les options d'exécution de vos fonctions. Si vous l'utilisez, consultez la console Google Cloud ou utilisez l'interface de ligne de commande gcloud pour afficher la configuration complète d'une fonction.

Définir la version de Node.js

Le SDK Firebase pour Cloud Functions 2.0.0 et versions ultérieures permet une sélection d'environnements d'exécution Node.js. Vous pouvez choisir d'exécuter toutes les fonctions d'un projet exclusivement sur l'environnement d'exécution correspondant à l'une de ces versions Node.js prises en charge :

  • Node.js 16
  • Node.js 14

Pour définir la version de Node.js :

Définissez la version dans le champ engines du fichier package.json qui a été créé dans votre répertoire functions/ lors de l'initialisation. Par exemple, pour n'utiliser que la version 16, modifiez cette ligne dans package.json :

  "engines": {"node": "16"}

Le champ engines est obligatoire ; il doit spécifier l'une des versions prises en charge de Node.js pour que vous puissiez déployer et exécuter des fonctions. Actuellement firebase init functions définissent ce champ sur 16 .

Mettez à niveau votre environnement d'exécution Node.js

Pour mettre à niveau votre environnement d'exécution Node.js :

  1. Assurez-vous que votre projet est sur le plan tarifaire Blaze .
  2. Assurez-vous que vous utilisez Firebase CLI v9.17.0 ou une version ultérieure.
  3. Modifiez la valeur des engines dans le fichier package.json qui a été créé dans votre répertoire functions/ lors de l'initialisation. Par exemple, si vous effectuez une mise à niveau de la version 10 vers la version 16, l'entrée devrait ressembler à ceci : "engines": {"node": "16"}
  4. Si vous le souhaitez, testez vos modifications à l'aide de Firebase Local Emulator Suite .
  5. Redéployez les fonctions à l'aide de Firebase CLI v9.17.0 ou version ultérieure.

Contrôler le comportement de mise à l'échelle

Par défaut, Cloud Functions pour Firebase adapte le nombre d'instances en cours d'exécution en fonction du nombre de requêtes entrantes, pouvant éventuellement réduire à zéro instance en période de trafic réduit. Toutefois, si votre application nécessite une latence réduite et que vous souhaitez limiter le nombre de démarrages à froid, vous pouvez modifier ce comportement par défaut en spécifiant un nombre minimum d'instances de conteneur à conserver au chaud et prêtes à répondre aux demandes.

De même, vous pouvez définir un nombre maximal pour limiter la mise à l'échelle des instances en réponse aux demandes entrantes. Utilisez ce paramètre pour contrôler vos coûts ou pour limiter le nombre de connexions à un service de sauvegarde tel qu'une base de données.

Réduire le nombre de démarrages à froid

Pour définir le nombre minimum d'instances d'une fonction dans le code source, utilisez la méthode runWith . Cette méthode accepte un objet JSON conforme à l'interface RuntimeOptions , qui définit la valeur de minInstances . Par exemple, cette fonction définit un minimum de 5 instances à maintenir au chaud :

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });

Voici quelques éléments à prendre en compte lors de la définition d'une valeur pour minInstances :

  • Si Cloud Functions pour Firebase fait évoluer votre application au-dessus de votre paramètre minInstances , vous subirez un démarrage à froid pour chaque instance au-dessus de ce seuil.
  • Les démarrages à froid ont l'effet le plus grave sur les applications avec un trafic irrégulier. Si votre application présente des pics de trafic et que vous définissez une valeur minInstances suffisamment élevée pour que les démarrages à froid soient réduits à chaque augmentation du trafic, vous constaterez une latence considérablement réduite. Pour les applications avec un trafic constant, les démarrages à froid ne sont pas susceptibles d'affecter gravement les performances.
  • La définition d'instances minimales peut être utile pour les environnements de production, mais doit généralement être évitée dans les environnements de test. Pour passer à zéro dans votre projet de test tout en réduisant les démarrages à froid dans votre projet de production, vous pouvez définir minInstances en fonction de la variable d'environnement FIREBASE_CONFIG :

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
    const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;
    
    exports.renderProfilePage = functions
        .runWith({
          // Keep 5 instances warm for this latency-critical function
          // in production only. Default to 0 for test projects.
          minInstances: envProjectId === "my-production-project" ? 5 : 0,
        })
        .https.onRequest((req, res) => {
          // render some html
        });
    

Limiter le nombre maximum d'instances pour une fonction

Pour définir le nombre maximal d'instances dans le code source de la fonction, utilisez la méthode runWith . Cette méthode accepte un objet JSON conforme à l'interface RuntimeOptions , qui définit des valeurs pour maxInstances . Par exemple, cette fonction fixe une limite de 100 instances afin de ne pas submerger une hypothétique ancienne base de données :

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });

Si une fonction HTTP est mise à l'échelle jusqu'à la limite maxInstances , les nouvelles demandes sont mises en file d'attente pendant 30 secondes, puis rejetées avec un code de réponse de 429 Too Many Requests si aucune instance n'est disponible à ce moment-là.

Pour en savoir plus sur les bonnes pratiques d'utilisation des paramètres d'instances maximales, consultez ces bonnes pratiques d'utilisation de maxInstances .

Définir le délai d'attente et l'allocation de mémoire

Dans certains cas, vos fonctions peuvent avoir des exigences particulières pour une longue valeur de délai d'attente ou une grande allocation de mémoire. Vous pouvez définir ces valeurs soit dans Google Cloud Console, soit dans le code source de la fonction (Firebase uniquement).

Pour définir l'allocation de mémoire et le délai d'expiration dans le code source des fonctions, utilisez le paramètre runWith introduit dans le SDK Firebase pour Cloud Functions 2.0.0. Cette option d'exécution accepte un objet JSON conforme à l'interface RuntimeOptions , qui définit des valeurs pour timeoutSeconds et memory . Par exemple, cette fonction de stockage utilise 1 Go de mémoire et expire au bout de 300 secondes :

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });

La valeur maximale de timeoutSeconds est 540 ou 9 minutes. La quantité de mémoire accordée à une fonction correspond au CPU alloué pour la fonction, comme détaillé dans cette liste de valeurs valides pour memory :

  • 128MB — 200 MHz
  • 256MB — 400 MHz
  • 512MB — 800 MHz
  • 1GB — 1,4 GHz
  • 2GB — 2,4 GHz
  • 4GB — 4,8 GHz
  • 8GB — 4,8 GHz

Pour définir l'allocation de mémoire et le délai d'expiration dans Google Cloud Console :

  1. Dans Google Google Cloud Console, sélectionnez Cloud Functions dans le menu de gauche.
  2. Sélectionnez une fonction en cliquant sur son nom dans la liste des fonctions.
  3. Cliquez sur l'icône Modifier dans le menu supérieur.
  4. Sélectionnez une allocation de mémoire dans le menu déroulant intitulé Mémoire allouée .
  5. Cliquez sur Plus pour afficher les options avancées et saisissez un nombre de secondes dans la zone de texte Délai d'expiration.
  6. Cliquez sur Enregistrer pour mettre à jour la fonction.