लोकल एम्युलेटर सुइट को इंस्टॉल, कॉन्फ़िगर, और इंटिग्रेट करें

Firebase लोकल एम्युलेटर सुइट को अलग-अलग वर्शन के लिए इंस्टॉल और कॉन्फ़िगर किया जा सकता है एक बार के प्रोटोटाइपिंग सेशन से लेकर, एआई मॉडल की मदद से लगातार इंटिग्रेशन वर्कफ़्लो बनाए रखना.

लोकल एम्युलेटर सुइट इंस्टॉल करें

Emulator Suite को इंस्टॉल करने से पहले आपको इनकी ज़रूरत होगी:

• Node.js का 16.0 या इसके बाद वाला वर्शन होना चाहिए.
• Java JDK वर्शन 11 या इसके बाद वाला वर्शन.

एम्युलेटर सुइट को इंस्टॉल करने के लिए:

1. Firebase सीएलआई इंस्टॉल करें. अगर आपने पहले से Firebase सीएलआई इंस्टॉल नहीं किया है, तो इसे अभी इंस्टॉल करें. एम्युलेटर सुइट का इस्तेमाल करने के लिए, आपको सीएलआई वर्शन 8.14.0 या इसके बाद वाले वर्शन की ज़रूरत होगी. आप देखें कि आपने निम्न आदेश का उपयोग करके कौन-सा वर्शन इंस्टॉल किया है:

   firebase --version

2. अगर आपने अभी तक ऐसा नहीं किया है, तो मौजूदा डायरेक्ट्री शुरू करें का इस्तेमाल किया जा सकता है. इस्तेमाल के लिए प्रॉडक्ट:

   firebase init

3. एम्युलेटर सुइट को सेट अप करें. यह निर्देश एक कॉन्फ़िगरेशन विज़र्ड शुरू करता है, जो आपको अपनी पसंद के एम्युलेटर चुनने की सुविधा मिलती है. साथ ही, इससे जुड़ा एम्युलेटर डाउनलोड करने की सुविधा मिलती है बाइनरी फ़ाइलें खोजी जाएंगी और अगर डिफ़ॉल्ट सही नहीं हैं, तो एम्युलेटर पोर्ट सेट करें.

   firebase init emulators

एम्युलेटर इंस्टॉल होने के बाद, अपडेट की न तो जांच की जाती है और न ही कोई अतिरिक्त जांच की जाती है अपने-आप डाउनलोड होने की प्रोसेस तब तक जारी रहेगी, जब तक Firebase सीएलआई वर्शन को अपडेट नहीं किया जाता.

एम्युलेटर सुइट को कॉन्फ़िगर करें

वैकल्पिक रूप से, एम्युलेटर को कॉन्फ़िगर किया जा सकता है नेटवर्क पोर्ट और सुरक्षा का पाथ firebase.json फ़ाइल में नियमों की परिभाषाएं:

• firebase init emulators चलाकर या बदलाव करके एम्युलेटर पोर्ट बदलें मैन्युअल रूप से firebase.json.
• firebase.json में बदलाव करके, सुरक्षा नियमों की परिभाषाओं का पाथ बदलें मैन्युअल रूप से.

अगर आप इन सेटिंग को कॉन्फ़िगर नहीं करते हैं, तो एम्युलेटर डिफ़ॉल्ट पोर्ट और Cloud Firestore, Realtime Database, और Cloud Storage for Firebase एम्युलेटर, ओपन डेटा सिक्योरिटी के साथ चलेंगे.

पोर्ट कॉन्फ़िगरेशन

हर एम्युलेटर, आपकी पसंदीदा डिफ़ॉल्ट सेवा के साथ आपकी मशीन पर एक अलग पोर्ट से जुड़ता है वैल्यू.

प्रोजेक्ट आईडी का कॉन्फ़िगरेशन

एम्युलेटर शुरू करने के आपके तरीके के आधार पर, आपके पास अलग-अलग Firebase प्रोजेक्ट आईडी या एक से ज़्यादा एम्युलेटर इंस्टेंस का इस्तेमाल करने वाला एम्युलेटर . ऐसे मामलों में, एम्युलेटर इंस्टेंस अलग एनवायरमेंट होने पर.

आम तौर पर, सभी एम्युलेटर के लिए एक प्रोजेक्ट आईडी सेट करना अच्छा होता है शुरू करने, इसलिए Emulator Suite UI, अलग-अलग प्रॉडक्ट एम्युलेटर, और सभी किसी विशेष एम्युलेटर के चल रहे इंस्टेंस सभी में सही ढंग से मामले.

Local Emulator Suite में एक से ज़्यादा प्रोजेक्ट आईडी मिलने पर, वह चेतावनी जारी करती है पर्यावरण के लिए तैयार किया गया है. हालांकि, इस व्यवहार में बदलाव करने के लिए, अपने firebase.json में false के लिए, singleProjectMode बटन दबाएं.

प्रोजेक्ट आईडी से जुड़े एलानों को देखा जा सकता है, ताकि इनमें जानकारी मेल न खाती हो:

• कमांड लाइन में डिफ़ॉल्ट प्रोजेक्ट. डिफ़ॉल्ट रूप से, प्रोजेक्ट आईडी firebase init के साथ चुने गए प्रोजेक्ट से स्टार्टअप पर लिया जाएगा या firebase use. प्रोजेक्ट की सूची देखने और यह देखने के लिए कि कौनसा प्रोजेक्ट चुना गया है firebase projects:list का इस्तेमाल करें.
• नियम यूनिट टेस्ट. प्रोजेक्ट आईडी को अक्सर नियमों को लागू करने के लिए किए गए कॉल में बताया जाता है यूनिट टेस्टिंग लाइब्रेरी के तरीके initializeTestEnvironment या initializeTestApp.
• कमांड लाइन --project फ़्लैग. Firebase सीएलआई को पास किया जा रहा है --project फ़्लैग, डिफ़ॉल्ट प्रोजेक्ट को बदल देता है. आपको यह पक्का करना होगा कि फ़्लैग का निशान, यूनिट टेस्ट और ऐप्लिकेशन शुरू करने की प्रोसेस में मौजूद प्रोजेक्ट आईडी से मेल खाता हो.

प्लैटफ़ॉर्म के हिसाब से वे प्रोजेक्ट आईडी कॉन्फ़िगरेशन भी देखें जिन्हें आपने सेट किया है आपके Apple प्लैटफ़ॉर्म को कॉन्फ़िगर करके, Android और वेब प्रोजेक्ट.

सुरक्षा के नियमों का कॉन्फ़िगरेशन

एम्युलेटर, database से सुरक्षा नियमों के कॉन्फ़िगरेशन को पूरा करेगा, firebase.json में 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.

स्टार्ट अप एम्युलेटर

एम्युलेटर को तब तक चलाया जा सकता है, जब तक कि उसे मैन्युअल तरीके से खत्म नहीं कर दिया जाता या फिर तय समय के लिए सेट अप करें और फिर अपने-आप शट डाउन हो जाए.

आम तौर पर, firebase emulators:exec तरीका इंटिग्रेशन से जुड़े वर्कफ़्लो को लगातार जारी रखा जा सकता है.

एम्युलेटर डेटा को एक्सपोर्ट और इंपोर्ट करें

आप Authentication, Cloud Firestore, Realtime Database और शेयर किए जा सकने वाले सामान्य बेसलाइन डेटा के तौर पर इस्तेमाल करने के लिए, Cloud Storage for Firebase एम्युलेटर सेट. इन डेटा सेट को --import फ़्लैग का इस्तेमाल करके इंपोर्ट किया जा सकता है. जैसे: ऊपर बताया गया है.

अपने सीआई सिस्टम से इंटिग्रेट करें

कंटेनर के तौर पर इस्तेमाल किए जा रहे एम्युलेटर सुइट की इमेज

कंटेनर के साथ 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 सीएलआई FIREBASE_TOKEN एनवायरमेंट वैरिएबल अपने-आप पिक अप हो जाएगा और एम्युलेटर ठीक से चालू हो जाएंगे.

आखिरी विकल्प के तौर पर, टोकन को अपनी बिल्ड स्क्रिप्ट में शामिल करें, लेकिन पक्का करें कि गैर-भरोसेमंद पक्षों के पास ऐक्सेस न हो. हार्ड कोड किए गए इस वीडियो के लिए तो आप --token "YOUR_TOKEN_STRING_HERE" को firebase emulators:exec निर्देश.

एम्युलेटर हब 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 एम्युलेटर, जो किसी भी onDelete फ़ंक्शन को ट्रिगर नहीं करता Cloud Functions या Extensions एम्युलेटर में चल रहे हैं.

लोकल फ़ंक्शन ट्रिगर को कुछ समय के लिए बंद करने के लिए PUT को एम्युलेटर हब का /functions/disableBackgroundTriggers एंडपॉइंट.

curl -X PUT localhost:4400/functions/disableBackgroundTriggers

इससे, एक JSON ऑब्जेक्ट मिलेगा, जिसमें मौजूदा स्थिति के बारे में जानकारी मिलेगी.

{
  "enabled": false
}

लोकल फ़ंक्शन ट्रिगर बंद होने के बाद उन्हें चालू करने के लिए, PUT भेजें एम्युलेटर के /functions/enableBackgroundTriggers एंडपॉइंट के लिए अनुरोध करें हब.

curl -X PUT localhost:4400/functions/enableBackgroundTriggers

इससे, एक JSON ऑब्जेक्ट मिलेगा, जिसमें मौजूदा स्थिति के बारे में जानकारी मिलेगी.

{
  "enabled": true
}

एम्युलेटर SDK टूल के इंटिग्रेशन

इस सेक्शन में मौजूद टेबल से पता चलता है कि क्लाइंट के पास कौनसे एम्युलेटर का इस्तेमाल करने की सुविधा है और एडमिन SDK टूल. आने वाले समय का मतलब है कि एम्युलेटर के लिए सहायता योजना बनाई गई है लेकिन अभी तक उपलब्ध नहीं है उपलब्ध हैं.

क्लाइंट SDK टूल की उपलब्धता

एडमिन SDK टूल की उपलब्धता