Gérer les fonctions

Vous pouvez déployer, supprimer et modifier des fonctions à l'aide de 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 de votre source en même temps. Si votre projet contient plus de cinq fonctions, nous vous recommandons d'utiliser l'indicateur --only avec des noms de fonction spécifiques pour ne déployer que les fonctions que vous avez modifiées. Déployer des fonctions spécifiques de cette manière accélère le processus de déploiement et vous évite de rencontrer des quotas de déploiement. Exemple :

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

Lorsque vous déployez 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 fonctions ou moins.

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

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

Supprimer des fonctions

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

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

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

La suppression explicite de fonction dans la CLI Firebase accepte plusieurs arguments, ainsi que des groupes de fonctions, et vous permet de spécifier une fonction exécutée dans une région particulière. Vous pouvez également 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 implicite des fonctions, firebase deploy analyse votre source 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 des 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écutent en même temps lors du changement.

Renommer une fonction

Pour renommer une fonction, créez une version renommée de la fonction dans votre source, puis exécutez deux commandes de déploiement distinctes. La première commande déploie la fonction renommée, et la seconde supprime la version précédemment déployée. Par exemple, si vous souhaitez renommer un webhook déclenché par HTTP, modifiez le code comme suit:

// before
const {onRequest}  = require('firebase-functions/v2/https');

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

// after
const {onRequest}  = require('firebase-functions/v2/https');

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

# before
from firebase_functions import https_fn

