אם רוצים לתזמן פונקציות כך שיפעלו בזמנים מסוימים, משתמשים ב-handler onSchedule שסופק על ידי firebase-functions/v2/scheduler.
הפונקציות האלה משתמשות ב-Cloud Scheduler כדי להפעיל את הלוגיקה של הפונקציה בזמנים או במרווחי הזמן שאתם מגדירים.
לפני שמתחילים
למרות שהפונקציות המתוזמנות מחויבות, העלות הכוללת אמורה להיות סבירה, כי כל משימת Cloud Scheduler עולה 0.10 דולר ארה"ב לחודש, וניתן להקצות שלוש משימות לכל חשבון Google ללא תשלום. השתמשו במחשבון עלויות של Blaze כדי ליצור הערכת עלויות בהתאם לשימוש החזוי.
צריך להפעיל את Cloud Scheduler API בפרויקט. הוא אמור להיות מופעל כבר ברוב הפרויקטים ב-Firebase. אפשר לבדוק את זה במסוף Google Cloud.
כתיבת פונקציה מתוזמנת
ב-Cloud Functions for Firebase, הלוגיקה של התזמון נמצאת בקוד הפונקציות, ללא דרישות מיוחדות בזמן הפריסה. לדוגמה, כדי לנקות חשבונות משתמשים לא פעילים פעם ביום, אפשר לכתוב פונקציה שמתחילה בהצהרות הייבוא הבאות:
Node.js
// The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onSchedule} = require("firebase-functions/scheduler");
const {logger} = require("firebase-functions");
// The Firebase Admin SDK to delete inactive users.
const {initializeApp} = require("firebase-admin/app");
const {getAuth} = require("firebase-admin/auth");
initializeApp();
// The es6-promise-pool to limit the concurrency of promises.
const PromisePool = /** @type {PromisePoolConstructor} */ (
require("es6-promise-pool")
);
// Maximum concurrent account deletions.
const MAX_CONCURRENT = 3;
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()
אחר כך, אפשר להשתמש ב-onSchedule כדי להתחיל משימה ב-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");
});
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()
Cloud Scheduler תומך גם בתחביר של Unix Crontab וגם בתחביר של App Engine. לדוגמה, כדי להשתמש ב-Crontab, מבצעים את הפעולות הבאות:
Node.js
exports.scheduledFunctionCrontab = onSchedule("5 11 * * *", async (event) => {
// ...
});
Python
@scheduler_fn.on_schedule(schedule="5 11 * * *")
פריסת פונקציה מתוזמנת
כשפורסים פונקציה מתוזמנת, נוצרות באופן אוטומטי משימת תזמון ופונקציית HTTP. ב-CLI של Firebase מופיע שם הפונקציה, ואפשר לראות את המשימה והפונקציה במסוף Google Cloud. השם של הנושא נקבע לפי המוסכמה הבאה:
firebase-schedule-function_name-region
לדוגמה:
firebase-schedule-accountcleanup-us-east1.
בזמן המתוזמן, חשבון השירות שמוגדר כברירת מחדל ב-Compute Engine מפעיל את פונקציית ה-HTTP המשויכת. כלומר, רק למשימת Cloud Scheduler המשויכת יש הרשאה להריץ את הפונקציה.