फ़ंक्शन को इंटरैक्टिव तरीके से टेस्ट करें

Cloud Functions शेल, टेस्ट डेटा वाले फ़ंक्शन को शुरू करने के लिए एक इंटरैक्टिव शेल उपलब्ध कराता है. शेल, सभी तरह के ट्रिगर के साथ काम करता है.

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

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

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

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

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

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

    Unix

    export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
firebase functions:shell

    शीशा

    set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
firebase functions:shell

इन चरणों को पूरा करने के बाद, आपके फ़ंक्शन टेस्ट, एडमिन SDK का इस्तेमाल करके Firebase और Google API को ऐक्सेस कर सकते हैं. उदाहरण के लिए, पुष्टि करने वाले ट्रिगर की जांच करते समय, एम्युलेट किया गया फ़ंक्शन admin.auth().getUserByEmail(email) को कॉल कर सकता है.

Cloud Functions शेल का इस्तेमाल करके फ़ंक्शन सर्व करें

Cloud Functions शेल, टेस्ट डेटा वाले फ़ंक्शन शुरू करने के लिए, इंटरैक्टिव शेल वाले सभी तरह के फ़ंक्शन ट्रिगर को एम्युलेट करता है. फ़ंक्शन टाइप के हिसाब से विकल्प अलग-अलग होते हैं, लेकिन इस्तेमाल का सामान्य फ़ॉर्मैट यह है:

myFunctionName(data, options)

data पैरामीटर, रीयलटाइम डेटाबेस, Cloud Firestore, और PubSub ट्रिगर के लिए ज़रूरी है. साथ ही, दूसरे सभी फ़ंक्शन के लिए ज़रूरी नहीं है. इसके अलावा, विकल्प के तौर पर दिया गया options पैरामीटर सिर्फ़ रीयलटाइम डेटाबेस और Cloud Firestore फ़ंक्शन के लिए मान्य है.

वैकल्पिक रूप से, फ़ाइल को वैरिएबल के रूप में सेव करके और उसके साथ फ़ंक्शन शुरू करके, किसी लोकल फ़ाइल से टेस्ट डेटा लोड किया जा सकता है:

var data = require('./path/to/testData.json');
myFunction(data);

Cloud Functions शेल इंस्टॉल और कॉन्फ़िगर करें

इस सुविधा का इस्तेमाल करने के लिए, firebase-tools में कम से कम 3.11.0 और firebase-functions SDK टूल का कम से कम वर्शन 0.6.2 होना चाहिए. दोनों को अपडेट करने के लिए, अपने प्रोजेक्ट की functions/ डायरेक्ट्री में इन निर्देशों को चलाएं:

npm install --save firebase-functions@latest
npm install -g firebase-tools

अगर आपने कस्टम फ़ंक्शन कॉन्फ़िगरेशन वैरिएबल का इस्तेमाल किया है, तो सबसे पहले अपने कस्टम कॉन्फ़िगरेशन (इसे functions डायरेक्ट्री में चलाएं) पाने के लिए, सबसे पहले अपने स्थानीय एनवायरमेंट में कमांड चलाएं:

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json

अंत में, निम्न आदेश के साथ शेल चलाएं:

firebase functions:shell

एचटीटीपीएस फ़ंक्शन शुरू करें

शेल में एचटीटीपीएस फ़ंक्शन को शुरू करने के लिए, request एनपीएम मॉड्यूल की तरह ही इस्तेमाल किया जाता है. हालांकि, request को उस फ़ंक्शन के नाम से बदल दिया जाता है जिसे आपको एम्युलेट करना है. उदाहरण के लिए:

# invoke
myHttpsFunction()
myHttpsFunction.get()
myHttpsFunction.post()

# invoke at sub-path
myHttpsFunction('/path')
myHttpsFunction.get('/path')
myHttpsFunction.post('/path')

# send POST request with form data
myHttpsFunction.post('/path').form( {foo: 'bar' })

एचटीटीपीएस कॉल करने वाले फ़ंक्शन शुरू करें

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

# invoke
myCallableFunction('test data')
myCallableFunction({'foo': 'bar'})

वैकल्पिक रूप से, आप Firebase-Instance-ID-token को दूसरे पैरामीटर के रूप में पास कर सकते हैं. यह एक स्ट्रिंग होनी चाहिए.

# invoke with FCM registration token
myCallableFunction('test data', {instanceIdToken: 'sample token'})

context.auth का एम्युलेशन फ़िलहाल उपलब्ध नहीं है.

रीयलटाइम डेटाबेस फ़ंक्शन शुरू करना

