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

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

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

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

Firebase सीएलआई इंस्टॉल करें

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

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

इन चरणों को पूरा करने के बाद, आपके फ़ंक्शन टेस्ट, Firebase और एडमिन SDK का इस्तेमाल करने वाले 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 टूल का इस्तेमाल करके.

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

Firebase Extensions कस्टम इवेंट को मैनेज करने के लिए लागू किए गए फ़ंक्शन के लिए Cloud Functions वर्शन 2 के साथ, 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

अगर आपके पास Firebase एडमिन SDK (9.7.0 या उसके बाद के वर्शन) का इस्तेमाल करने वाले फ़ंक्शन हैं Cloud Storage को लिखने के लिए, ये लेख 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 टैब खोलें. इस टैब में, ट्रिगर से संबद्ध अलर्ट प्रकार (उदाहरण के लिए, यदि आपके पास onNewFatalIssue इन्हें ट्रिगर के बाद बंद किया जाता है, फिर चार्ज होने के बाद क्रैशlytics.newFatalIssue के साथ दिखाई गई है).
  2. सूचना का कोई टाइप चुनें. फ़ॉर्म में डिफ़ॉल्ट वैल्यू अपने-आप भर जाती हैं, जो बदलाव किया जा सकता है. आप इवेंट के फ़ील्ड में बदलाव कर सकते हैं (अन्य अलर्ट इवेंट से मिलने वाली जानकारी के लिए अनुमान लगाया जाता है, मॉक वैल्यू या रैंडम तरीके से जनरेट होने की सुविधा).
  3. फ़ंक्शन एम्युलेटर पर सिंथेटिक सूचना भेजने के लिए, सूचना भेजें चुनें. Firebase कंसोल में चेतावनियों में लॉग इन करके (साथ ही लॉग में).

लॉगिंग

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

अगले चरण

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