अपने ऐप्लिकेशन के साथ Extensions एम्युलेटर का इस्तेमाल करने से पहले, पक्का करें कि आपको Firebase Local Emulator Suite के पूरे वर्कफ़्लो की जानकारी हो. साथ ही, आपने Local Emulator Suite को इंस्टॉल और कॉन्फ़िगर किया हो और इसके सीएलआई कमांड की समीक्षा की हो.
इस गाइड में यह भी माना गया है कि आपको Firebase Extensions के बारे में जानकारी है. साथ ही, आपको अपने Firebase ऐप्लिकेशन में इनका इस्तेमाल करने का तरीका पता है.
Extensions एम्युलेटर की मदद से क्या किया जा सकता है?
Extensions एम्युलेटर की मदद से, सुरक्षित लोकल एनवायरमेंट में एक्सटेंशन इंस्टॉल और मैनेज किए जा सकते हैं. साथ ही, बिलिंग की कुल लागत को कम करते हुए, उनकी क्षमताओं को बेहतर तरीके से समझा जा सकता है. एम्युलेटर, आपके एक्सटेंशन के फ़ंक्शन को स्थानीय तौर पर चलाता है. इसमें Cloud Firestore, Realtime Database, Cloud Storage for Firebase, Authentication, और Pub/Sub के लिए एम्युलेटर का इस्तेमाल करके, बैकग्राउंड इवेंट से ट्रिगर होने वाले फ़ंक्शन शामिल हैं. साथ ही, Cloud Functions के दूसरे वर्शन में लागू किए गए Eventarc से ट्रिगर होने वाले फ़ंक्शन भी शामिल हैं.
कोई Firebase प्रोजेक्ट चुनें
Firebase Local Emulator Suite, किसी एक Firebase प्रोजेक्ट के लिए प्रॉडक्ट को एम्युलेट करता है.
इस्तेमाल करने के लिए प्रोजेक्ट चुनने के लिए, एम्युलेटर शुरू करने से पहले, सीएलआई में अपनी वर्किंग डायरेक्ट्री में firebase use चलाएं. इसके अलावा, हर एम्युलेटर कमांड में --project फ़्लैग को पास किया जा सकता है.
Local Emulator Suite, असल Firebase प्रोजेक्ट और डेमो प्रोजेक्ट के एम्युलेशन के साथ काम करता है.
| प्रोजेक्ट टाइप | सुविधाएं | एम्युलेटर के साथ इस्तेमाल करना |
|---|---|---|
| रियाल |
असली Firebase प्रोजेक्ट वह होता है जिसे आपने बनाया और कॉन्फ़िगर किया हो. ऐसा ज़्यादातर Firebase कंसोल की मदद से किया जाता है. असली प्रोजेक्ट में लाइव रिसॉर्स होते हैं. जैसे, डेटाबेस इंस्टेंस, स्टोरेज बकेट, फ़ंक्शन या कोई अन्य रिसॉर्स, जिसे आपने उस Firebase प्रोजेक्ट के लिए सेट अप किया है. |
असली Firebase प्रोजेक्ट के साथ काम करते समय, काम करने वाले किसी भी या सभी प्रॉडक्ट के लिए एमुलेटर चलाए जा सकते हैं. जिन प्रॉडक्ट को एम्युलेट नहीं किया जा रहा है उनके लिए, आपके ऐप्लिकेशन और कोड, लाइव रिसॉर्स (डेटाबेस इंस्टेंस, स्टोरेज बकेट, फ़ंक्शन वगैरह) के साथ इंटरैक्ट करेंगे. |
| डेमो |
डेमो Firebase प्रोजेक्ट में कोई असल Firebase कॉन्फ़िगरेशन और लाइव संसाधन नहीं होते. आम तौर पर, इन प्रोजेक्ट को कोडलैब या अन्य ट्यूटोरियल की मदद से ऐक्सेस किया जाता है. डेमो प्रोजेक्ट के प्रोजेक्ट आईडी में, |
डेमो Firebase प्रोजेक्ट के साथ काम करते समय, आपके ऐप्लिकेशन और कोड सिर्फ़ एम्युलेटर के साथ इंटरैक्ट करते हैं. अगर आपका ऐप्लिकेशन किसी ऐसे संसाधन के साथ इंटरैक्ट करने की कोशिश करता है जिसके लिए एम्युलेटर नहीं चल रहा है, तो वह कोड काम नहीं करेगा. |
हमारा सुझाव है कि जहां भी संभव हो वहां डेमो प्रोजेक्ट का इस्तेमाल करें. इसके ये फ़ायदे हैं:
- इसे सेट अप करना आसान है, क्योंकि एम्युलेटर को Firebase प्रोजेक्ट बनाए बिना भी चलाया जा सकता है
- बेहतर सुरक्षा, क्योंकि अगर आपका कोड गलती से नॉन-इम्युलेटेड (प्रोडक्शन) रिसॉर्स को शुरू करता है, तो डेटा में बदलाव, इस्तेमाल, और बिलिंग की कोई संभावना नहीं होती
- ऑफ़लाइन मोड में बेहतर सहायता, क्योंकि एसडीके कॉन्फ़िगरेशन को डाउनलोड करने के लिए इंटरनेट ऐक्सेस करने की ज़रूरत नहीं होती.
एक्सटेंशन इंस्टॉल करना और उसका आकलन करना
Extensions एमुलेटर का इस्तेमाल करके, यह आसानी से पता लगाया जा सकता है कि कोई एक्सटेंशन आपकी ज़रूरतों को पूरा करता है या नहीं.
मान लें कि आपको ट्रिगर ईमेल (firestore-send-email) एक्सटेंशन में दिलचस्पी है. हालांकि, यहां बताया गया वर्कफ़्लो किसी भी एक्सटेंशन के लिए लागू होता है. लोकल एम्युलेटर के साथ चलाने पर, ट्रिगर ईमेल अपने-आप Cloud Firestore और Cloud Functions एम्युलेटर का इस्तेमाल करेगा.
किसी एक्सटेंशन को स्थानीय तौर पर टेस्ट करने के लिए:
एक्सटेंशन को लोकल एक्सटेंशन मेनिफ़ेस्ट में जोड़ें. एक्सटेंशन मेनिफ़ेस्ट, एक्सटेंशन इंस्टेंस और उनके कॉन्फ़िगरेशन की सूची होती है.
firebase ext:install --local firebase/firestore-send-email
ऊपर दिया गया निर्देश चलाने पर, आपको
firebase/firestore-send-emailएक्सटेंशन के नए वर्शन को कॉन्फ़िगर करने और कॉन्फ़िगरेशन को मेनिफ़ेस्ट में सेव करने के लिए कहा जाएगा. हालांकि, यह कॉन्फ़िगरेशन आपके प्रोजेक्ट में डिप्लॉय नहीं होगा. इस बारे में ज़्यादा जानने के लिए, मेनिफ़ेस्ट की मदद से एक्सटेंशन कॉन्फ़िगरेशन मैनेज करना लेख पढ़ेंLocal Emulator Suite को सामान्य तरीके से चालू करें.
firebase emulators:start
अब, आपके मेनिफ़ेस्ट में मौजूद firestore-send-email एक्सटेंशन इंस्टेंस का इस्तेमाल करके, Local Emulator Suite उस एक्सटेंशन का सोर्स कोड ~/.cache/firebase/extensions में डाउनलोड करेगा. सोर्स डाउनलोड होने के बाद, Local Emulator Suite शुरू हो जाएगा. इसके बाद, एक्सटेंशन के बैकग्राउंड में ट्रिगर होने वाले किसी भी फ़ंक्शन को ट्रिगर किया जा सकेगा. साथ ही, अपने ऐप्लिकेशन को Local Emulator Suite से कनेक्ट किया जा सकेगा, ताकि यह टेस्ट किया जा सके कि वे आपके ऐप्लिकेशन के साथ इंटिग्रेट हो रहे हैं या नहीं.
Emulator Suite UI का इस्तेमाल करके, ईमेल दस्तावेज़ों के कलेक्शन में डेटा जोड़ा जा सकता है. साथ ही, ट्रिगर ईमेल एक्सटेंशन की ज़रूरत के मुताबिक, अन्य बैकएंड रिसॉर्स सेट अप किए जा सकते हैं.
इसके अलावा, लगातार इंटिग्रेशन वाले वर्कफ़्लो जैसे नॉन-इंटरैक्टिव टेस्टिंग एनवायरमेंट के लिए, एक्सटेंशन का आकलन करने के लिए टेस्ट स्क्रिप्ट लिखी जा सकती है. इसमें अन्य चरणों के साथ-साथ, ज़रूरी Cloud Firestore डेटा को पॉप्युलेट करना और फ़ंक्शन ट्रिगर करना शामिल है. इसके बाद, आपको अपनी टेस्ट स्क्रिप्ट को लागू करने के लिए, Local Emulator Suite को शुरू करना होगा:
firebase emulators:exec my-test.shExtensions एम्युलेटर की मदद से टेस्टिंग करना, प्रोडक्शन से कैसे अलग है
Extensions एम्युलेटर की मदद से, एक्सटेंशन को इस तरह से टेस्ट किया जा सकता है कि वह प्रोडक्शन के अनुभव से काफ़ी हद तक मेल खाए. हालांकि, प्रोडक्शन के व्यवहार में कुछ अंतर हैं.
Cloud IAM
Firebase Emulator Suite, आईएएम से जुड़े किसी भी व्यवहार को दोहराने या उसका पालन करने की कोशिश नहीं करता. एम्युलेटर, Firebase के सुरक्षा नियमों का पालन करते हैं. हालांकि, कुछ मामलों में आईएएम का इस्तेमाल किया जाता है. जैसे, Cloud Functions को शुरू करने वाले सेवा खाते और अनुमतियों को सेट करने के लिए. ऐसे मामलों में, एम्युलेटर को कॉन्फ़िगर नहीं किया जा सकता. साथ ही, यह आपकी डेवलपमेंट मशीन पर दुनिया भर में उपलब्ध खाते का इस्तेमाल करेगा. यह सीधे तौर पर लोकल स्क्रिप्ट चलाने जैसा है.
ट्रिगर करने के टाइप से जुड़ी सीमा
फ़िलहाल, Firebase Local Emulator Suite में सिर्फ़ एचटीटीपी अनुरोध से ट्रिगर होने वाले फ़ंक्शन, एक्सटेंशन के लिए Eventarc के कस्टम इवेंट ट्रिगर, और Cloud Firestore, Realtime Database, Cloud Storage for Firebase, Authentication, और Pub/Sub के लिए बैकग्राउंड इवेंट से ट्रिगर होने वाले फ़ंक्शन काम करते हैं. ट्रिगर किए गए अन्य फ़ंक्शन का इस्तेमाल करने वाले एक्सटेंशन का आकलन करने के लिए, आपको टेस्ट Firebase प्रोजेक्ट में अपना एक्सटेंशन इंस्टॉल करना होगा.
आगे क्या करना है?
- वीडियो के चुने हुए सेट और उदाहरणों के साथ सिलसिलेवार तरीके से जानकारी पाने के लिए, Firebase एमुलेटर की ट्रेनिंग प्लेलिस्ट देखें.