Firebase Local Emulator Suite को अलग-अलग प्रोटोटाइप और टेस्ट एनवायरमेंट के लिए इंस्टॉल और कॉन्फ़िगर किया जा सकता है. इसमें, प्रोटोटाइप बनाने के एक बार के सेशन से लेकर, प्रोडक्शन-स्केल के लगातार इंटिग्रेशन वाले वर्कफ़्लो तक सब कुछ शामिल है.
Local Emulator Suite इंस्टॉल करना
Emulator Suite इंस्टॉल करने से पहले, आपको ये काम करने होंगे:
Emulator Suite को इंस्टॉल करने के लिए:
- Firebase सीएलआई इंस्टॉल करें.
अगर आपके पास पहले से Firebase CLI इंस्टॉल नहीं है, तो
इसे अभी इंस्टॉल करें.
Emulator Suite का इस्तेमाल करने के लिए, आपके पास सीएलआई का 8.14.0 या इसके बाद का वर्शन होना चाहिए. इस निर्देश का इस्तेमाल करके, यह देखा जा सकता है कि आपने कौनसा वर्शन इंस्टॉल किया है:
firebase --version
- अगर आपने अब तक ऐसा नहीं किया है, तो मौजूदा वर्किंग डायरेक्ट्री को Firebase प्रोजेक्ट के तौर पर शुरू करें. इसके लिए, स्क्रीन पर दिए गए निर्देशों का पालन करके बताएं कि आपको किन प्रॉडक्ट का इस्तेमाल करना है:
firebase init
- Emulator Suite को सेट अप करें. यह निर्देश, कॉन्फ़िगरेशन विज़र्ड को शुरू करता है. इसकी मदद से, अपनी पसंद के एम्युलेटर चुने जा सकते हैं, उनसे जुड़ी एम्युलेटर बाइनरी फ़ाइलें डाउनलोड की जा सकती हैं, और एम्युलेटर पोर्ट सेट किए जा सकते हैं. ऐसा तब किया जा सकता है, जब डिफ़ॉल्ट पोर्ट सही न हों.
firebase init emulators
एम्युलेटर इंस्टॉल होने के बाद, अपडेट की जांच नहीं की जाती. साथ ही, जब तक Firebase CLI वर्शन को अपडेट नहीं किया जाता, तब तक कोई और डाउनलोड अपने-आप नहीं होगा.
Emulator Suite को कॉन्फ़िगर करना
आपके पास firebase.json फ़ाइल में, एम्युलेटर के नेटवर्क पोर्ट और सुरक्षा नियमों की परिभाषाओं के पाथ को कॉन्फ़िगर करने का विकल्प होता है:
firebase init emulatorsको चलाकर याfirebase.jsonमें मैन्युअल तरीके से बदलाव करके, एम्युलेटर पोर्ट बदलें.firebase.jsonमें मैन्युअल तरीके से बदलाव करके, सुरक्षा नियमों की परिभाषाओं का पाथ बदलें.
अगर इन सेटिंग को कॉन्फ़िगर नहीं किया जाता है, तो एम्युलेटर अपने डिफ़ॉल्ट पोर्ट पर काम करेंगे. साथ ही, Cloud Firestore, Realtime Database, और Cloud Storage for Firebase एम्युलेटर, ओपन डेटा सिक्योरिटी के साथ काम करेंगे.
| निर्देश देने के लिए | ब्यौरा |
|---|---|
| init emulators | एम्युलेटर को शुरू करने वाला विज़र्ड लॉन्च करें. इंस्टॉल किए जाने वाले एम्युलेटर की पहचान करें. साथ ही, एम्युलेटर पोर्ट की सेटिंग तय करें. हालांकि, ऐसा करना ज़रूरी नहीं है. init emulators से कोई नुकसान नहीं होता. डिफ़ॉल्ट सेटिंग स्वीकार करने पर, मौजूदा एम्युलेटर कॉन्फ़िगरेशन सुरक्षित रहेगा. |
पोर्ट कॉन्फ़िगरेशन
हर एम्युलेटर, आपकी मशीन पर किसी अलग पोर्ट से बाइंड होता है. इसके लिए, डिफ़ॉल्ट वैल्यू को प्राथमिकता दी जाती है.
| एम्युलेटर | डिफ़ॉल्ट पोर्ट |
|---|---|
| Authentication | 9099 |
| App Hosting | 5002 |
| Emulator Suite UI | 4,000 |
| Cloud Functions | 5001 |
| Eventarc | 9299 |
| Realtime Database | 9000 |
| Cloud Firestore | 8080 |
| Cloud Storage for Firebase | 9199 |
| Firebase Hosting | 5000 |
| Pub/Sub | 8085 |
प्रोजेक्ट आईडी कॉन्फ़िगरेशन
एम्युलेटर को शुरू करने के तरीके के आधार पर, अलग-अलग Firebase प्रोजेक्ट आईडी का इस्तेमाल करके, एम्युलेटर के कई इंस्टेंस चलाए जा सकते हैं. इसके अलावा, किसी प्रोजेक्ट आईडी के लिए, एम्युलेटर के कई इंस्टेंस भी चलाए जा सकते हैं. ऐसे मामलों में, एम्युलेटर इंस्टेंस अलग एनवायरमेंट में चलते हैं.
आम तौर पर, एम्युलेटर के सभी इन्वोकेशन के लिए एक प्रोजेक्ट आईडी सेट करना सही रहता है. इससे Emulator Suite UI, अलग-अलग प्रॉडक्ट एम्युलेटर, और किसी एम्युलेटर के सभी रनिंग इंस्टेंस, हर मामले में सही तरीके से कम्यूनिकेट कर सकते हैं.
Local Emulator Suite को जब एनवायरमेंट में कई प्रोजेक्ट आईडी मिलते हैं, तो वह चेतावनी जारी करता है. हालांकि, firebase.json में singleProjectMode कुंजी को false पर सेट करके, इस व्यवहार को बदला जा सकता है.
प्रोजेक्ट आईडी के एलान में मौजूद जानकारी के मेल न खाने की जांच, यहां की जा सकती है:
- कमांड लाइन में डिफ़ॉल्ट प्रोजेक्ट. डिफ़ॉल्ट रूप से, प्रोजेक्ट आईडी को स्टार्टअप पर
firebase initयाfirebase useसे चुने गए प्रोजेक्ट से लिया जाएगा. प्रोजेक्ट की सूची देखने और यह देखने के लिए कि कौनसा प्रोजेक्ट चुना गया है,firebase projects:listका इस्तेमाल करें. - नियमों के यूनिट टेस्ट. प्रोजेक्ट आईडी को अक्सर नियमों की यूनिट टेस्टिंग लाइब्रेरी के तरीकों
initializeTestEnvironmentयाinitializeTestAppके कॉल में बताया जाता है. - कमांड लाइन
--projectफ़्लैग. Firebase सीएलआई--projectफ़्लैग को पास करने पर, डिफ़ॉल्ट प्रोजेक्ट बदल जाता है. आपको यह पक्का करना होगा कि फ़्लैग की वैल्यू, यूनिट टेस्ट और ऐप्लिकेशन शुरू करने के दौरान प्रोजेक्ट आईडी से मैच करती हो.
Apple प्लैटफ़ॉर्म, Android, और वेब प्रोजेक्ट को कॉन्फ़िगर करते समय, प्लैटफ़ॉर्म के हिसाब से सेट किए गए प्रोजेक्ट आईडी कॉन्फ़िगरेशन भी देखें.
सुरक्षा नियमों का कॉन्फ़िगरेशन
एम्युलेटर, firebase.json में मौजूद database, firestore, और storage कॉन्फ़िगरेशन कुंजियों से सुरक्षा नियमों का कॉन्फ़िगरेशन लेंगे.
{
// Existing firebase configuration ...
"database": {
"rules": "database.rules.json"
},
"firestore": {
"rules": "firestore.rules"
},
"storage": {
"rules": "storage.rules"
}
// ...
// Optional emulator configuration. Default
// values are used if absent.
"emulators": {
"singleProjectMode": false, // do not warn on detection of multiple project IDs
"firestore": {
"port": "8080"
},
"ui": {
"enabled": true, // Default is `true`
"port": 4000 // If unspecified, see CLI log for selected port
},
"auth": {
"port": "9099"
},
"pubsub": {
"port": "8085"
}
}
}
Java के विकल्प तय करना
Realtime Database एम्युलेटर, Cloud Firestore एम्युलेटर, और Cloud Storage for Firebase एम्युलेटर का कुछ हिस्सा Java पर आधारित है. इसे एनवायरमेंट वैरिएबल JAVA_TOOL_OPTIONS की मदद से, जेवीएम फ़्लैग के साथ पसंद के मुताबिक बनाया जा सकता है.
उदाहरण के लिए, अगर आपको Java हीप स्पेस से जुड़ी गड़बड़ियां मिलती हैं, तो Java हीप के साइज़ को बढ़ाकर 4 जीबी किया जा सकता है:
export JAVA_TOOL_OPTIONS="-Xmx4g"
firebase emulators:start
एक से ज़्यादा फ़्लैग को कोटेशन मार्क में स्पेस देकर अलग किया जा सकता है. जैसे, JAVA_TOOL_OPTIONS="-Xms2g -Xmx4g". इन फ़्लैग का असर, एम्युलेटर के सिर्फ़ Java पर आधारित कॉम्पोनेंट पर पड़ता है. इनका असर, Firebase सीएलआई के अन्य हिस्सों पर नहीं पड़ता. जैसे, Emulator Suite UI.
एम्युलेटर चालू करना
एम्युलेटर को तब तक चलाया जा सकता है, जब तक उन्हें मैन्युअल तरीके से बंद न किया जाए. इसके अलावा, उन्हें किसी टेस्ट स्क्रिप्ट के लिए तय की गई अवधि तक चलाया जा सकता है. इसके बाद, वे अपने-आप बंद हो जाएंगे.
| निर्देश देने के लिए | ब्यौरा | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
emulators:start
|
|
||||||||||||||
emulators:exec PATH/TO/SCRIPT
|
|
firebase emulators:exec तरीका, आम तौर पर लगातार इंटिग्रेशन वाले वर्कफ़्लो के लिए ज़्यादा सही होता है.
एम्युलेटर का डेटा एक्सपोर्ट और इंपोर्ट करना
Authentication, Cloud Firestore, Realtime Database, और Cloud Storage for Firebase एम्युलेटर से डेटा एक्सपोर्ट किया जा सकता है. इस डेटा को शेयर किए जा सकने वाले सामान्य बेसलाइन डेटा सेट के तौर पर इस्तेमाल किया जा सकता है. इन डेटा सेट को --import फ़्लैग का इस्तेमाल करके इंपोर्ट किया जा सकता है, जैसा कि ऊपर बताया गया है.
| emulators:export export_directory |
Authentication, Cloud Firestore, Realtime Database या Cloud Storage for Firebase एम्युलेटर.
Cloud Firestore, Realtime Database या Cloud Storage for Firebase के चल रहे किसी एम्युलेटर इंस्टेंस से डेटा एक्सपोर्ट करें. अगर तय किया गया
ऊपर बताए गए |
अपने सीआई सिस्टम के साथ इंटिग्रेट करना
कंटेनर में मौजूद Emulator Suite की इमेज चलाना
किसी सामान्य सीआई सेटअप में कंटेनर के साथ Emulator Suite को इंस्टॉल और कॉन्फ़िगर करना आसान है.
इन समस्याओं पर ध्यान दें:
JAR फ़ाइलें,
~/.cache/firebase/emulators/पर इंस्टॉल और कैश मेमोरी में सेव की जाती हैं.- बार-बार डाउनलोड करने से बचने के लिए, इस पाथ को अपने सीआई कैश मेमोरी कॉन्फ़िगरेशन में जोड़ा जा सकता है.
अगर आपकी रिपॉज़िटरी में
firebase.jsonफ़ाइल नहीं है, तो आपकोemulators:startयाemulators:execकमांड में कमांड लाइन आर्ग्युमेंट जोड़ना होगा. इससे यह तय किया जा सकेगा कि कौनसे एम्युलेटर शुरू किए जाने चाहिए. उदाहरण के लिए,--only functions,firestore.
पुष्टि करने के लिए टोकन जनरेट करना (सिर्फ़ होस्टिंग एम्युलेटर के लिए)
अगर आपके लगातार इंटिग्रेशन वाले वर्कफ़्लो Firebase Hosting पर निर्भर हैं, तो आपको firebase emulators:exec को चलाने के लिए टोकन का इस्तेमाल करके लॉग इन करना होगा. अन्य एम्युलेटर के लिए लॉगिन करने की ज़रूरत नहीं होती.
टोकन जनरेट करने के लिए, अपने लोकल एनवायरमेंट पर firebase login:ci चलाएं. इसे सीआई सिस्टम से नहीं चलाया जाना चाहिए. पुष्टि करने के लिए, निर्देशों का पालन करें. आपको हर प्रोजेक्ट के लिए, यह चरण सिर्फ़ एक बार पूरा करना होगा. ऐसा इसलिए, क्योंकि टोकन सभी बिल्ड के लिए मान्य होगा. टोकन को पासवर्ड की तरह ही गोपनीय रखना चाहिए.
अगर आपका सीआई एनवायरमेंट, आपको ऐसे एनवायरमेंट वैरिएबल तय करने की अनुमति देता है जिनका इस्तेमाल बिल्ड स्क्रिप्ट में किया जा सकता है, तो बस FIREBASE_TOKEN नाम का एक एनवायरमेंट वैरिएबल बनाएं. इसकी वैल्यू, ऐक्सेस टोकन स्ट्रिंग होनी चाहिए. Firebase CLI, FIREBASE_TOKEN एनवायरमेंट वैरिएबल को अपने-आप चुन लेगा और एम्युलेटर ठीक से काम करने लगेंगे.
आखिरी विकल्प के तौर पर, टोकन को अपनी बिल्ड स्क्रिप्ट में शामिल किया जा सकता है. हालांकि, पक्का करें कि जिन पक्षों पर भरोसा नहीं किया जा सकता उनके पास इसका ऐक्सेस न हो. हार्ड-कोड किए गए इस तरीके के लिए,
firebase emulators:exec कमांड में --token "YOUR_TOKEN_STRING_HERE" को जोड़ा जा सकता है.
Emulator Hub REST API का इस्तेमाल करना
चल रहे एम्युलेटर की सूची देखना
फ़िलहाल चल रहे एम्युलेटर की सूची देखने के लिए, एम्युलेटर हब के /emulators एंडपॉइंट पर GET अनुरोध भेजें.
curl localhost:4400/emulatorsनतीजे के तौर पर, एक JSON ऑब्जेक्ट मिलेगा. इसमें चल रहे सभी एम्युलेटर और उनके होस्ट/पोर्ट कॉन्फ़िगरेशन की सूची होगी. उदाहरण के लिए:
{
"hub":{
"name": "hub",
"host": "localhost",
"port": 4400
},
"functions": {
"name": "functions",
"host": "localhost",
"port": 5001
}
"firestore": {
"name": "firestore",
"host": "localhost",
"port": 8080
}
}
बैकग्राउंड फ़ंक्शन ट्रिगर चालू / बंद करें
कुछ मामलों में, आपको लोकल फ़ंक्शन और एक्सटेंशन ट्रिगर को कुछ समय के लिए बंद करना होगा. उदाहरण के लिए, हो सकता है कि आपको Cloud Firestore एम्युलेटर में मौजूद पूरा डेटा मिटाना हो. इसके लिए, आपको Cloud Functions या Extensions एम्युलेटर में चल रहे किसी भी onDelete फ़ंक्शन को ट्रिगर करने की ज़रूरत नहीं है.
लोकल फ़ंक्शन ट्रिगर को कुछ समय के लिए बंद करने के लिए, एम्युलेटर हब के /functions/disableBackgroundTriggers एंडपॉइंट पर PUT अनुरोध भेजें.
curl -X PUT localhost:4400/functions/disableBackgroundTriggersनतीजा एक JSON ऑब्जेक्ट होगा, जिसमें मौजूदा स्थिति की जानकारी होगी.
{
"enabled": false
}
लोकल फ़ंक्शन ट्रिगर बंद होने के बाद उन्हें चालू करने के लिए, एम्युलेटर हब के /functions/enableBackgroundTriggers एंडपॉइंट पर PUT अनुरोध भेजें.
curl -X PUT localhost:4400/functions/enableBackgroundTriggersनतीजा एक JSON ऑब्जेक्ट होगा, जिसमें मौजूदा स्थिति की जानकारी होगी.
{
"enabled": true
}
एम्युलेटर एसडीके टूल के इंटिग्रेशन
इस सेक्शन में मौजूद टेबल से पता चलता है कि क्लाइंट और Admin SDK टूल, किन एम्युलेटर के साथ काम करते हैं. आने वाले समय में का मतलब है कि एम्युलेटर की सुविधा उपलब्ध कराने की योजना है, लेकिन फ़िलहाल यह उपलब्ध नहीं है.
क्लाइंट SDK टूल की उपलब्धता
| Android | Apple के प्लैटफ़ॉर्म | वेब |
Firebase यूज़र इंटरफ़ेस (यूआई) Android |
Firebase यूज़र इंटरफ़ेस iOS |
Firebase यूज़र इंटरफ़ेस (यूआई) वेब |
|
|---|---|---|---|---|---|---|
| Realtime Database | 19.4.0 | 7.2.0 | 8.0.0 | 6.4.0 | फ़्यूचर | लागू नहीं |
| Cloud Firestore | 21.6.0 | 7.2.0 | 8.0.0 | 6.4.0 | फ़्यूचर | लागू नहीं |
| Authentication | 20.0.0 | 7.0.0 | 8.0.0 | 7.0.0 | फ़्यूचर | 4.7.2 |
| Cloud Storage for Firebase | 20.0.0 | 8.0.0 | 8.4.0 | 7.0.0 | 11.0.0 | लागू नहीं |
| Cloud Functions | 19.1.0 | 7.2.0 | 8.0.0 | लागू नहीं | लागू नहीं | लागू नहीं |
| Hosting | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं |
| Extensions | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं |
Admin SDK की उपलब्धता
| नोड | Java | Python | Go | |
|---|---|---|---|---|
| Realtime Database | 8.6.0 | 6.10.0 | 2.18.0 | फ़्यूचर |
| Cloud Firestore | 8.0.0 | 6.10.0 | 3.0.0 | 1.0.0 |
| Authentication | 9.3.0 | 7.2.0 | 5.0.0 | 4.2.0 |
| Cloud Storage for Firebase | 9.8.0 | फ़्यूचर | फ़्यूचर | फ़्यूचर |
| Cloud Functions | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं |
| Hosting | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं |
| Extensions | लागू नहीं | लागू नहीं | लागू नहीं | लागू नहीं |