הוספת פונקציות לתור באמצעות Cloud Tasks

הפונקציות של תור המשימות מנצלים את היתרונות של Google Cloud Tasks כדי לעזור לאפליקציה שלכם לפעול שהיא גוזלת זמן רב, צורכת משאבים רבים או שהיא מוגבלת ברוחב פס באופן אסינכרוני, מחוץ לתהליך הראשי של האפליקציה.

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

כדי לצמצם את המורכבות הזו, אפשר לכתוב פונקציית תור משימות שמגדירה אפשרויות כמו scheduleTime ו-dispatchDeadline, ואז נותנים הפונקציה מושבתת לתור ב-Cloud Tasks. Cloud Tasks עוצבה במיוחד כדי להבטיח בקרת צפיפות יעילה לביצוע ניסיונות חוזרים של כללי מדיניות מהסוגים האלה.

ה-SDK של Firebase for Cloud Functions for Firebase בגרסה 3.20.1 ואילך פועל באופן הדדי עם Firebase Admin SDK מגרסה 10.2.0 ואילך, כדי לתמוך בפונקציות של תור המשימות.

שימוש בפונקציות של תור משימות עם Firebase עלול לגרום לחיוב על עיבוד Cloud Tasks. למידע נוסף, ראו תמחור Cloud Tasks.

יצירת פונקציות בתור המשימות

כדי להשתמש בפונקציות של תור המשימות, צריך לפעול לפי השלבים הבאים:

כתיבת פונקציה של תור המשימות באמצעות ה-SDK Firebase של Cloud Functions.
כדי לבדוק את הפונקציה, מפעילים אותה באמצעות בקשת HTTP.
פורסים את הפונקציה עם ה-CLI Firebase. כשפורסים את הפונקציה של תור המשימות בפעם הראשונה, ה-CLI יוצר תור משימות ב-Cloud Tasks עם אפשרויות (הגבלת קצב וניסיון חוזר) שצוינו בקוד המקור.
להוסיף משימות לתור המשימות החדש שנוצר, ולהעביר פרמטרים להגדרה לוח זמנים לביצוע במידת הצורך. אפשר לעשות זאת באמצעות כתיבת הקוד באמצעות Admin SDK ולפרוס אותו ב-Cloud Functions for Firebase.

כתיבת פונקציות של תור המשימות

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

הגדרת הפונקציות בתור המשימות

הפונקציות של 'הבאים בתור' כוללות קבוצה עוצמתית של הגדרות תצורה כדי לשלוט במדויק במגבלות הקצב של יצירת הבקשות ולנסות שוב את ההתנהגות של תור המשימות:

exports.backupApod = functions
    .runWith( {secrets: ["NASA_API_KEY"]})
    .tasks.taskQueue({
      retryConfig: {
        maxAttempts: 5,
        minBackoffSeconds: 60,
      },
      rateLimits: {
        maxConcurrentDispatches: 6,
      },
    }).onDispatch(async (data) => {index.js

retryConfig.maxAttempts=5: כל משימה בתור המשימות מתעדכנת באופן אוטומטי בוצעה ניסיון חוזר של עד 5 פעמים. כך ניתן לצמצם שגיאות זמניות, כמו רשת שגיאות או שיבושים זמניים בשירות של שירות חיצוני תלויי.
retryConfig.minBackoffSeconds=60: צריך לבצע ניסיון חוזר של כל משימה במשך 60 שניות לפחות בנפרד מכל ניסיון. כך נוצר מרווח פנימי גדול בין כל ניסיון כך שלא נמהר למצות את חמשת הניסיונות החוזרים מהר מדי.
rateLimits.maxConcurrentDispatch=6: 6 משימות לכל היותר נשלחות בבת אחת בזמן נתון. כך אפשר להבטיח זרם יציב של בקשות לפונקציה הבסיסית, ולצמצם את מספר המכונות הפעילות והפעלות במצב התחלתי (cold start).

בדיקת הפונקציות בתור המשימה

ברוב המקרים, האמולטור Cloud Functions הוא הדרך הטובה ביותר לבדוק את המשימה בתור. במסמכי התיעוד של Emulator Suite מוסבר איך לספק לאפליקציה כלים להדמיה של פונקציות של תורי משימות.

בנוסף, הפונקציות של תור המשימות נחשפות כפשוטות פונקציות HTTP בFirebase Local Emulator Suite. כדי לבדוק פונקציית משימה שעברה הדמיה, שולחים בקשת HTTP POST עם מטען נתונים מסוג JSON:

 # start the Firebase Emulators
 firebase emulators:start

 # trigger the emulated task queue function
 curl \
  -X POST                                            # An HTTP POST request...
  -H "content-type: application/json" \              # ... with a JSON body
  http://localhost:$PORT/$PROJECT_ID/$REGION/$NAME \ # ... to function url
  -d '{"data": { ... some data .... }}'              # ... with JSON encoded data

פריסת פונקציות של תור משימות

פורסים את הפונקציה של תור המשימות באמצעות CLI של Firebase:

$ firebase deploy --only functions:backupApod

בעת פריסת פונקציית תור משימות בפעם הראשונה, ה-CLI יוצר תור משימות ב-Cloud Tasks עם אפשרויות (הגבלת קצב וביצוע ניסיון חוזר) שצוין בקוד המקור שלכם.

אם נתקלתם בשגיאות הרשאה בזמן הפריסה של הפונקציות, ודאו שהתפקידי ה-IAM המתאימים הוקצו למשתמש שמריץ את פקודות הפריסה.

הוספת פונקציות של תור משימות לתור

אפשר להוסיף את הפונקציות לתור למשימות לתור ב-Cloud Tasks מחשבון מהימן סביבת שרת כמו Cloud Functions for Firebase באמצעות Firebase Admin SDK Node.js. אם זו הפעם הראשונה שיש לך Admin SDK, כדאי לעיין במאמר הבא: כדי להתחיל, מוסיפים את Firebase לשרת.

בקצב רגיל, Admin SDK יוצר משימה חדשה ומכניס אותה לתור Cloud Tasks, וקובע את ההגדרות האישיות של המשימה:

exports.enqueueBackupTasks = functions.https.onRequest(
async (_request, response) => {
  const queue = getFunctions().taskQueue("backupApod");
  const enqueues = [];
  for (let i = 0; i <= 10; i += 1) {
    // Enqueue each task with i*60 seconds delay. Our task queue function
    // should process ~1 task/min.
    const scheduleDelaySeconds = i * 60 
    enqueues.push(
        queue.enqueue(
          { id: `task-${i}` },
          {
            scheduleDelaySeconds,
            dispatchDeadlineSeconds: 60 * 5 // 5 minutes
          },
        ),
    );
  }
  await Promise.all(enqueues);
  response.sendStatus(200);

});

scheduleDelaySeconds: הקוד לדוגמה מנסה לפזר את הביצוע של משימות באמצעות שיוך השהיה של N דקות למשימה N. הזה מתורגמת להפעלה של כמשימה אחת בדקה. שימו לב שאפשר להשתמש גם ב-scheduleTime אם רוצים ש-Cloud Tasks יפעיל משימה בזמן מסוים.
dispatchDeadlineSeconds: משך הזמן המקסימלי ש-Cloud Tasks ימתין לסיום המשימה. ניסיון נוסף של Cloud Tasks המשימה שאחרי הניסיון החוזר של התור או עד שהמועד האחרון יגיע. בדגימה, הוגדר בתור לבצע ניסיון חוזר למשימה עד 5 פעמים, אבל המשימה מוגדרת הפעולה תבוטל באופן אוטומטי אם התהליך כולו (כולל ניסיונות חוזרים) נמשך יותר מ-5 דקות.

פתרון בעיות

Cloud Tasks">הפעלת הרישום ביומן של Cloud Tasks

היומנים מ-Cloud Tasks מכילים מידע שימושי לאבחון, כמו סטטוס הבקשה שמשויכת למשימה. כברירת מחדל, יומנים מ- Cloud Tasks מושבתים בגלל כמות היומנים הגדולה שיכולים שיש אפשרות ליצור בפרויקט שלכם. מומלץ להפעיל את יומני ניפוי הבאגים בזמן הפיתוח והניפוי של פונקציות תור המשימות. צפייה הפעלה רישום ביומן.

הרשאות IAM

יכול להיות שיופיעו PERMISSION DENIED שגיאות ברשימת המשימות או Cloud Tasks מנסה להפעיל את הפונקציות בתור המשימות. צריך לוודא שהמאפיינים לפרויקט יש את קישורי ה-IAM הבאים:

הזהות שמשמשת להוספת משימות לתור לצרכים של Cloud Tasks הרשאת IAM cloudtasks.tasks.create.

בדוגמה, זהו חשבון השירות שמוגדר כברירת מחדל App Engine

gcloud projects add-iam-policy-binding $PROJECT_ID \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudtasks.enqueuer

הזהות שמשמשת להעברת משימות לתור ל-Cloud Tasks צריכה הרשאה כדי להשתמש בחשבון השירות שמשויך למשימה ב-Cloud Tasks.

בדוגמה, זהו חשבון השירות שמוגדר כברירת מחדל App Engine.

מאמרי העזרה של Google Cloud IAM איך מוסיפים את חשבון השירות App Engine שמוגדר כברירת מחדל? כמשתמש בחשבון השירות App Engine שמוגדר כברירת מחדל.

הזהות שמשמשת כדי להפעיל את הפונקציה של תור המשימות ההרשאה cloudfunctions.functions.invoke.

בדוגמה, זהו חשבון השירות שמוגדר כברירת מחדל App Engine

gcloud functions add-iam-policy-binding $FUNCTION_NAME \
  --region=us-central1 \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudfunctions.invoker