रीयल टाइम डेटाबेस के फ़ंक्शन को स्थानीय तौर पर चलाते समय, आपको सही टेस्ट डेटा देना होगा. आम तौर पर इसका मतलब है, onCreate कार्रवाइयों के लिए जांच का नया डेटा देना, onDelete कार्रवाइयों के लिए पुराना/हटाया गया डेटा देना, और onUpdate या onWrite फ़ंक्शन के लिए, दोनों का डेटा देना:

# invoke onCreate function
myDatabaseFunction('new_data')

# invoke onDelete function
myDatabaseFunction('old_data')

# invoke onUpdate or onWrite function
myDatabaseFunction({before: 'old_data', after: 'new_data' })

before/after विकल्पों के अलावा, शेल, params का विकल्प देता है. इसे पाथ में वाइल्डकार्ड की नकल करने के लिए इस्तेमाल किया जाता है:

# mock wildcards in path, for example: if the path was input/{group}/{id}
myDatabaseFunction('data', {params: {group: 'a', id: 123}})

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

# to mock unauthenticated user
myDatabaseFunction('data', {authMode: 'USER'})
# to mock end user
myDatabaseFunction('data', {auth: {uid: 'abcd'}})

Firestore फ़ंक्शन शुरू करें

स्थानीय तौर पर Firestore फ़ंक्शन चलाते समय, आपको टेस्ट के लिए सही डेटा देना होगा. आम तौर पर, इसका मतलब है, onCreate कार्रवाइयों के लिए जांच का नया डेटा देना, onDelete कार्रवाइयों के लिए पुराना/हटाया गया डेटा देना, और onUpdate या onWrite फ़ंक्शन के लिए, दोनों का डेटा देना. ध्यान दें कि Firestore डेटा की-वैल्यू पेयर होने चाहिए. काम करने वाले डेटा टाइप देखें.

# invoke onCreate function
myFirestoreFunction({foo: ‘new’})

# invoke onDelete function
myFirestoreFunction({foo: ‘old’})

# invoke onUpdate or onWrite function
myFirestoreFunction({before: {foo: ‘old’}, after: {foo: ‘new’} })

data ऑब्जेक्ट के before/after फ़ील्ड के अलावा, किसी दस्तावेज़ के नाम में वाइल्डकार्ड की नकल करने के लिए, options ऑब्जेक्ट पर दिए गए params फ़ील्ड का इस्तेमाल किया जा सकता है:

# mock wildcards in document name, for example: if the name was input/{group}/{id}
myFirestoreFunction({foo: ‘new’}, {params: {group: 'a', id: 123}})

शेल हमेशा एडमिन के अधिकारों के साथ Firestore फ़ंक्शन चलाता है. इसका मतलब है कि यह इवेंट बनाने/अपडेट करने/मिटाने का मॉक ऐसे ही काम करता है जैसे एडमिन ऐक्सेस वाले किसी उपयोगकर्ता ने किया हो.

PubSub फ़ंक्शन शुरू करना

PubSub फ़ंक्शन के लिए, Buffer इंस्टेंस में अपना मैसेज पेलोड डालें और वैकल्पिक रूप से डेटा एट्रिब्यूट जोड़ें, जैसे कि:

// invokes a function with the JSON message { hello: 'world' } and attributes { foo: 'bar' }
myPubsubFunction({data: new Buffer('{"hello":"world"}'), attributes: {foo: 'bar'}})

Analytics फ़ंक्शन शुरू करना

शेल में myAnalyticsFunction() चलाकर, किसी भी डेटा के बिना Analytics फ़ंक्शन शुरू किया जा सकता है. फ़ंक्शन को टेस्ट डेटा के साथ चलाने के लिए, हमारा सुझाव है कि आप अपने फ़ंक्शन के लिए ज़रूरी इवेंट डेटा फ़ील्ड के लिए एक वैरिएबल तय करें:

var data = {
  eventDim: [{
    // populates event.data.params
    params: {foo: {stringValue: 'bar'} },
    // Also valid:
    //   {intValue: '10'}, {floatValue: '1.0'}, {doubleValue: '1.0'}
    // populates event.data.name
    name: 'event_name',
    // populates event.data.logTime, specify in microseconds
    timestampMicros: Date.now() * 1000,
    // populates event.data.previousLogTime, specify in microseconds
    previousTimestampMicros: Date.now() * 1000,
    // populates event.data.reportingDate, specify in 'YYYYMMDD' format
    date: '20170930',
    // populates event.data.valueInUSD
    valueInUsd: 230
  }],
  userDim: userDim
};

myAnalyticsFunction(data);

स्टोरेज और पुष्टि करने से जुड़े फ़ंक्शन शुरू करें

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

सिर्फ़ उन फ़ील्ड के बारे में बताएं जिन पर आपका कोड निर्भर करता है. अगर आपको सिर्फ़ फ़ंक्शन चलाना है, तो फ़ील्ड के बारे में बताएं.