ניהול פונקציות


אפשר לפרוס, למחוק ולשנות פונקציות באמצעות Firebase פקודות CLI או על ידי הגדרת אפשרויות זמן ריצה בקוד המקור של הפונקציות.

פריסת פונקציות

כדי לפרוס פונקציות, מריצים את הפקודה הבאה ב-FirebaseCLI:

firebase deploy --only functions

כברירת מחדל, Firebase CLI פורס את כל הפונקציות במקור בו-זמנית. אם הפרויקט מכיל יותר מ-5 פונקציות, מומלץ להשתמש בדגל --only עם שמות פונקציות ספציפיים כדי לפרוס רק את הפונקציות שערכתם. פריסת פונקציות ספציפיות השיטה הזו מזרזת את תהליך הפריסה ועוזרת לכם להימנע מחריגה ממכסות הפריסה. לדוגמה:

firebase deploy --only functions:addMessage,functions:makeUppercase

כשפורסים מספר גדול של פונקציות, יכול להיות שתחרגו מהמכסה הרגילה ותקבלו הודעות שגיאה HTTP 429 או 500. כדי לפתור את הבעיה, כדאי לפרוס פונקציות בקבוצות של 10 או פחות.

רשימה מלאה של הפקודות הזמינות מופיעה במאמרי העזרה של Firebase CLI.

כברירת מחדל, ה-CLI של Firebase מחפש את קוד המקור בתיקייה functions/. אם רוצים, אפשר לארגן פונקציות בבסיסי קוד או בכמה קבוצות של קבצים.

ניקוי של ארטיפקטים של פריסה

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

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

כדי לעזור לכם לנהל את עלויות האחסון, ב-Firebase CLI בגרסה 14.0.0 ואילך אפשר להגדיר Artifact Registryמדיניות ניקוי למאגרי מידע שמאחסנים ארטיפקטים של פריסה אחרי כל פריסה של פונקציה.

אפשר להגדיר או לערוך מדיניות ניקוי באופן ידני באמצעות הפקודה functions:artifacts:setpolicy:

firebase functions:artifacts:setpolicy

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

אפשר להתאים אישית את תקופת השמירה באמצעות האפשרות --days:

firebase functions:artifacts:setpolicy --days 7  # Delete images older than 7 days

אם פורסים פונקציות בכמה אזורים, אפשר להגדיר מדיניות ניקוי למיקום ספציפי באמצעות האפשרות --location:

$ firebase functions:artifacts:setpolicy --location europe-west1

ביטול ההסכמה לניקוי פריטי מידע שנוצרו בתהליך פיתוח (Artifact)

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

$ firebase functions:artifacts:setpolicy --none

הפקודה הזו מסירה כל מדיניות ניקוי קיימת שהוגדרה באמצעות Firebase CLI ומונעת מ-Firebase להגדיר מדיניות ניקוי אחרי פריסת פונקציות.

מחיקת פונקציות

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

  • באופן מפורש ב-CLI של Firebase באמצעות functions:delete
  • באופן מפורש במסוף Google Cloud.
  • באופן משתמע על ידי הסרת הפונקציה מהמקור לפני הפריסה.

בכל פעולות המחיקה מוצגת בקשה לאישור לפני הסרת הפונקציה מסביבת הייצור.

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

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction

# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1

# Delete more than one function
firebase functions:delete myFunction myOtherFunction

# Delete a specified functions group.
firebase functions:delete groupA

# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

במחיקה מרומזת של פונקציות, firebase deploy מנתח את המקור ומסיר מהייצור את כל הפונקציות שהוסרו מהקובץ.

שינוי השם, האזור או הטריגר של פונקציה

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

שינוי שם של פונקציה

כדי לשנות את השם של פונקציה, יוצרים גרסה חדשה של הפונקציה עם השם החדש במקור, ואז מריצים שתי פקודות פריסה נפרדות. הפקודה הראשונה פורסת את הפונקציה החדשה, והפקודה השנייה מסירה את הגרסה שנפרסה קודם. לדוגמה, אם יש לכם פונקציית Node.js בשם webhook שאתם רוצים לשנות ל-webhookNew, אתם יכולים לשנות את הקוד באופן הבא:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

