फ़ंक्शन को स्थानीय तौर पर चलाएं

Firebase CLI में एक Cloud Functions एमुलेटर शामिल होता है, जो इन फ़ंक्शन टाइप को एमुलेट कर सकता है:

  • एचटीटीपीएस फ़ंक्शन
  • कॉल किए जा सकने वाले फ़ंक्शन
  • टास्क की सूची वाले फ़ंक्शन
  • Firebase Authentication, Realtime Database, से ट्रिगर हुए बैकग्राउंड फ़ंक्शन Cloud Firestore, Cloud Storage, काम करने वाली Firebase चेतावनियां, और Cloud Pub/Sub.

प्रोडक्शन में डिप्लॉय करने से पहले, फ़ंक्शन को स्थानीय तौर पर चलाकर उनकी जांच की जा सकती है.

Firebase CLI इंस्टॉल करना

Cloud Functions एमुलेटर का इस्तेमाल करने के लिए, पहले Firebase CLI इंस्टॉल करें:

npm install -g firebase-tools

लोकल एमुलेटर का इस्तेमाल करने के लिए, आपका Cloud Functions इन पर निर्भर होना चाहिए:

  • firebase-admin का 8.0.0 या इसके बाद का वर्शन.
  • firebase-functions वर्शन 3.0.0 या इसके बाद वाला वर्शन.

एडमिन क्रेडेंशियल सेट अप करना (ज़रूरी नहीं)

अगर आपको अपने फ़ंक्शन की जांच करने के लिए, Google API या अन्य Firebase का इस्तेमाल करना है Firebase एडमिन SDK के ज़रिए एपीआई का इस्तेमाल करने के लिए, आपको इन्हें सेट अप करना पड़ सकता है एडमिन के क्रेडेंशियल.

  • Cloud Firestore और Realtime Database ट्रिगर में पहले से ही ज़रूरी क्रेडेंशियल मौजूद होते हैं. साथ ही, इनके लिए अलग से सेटअप करने की ज़रूरत नहीं होती.
  • Authentication और FCM जैसे Firebase API या Cloud Translation या Cloud Speech जैसे Google API के साथ-साथ, अन्य सभी एपीआई के लिए, इस सेक्शन में बताए गए सेटअप चरणों का पालन करना ज़रूरी है. यह Cloud Functions शेल या firebase emulators:start, दोनों पर लागू होता है.

सिम्युलेट किए गए फ़ंक्शन के लिए, एडमिन के क्रेडेंशियल सेट अप करने के लिए:

  1. खोलें सेवा खातों का पैनल Google Cloud कंसोल का इस्तेमाल किया जा सकता है.
  2. पक्का करें कि आपने App Engine का डिफ़ॉल्ट सेवा खाता चुना हो. साथ ही, इसका इस्तेमाल करें कुंजी बनाएं को चुनने के लिए, दाईं ओर मौजूद विकल्प मेन्यू.
  3. जब कहा जाए, तब कुंजी के टाइप के लिए JSON चुनें और बनाएं पर क्लिक करें.

  4. डाउनलोड की गई कुंजी पर ले जाने के लिए, Google के डिफ़ॉल्ट क्रेडेंशियल सेट करें:

    Unix

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

    शीशा

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

यह तरीका अपनाने के बाद, आपके फ़ंक्शन टेस्ट एडमिन SDK का इस्तेमाल करके, Firebase और Google API को ऐक्सेस कर सकते हैं. उदाहरण के लिए, 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, रीयलटाइम डेटाबेस, और Firebase होस्टिंग के लिए एमुलेटर शुरू करेगा. यह उन प्रॉडक्ट के आधार पर होगा जिन्हें आपने 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

एचटीटीपीएस फ़ंक्शन एम्युलेशन के लिए अपने ऐप्लिकेशन का इंस्ट्रुमेंट

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

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

उदाहरण के लिए, डिफ़ॉल्ट होस्ट पोर्ट और क्षेत्र वाला एक सामान्य helloWorld फ़ंक्शन यहां दिखाया जाएगा:

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

टास्क सूची के फ़ंक्शन को एम्युलेट करने के लिए, अपने ऐप्लिकेशन का इंस्ट्रुमेंट इस्तेमाल करें

एमुलेटर, ट्रिगर की परिभाषाओं के आधार पर, एमुलेट किए गए टास्क की सूचियों को अपने-आप सेट अप करता है. अगर एडमिन SDK टूल को पता चलता है कि वह CLOUD_TASKS_EMULATOR_HOST एनवायरमेंट वैरिएबल के ज़रिए चल रहा है, तो वह सूची में शामिल अनुरोधों को एमुलेटर पर रीराउंड करता है.

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

बैकग्राउंड से ट्रिगर होने वाले फ़ंक्शन को एम्युलेट करने के लिए, अपने ऐप्लिकेशन का इंस्ट्रुमेंट

Cloud Functions एम्युलेटर, इन सोर्स के बैकग्राउंड में ट्रिगर होने वाले फ़ंक्शन के साथ काम करता है:

  • Realtime Database एम्युलेटर
  • Cloud Firestore एम्युलेटर
  • Authentication एम्युलेटर
  • Pub/Sub एम्युलेटर
  • Firebase सूचना एमुलेटर

बैकग्राउंड इवेंट ट्रिगर करने के लिए, Emulator Suite UI का इस्तेमाल करके बैक-एंड संसाधनों में बदलाव करें. इसके अलावा, अपने प्लैटफ़ॉर्म के लिए SDK टूल का इस्तेमाल करके, अपने ऐप्लिकेशन या टेस्ट कोड को एमुलेटर से कनेक्ट करें.

एक्सटेंशन से जनरेट होने वाले कस्टम इवेंट के लिए, हैंडलर की जांच करें

