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

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

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

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

  • Cloud Firestore और Realtime Database ट्रिगर के पास पहले से ही ज़रूरी क्रेडेंशियल हैं. इसलिए, इन्हें अतिरिक्त सेटअप की ज़रूरत नहीं है.
  • अन्य सभी एपीआई के लिए, इस सेक्शन में बताया गया सेटअप का तरीका अपनाना ज़रूरी है. इनमें Firebase एपीआई, जैसे कि Authentication और FCM या Google APIs, जैसे कि Cloud Translation या Cloud Speech शामिल हैं. यह तब लागू होता है, जब 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 functions:shell

    खिड़कियां

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

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

स्टोरेज और Auth फ़ंक्शन को शुरू करना

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

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