הרצת פונקציות באופן מקומי

ה-CLI של Firebase כולל אמולטור של Cloud Functions שיכול לדמות את סוגי הפונקציות הבאים:

  • פונקציות HTTPS
  • פונקציות שניתן להפעיל
  • פונקציות של תור משימות
  • פונקציות רקע שמופעלות מ-Firebase Authentication, מ-Realtime Database, מ-Cloud Firestore, מ-Cloud Storage, מהתראות נתמכות של Firebase ומ-Cloud Pub/Sub.

אפשר להריץ פונקציות באופן מקומי כדי לבדוק אותן לפני הפריסה בסביבת הייצור.

התקנת ה-CLI של Firebase

כדי להשתמש במהדר Cloud Functions, קודם צריך להתקין את Firebase CLI:

npm install -g firebase-tools

כדי להשתמש בסימולטור המקומי, Cloud Functions צריך להיות תלוי ב:

  • firebase-admin בגרסה 8.0.0 ואילך.
  • firebase-functions בגרסה 3.0.0 ואילך.

הגדרת פרטי הכניסה של האדמין (אופציונלי)

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

  • לטריגרים Cloud Firestore ו-Realtime Database כבר יש פרטי כניסה מספיקים, והם לא דורשים הגדרה נוספת.
  • כל ממשקי ה-API האחרים, כולל ממשקי Firebase כמו Authentication ו-FCM או ממשקי Google כמו Cloud Translation או Cloud Speech, דורשים את שלבי ההגדרה שמפורטים בקטע הזה. ההנחיה הזו רלוונטית גם אם משתמשים במעטפת Cloud Functions וגם אם משתמשים ב-firebase emulators:start.

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

  1. פותחים את החלונית Service Accounts במסוף Google Cloud.
  2. מוודאים שבחרתם באפשרות App Engine default service account, ובתפריט האפשרויות שבצד שמאל בוחרים באפשרות Create key.
  3. כשמופיעה בקשה, בוחרים באפשרות JSON בתור סוג המפתח ולוחצים על Create.

  4. מגדירים את פרטי הכניסה שמוגדרים כברירת מחדל ב-Google כך שיצביעו על המפתח שהורדתם:

    Unix

    export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
firebase emulators:start

    Windows

    set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
firebase emulators:start

אחרי ביצוע השלבים האלה, לבדיקות הפונקציות תהיה גישה ל-Firebase ול-Google APIs באמצעות Admin SDK. לדוגמה, כשבודקים טריגר Authentication, הפונקציה המדומה יכולה להפעיל את admin.auth().getUserByEmail(email).

הגדרת ההגדרות של הפונקציות (אופציונלי)

אם אתם משתמשים במשתני תצורה מותאמים אישית של פונקציות, תחילה מריצים את הפקודה כדי לקבל את ההגדרות המותאמות אישית (מריצים את הפקודה בתוך הספרייה functions) בסביבה המקומית:

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json

הפעלת חבילת האמולטורים

כדי להריץ את המהדר של Cloud Functions, משתמשים בפקודה emulators:start:

firebase emulators:start

הפקודה emulators:start תפעיל אמוללטורים של Cloud Functions,‏ Cloud Firestore, ‏ Realtime Database ו-Firebase Hosting, בהתאם למוצרים שהפעלתם בפרויקט המקומי באמצעות firebase init. אם רוצים להפעיל אמולטור מסוים, משתמשים בדגל --only:

firebase emulators:start --only functions

אם רוצים להריץ חבילת בדיקות או סקריפט בדיקה אחרי שהאמולטורים הופעלו, משתמשים בפקודה emulators:exec:

firebase emulators:exec "./my-test.sh"

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

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

הוספת כלי למדידה לאפליקציה לצורך קריאה לפונקציות

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

Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val functions = Firebase.functions
functions.useEmulator("10.0.2.2", 5001)
MainActivity.kt
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFunctions functions = FirebaseFunctions.getInstance();
functions.useEmulator("10.0.2.2", 5001);
MainActivity.java
Swift
Functions.functions().useFunctionsEmulator(origin: "http://127.0.0.1:5001")
ViewController.swift

Web

import { getApp } from "firebase/app";
import { getFunctions, connectFunctionsEmulator } from "firebase/functions";