Cloud Functions v2 के साथ Firebase Extensions कस्टम इवेंट मैनेज करने के लिए लागू किए गए फ़ंक्शन के लिए, Cloud Functions एमुलेटर, Eventarc ट्रिगर के साथ काम करने के लिए, Eventarc एमुलेटर के साथ जोड़ा जाता है.

इवेंट उत्सर्जित करने वाले एक्सटेंशन के लिए कस्टम इवेंट हैंडलर की जांच करने के लिए, आपको Cloud Functions और Eventarc इम्युलेटर इंस्टॉल करने होंगे.

Cloud Functions रनटाइम, EVENTARC_EMULATOR एनवायरमेंट को सेट करता है मौजूदा प्रोसेस में वैरिएबल localhost:9299 के लिए होगा, अगर Eventarc एम्युलेटर चल रहा है. Firebase Admin SDKs अपने-आप Eventarc से कनेक्ट हो जाते हैं एम्युलेटर, जब EVENTARC_EMULATOR एनवायरमेंट वैरिएबल सेट हो. Local Emulator Suite कॉन्फ़िगर करें में बताए गए तरीके से, डिफ़ॉल्ट पोर्ट में बदलाव किया जा सकता है.

एनवायरमेंट वैरिएबल सही तरीके से कॉन्फ़िगर किए जाने पर, Firebase Admin SDK अपने-आप Eventarc एम्युलेटर पर इवेंट भेजता है. इसके बाद, Eventarc एमुलेटर, रजिस्टर किए गए किसी भी हैंडलर को ट्रिगर करने के लिए, Cloud Functions एमुलेटर को कॉलबैक करता है.

हैंडलर के चालू होने की जानकारी के लिए, Emulator Suite UI में फ़ंक्शन लॉग देखे जा सकते हैं.

अन्य सेवाओं के साथ इंटरैक्शन

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

Cloud Firestore

अगर आपके पास ऐसे फ़ंक्शन हैं जो कोड लिखने के लिए Firebase एडमिन SDK का इस्तेमाल करते हैं Cloud Firestore, ये लेख Cloud Firestore एम्युलेटर पर भेजे जाएंगे अगर वह पहले से चल रहा है. अगर उन लिखने की वजह से आगे के फ़ंक्शन ट्रिगर होते हैं, इन्हें Cloud Functions एम्युलेटर में चलाया जाएगा.

Cloud Storage

अगर आपके पास ऐसे फ़ंक्शन हैं जो Cloud Storage में डेटा लिखने के लिए, Firebase Admin SDK टूल (9.7.0 या इसके बाद का वर्शन) का इस्तेमाल करते हैं, तो ये डेटा Cloud Storage एमुलेटर में भेज दिए जाएंगे. हालांकि, ऐसा तब ही होगा, जब एमुलेटर चालू हो. अगर उन लिखावटों से और फ़ंक्शन ट्रिगर होते हैं, तो उन्हें Cloud Functions एमुलेटर में चलाया जाएगा.

Firebase Authentication

अगर आपके पास Firebase एडमिन SDK (9.3.0 या इसके बाद के वर्शन) का इस्तेमाल करने वाले फ़ंक्शन हैं Firebase Authentication को लिखने के लिए, ये लेख Auth एम्युलेटर को भेजे जाएंगे अगर वह पहले से चल रहा है. अगर उन लिखावटों से और फ़ंक्शन ट्रिगर होते हैं, तो उन्हें Cloud Functions एमुलेटर में चलाया जाएगा.

Firebase होस्टिंग

अगर Cloud Functions का इस्तेमाल करके, इसके लिए डाइनैमिक कॉन्टेंट जनरेट किया जा रहा है Firebase Hosting, firebase emulators:start आपके लोकल एचटीटीपी फ़ंक्शन को होस्ट करने के लिए प्रॉक्सी के तौर पर इस्तेमाल करता है.

Firebase की सूचनाएं

किसी भी प्रोजेक्ट में, जिसमें कम से कम एक काम करने वाला Firebase सूचना ट्रिगर शामिल हो, तो एम्युलेटर यूज़र इंटरफ़ेस (यूआई) में FireAlerts टैब शामिल है. सूचना ट्रिगर को एम्युलेट करने के लिए:

  1. FireAlerts टैब खोलें. यह टैब, सूचना के उन टाइप के साथ एक ड्रॉपडाउन दिखाता है जिनके साथ ट्रिगर जुड़े होते हैं. उदाहरण के लिए, अगर आपके पास onNewFatalIssuePublished ट्रिगर है, तो crashlytics.newFatalIssue दिखता है.
  2. सूचना का टाइप चुनें. फ़ॉर्म में डिफ़ॉल्ट वैल्यू अपने-आप भर जाती हैं, जो बदलाव किया जा सकता है. आपके पास इवेंट के फ़ील्ड में बदलाव करने का विकल्प होता है. सूचना वाले इवेंट की अन्य जानकारी, अनुमानित, मॉक वैल्यू या रैंडम तौर पर जनरेट की गई होती है.
  3. फ़ंक्शन एमुलेटर को सिंथेटिक सूचना भेजने के लिए, सूचना भेजें चुनें. साथ ही, Firebase कंसोल में सूचनाएं में लॉगिंग की सुविधा उपलब्ध है.

लॉगिंग

एमुलेटर, आपके फ़ंक्शन से लॉग को उस टर्मिनल विंडो पर स्ट्रीम करता है जहां वे चलते हैं. इसमें console.log(), console.info(), आपके फ़ंक्शन के अंदर console.error() और console.warn() स्टेटमेंट.

अगले चरण

Firebase एम्युलेटर सुइट को इस्तेमाल करने का पूरा उदाहरण देखने के लिए, टेस्टिंग क्विकस्टार्ट सैंपल.