פונקציות תזמון

דור שני דור ראשון

אם רוצים לתזמן פונקציות כך שיפעלו במועדים מסוימים, צריך להשתמש במטפל onSchedule ש-firebase-functions/v2/scheduler מספק. הפונקציות האלה משתמשות ב-Cloud Scheduler כדי להפעיל את הלוגיקה של הפונקציה בזמנים או במרווחי הזמן שתגדירו.

לפני שמתחילים

כדי להשתמש בפתרון הזה בפרויקט Firebase, צריך להגדיר את הפרויקט בתמחור של Blaze. אם הוא עדיין לא בתוכנית Blaze, משדרגים את תוכנית התמחור.

החיוב נדרש, אבל העלות הכוללת צפויה להיות סבירה. כל משימה ב-Cloud Scheduler עולה 0.10$ (USD) לחודש, ויש הרשאה לשלוש משימות לכל חשבון Google ללא תשלום. אתם יכולים להשתמש במחשבון התמחור של Blaze כדי ליצור הערכת עלות על סמך השימוש החזוי.

צריך להפעיל את ה-API של Cloud Scheduler בפרויקט. הוא אמור להיות מופעל כבר ברוב הפרויקטים ב-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/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

לאחר מכן, תוכלו להשתמש ב-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");
});
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

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 המשויכת יש הרשאה להריץ את הפונקציה.

חשוב: חשוב לא למחוק או לשנות באופן ידני את הפונקציה או את המשימה של מתזמן המשימות במסוף. הפעולה הזו עלולה לגרום לשגיאות בהפעלה של הפונקציה המתוזמנת.