טריגרים של Pub/Sub


Pub/Sub של Google Cloud הוא מערך הודעות שמופץ ברחבי העולם, שמתאים את עצמו באופן אוטומטי לצרכים שלכם. אפשר ליצור פונקציה שמטפלת באירועי Pub/Sub באמצעות functions.pubsub.

הפעלת פונקציית Pub/Sub

אפשר להפעיל פונקציה בכל פעם שנשלחת הודעה חדשה מסוג Pub/Sub לנושא ספציפי. צריך לציין את שם הנושא Pub/Sub שבו רוצים להפעיל את הפונקציה, ולהגדיר את האירוע בתוך פונקציית הטיפול באירועים onPublish():

exports.helloPubSub = functions.pubsub.topic('topic-name').onPublish((message) => {
  // ...
});

גישה לעומס של הודעות Pub/Sub {:#access-pub/sub}

אפשר לגשת למטען הייעודי (Payload) של ההודעה Pub/Sub מהאובייקט Message שמוחזר לפונקציה. בהודעות עם JSON בגוף ההודעה Pub/Sub, ל-SDK של Firebase עבור Cloud Functions יש מאפיין עזר לפענוח ההודעה. לדוגמה, הנה הודעה שפורסמה עם מטען ייעודי (payload) פשוט של JSON:

gcloud pubsub topics publish topic-name --message '{"name":"Xenia"}'

אפשר לגשת למטען נתונים של JSON באופן הבא דרך המאפיין json:

  // Get the `name` attribute of the PubSub message JSON body.
  let name = null;
  try {
    name = message.json.name;
  } catch (e) {
    functions.logger.error('PubSub message was not JSON', e);
  }

מטענים ייעודיים (payloads) אחרים שאינם בפורמט JSON נמצאים בהודעה Pub/Sub כמחרוזות בקידוד base64 באובייקט ההודעה. כדי לקרוא הודעה כמו זו, צריך לפענח את המחרוזת בקידוד base64 כפי שמוצג:

gcloud pubsub topics publish topic-name --message 'MyMessage'

// Decode the PubSub Message body.
const messageBody = message.data ? Buffer.from(message.data, 'base64').toString() : null;

מאפייני הודעות גישה {:#access-message}

ניתן לשלוח הודעת Pub/Sub עם מאפייני נתונים שמוגדרים בפקודת הפרסום. לדוגמה, אפשר לפרסם הודעה עם המאפיין name:

gcloud pubsub topics publish topic-name --attribute name=Xenia

אפשר לקרוא מאפיינים כאלה ב-Message.attributes:

// Get the `name` attribute of the message.
const name = message.attributes.name;

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

exports.myFunction = functions.pubsub.topic('topic1').onPublish((message, context) => {
    console.log('The function was triggered at ', context.timestamp);
    console.log('The unique ID for the event is', context.eventId);
});