קישור האפליקציה ויצירת אב טיפוס


לפני שמתחילים להשתמש ב-Firebase Local Emulator Suite, צריך לוודא שיצרתם פרויקט Firebase, הגדרתם את סביבת הפיתוח ובחרתם והתקנתם את ערכות ה-SDK של Firebase לפלטפורמה שלכם בהתאם לנושאים במאמר תחילת העבודה עם Firebase לפלטפורמה שלכם: Apple,‏ Android או Web.

יצירת אב טיפוס ובדיקה

המאגר Local Emulator Suite מכיל כמה אמולטורים של מוצרים, כפי שמתואר במאמר מבוא ל-Firebase Local Emulator Suite. אתם יכולים ליצור אב טיפוס ולבדוק באמצעות אמולטורים בודדים וגם באמצעות שילובים של אמולטורים, בהתאם למוצרי Firebase שבהם אתם משתמשים בסביבת הייצור.

אינטראקציה בין מסד נתונים של Firebase לבין אמולטורים של פונקציות
מסד נתונים ואמולטורים של Cloud Functions כחלק מLocal Emulator Suite מלא.

כדי להציג את תהליך העבודה של Local Emulator Suite, נניח שאתם עובדים על אפליקציה שמשתמשת בשילוב אופייני של מוצרים: מסד נתונים של Firebase ופונקציות בענן שמופעלות על ידי פעולות במסד הנתונים הזה.

אחרי שמפעילים את פרויקט Firebase באופן מקומי, מחזור הפיתוח באמצעות Local Emulator Suite כולל בדרך כלל שלושה שלבים:

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

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

  3. אפשר להשתמש באמולטורים ובסקריפטים בהתאמה אישית כדי להפוך את הבדיקות לאוטומטיות.

הפעלה מקומית של פרויקט Firebase

חשוב להתקין את ה-CLI או לעבור לגרסה העדכנית שלו.

curl -sL firebase.tools | bash

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

firebase init

ספריית הפרויקט תכיל עכשיו קובצי תצורה של Firebase, Firebase Security Rulesקובץ הגדרה למסד הנתונים, functionsספרייה שמכילה קוד של Cloud Functions וקבצים תומכים אחרים.

יצירת אב טיפוס אינטראקטיבי

‫Local Emulator Suite נועד לאפשר לכם ליצור אב טיפוס במהירות של תכונות חדשות, וממשק המשתמש המובנה של Suite הוא אחד מכלי האב טיפוס השימושיים ביותר שלו. זה קצת כמו להריץ את מסוף Firebase באופן מקומי.

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

הכל זמין כשמתחילים את Local Emulator Suite עם:

firebase emulators:start

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

  1. כדי ליצור פונקציית Cloud שמופעלת על ידי כתיבה למסד נתונים, עורכים את הקובץ functions/index.js בספריית הפרויקט. מחליפים את התוכן של הקובץ הקיים בקטע הקוד הבא. הפונקציה הזו עוקבת אחרי שינויים במסמכים באוסף messages, ממירה את התוכן של השדה original במסמך לאותיות רישיות, ומאחסנת את התוצאה בשדה uppercase במסמך.
    2.   const functions = require('firebase-functions/v1');

  exports.makeUppercase = functions.firestore.document('/messages/{documentId}')
      .onCreate((snap, context) => {
        const original = snap.data().original;
        console.log('Uppercasing', context.params.documentId, original);
        const uppercase = original.toUpperCase();
        return snap.ref.set({uppercase}, {merge: true});
      });
  2. מפעילים את Local Emulator Suite באמצעות firebase emulators:start. האמולטורים של Cloud Functions ושל מסד הנתונים מופעלים ומוגדרים אוטומטית לפעולה הדדית.
  3. אפשר לראות את ממשק המשתמש בדפדפן בכתובת http://localhost:4000. יציאה 4000 היא ברירת המחדל לממשק המשתמש, אבל כדאי לבדוק את הפלט של הודעות הטרמינל שמופק על ידי Firebase CLI. שימו לב לסטטוס של האמולטורים הזמינים. במקרה שלנו, יפעלו האמולטורים Cloud Functions ו-Cloud Firestore.
    התמונה שלי
  4. בממשק המשתמש, בכרטיסייה Firestore > Data, לוחצים על Start collection ופועלים לפי ההנחיות כדי ליצור מסמך חדש באוסף messages, עם שם השדה original והערך test. הפעולה הזו מפעילה את פונקציית הענן שלנו. אחרי זמן קצר יופיע שדה חדש uppercase עם המחרוזת TEST.
    התמונה שלי התמונה שלי
  5. בכרטיסייה Firestore > Requests, בודקים את הבקשות שנשלחו למסד הנתונים המדומה, כולל כל ההערכות של Firebase Security Rules שבוצעו כחלק ממימוש הבקשות האלה.
  6. בודקים בכרטיסייה Logs (יומנים) כדי לוודא שהפונקציה לא נתקלה בשגיאות בזמן שהיא עדכנה את מסד הנתונים.

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

חיבור האפליקציה לאמולטורים

אחרי שתתקדמו עם יצירת אב טיפוס אינטראקטיבי ותבחרו עיצוב, תוכלו להוסיף לאפליקציה קוד גישה למסד נתונים באמצעות ה-SDK המתאים. תמשיכו להשתמש בכרטיסייה'מסד נתונים' ובכרטיסייה Logs (יומנים) ב-Emulator Suite UI כדי לוודא שההתנהגות של האפליקציה תקינה.

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

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

Kotlin
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val firestore = Firebase.firestore
firestore.useEmulator("10.0.2.2", 8080)

firestore.firestoreSettings = firestoreSettings {
    isPersistenceEnabled = false
}
EmulatorSuite.kt
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);
EmulatorSuite.java
Swift
let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings
ViewController.swift

Web

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
fs_emulator_connect.js

Web

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("127.0.0.1", 8080);
}
emulator-suite.js

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

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

firebase emulators:exec "./testdir/test.sh"

מידע מפורט על אמולטורים ספציפיים

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

מה הלאה?

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