לאחר מכן מריצים את הפקודות הבאות כדי לפרוס את הפונקציה החדשה:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

שינוי האזור או האזורים של פונקציה

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

  1. משנים את השם של הפונקציה, ומשנים את האזור או האזורים שלה לפי הצורך.
  2. מפעילים את הפונקציה ששמה שונה, וכתוצאה מכך אותו קוד מופעל באופן זמני בשתי קבוצות האזורים.
  3. מחיקת הפונקציה הקודמת.

לדוגמה, אם יש לכם פונקציה בשם webhook שנמצאת כרגע באזור ברירת המחדל של הפונקציות ב-us-central1, ואתם רוצים להעביר אותה ל-asia-northeast1, אתם צריכים קודם לשנות את קוד המקור כדי לשנות את השם של הפונקציה ולשנות את האזור.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

לאחר מכן מפעילים את הפקודה הבאה כדי לפרוס:

firebase deploy --only functions:webhookAsia

עכשיו פועלות שתי פונקציות זהות: webhook פועלת ב-us-central1 ו-webhookAsia פועלת ב-asia-northeast1.

לאחר מכן, מוחקים את webhook:

firebase functions:delete webhook

עכשיו יש רק פונקציה אחת – webhookAsia, שפועלת ב-asia-northeast1.

שינוי סוג הטריגר של פונקציה

במהלך הפיתוח של Cloud Functions for Firebaseהפריסה לאורך זמן, יכול להיות שתצטרכו לשנות את סוג הטריגר של פונקציה מסיבות שונות. לדוגמה, יכול להיות שתרצו לשנות מסוג אחד של אירוע Firebase Realtime Database או Cloud Firestore לסוג אחר.

אי אפשר לשנות את סוג האירוע של פונקציה רק על ידי שינוי קוד המקור והרצת firebase deploy. כדי להימנע משגיאות, צריך לשנות את סוג הטריגר של פונקציה באמצעות התהליך הבא:

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

לדוגמה, אם יש לכם פונקציית Node.js בשם objectChanged עם סוג האירוע מדור קודם onChange, ואתם רוצים לשנות אותה ל-onFinalize, קודם תשנו את השם של הפונקציה ותערכו אותה כך שסוג האירוע יהיה onFinalize.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

לאחר מכן מריצים את הפקודות הבאות כדי ליצור את הפונקציה החדשה לפני שמוחקים את הפונקציה הישנה:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

הגדרת אפשרויות זמן ריצה

‫Cloud Functions for Firebase מאפשר לבחור אפשרויות של זמן ריצה, כמו גרסת זמן הריצה של Node.js, וזמן קצוב לתפוגה לכל פונקציה, הקצאת זיכרון ומספר מינימלי/מקסימלי של מופעי פונקציה.

השיטה המומלצת היא להגדיר את האפשרויות האלה (חוץ מגרסת Node.js) באובייקט הגדרה בתוך קוד הפונקציה. אובייקט RuntimeOptions הזה הוא מקור האמת של אפשרויות זמן הריצה של הפונקציה, והוא יבטל אפשרויות שהוגדרו בכל שיטה אחרת (למשל באמצעות מסוף Google Cloud או gcloud CLI).