@https_fn.on_request()
def webhook(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello world!")

# after
from firebase_functions import https_fn

@https_fn.on_request()
def webhook_new(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello world!")

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

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

# Wait until deployment is done; now both functions 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 procédant comme suit:

1. Renommez la fonction et modifiez sa 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. Supprimez la fonction précédente.

Par exemple, si vous disposez d'une fonction déclenchée par Cloud Firestore 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
exports.firestoreTrigger = onDocumentCreated(
  "my-collection/{docId}",
  (event) => {},
);

// after
exports.firestoreTriggerAsia = onDocumentCreated(
  {
    document: "my-collection/{docId}",
    region: "asia-northeast1",
  },
  (event) => {},
);

# Before
@firestore_fn.on_document_created("my-collection/{docId}")
def firestore_trigger(event):
    pass

# After
@firestore_fn.on_document_created("my-collection/{docId}",
                                  region="asia-northeast1")
def firestore_trigger_asia(event):
    pass

Déployez ensuite en exécutant la commande suivante:

firebase deploy --only functions:firestoreTriggerAsia

Deux fonctions identiques s'exécutent maintenant: firestoreTrigger s'exécute dans us-central1 et firestoreTriggerAsia s'exécute dans asia-northeast1.

Supprimez ensuite firestoreTrigger:

firebase functions:delete firestoreTrigger

Il n'y a désormais qu'une seule fonction : firestoreTriggerAsia, qui s'exécute dans asia-northeast1.

Modifier le type de déclencheur d'une fonction

Au fur et à mesure du développement de votre déploiement Cloud Functions for Firebase, vous devrez peut-être modifier le type de déclencheur d'une fonction pour diverses raisons. Par exemple, vous pouvez passer d'un type d'événement Firebase Realtime Database ou Cloud Firestore à un autre.

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

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 des deux fonctions.
3. Supprimez explicitement l'ancienne fonction de production à l'aide de la CLI Firebase.

Par exemple, si une fonction était déclenchée lorsqu'un objet était supprimé, mais que vous avez ensuite activé la gestion des versions d'objets et que vous souhaitez vous abonner à l'événement d'archivage à la place, commencez par renommer la fonction et modifiez-la pour qu'elle utilise le nouveau type de déclencheur.

// before
const {onObjectDeleted} = require("firebase-functions/v2/storage");

exports.objectDeleted = onObjectDeleted((event) => {
    // ...
});

// after
const {onObjectArchived} = require("firebase-functions/v2/storage");

exports.objectArchived = onObjectArchived((event) => {
    // ...
});

# before
from firebase_functions import storage_fn

@storage_fn.on_object_deleted()
def object_deleted(event):
  # ...

# after 
from firebase_functions import storage_fn

@storage_fn.on_object_archived()
def object_archived(event):
  # ...

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

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

# Wait until deployment is done; now both objectDeleted and objectArchived are running

# Delete objectDeleted
firebase functions:delete objectDeleted

Définir les options d'exécution

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

Nous vous recommandons de définir ces options (à l'exception de la version Node.js) 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 remplace les options définies via toute autre méthode (par exemple, via la console Google Cloud ou la gcloud CLI).

Si votre workflow de développement implique de définir manuellement des options d'exécution via la console Google Cloud ou la gcloud CLI et que vous ne souhaitez pas que ces valeurs soient remplacées à chaque déploiement, définissez l'option preserveExternalChanges sur true. Lorsque cette option est 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: forcer 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 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 pour 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 la CLI gcloud pour afficher la configuration complète d'une fonction.

Définir la version de Node.js

Le SDK Firebase pour Cloud Functions permet de sélectionner un environnement d'exécution Node.js. Vous pouvez choisir d'exécuter toutes les fonctions d'un projet exclusivement dans l'environnement d'exécution correspondant à l'une des versions Node.js compatibles suivantes:

• Node.js 22 (preview)
• Node.js 20
• Node.js 18

Les versions 14 et 16 de Node.js sont obsolètes et seront mises hors service début 2025. Le déploiement avec ces versions obsolètes est désactivé.

Pour définir la version de Node.js:

Vous pouvez définir la version dans le champ engines du fichier package.json créé dans votre répertoire functions/ lors de l'initialisation. Par exemple, pour n'utiliser que la version 18, modifiez cette ligne dans package.json:

  "engines": {"node": "20"}

Si vous utilisez le gestionnaire de paquets Yarn ou si vous avez d'autres exigences spécifiques pour le champ engines, vous pouvez définir l'environnement d'exécution du SDK Firebase pour Cloud Functions dans firebase.json à la place:

  {
    "functions": {
      "runtime": "nodejs18" // or nodejs20
    }
  }

La CLI utilise la valeur définie dans firebase.json de préférence à toute valeur ou plage que vous définissez séparément dans package.json.

Mettre à 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 associé au forfait Blaze.
2. Assurez-vous d'utiliser la version 11.18.0 ou ultérieure de la CLI Firebase.
3. Modifiez la valeur engines dans le fichier package.json créé dans votre répertoire functions/ lors de l'initialisation. Par exemple, si vous passez de la version 18 à la version 20, l'entrée doit se présenter comme suit: "engines": {"node": "20"}
4. Vous pouvez également tester vos modifications à l'aide de Firebase Local Emulator Suite.
5. Redéployez toutes les fonctions.

Définir la version Python

Le SDK Firebase pour les versions Cloud Functions 12.0.0 et ultérieures permet de sélectionner l'environnement d'exécution Python. Définissez la version d'exécution dans firebase.json comme indiqué:

  {
    "functions": {
      "runtime": "python310" // or python311
    }
  }

Contrôler le comportement du scaling

Par défaut, Cloud Functions for Firebase adapte le nombre d'instances en cours d'exécution en fonction du nombre de requêtes entrantes, et peut réduire le nombre d'instances à zéro en cas 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 minimal d'instances de conteneur à garder en attente et prêtes à traiter des requêtes.

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

En utilisant ces paramètres avec le paramètre de concurrencialité par instance (nouveauté de la 2e génération), vous pouvez contrôler et ajuster le comportement de scaling de vos fonctions. La nature de votre application et de votre fonction déterminera les paramètres les plus rentables et qui offrent les meilleures performances.

Pour certaines applications à faible trafic, une option de processeur inférieure sans multiconcurrency est optimale. Pour les autres cas où les démarrages à froid sont un problème critique, définir une simultanéité et un nombre minimal d'instances élevés signifie qu'un ensemble d'instances est toujours maintenu à chaud pour gérer les pics de trafic importants.

Pour les applications de petite envergure qui reçoivent très peu de trafic, définir un nombre d'instances maximales faible avec une concurrence élevée signifie que l'application peut gérer des pics de trafic sans encourir de coûts excessifs. Toutefois, n'oubliez pas que lorsque le nombre maximal d'instances est défini trop bas, les requêtes peuvent être abandonnées lorsque le plafond est atteint.

Autoriser les requêtes simultanées

Dans Cloud Functions for Firebase (1re génération), chaque instance pouvait gérer une seule requête à la fois. Le comportement de scaling n'était donc défini qu'avec les paramètres d'instance minimal et maximal. En plus de contrôler le nombre d'instances, dans Cloud Functions for Firebase (2e génération), vous pouvez contrôler le nombre de requêtes que chaque instance peut traiter en même temps avec l'option concurrency. La valeur par défaut de la simultanéité est 80, mais vous pouvez la définir sur n'importe quel entier compris entre 1 et 1 000.

Les fonctions avec des paramètres de simultanéité plus élevés peuvent absorber les pics de trafic sans démarrage à froid, car chaque instance dispose probablement d'une marge de manœuvre. Si une instance est configurée pour gérer jusqu'à 50 requêtes simultanées, mais qu'elle n'en gère actuellement que 25, elle peut gérer un pic de 25 requêtes supplémentaires sans qu'une nouvelle instance ne soit démarrée à froid. En revanche, avec un paramètre de simultanéité de seulement 1, ce pic de requêtes pourrait entraîner 25 démarrages à froid.

Ce scénario simplifié illustre les gains d'efficacité potentiels de la simultanéité. En réalité, le comportement de scaling pour optimiser l'efficacité et réduire les démarrages à froid avec la concurrence est plus complexe. La concurrence dans la deuxième génération de Cloud Functions for Firebase est gérée par Cloud Run et suit les règles d'autoscaling des instances de conteneur de Cloud Run.

Lorsque vous testez des paramètres de simultanéité plus élevés dans Cloud Functions for Firebase (2e génération), tenez compte des points suivants:

• Des paramètres de simultanéité plus élevés peuvent nécessiter un CPU et une RAM plus importants pour des performances optimales jusqu'à atteindre une limite pratique. Par exemple, une fonction qui effectue un traitement d'image ou de vidéo lourd peut manquer de ressources pour gérer 1 000 requêtes simultanées, même lorsque ses paramètres de processeur et de RAM sont maximisés.
• Étant donné que Cloud Functions for Firebase (2e génération) est alimenté par Cloud Run, vous pouvez également consulter les conseils sur Google Cloud pour optimiser la simultanéité.
• Veillez à tester minutieusement la multiconcurrency dans un environnement de test avant de passer à la multiconcurrency en production.

Maintenir un nombre minimal d'instances en attente

Vous pouvez définir un nombre minimal d'instances pour une fonction dans le code source. Par exemple, cette fonction définit un minimum de cinq instances pour maintenir la température:

const { onCall } = require("firebase-functions/v2/https");

exports.getAutocompleteResponse = onCall(
  {
    // Keep 5 instances warm for this latency-critical function
    minInstances: 5,
  },
  (event) => {
    // Autocomplete user’s search term
  }
);

@https_fn.on_call(min_instances=5)
def get_autocomplete_response(event: https_fn.CallableRequest) -> https_fn.Response:

Voici quelques éléments à prendre en compte lorsque vous définissez une valeur minimale d'instances:

• Si Cloud Functions for Firebase met à l'échelle votre application au-delà de votre paramètre, un démarrage à froid se produira pour chaque instance au-dessus de ce seuil.
• Les démarrages à froid ont le plus d'impact sur les applications dont le trafic est irrégulier. Si le trafic de votre application est irrégulier et que vous définissez une valeur suffisamment élevée pour que les démarrages à froid soient réduits à chaque augmentation du trafic, la latence sera considérablement réduite. Pour les applications dont le trafic est constant, les démarrages à froid ne sont pas susceptibles d'affecter gravement les performances.

• Définir un nombre minimal d'instances peut être utile pour les environnements de production, mais il est généralement préférable de l'éviter dans les environnements de test. Pour réduire à zéro la mise à l'échelle dans votre projet de test, tout en réduisant les démarrages à froid dans votre projet de production, vous pouvez définir une valeur minimale d'instances dans votre configuration paramétrée:

  Node.js

  const functions = require('firebase-functions/v1');
  const { defineInt, defineString } = require('firebase-functions/params');
  
  // Define some parameters
  const minInstancesConfig = defineInt('HELLO_WORLD_MININSTANCES');
  const welcomeMessage = defineString('WELCOME_MESSAGE');
  
  // To use configured parameters inside the config for a function, provide them 
  // directly. To use them at runtime, call .value() on them.
  export const helloWorld = functions.runWith({ minInstances: minInstancesConfig}).https.onRequest(
    (req, res) => {
      res.send(`${welcomeMessage.value()}! I am a function.`);
    }
  );
  

  Python

  MIN_INSTANCES = params.IntParam("HELLO_WORLD_MININSTANCES")
  WELCOME_MESSAGE = params.StringParam("WELCOME_MESSAGE")
  
  @https_fn.on_request(min_instances=MIN_INSTANCES.value())
  def get_autocomplete_response(event: https_fn.Request) -> https_fn.Response:
      return https_fn.Response(f"{WELCOME_MESSAGE.value()} I'm a function.")
  

Limiter le nombre maximal d'instances pour une fonction

Vous pouvez définir une valeur pour le nombre maximal d'instances dans le code source de la fonction. Par exemple, cette fonction définit une limite de 100 instances afin de ne pas surcharger une base de données existante hypothétique:

const { onMessagePublished } = require("firebase-functions/v2/pubsub");

exports.mirrorevents = onMessagePublished(
  { topic: "topic-name", maxInstances: 100 },
  (event) => {
    // Connect to legacy database
  }
);

@pubsub_fn.on_message_published(topic="topic-name", max_instances=100)
def mirrorevents(event: pubsub_fn.CloudEvent):
#  Connect to legacy database

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

Pour en savoir plus sur les bonnes pratiques à suivre pour utiliser les paramètres de nombre maximal d'instances, consultez les bonnes pratiques pour définir le nombre maximal d'instances.

Définir un délai avant expiration et une allocation de mémoire

Dans certains cas, vos fonctions peuvent avoir des exigences spéciales pour une valeur de délai avant expiration longue ou une allocation de mémoire importante. Vous pouvez définir ces valeurs dans la console Google Cloud ou dans le code source de la fonction (Firebase uniquement).

Pour définir l'allocation de mémoire et le délai avant expiration dans le code source des fonctions, utilisez les options globales pour la mémoire et le délai avant expiration afin de personnaliser la machine virtuelle exécutant vos fonctions. Par exemple, cette fonction Cloud Storage utilise 1 Go de mémoire et expire au bout de 300 secondes:

exports.convertLargeFile = onObjectFinalized({
  timeoutSeconds: 300,
  memory: "1GiB",
}, (event) => {
  // Do some complicated things that take a lot of memory and time
});

@storage_fn.on_object_finalized(timeout_sec=300, memory=options.MemoryOption.GB_1)
def convert_large_file(event: storage_fn.CloudEvent):
# Do some complicated things that take a lot of memory and time.

La valeur maximale du délai avant expiration en secondes est 540, soit neuf minutes.

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

1. Dans la console Google Cloud, sélectionnez Cloud Functions for Firebase 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 du haut.
4. Sélectionnez une allocation de mémoire dans le menu déroulant Memory allocated (Mémoire allouée).
5. Cliquez sur Plus pour afficher les options avancées, puis saisissez un nombre de secondes dans la zone de texte Délai avant expiration.
6. Cliquez sur Enregistrer pour mettre à jour la fonction.

Ignorer les paramètres par défaut du processeur

Jusqu'à 2 Go de mémoire allouée, chaque fonction dans Cloud Functions for Firebase (2e génération) est par défaut associée à un seul processeur, puis à deux processeurs pour 4 et 8 Go. Notez que ce comportement est très différent du comportement par défaut de la 1re génération, ce qui peut entraîner des coûts légèrement plus élevés pour les fonctions à faible mémoire, comme indiqué dans le tableau suivant:

Si vous préférez le comportement de la 1re génération pour vos fonctions de 2e génération, définissez les valeurs par défaut de la 1re génération comme option globale:

// Turn off Firebase defaults
setGlobalOptions({ cpu: 'gcf_gen1' });

# Use 1st gen behavior
set_global_options(cpu="gcf_gen1")

Pour les fonctions gourmandes en processeur, la 2e génération offre la flexibilité de configurer des processeurs supplémentaires. Vous pouvez accélérer le processeur par fonction, comme illustré ci-dessous:

// Boost CPU in a function:
export const analyzeImage = onObjectFinalized({ cpu: 2 }, (event) => {
  // computer vision goes here
});

# Boost CPU in a function:
@storage_fn.on_object_finalized(cpu=2)
def analyze_image(event: storage_fn.CloudEvent):
# computer vision goes here