טריגרים של Cloud Firestore

בעזרת Cloud Functions תוכלו לטפל באירועים ב-Cloud Firestore בלי שתצטרכו לעדכן את קוד הלקוח. אפשר לבצע שינויים ב-Cloud Firestore דרך הממשק של קובץ snapshot של מסמך או דרך Admin SDK.

במחזור חיים טיפוסי, פונקציה של Cloud Firestore מבצעת את הפעולות הבאות:

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

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

טריגרים של פונקציות ב-Cloud Firestore

ה-SDK של Cloud Functions for Firebase מייצא אובייקט functions.firestore שמאפשר ליצור מנהלים שמקושרים לאירועים ספציפיים ב-Cloud Firestore.

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

כתיבת פונקציות שמופעל בהן טריגר של Cloud Firestore

הגדרת טריגר לפונקציה

כדי להגדיר טריגר ב-Cloud Firestore, מציינים נתיב למסמך וסוג אירוע:

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

נתיבי מסמכים יכולים להפנות למסמך ספציפי או לתבנית של תו כללי לחיפוש.

ציון מסמך יחיד

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

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

ציון קבוצה של מסמכים באמצעות תווים כלליים לחיפוש

אם רוצים לצרף טריגר לקבוצת מסמכים, למשל כל מסמך בקולקציה מסוימת, צריך להשתמש ב-{wildcard} במקום במזהה המסמך:

// Listen for changes in all documents in the 'users' collection
exports.useWildcard = functions.firestore
    .document('users/{userId}')
    .onWrite((change, context) => {
      // If we set `/users/marie` to {name: "Marie"} then
      // context.params.userId == "marie"
      // ... and ...
      // change.after.data() == {name: "Marie"}
    });
index.js

בדוגמה הזו, כששדה כלשהו במסמך כלשהו ב-users משתנה, הוא תואם למשתנה אסימון 'כל תו' שנקרא userId.

אם למסמך ב-users יש אוספי משנה, ושדה באחד מהמסמכים של אוספי המשנה האלה משתנה, תו המשתנה הלא ידוע userId לא מופעל.

התאמות של תווים כלליים לחיפוש מופקות מנתיב המסמך ונשמרות ב-context.params. אפשר להגדיר כמה תווים כלליים לחיפוש שרוצים כדי להחליף מזהי אוספים או מסמכים מפורשים, לדוגמה:

// Listen for changes in all documents in the 'users' collection and all subcollections
exports.useMultipleWildcards = functions.firestore
    .document('users/{userId}/{messageCollectionId}/{messageId}')
    .onWrite((change, context) => {
      // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
      // context.params.userId == "marie";
      // context.params.messageCollectionId == "incoming_messages";
      // context.params.messageId == "134";
      // ... and ...
      // change.after.data() == {body: "Hello"}
    });
index.js

טריגרים של אירועים

הפעלת פונקציה כשיוצרים מסמך חדש

אפשר להפעיל פונקציה שתופעל בכל פעם שייווצר מסמך חדש באוסף באמצעות טיפולן onCreate() עם תו אסימון כללי. פונקציית הדוגמה הזו מפעילה את createUser בכל פעם שנוסף פרופיל משתמש חדש:

exports.createUser = functions.firestore
    .document('users/{userId}')
    .onCreate((snap, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = snap.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

הפעלת פונקציה כשמסמך מתעדכן

אפשר גם להפעיל פונקציה כך שתופעל כשמסמך מתעדכן באמצעות הפונקציה onUpdate() עם תו פלג. הפונקציה לדוגמה הזו קורא לפונקציה updateUser אם משתמש משנה את הפרופיל שלו:

exports.updateUser = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

הפעלת פונקציה כשמסמך נמחק

אפשר גם להפעיל פונקציה כשמסמך נמחק באמצעות הפונקציה onDelete() עם תו כללי לחיפוש. הפונקציה לדוגמה קורא ל-deleteUser כשמשתמש מחק את פרופיל המשתמש שלו:

exports.deleteUser = functions.firestore
    .document('users/{userID}')
    .onDelete((snap, context) => {
      // Get an object representing the document prior to deletion
      // e.g. {'name': 'Marie', 'age': 66}
      const deletedValue = snap.data();

      // perform desired operations ...
    });
index.js

הפעלת פונקציה לכל השינויים במסמך

אם לא אכפת לכם מהסוג של האירוע שמופעל, אתם יכולים להאזין לכל השינויים במסמך ב-Cloud Firestore באמצעות הפונקציה onWrite() עם תו Wildcard. הפונקציה לדוגמה הזו מפעילה את modifyUser אם משתמש נוצר, מתעדכן או נמחק:

exports.modifyUser = functions.firestore
    .document('users/{userID}')
    .onWrite((change, context) => {
      // Get an object with the current document value.
      // If the document does not exist, it has been deleted.
      const document = change.after.exists ? change.after.data() : null;

      // Get an object with the previous document value (for update or delete)
      const oldDocument = change.before.data();

      // perform desired operations ...
    });
index.js

קריאה וכתיבה של נתונים

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

נתוני אירוע

קריאת נתונים

כשפונקציה מופעלת, יכול להיות שתרצו לקבל נתונים ממסמך שעודכן, או לקבל את הנתונים לפני העדכון. אפשר לקבל את הנתונים הקודמים באמצעות change.before.data(), שמכיל את קובץ snapshot של המסמך לפני העדכון. באופן דומה, המשתנה change.after.data() מכיל את המצב של תמונת המצב של המסמך אחרי העדכון.

exports.updateUser2 = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the current document
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();
    });