אם תהליך העבודה שלכם בפיתוח כולל הגדרה ידנית של אפשרויות זמן ריצה דרך מסוף Google Cloud או CLI של gcloud, ואתם לא רוצים שהערכים האלה יוחלפו בכל פריסה, צריך להגדיר את האפשרות preserveExternalChanges לערך true. אם האפשרות הזו מוגדרת ל-true,‏ Firebase ממזג את אפשרויות זמן הריצה שמוגדרות בקוד עם ההגדרות של הגרסה הנוכחית של הפונקציה שפרסמתם, לפי סדר העדיפות הבא:

  1. האפשרות מוגדרת בקוד הפונקציות: ביטול שינויים חיצוניים.
  2. האפשרות מוגדרת ל-RESET_VALUE בקוד הפונקציות: שינויים חיצוניים מוחלפים בערך ברירת המחדל.
  3. האפשרות לא מוגדרת בקוד הפונקציות, אבל היא מוגדרת בפונקציה שכרגע בפריסה: משתמשים באפשרות שצוינה בפונקציה שפריסה.

לא מומלץ להשתמש באפשרות preserveExternalChanges: true ברוב התרחישים, כי הקוד לא יהיה יותר המקור המלא של האמת לגבי אפשרויות זמן הריצה של הפונקציות. אם משתמשים בו, צריך לבדוק את מסוף Google Cloud או להשתמש ב-CLI של gcloud כדי לראות את ההגדרה המלאה של פונקציה.

הגדרת גרסת Node.js

ערכת ה-SDK‏ Firebase ל-Cloud Functions מאפשרת לבחור סביבת זמן ריצה של Node.js. אתם יכולים להפעיל את כל הפונקציות בפרויקט באופן בלעדי בסביבת זמן הריצה שמתאימה לאחת מגרסאות Node.js הנתמכות הבאות:

  • ‫Node.js 20
  • ‫Node.js 18 (הוצא משימוש)

בלוח הזמנים לתמיכה מופיע מידע חשוב לגבי תמיכה שוטפת בגרסאות האלה של Node.js.

כדי להגדיר את גרסת Node.js:

אפשר להגדיר את הגרסה בשדה engines בקובץ package.json שנוצר בספרייה functions/ במהלך האתחול. לדוגמה, כדי להשתמש רק בגרסה 20, עורכים את השורה הזו ב-package.json:

  "engines": {"node": "20"}

אם אתם משתמשים במנהל החבילות Yarn או שיש לכם דרישות ספציפיות אחרות לגבי השדה engines, אתם יכולים להגדיר את זמן הריצה של Firebase SDK ל-Cloud Functions ב-firebase.json במקום זאת:

  {
    "functions": {
      "runtime": "nodejs20"
    }
  }

ממשק ה-CLI משתמש בערך שמוגדר ב-firebase.json במקום בכל ערך או טווח שמוגדרים בנפרד ב-package.json.

שדרוג סביבת הריצה של Node.js

כדי לשדרג את זמן הריצה של Node.js:

  1. מוודאים שהפרויקט שלכם מוגדר בתוכנית התמחור Blaze.
  2. חשוב לוודא שאתם משתמשים ב-Firebase CLI בגרסה 11.18.0 ואילך.
  3. משנים את הערך engines בקובץ package.json שנוצר בספרייה functions/ במהלך האתחול. לדוגמה, אם משדרגים מגרסה 16 לגרסה 18, הרשומה צריכה להיראות כך: "engines": {"node": "18"}
  4. אפשר גם לבדוק את השינויים באמצעות Firebase Local Emulator Suite.
  5. פורסים מחדש את כל הפונקציות.

שליטה בהתנהגות ההתאמה לעומס

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

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

צמצום מספר ההפעלות הקרות

כדי להגדיר מספר מינימלי של מופעים לפונקציה בקוד המקור, משתמשים בשיטה runWith. השיטה הזו מקבלת אובייקט JSON שתואם לממשק RuntimeOptions, שמגדיר את הערך של minInstances. לדוגמה, הפונקציה הזו מגדירה מינימום של 5 מופעים כדי לשמור על מצב פעיל:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });
index.js

