Fonctions de programmation

Si vous souhaitez planifier l'exécution de fonctions à des moments spécifiés, utilisez le gestionnaire onSchedule pour créer un sujet Pub/Sub qui déclenche des événements sur ce sujet à l'aide de Cloud Scheduler.

Avant de commencer

Pour utiliser cette solution dans votre projet Firebase, celui-ci doit disposer du forfait Blaze. Si ce n'est pas déjà le cas, passez à un forfait supérieur.

Bien que la facturation soit obligatoire, le coût global devrait être gérable, car chaque tâche Cloud Scheduler coûte 0, 10 $ (USD) par mois et vous disposez d'une allocation de trois tâches par compte Google, sans frais. Utilisez le simulateur de coût Blaze pour générer une estimation des coûts en fonction de votre utilisation prévue.

Les API Pub/Sub et Cloud Scheduler doivent être activées pour votre projet. Ils doivent déjà être activés pour la plupart des projets Firebase. Vous pouvez le vérifier dans la console Google Cloud.

Écrire une fonction planifiée

Dans Cloud Functions for Firebase, la logique de planification se trouve dans le code de vos fonctions, sans exigence particulière en termes de temps de déploiement. Pour créer une fonction planifiée, utilisez functions.pubsub.schedule('your schedule').onRun((context)). Par exemple, pour exécuter une fonction toutes les cinq minutes avec la syntaxe App Engine cron.yaml, procédez comme suit :

exports.scheduledFunction = functions.pubsub.schedule('every 5 minutes').onRun((context) => {
  console.log('This will be run every 5 minutes!');
  return null;
});

Unix Crontab et la syntaxe App Engine sont compatibles avec Cloud Scheduler. Par exemple, si vous souhaitez utiliser Crontab afin de sélectionner un fuseau horaire spécifique dans lequel exécuter une fonction planifiée, procédez comme suit:

exports.scheduledFunctionCrontab = functions.pubsub.schedule('5 11 * * *')
  .timeZone('America/New_York') // Users can choose timezone - default is America/Los_Angeles
  .onRun((context) => {
  console.log('This will be run every day at 11:05 AM Eastern!');
  return null;
});

La valeur de timeZone doit être un nom de fuseau horaire issu de la base de données tz. Pour en savoir plus sur les propriétés compatibles, consultez la documentation de référence sur Cloud Scheduler.

Déployer une fonction planifiée

Lorsque vous déployez une fonction planifiée, la tâche de planification et le sujet Pub/Sub associés sont créés automatiquement. La CLI Firebase renvoie le nom du sujet. Vous pouvez afficher la tâche et le sujet dans la console Google Cloud. Le nom du sujet respecte la convention suivante:

firebase-scheduled-function_name-region

Exemple :

firebase-scheduled-scheduledFunctionCrontab-us-east1.