index.js

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

// Fetch data using standard accessors
const age = snap.data().age;
const name = snap.data()['name'];

// Fetch data using built in accessor
const experience = snap.get('experience');
index.js

כתיבת נתונים

כל קריאה לפונקציה משויכת למסמך ספציפי במסד הנתונים של Cloud Firestore. אפשר לגשת למסמך הזה בתור DocumentReference במאפיין ref של קובץ snapshot שמוחזרת לפונקציה.

הערך של DocumentReference מגיע מ-Cloud Firestore Node.js SDK, וכולל שיטות כמו update(), ‏ set() ו-remove() שמאפשרות לשנות בקלות את המסמך שהפעיל את הפונקציה.

// Listen for updates to any `user` document.
exports.countNameChanges = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Retrieve the current and previous value
      const data = change.after.data();
      const previousData = change.before.data();

      // We'll only update if the name has changed.
      // This is crucial to prevent infinite loops.
      if (data.name == previousData.name) {
        return null;
      }

      // Retrieve the current count of name changes
      let count = data.name_change_count;
      if (!count) {
        count = 0;
      }

      // Then return a promise of a set operation to update the count
      return change.after.ref.set({
        name_change_count: count + 1
      }, {merge: true});
    });
index.js

נתונים מחוץ לאירוע ההפעלה

Cloud Functions מריצים בסביבה מהימנה, כלומר הם מוסמכים כחשבון שירות בפרויקט. אפשר לבצע פעולות קריאה וכתיבה באמצעות Firebase Admin SDK:

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();

exports.writeToFirestore = functions.firestore
  .document('some/doc')
  .onWrite((change, context) => {
    db.doc('some/otherdoc').set({ ... });
  });

מגבלות

חשוב לשים לב למגבלות הבאות לגבי טריגרים של Cloud Firestore ל-Cloud Functions:

• Cloud Functions (דור ראשון) מחייב מסד נתונים קיים מסוג '(default)' במצב מקורי של Firestore. הוא לא תומך במסדי נתונים Cloud Firestore עם שם או במצב Datastore. במקרים כאלה, צריך להשתמש ב-Cloud Functions (דור שני) כדי להגדיר אירועים.
• לא מובטח שההזמנה תבוצע. שינויים מהירים יכולים להפעיל קריאות לפונקציות בסדר לא צפוי.
• האירועים מועברים לפחות פעם אחת, אבל אירוע אחד יכול לגרום להפעלה של כמה פונקציות. הימנעו מהסתמכות על מנגנונים של 'פעם אחת בלבד', וכתבו פונקציות חד-ערכיות (idempotent).
• כדי להשתמש ב-Cloud Firestore במצב Datastore נדרש Cloud Functions (דור שני). ב-Cloud Functions (דור ראשון) אין תמיכה במצב Datastore.
• כל טריגר משויך למסד נתונים אחד. לא ניתן ליצור טריגר שתואמת למספר מסדי נתונים.
• מחיקת מסד נתונים לא מוחקת באופן אוטומטי את הטריגרים של אותו מסד נתונים. הטריגר יפסיק לשלוח אירועים, אבל הוא ימשיך להתקיים עד שתמחקו אותו.
• אם אירוע תואם חורג מגודל הבקשה המקסימלי, יכול להיות שהאירוע לא יישלח אל Cloud Functions (דור ראשון).
  • אירועים שלא נשלחו בגלל גודל הבקשה מתועדים ביומני הפלטפורמה ומספרם נספר בשימוש היומן של הפרויקט.
  • היומנים האלה מופיעים ב-Logs Explorer עם ההודעה "Event cannot deliver to Cloud function due to size exceeding the limit for 1st gen..." ברמת חומרה error. שם הפונקציה מופיע בשדה functionName. אם השדה receiveTimestamp עדיין מתייחס לשעה הקרובה, תוכלו להסיק את תוכן האירוע בפועל על ידי קריאת המסמך הרלוונטי באמצעות קובץ snapshot לפני ואחרי חותמת הזמן.
  • כדי להימנע מקצב כזה, אתם יכולים:
    • העברה ושדרוג ל-Cloud Functions (דור שני)
    • צמצום המסמך
    • מוחקים את ה-Cloud Functions הרלוונטי
  • אפשר להשבית את הרישום ביומן באמצעות החרגות, אבל חשוב לזכור שהאירועים הבעייתיים עדיין לא יישלחו.