כמה דברים שכדאי לזכור כשמגדירים ערך לפרמטר minInstances:

  • אם Cloud Functions for Firebase יגדיל את האפליקציה מעל ההגדרה minInstances, תהיה הפעלה במצב התחלתי (cold start) לכל מופע מעל הסף הזה.
  • ההשפעה של הפעלות במצב התחלתי (cold start) חמורה במיוחד באפליקציות עם תנועה לא יציבה. אם לאפליקציה שלכם יש תנועה עם עליות חדות ואתם מגדירים ערך גבוה מספיק ל-minInstances כך שזמני ההפעלה הקרים יצטמצמו בכל עלייה בתנועה, תבחינו בצמצום משמעותי של זמן האחזור. באפליקציות עם תנועה קבועה, סביר להניח שהפעלות במצב התחלתי לא ישפיעו באופן משמעותי על הביצועים.

  • הגדרת מספר מינימלי של מופעים יכולה להיות הגיונית בסביבות ייצור, אבל בדרך כלל כדאי להימנע ממנה בסביבות בדיקה. כדי להגדיר את הערך minInstances ל-0 בפרויקט הבדיקה, אבל עדיין לצמצם את ההפעלה האיטית במצב התחלתי בפרויקט הייצור, אפשר להגדיר את הערך הזה על סמך משתנה הסביבה FIREBASE_CONFIG:

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      // in production only. Default to 0 for test projects.
      minInstances: envProjectId === "my-production-project" ? 5 : 0,
    })
    .https.onRequest((req, res) => {
      // render some html
    });
    index.js

הגבלת המספר המקסימלי של מופעים לפונקציה

כדי להגדיר את מספר המופעים המקסימלי בקוד המקור של הפונקציה, משתמשים בשיטה runWith. השיטה הזו מקבלת אובייקט JSON שתואם לממשק RuntimeOptions, שמגדיר ערכים ל-maxInstances. לדוגמה, הפונקציה הזו מגדירה מגבלה של 100 מופעים כדי לא להעמיס על מסד נתונים היפותטי מדור קודם:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });
index.js

אם פונקציית HTTP מורחבת עד למגבלת maxInstances, בקשות חדשות מוכנסות לתור למשך 30 שניות ואז נדחות עם קוד תגובה של 429 Too Many Requests אם אף מופע לא זמין עד אז.

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

הגדרת פסק זמן והקצאת זיכרון

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

כדי להגדיר הקצאת זיכרון וזמן קצוב לתפוגה בקוד המקור של הפונקציות, משתמשים בפרמטר runWith שהוצג ב-Firebase SDK ל-Cloud Functions 2.0.0. אפשר להזין לאפשרות הזו בזמן הריצה אובייקט JSON שתואם לממשק RuntimeOptions, שמגדיר ערכים ל-timeoutSeconds ול-memory. לדוגמה, פונקציית האחסון הזו משתמשת בזיכרון בנפח 1GB והזמן הקצוב לתפוגה שלה הוא 300 שניות:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });
index.js

הערך המקסימלי של timeoutSeconds הוא 540, או 9 דקות. כמות הזיכרון שמוקצה לפונקציה תואמת למעבד שהוקצה לפונקציה, כפי שמפורט ברשימת הערכים התקינים של memory:

  • ‫128MB — 200MHz
  • ‫256MB – 400MHz
  • ‫512MB — 800MHz
  • ‫1GB — 1.4 GHz
  • ‫2GB — 2.4 GHz
  • ‫4GB — 4.8 GHz
  • ‫8GB — 4.8 GHz

כדי להגדיר הקצאת זיכרון וזמן קצוב לתפוגה במסוף Google Cloud:

  1. במסוף Google Google Cloud, בוחרים באפשרות Cloud Functions בתפריט הימני.
  2. בוחרים פונקציה על ידי לחיצה על השם שלה ברשימת הפונקציות.
  3. לוחצים על סמל העריכה בתפריט העליון.
  4. בוחרים הקצאת זיכרון מהתפריט הנפתח עם התווית הזיכרון שהוקצה.
  5. לוחצים על עוד כדי להציג את האפשרויות המתקדמות, ומזינים מספר שניות בתיבת הטקסט זמן קצוב לתפוגה.
  6. לוחצים על שמירה כדי לעדכן את הפונקציה.