Fonctions de programmation

Si vous souhaitez planifier l'exécution de fonctions à des heures spécifiées, utilisez le gestionnaire onSchedule fourni par firebase-functions/v2/scheduler. Ces fonctions utilisent Cloud Scheduler pour appeler la logique de fonction aux heures ou aux intervalles que vous définissez.

Avant de commencer

Pour utiliser cette solution dans votre projet Firebase, vous devez 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.

L'API Cloud Scheduler doit être activée pour votre projet. Il devrait déjà être activé 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 réside dans le code de vos fonctions, sans aucune exigence particulière au moment du déploiement. Par exemple, pour nettoyer les comptes utilisateur inactifs une fois par jour, vous pouvez écrire une fonction commençant par les instructions d'importation suivantes:

Node.js

// The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onSchedule} = require("firebase-functions/v2/scheduler");
const {logger} = require("firebase-functions");

// The Firebase Admin SDK to delete inactive users.
const admin = require("firebase-admin");
admin.initializeApp();

// The es6-promise-pool to limit the concurrency of promises.
const PromisePool = require("es6-promise-pool").default;
// Maximum concurrent account deletions.
const MAX_CONCURRENT = 3;index.js

Python

# The Cloud Functions for Firebase SDK to set up triggers and logging.
from firebase_functions import scheduler_fn

# The Firebase Admin SDK to delete users.
import firebase_admin
from firebase_admin import auth

firebase_admin.initialize_app()main.py

Vous pouvez ensuite utiliser onSchedule pour démarrer une tâche Cloud Scheduler:

Node.js

// Run once a day at midnight, to clean up the users
// Manually run the task here https://console.cloud.google.com/cloudscheduler
exports.accountcleanup = onSchedule("every day 00:00", async (event) => {
  // Fetch all user details.
  const inactiveUsers = await getInactiveUsers();

  // Use a pool so that we delete maximum `MAX_CONCURRENT` users in parallel.
  const promisePool = new PromisePool(
      () => deleteInactiveUser(inactiveUsers),
      MAX_CONCURRENT,
  );
  await promisePool.start();

  logger.log("User cleanup finished");
});index.js

Python

# Run once a day at midnight, to clean up inactive users.
# Manually run the task here https://console.cloud.google.com/cloudscheduler
@scheduler_fn.on_schedule(schedule="every day 00:00")
def accountcleanup(event: scheduler_fn.ScheduledEvent) -> None:
    """Delete users who've been inactive for 30 days or more."""
    user_page: auth.ListUsersPage | None = auth.list_users()
    while user_page is not None:
        inactive_uids = [
            user.uid for user in user_page.users if is_inactive(user, timedelta(days=30))
        ]
        auth.delete_users(inactive_uids)
        user_page = user_page.get_next_page()main.py

La syntaxe Unix Crontab et App Engine sont compatibles avec Cloud Scheduler. Par exemple, pour utiliser Crontab, procédez comme suit:

Node.js

exports.scheduledFunctionCrontab = onSchedule("5 11 * * *", async (event) => {
  // ...
});

Python

@scheduler_fn.on_schedule(schedule="5 11 * * *")

Déployer une fonction planifiée

Lorsque vous déployez une fonction planifiée, une tâche de planification et une fonction HTTP sont créées automatiquement. La CLI Firebase affiche le nom de la fonction. Vous pouvez afficher la tâche et la fonction dans la console Google Cloud. Le sujet est nommé selon la convention suivante:

firebase-schedule-function_name-region

Exemple :

firebase-schedule-accountcleanup-us-east1.

À l'heure planifiée, le compte de service Compute par défaut appelle la fonction HTTP associée. Cela signifie que seule la tâche Cloud Scheduler associée est autorisée à exécuter la fonction.