const functions = getFunctions(getApp());
connectFunctionsEmulator(functions, "127.0.0.1", 5001);
fb_functions_emulator_connect.js

Web

firebase.functions().useEmulator("127.0.0.1", 5001);
emulator-suite.js

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

כל פונקציית HTTPS בקוד תוצג מהאמולטור המקומי באמצעות פורמט כתובת ה-URL הבא:

http://$HOST:$PORT/$PROJECT/$REGION/$NAME

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

https://localhost:5001/$PROJECT/us-central1/helloWorld

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

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

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

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

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

  • אמולטור Realtime Database
  • אמולטור Cloud Firestore
  • אמולטור Authentication
  • אמולטור Pub/Sub
  • אמולטור התראות של Firebase

כדי להפעיל אירועים ברקע, משנים את המשאבים בקצה העורפי באמצעות Emulator Suite UI, או מחברים את האפליקציה או את קוד הבדיקה למהדמנים באמצעות ה-SDK של הפלטפורמה.

בדיקת רכיבי טיפול (handler) לאירועים מותאמים אישית שמופעלים על ידי תוספים

בפונקציות שמטמיעים כדי לטפל באירועים מותאמים אישית של Firebase Extensions באמצעות Cloud Functions v2, הסימולטור של Cloud Functions מתואם עם הסימולטור של Eventarc כדי לתמוך בטריגרים של Eventarc.

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

סביבת זמן הריצה Cloud Functions מגדירה את משתנה הסביבה EVENTARC_EMULATOR לערך localhost:9299 בתהליך הנוכחי, אם אמולטור Eventarc פועל. ה-Firebase Admin SDK מתחברים באופן אוטומטי למהדמ של Eventarc כשמגדירים את משתנה הסביבה EVENTARC_EMULATOR. אפשר לשנות את יציאת ברירת המחדל כפי שמתואר בקטע הגדרת Local Emulator Suite.

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

אפשר לבדוק את יומני Functions ב-Emulator Suite UI כדי לקבל פרטים על ביצוע הטיפול.

אינטראקציות עם שירותים אחרים

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

Cloud Firestore

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

Cloud Storage

אם יש לכם פונקציות שמשתמשות ב-Firebase Admin SDK (גרסה 9.7.0 ואילך) כדי לכתוב ב-Cloud Storage, פעולות הכתיבה האלה יישלחו למהדר של Cloud Storage אם הוא פועל. אם הפעולות האלה יפעילו פונקציות נוספות, הן יופעלו במהמתר Cloud Functions.

Firebase Authentication

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

אירוח ב-Firebase

אם אתם משתמשים ב-Cloud Functions כדי ליצור תוכן דינמי עבור Firebase Hosting, firebase emulators:start משתמש בפונקציות ה-HTTP המקומיות שלכם כשרתי proxy לאירוח.

התראות ב-Firebase

בכל פרויקט שכולל לפחות טריגר אחד נתמך של התראות ב-Firebase, כרטיסיית FireAlerts מופיעה בממשק המשתמש של המהדר. כדי לדמות הפעלה של התראה:

  1. פותחים את הכרטיסייה FireAlerts. בכרטיסייה הזו מוצגת תפריט נפתח עם סוגי ההתראות שיש להן טריגרים משויכים (לדוגמה, אם יש לכם טריגר onNewFatalIssuePublished, יוצג הערך crashlytics.newFatalIssue).
  2. בוחרים סוג התראה. הטופס מתמלא באופן אוטומטי בערכי ברירת מחדל, שאפשר לערוך. אפשר לערוך את השדות של האירוע (מידע אחר מאירוע ההתראה הוא משוער, ערכים מדומים או שנוצרו באופן אקראי).
  3. בוחרים באפשרות Send Alert כדי לשלוח התראה סינתטית למהדמם הפונקציות, עם רישום ביומן בAlerts במסוף Firebase (וגם ביומנים).

רישום ביומן

הסימולטור מעביר בזמן אמת יומנים מהפונקציות שלכם לחלון מסוף שבו הן פועלות. הוא מציג את כל הפלט מהצהרות console.log(),‏ console.info(),‏ console.error() ו-console.warn() בתוך הפונקציות.

השלבים הבאים

דוגמה מלאה לשימוש בחבילת המהדמנים של Firebase מופיעה במדריך למתחילים בנושא בדיקות.