Synchronisation, asynchrone et promesses

Il est important de gérer le cycle de vie d'une fonction pour s'assurer qu'elle se résout correctement. En arrêtant correctement les fonctions, vous pouvez éviter des frais excessifs liés à des fonctions qui s'exécutent trop longtemps ou qui bouclent indéfiniment. Vous pouvez également vous assurer que l'instance Cloud Functions qui exécute votre fonction ne s'arrête pas avant que votre fonction n'atteigne sa condition ou son état de fin.

Utilisez les approches recommandées suivantes pour gérer le cycle de vie de vos fonctions :

  • Résolvez les fonctions qui effectuent un traitement asynchrone (également appelées "fonctions d'arrière-plan") en renvoyant une promesse JavaScript.
  • Arrêtez les fonctions HTTP avec res.redirect(), res.send() ou res.end().
  • Terminez une fonction synchrone par une instruction return;.

Simplifier le code asynchrone avec des promesses JavaScript

Les promesses sont une alternative moderne aux rappels pour le code asynchrone. Une promesse représente une opération et la valeur future qu'elle peut renvoyer. Il vous permet également de propager des erreurs semblables à try/catch dans du code synchrone. Pour en savoir plus sur les promesses dans le SDK Firebase, consultez le blog Firebase. Pour en savoir plus sur les promesses en général, consultez le site MDN.

Fonctionnement des promesses avec les fonctions

Lorsque vous renvoyez une promesse JavaScript à une fonction, celle-ci continue de s'exécuter jusqu'à ce que la promesse soit résolue ou rejetée. Pour indiquer qu'une fonction a bien été exécutée, la promesse doit être résolue. Pour indiquer une erreur, la promesse doit être rejetée. Cela signifie que vous n'avez qu'à gérer les erreurs que vous souhaitez.

Le code suivant prend un Firebase Realtime Database ref et définit sa valeur sur "world!". En renvoyant le résultat de set, votre fonction continuera de s'exécuter jusqu'à ce que l'écriture asynchrone de la chaîne dans la base de données soit entièrement terminée :

// Always change the value of "/hello" to "world!"
exports.hello = functions.database.ref('/hello').onWrite(event => {
  // set() returns a promise. We keep the function alive by returning it.
  return event.data.ref.set('world!').then(() => {
    console.log('Write succeeded!');
  });
});

Exemples en contexte

La plupart de nos exemples de code Cloud Functions incluent des exemples de fin de fonction appropriée. Voici quelques exemples de cas d'utilisation courants :