Firebase Emulator Suite की मदद से लोकल डेवलपमेंट

1. शुरू करने से पहले

Cloud Firestore और Cloud Functions जैसे सर्वरलेस बैकएंड टूल इस्तेमाल करने में बहुत आसान हैं. हालांकि, इन्हें टेस्ट करना मुश्किल हो सकता है. Firebase Local Emulator Suite की मदद से, अपनी डेवलपमेंट मशीन पर इन सेवाओं के लोकल वर्शन चलाए जा सकते हैं. इससे आपको अपने ऐप्लिकेशन को तेज़ी से और सुरक्षित तरीके से डेवलप करने में मदद मिलती है.

ज़रूरी शर्तें

  • Visual Studio Code, Atom या Sublime Text जैसा कोई आसान एडिटर
  • Node.js 10.0.0 या इसके बाद का वर्शन (Node.js इंस्टॉल करने के लिए, nvm का इस्तेमाल करें. अपना वर्शन देखने के लिए, node --version चलाएं)
  • Java 7 या इसके बाद का वर्शन (Java इंस्टॉल करने के लिए, इन निर्देशों का इस्तेमाल करें. अपना वर्शन देखने के लिए, java -version चलाएं)

आपको क्या करना होगा

इस कोडलैब में, आपको ऑनलाइन शॉपिंग वाले एक आसान ऐप्लिकेशन को चलाने और उसे डीबग करने का तरीका बताया जाएगा. यह ऐप्लिकेशन, Firebase की कई सेवाओं की मदद से काम करता है:

  • Cloud Firestore: यह दुनिया भर में इस्तेमाल किया जा सकने वाला, बिना सर्वर वाला, और रीयल-टाइम सुविधाओं वाला NoSQL डेटाबेस है.
  • Cloud Functions: यह एक सर्वरलेस बैकएंड कोड है, जो इवेंट या एचटीटीपी अनुरोधों के जवाब में चलता है.
  • Firebase से पुष्टि करना: यह पुष्टि करने की एक ऐसी सेवा है जिसे मैनेज किया जाता है. यह सेवा, Firebase के अन्य प्रॉडक्ट के साथ इंटिग्रेट होती है.
  • Firebase होस्टिंग: वेब ऐप्लिकेशन के लिए तेज़ और सुरक्षित होस्टिंग.

लोकल डेवलपमेंट को चालू करने के लिए, ऐप्लिकेशन को Emulator Suite से कनेक्ट करना होगा.

2589e2f95b74fa88.png

आपको इनके बारे में भी जानकारी मिलेगी:

  • अपने ऐप्लिकेशन को Emulator Suite से कनेक्ट करने का तरीका और अलग-अलग एमुलेटर को कनेक्ट करने का तरीका.
  • Firebase के सुरक्षा नियम कैसे काम करते हैं और किसी लोकल एम्युलेटर पर Firestore के सुरक्षा नियमों की जांच कैसे की जाती है.
  • Firestore इवेंट से ट्रिगर होने वाला Firebase फ़ंक्शन लिखने का तरीका. साथ ही, Emulator Suite के लिए इंटिग्रेशन टेस्ट लिखने का तरीका.

2. सेट अप करें

सोर्स कोड पाना

इस कोडलैब में, आपको Fire Store के सैंपल का ऐसा वर्शन मिलेगा जो करीब-करीब पूरा हो चुका है. इसलिए, आपको सबसे पहले सोर्स कोड को क्लोन करना होगा:

$ git clone https://github.com/firebase/emulators-codelab.git

इसके बाद, कोडलैब डायरेक्ट्री में जाएं. यहां आपको इस कोडलैब के बाकी हिस्से के लिए काम करना होगा:

$ cd emulators-codelab/codelab-initial-state

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

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

# Move back into the previous directory
$ cd ../

Firebase CLI डाउनलोड करना

Emulator Suite, Firebase CLI (कमांड-लाइन इंटरफ़ेस) का हिस्सा है. इसे इस निर्देश का इस्तेमाल करके, अपनी मशीन पर इंस्टॉल किया जा सकता है:

$ npm install -g firebase-tools

इसके बाद, पक्का करें कि आपके पास सीएलआई का नया वर्शन हो. यह कोडलैब, 9.0.0 या इसके बाद के वर्शन के साथ काम करना चाहिए. हालांकि, इसके बाद के वर्शन में ज़्यादा गड़बड़ियां ठीक की गई हैं.

$ firebase --version
9.6.0

अपने Firebase प्रोजेक्ट से कनेक्ट करना

Firebase प्रोजेक्ट बनाना

  1. अपने Google खाते का इस्तेमाल करके, Firebase कंसोल में साइन इन करें.
  2. नया प्रोजेक्ट बनाने के लिए, बटन पर क्लिक करें. इसके बाद, प्रोजेक्ट का नाम डालें. उदाहरण के लिए, Emulators Codelab.
  3. जारी रखें पर क्लिक करें.
  4. अगर कहा जाए, तो Firebase की शर्तें पढ़ें और उन्हें स्वीकार करें. इसके बाद, जारी रखें पर क्लिक करें.
  5. (ज़रूरी नहीं) Firebase कंसोल में एआई असिस्टेंस की सुविधा चालू करें. इसे "Firebase में Gemini" कहा जाता है.
  6. इस कोडलैब के लिए, आपको Google Analytics की ज़रूरत नहीं है. इसलिए, Google Analytics के विकल्प को टॉगल करके बंद करें.
  7. प्रोजेक्ट बनाएं पर क्लिक करें. इसके बाद, प्रोजेक्ट के सेट अप होने का इंतज़ार करें और फिर जारी रखें पर क्लिक करें.

अपने कोड को Firebase प्रोजेक्ट से कनेक्ट करना

अब हमें इस कोड को आपके Firebase प्रोजेक्ट से कनेक्ट करना होगा. Firebase CLI में लॉग इन करने के लिए, सबसे पहले यह कमांड चलाएं:

$ firebase login

इसके बाद, प्रोजेक्ट का उपनाम बनाने के लिए यह कमांड चलाएं. $YOUR_PROJECT_ID को अपने Firebase प्रोजेक्ट के आईडी से बदलें.

$ firebase use $YOUR_PROJECT_ID

अब ऐप्लिकेशन को चलाया जा सकता है!

3. एम्युलेटर चलाना

इस सेक्शन में, आपको ऐप्लिकेशन को स्थानीय तौर पर चलाने का तरीका बताया जाएगा. इसका मतलब है कि अब Emulator Suite को बूट करने का समय आ गया है.

एम्युलेटर शुरू करना

एम्युलेटर शुरू करने के लिए, कोडलैब की सोर्स डायरेक्ट्री में जाकर यह कमांड चलाएं:

$ firebase emulators:start --import=./seed

आपको कुछ ऐसा आउटपुट दिखेगा:

$ firebase emulators:start --import=./seed
i  emulators: Starting emulators: auth, functions, firestore, hosting
⚠  functions: The following emulators are not running, calls to these services from the Functions emulator will affect production: database, pubsub
i  firestore: Importing data from /Users/samstern/Projects/emulators-codelab/codelab-initial-state/seed/firestore_export/firestore_export.overall_export_metadata
i  firestore: Firestore Emulator logging to firestore-debug.log
i  hosting: Serving hosting files from: public
✔  hosting: Local server: http://127.0.0.1:5000
i  ui: Emulator UI logging to ui-debug.log
i  functions: Watching "/Users/samstern/Projects/emulators-codelab/codelab-initial-state/functions" for Cloud Functions...
✔  functions[calculateCart]: firestore function initialized.

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://127.0.0.1:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at 127.0.0.1:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

सभी एम्युलेटर चालू हो गए हैं मैसेज दिखने के बाद, ऐप्लिकेशन इस्तेमाल के लिए तैयार हो जाता है.

वेब ऐप्लिकेशन को एम्युलेटर से कनेक्ट करना

लॉग में मौजूद टेबल के आधार पर, हम देख सकते हैं कि Cloud Firestore एम्युलेटर, पोर्ट 8080 पर और Authentication एम्युलेटर, पोर्ट 9099 पर सुन रहा है.

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘

आइए, आपके फ़्रंटएंड कोड को प्रोडक्शन के बजाय एम्युलेटर से कनेक्ट करें. public/js/homepage.js फ़ाइल खोलें और onDocumentReady फ़ंक्शन ढूंढें. हम देख सकते हैं कि कोड, स्टैंडर्ड Firestore और Auth इंस्टेंस को ऐक्सेस करता है:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

आइए, db और auth ऑब्जेक्ट को अपडेट करें, ताकि वे लोकल एम्युलेटर पर ले जाएं:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

  // ADD THESE LINES
  if (location.hostname === "127.0.0.1") {
    console.log("127.0.0.1 detected!");
    auth.useEmulator("http://127.0.0.1:9099");
    db.useEmulator("127.0.0.1", 8080);
  }

अब जब ऐप्लिकेशन आपकी लोकल मशीन पर चल रहा हो (होस्टिंग एम्युलेटर की मदद से), तो Firestore क्लाइंट भी प्रोडक्शन डेटाबेस के बजाय लोकल एम्युलेटर पर ले जाता है.

EmulatorUI खोलना

अपने वेब ब्राउज़र में, http://127.0.0.1:4000/ पर जाएं. आपको Emulator Suite का यूज़र इंटरफ़ेस (यूआई) दिखेगा.

एम्युलेटर के यूज़र इंटरफ़ेस (यूआई) की होम स्क्रीन

Firestore एम्युलेटर का यूज़र इंटरफ़ेस (यूआई) देखने के लिए क्लिक करें. items कलेक्शन में पहले से ही डेटा मौजूद है, क्योंकि --import फ़्लैग के साथ डेटा इंपोर्ट किया गया है.

4ef88d0148405d36.png

4. ऐप्लिकेशन चलाना

ऐप्लिकेशन खोलें

अपने वेब ब्राउज़र में, http://127.0.0.1:5000 पर जाएं. आपको अपनी मशीन पर, Fire Store स्थानीय तौर पर चलता हुआ दिखेगा!

939f87946bac2ee4.png

ऐप्लिकेशन का इस्तेमाल करना

होम पेज पर कोई आइटम चुनें और कार्ट में जोड़ें पर क्लिक करें. हालांकि, आपको यह गड़बड़ी दिखेगी:

a11bd59933a8e885.png

चलिए, इस गड़बड़ी को ठीक करते हैं! एम्युलेटर में सब कुछ चलने की वजह से, हम असल डेटा पर असर पड़ने की चिंता किए बिना एक्सपेरिमेंट कर सकते हैं.

5. ऐप्लिकेशन को डीबग करना

गड़बड़ी का पता लगाना

ठीक है, Chrome डेवलपर कंसोल में देखते हैं. कंसोल पर गड़बड़ी देखने के लिए, Control+Shift+J (Windows, Linux, Chrome OS) या Command+Option+J (Mac) दबाएं:

74c45df55291dab1.png

ऐसा लगता है कि addToCart तरीके में कोई गड़बड़ी हुई है. चलिए, इस पर एक नज़र डालते हैं. हम उस तरीके में uid को ऐक्सेस करने की कोशिश कहां करते हैं और वह null क्यों होगा? फ़िलहाल, public/js/homepage.js में यह तरीका इस तरह दिखता है:

public/js/homepage.js

  addToCart(id, itemData) {
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

अहा! हमने ऐप्लिकेशन में साइन इन नहीं किया है. Firebase से पुष्टि करने के दस्तावेज़ के मुताबिक, जब हम साइन इन नहीं करते हैं, तो auth.currentUser, null होता है. आइए, इसके लिए एक जांच जोड़ें:

public/js/homepage.js

  addToCart(id, itemData) {
    // ADD THESE LINES
    if (this.auth.currentUser === null) {
      this.showError("You must be signed in!");
      return;
    }

    // ...
  }

ऐप्लिकेशन की जांच करना

अब पेज को रीफ़्रेश करें. इसके बाद, कार्ट में जोड़ें पर क्लिक करें. इस बार आपको गड़बड़ी का यह मैसेज दिखेगा:

c65f6c05588133f7.png

हालांकि, अगर सबसे ऊपर मौजूद टूलबार में साइन इन करें पर क्लिक करने के बाद, फिर से कार्ट में जोड़ें पर क्लिक किया जाता है, तो आपको कार्ट अपडेट होता हुआ दिखेगा.

हालांकि, ऐसा लगता है कि ये नंबर बिलकुल भी सही नहीं हैं:

239f26f02f959eef.png

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

6. लोकल फ़ंक्शन ट्रिगर

कार्ट में जोड़ें पर क्लिक करने से, कई इवेंट की एक चेन शुरू हो जाती है. इसमें कई एम्युलेटर शामिल होते हैं. कार्ट में कोई आइटम जोड़ने के बाद, आपको Firebase CLI लॉग में इस तरह के मैसेज दिखेंगे:

i  functions: Beginning execution of "calculateCart"
i  functions: Finished "calculateCart" in ~1s

उन लॉग को जनरेट करने और यूज़र इंटरफ़ेस (यूआई) में अपडेट करने के लिए, चार मुख्य इवेंट हुए:

68c9323f2ad10f7a.png

1) Firestore Write - Client

Firestore कलेक्शन /carts/{cartId}/items/{itemId}/ में एक नया दस्तावेज़ जोड़ा जाता है. इस कोड को public/js/homepage.js में मौजूद addToCart फ़ंक्शन में देखा जा सकता है:

public/js/homepage.js

  addToCart(id, itemData) {
    // ...
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

2) Cloud फ़ंक्शन ट्रिगर होना

Cloud फ़ंक्शन calculateCart, onWrite ट्रिगर का इस्तेमाल करके, कार्ट में मौजूद आइटम में होने वाले किसी भी बदलाव (बनाना, अपडेट करना या मिटाना) को ट्रैक करता है. इसे functions/index.js में देखा जा सकता है:

functions/index.js

exports.calculateCart = functions.firestore
    .document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    }
);

3) Firestore Write - Admin

calculateCart फ़ंक्शन, कार्ट में मौजूद सभी आइटम को पढ़ता है और कुल संख्या और कीमत को जोड़ता है. इसके बाद, यह "कार्ट" दस्तावेज़ को नए कुल योग के साथ अपडेट करता है (ऊपर cartRef.update(...) देखें).

4) Firestore Read - Client

वेब फ़्रंटएंड ने कार्ट में होने वाले बदलावों के बारे में अपडेट पाने के लिए सदस्यता ली है. Cloud फ़ंक्शन के नए कुल डेटा को लिखने और यूआई को अपडेट करने के बाद, इसे रीयल-टाइम में अपडेट किया जाता है. जैसा कि public/js/homepage.js में देखा जा सकता है:

public/js/homepage.js

this.cartUnsub = cartRef.onSnapshot(cart => {
   // The cart document was changed, update the UI
   // ...
});

Recap

बहुत अच्छे! आपने पूरी तरह से लोकल ऐप्लिकेशन सेट अप कर लिया है. यह ऐप्लिकेशन, पूरी तरह से लोकल टेस्टिंग के लिए, Firebase के तीन अलग-अलग एम्युलेटर का इस्तेमाल करता है.

db82eef1706c9058.gif

लेकिन रुकें, यहां और भी हैं! अगले सेक्शन में आपको इनके बारे में जानकारी मिलेगी:

  • Firebase एम्युलेटर का इस्तेमाल करने वाले यूनिट टेस्ट लिखने का तरीका.
  • सुरक्षा नियमों को डीबग करने के लिए, Firebase एमुलेटर इस्तेमाल करने का तरीका.

7. अपने ऐप्लिकेशन के हिसाब से सुरक्षा के नियम बनाना

हमारा वेब ऐप्लिकेशन, डेटा को पढ़ता और लिखता है. हालांकि, अब तक हमने सुरक्षा पर ध्यान नहीं दिया है. Cloud Firestore, "सुरक्षा के नियम" नाम के सिस्टम का इस्तेमाल करता है. इससे यह तय किया जाता है कि डेटा को पढ़ने और उसमें बदलाव करने का ऐक्सेस किसके पास है. Emulator Suite, इन नियमों का प्रोटोटाइप बनाने का एक बेहतरीन तरीका है.

एडिटर में, emulators-codelab/codelab-initial-state/firestore.rules फ़ाइल खोलें. आपको दिखेगा कि हमारे नियमों में तीन मुख्य सेक्शन हैं:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

फ़िलहाल, कोई भी व्यक्ति हमारे डेटाबेस में मौजूद डेटा को पढ़ सकता है और उसमें बदलाव कर सकता है! हम यह पक्का करना चाहते हैं कि सिर्फ़ मान्य कार्रवाइयां ही पूरी हों और कोई भी संवेदनशील जानकारी लीक न हो.

इस कोडलैब के दौरान, कम से कम अधिकारों के सिद्धांत का पालन करते हुए, हम सभी दस्तावेज़ों को लॉक कर देंगे. इसके बाद, हम धीरे-धीरे ऐक्सेस जोड़ेंगे, ताकि सभी उपयोगकर्ताओं को ज़रूरत के मुताबिक ऐक्सेस मिल सके. आइए, पहले दो नियमों को अपडेट करके, ऐक्सेस को अस्वीकार करने के लिए शर्त को false पर सेट करें:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

8. एम्युलेटर और टेस्ट चलाना

एम्युलेटर शुरू करना

कमांड लाइन पर, पक्का करें कि आप emulators-codelab/codelab-initial-state/ में हों. ऐसा हो सकता है कि पिछले चरणों में इस्तेमाल किए गए एम्युलेटर अब भी चल रहे हों. अगर ऐसा नहीं है, तो एम्युलेटर फिर से चालू करें:

$ firebase emulators:start --import=./seed

एम्युलेटर चालू होने के बाद, उनके लिए लोकल लेवल पर टेस्ट चलाए जा सकते हैं.

टेस्ट चलाना

emulators-codelab/codelab-initial-state/ डायरेक्ट्री से नए टर्मिनल टैब में कमांड लाइन पर

सबसे पहले, फ़ंक्शन डायरेक्ट्री में जाएं. हम इस कोडलैब के बाकी हिस्से के लिए यहीं रहेंगे:

$ cd functions

अब फ़ंक्शन डायरेक्ट्री में mocha टेस्ट चलाएं और आउटपुट के सबसे ऊपर स्क्रोल करें:

# Run the tests
$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    1) can be created and updated by the cart owner
    2) can be read only by the cart owner

  shopping cart items
    3) can be read only by the cart owner
    4) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  0 passing (364ms)
  1 pending
  4 failing

फ़िलहाल, हमारे पास चार गड़बड़ियां हैं. नियमों की फ़ाइल बनाते समय, ज़्यादा टेस्ट पास होते देखकर प्रोग्रेस को मेज़र किया जा सकता है.

9. कार्ट को सुरक्षित तरीके से ऐक्सेस करना

पहले दो फ़ेलियर, "शॉपिंग कार्ट" टेस्ट हैं. इनसे यह जांच की जाती है कि:

  • उपयोगकर्ता सिर्फ़ अपने कार्ट बना सकते हैं और उन्हें अपडेट कर सकते हैं
  • उपयोगकर्ता सिर्फ़ अपने कार्ट देख सकते हैं

functions/test.js

  it('can be created and updated by the cart owner', async () => {
    // Alice can create her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Bob can't create Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Alice can update her own cart with a new total
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").update({
      total: 1
    }));

    // Bob can't update Alice's cart with a new total
    await firebase.assertFails(bobDb.doc("carts/alicesCart").update({
      total: 1
    }));
  });

  it("can be read only by the cart owner", async () => {
    // Setup: Create Alice's cart as admin
    await admin.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    });

    // Alice can read her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").get());

    // Bob can't read Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").get());
  });

चलिए, इन टेस्ट को पास करते हैं. एडिटर में, सुरक्षा के नियमों वाली फ़ाइल firestore.rules खोलें और match /carts/{cartID} में मौजूद स्टेटमेंट अपडेट करें:

firestore.rules

rules_version = '2';
service cloud.firestore {
    // UPDATE THESE LINES
    match /carts/{cartID} {
      allow create: if request.auth.uid == request.resource.data.ownerUID;
      allow read, update, delete: if request.auth.uid == resource.data.ownerUID;
    }

    // ...
  }
}

इन नियमों के तहत, अब सिर्फ़ कार्ट का मालिक ही कार्ट को ऐक्सेस कर सकता है और उसमें बदलाव कर सकता है.

इनकमिंग डेटा और उपयोगकर्ता की पुष्टि करने के लिए, हम दो ऑब्जेक्ट का इस्तेमाल करते हैं. ये ऑब्जेक्ट, हर नियम के संदर्भ में उपलब्ध होते हैं:

  • request ऑब्जेक्ट में, की जा रही कार्रवाई का डेटा और मेटाडेटा शामिल होता है.
  • अगर कोई Firebase प्रोजेक्ट Firebase से पुष्टि करने की सुविधा का इस्तेमाल कर रहा है, तो request.auth ऑब्जेक्ट, अनुरोध करने वाले उपयोगकर्ता के बारे में बताता है.

10. कार्ट के ऐक्सेस की जांच करना

firestore.rules को सेव करने पर, Emulator Suite नियमों को अपने-आप अपडेट कर देता है. एम्युलेटर को चलाने वाले टैब में जाकर, यह पुष्टि की जा सकती है कि एम्युलेटर में नियम अपडेट हो गए हैं. इसके लिए, आपको यह मैसेज देखना होगा Rules updated:

5680da418b420226.png

टेस्ट फिर से चलाएं और देखें कि पहले दो टेस्ट अब पास हो रहे हैं या नहीं:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    1) can be read only by the cart owner
    2) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items

  2 passing (482ms)
  1 pending
  2 failing

बहुत खूब! अब आपके पास शॉपिंग कार्ट का ऐक्सेस है. चलिए, अब अगले टेस्ट पर चलते हैं.

11. यूज़र इंटरफ़ेस (यूआई) में "कार्ट में जोड़ें" फ़्लो की जांच करना

फ़िलहाल, कार्ट के मालिक अपने कार्ट में मौजूद डेटा को पढ़ सकते हैं और उसमें बदलाव कर सकते हैं. हालांकि, वे कार्ट में मौजूद अलग-अलग आइटम के डेटा को न तो पढ़ सकते हैं और न ही उसमें बदलाव कर सकते हैं. ऐसा इसलिए है, क्योंकि मालिकों के पास कार्ट दस्तावेज़ का ऐक्सेस तो है, लेकिन कार्ट के आइटम के सब-कलेक्शन का ऐक्सेस नहीं है.

इससे उपयोगकर्ताओं को खराब अनुभव मिलता है.

http://127.0.0.1:5000, पर चल रहे वेब यूज़र इंटरफ़ेस (यूआई) पर वापस जाएं और अपने कार्ट में कुछ जोड़ने की कोशिश करें. आपको Permission Denied गड़बड़ी का मैसेज मिलता है, जो डीबग कंसोल में दिखता है. ऐसा इसलिए होता है, क्योंकि हमने अब तक उपयोगकर्ताओं को items सब-कलेक्शन में बनाए गए दस्तावेज़ों का ऐक्सेस नहीं दिया है.

12. कार्ट में मौजूद आइटम ऐक्सेस करने की अनुमति दें

इन दो टेस्ट से यह पुष्टि होती है कि उपयोगकर्ता सिर्फ़ अपने कार्ट में आइटम जोड़ सकते हैं या अपने कार्ट में मौजूद आइटम पढ़ सकते हैं:

  it("can be read only by the cart owner", async () => {
    // Alice can read items in her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/milk").get());

    // Bob can't read items in alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/milk").get())
  });

  it("can be added only by the cart owner",  async () => {
    // Alice can add an item to her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));

    // Bob can't add an item to alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));
  });

इसलिए, हम एक ऐसा नियम लिख सकते हैं जो मौजूदा उपयोगकर्ता को ऐक्सेस की अनुमति देता है. हालांकि, इसके लिए ज़रूरी है कि मौजूदा उपयोगकर्ता का यूआईडी, कार्ट दस्तावेज़ पर मौजूद ownerUID से मेल खाता हो. create, update, delete के लिए अलग-अलग नियम तय करने की ज़रूरत नहीं है. इसलिए, write नियम का इस्तेमाल किया जा सकता है. यह नियम, डेटा में बदलाव करने वाले सभी अनुरोधों पर लागू होता है.

आइटम के सब-कलेक्शन में मौजूद दस्तावेज़ों के लिए नियम अपडेट करें. शर्त में मौजूद get, Firestore से वैल्यू को रीड कर रहा है. इस मामले में, कार्ट दस्तावेज़ पर मौजूद ownerUID को रीड किया जा रहा है.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ...

    // UPDATE THESE LINES
    match /carts/{cartID}/items/{itemID} {
      allow read, write: if get(/databases/$(database)/documents/carts/$(cartID)).data.ownerUID == request.auth.uid;
    }

    // ...
  }
}

13. कार्ट में मौजूद आइटम को ऐक्सेस करने की सुविधा को टेस्ट करना

अब हम टेस्ट को फिर से चला सकते हैं. आउटपुट में सबसे ऊपर स्क्रोल करें और देखें कि ज़्यादा टेस्ट पास हुए हैं या नहीं:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    ✓ can be read only by the cart owner (111ms)
    ✓ can be added only by the cart owner


  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  4 passing (401ms)
  1 pending

बहुत बढ़िया! अब हमारे सभी टेस्ट पास हो गए हैं. एक टेस्ट बाकी है, लेकिन हम कुछ चरणों के बाद उस पर आएंगे.

14. "कार्ट में जोड़ें" फ़्लो को फिर से देखें

वेब फ़्रंट एंड ( http://127.0.0.1:5000) पर वापस जाएं और कार्ट में कोई आइटम जोड़ें. यह पुष्टि करने के लिए यह एक ज़रूरी कदम है कि हमारे टेस्ट और नियम, क्लाइंट की ज़रूरी शर्तों के मुताबिक हैं. (याद रखें कि पिछली बार जब हमने यूज़र इंटरफ़ेस (यूआई) को आज़माया था, तब उपयोगकर्ता अपने कार्ट में आइटम नहीं जोड़ पा रहे थे!)

69ad26cee520bf24.png

firestore.rules सेव होने पर, क्लाइंट नियमों को अपने-आप फिर से लोड करता है. इसलिए, कार्ट में कुछ जोड़ें.

Recap

बहुत अच्छे! आपने अपने ऐप्लिकेशन की सुरक्षा को बेहतर बना लिया है. यह ऐप्लिकेशन को प्रोडक्शन के लिए तैयार करने का एक ज़रूरी चरण है! अगर यह कोई प्रोडक्शन ऐप्लिकेशन होता, तो हम इन टेस्ट को अपनी लगातार इंटिग्रेशन पाइपलाइन में जोड़ सकते थे. इससे हमें यह भरोसा मिलेगा कि आने वाले समय में, हमारे शॉपिंग कार्ट डेटा के लिए ये ऐक्सेस कंट्रोल मौजूद रहेंगे. भले ही, अन्य लोग नियमों में बदलाव कर रहे हों.

ba5440b193e75967.gif

लेकिन रुकिए, और भी बहुत कुछ है!

अगर आप इस वीडियो को देखना जारी रखते हैं, तो आपको ये बातें पता चलेंगी:

  • Firestore इवेंट से ट्रिगर होने वाला फ़ंक्शन लिखने का तरीका
  • कई एम्युलेटर पर काम करने वाले टेस्ट बनाने का तरीका

15. Cloud Functions के टेस्ट सेट अप करना

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

Emulator Suite की मदद से, Cloud फ़ंक्शन को टेस्ट करना बहुत आसान हो जाता है. इसमें Cloud Firestore और अन्य सेवाओं का इस्तेमाल करने वाले फ़ंक्शन भी शामिल हैं.

एडिटर में, emulators-codelab/codelab-initial-state/functions/test.js फ़ाइल खोलें और फ़ाइल में मौजूद आखिरी टेस्ट तक स्क्रोल करें. फ़िलहाल, इसे 'मंज़ूरी बाकी है' के तौर पर मार्क किया गया है:

//  REMOVE .skip FROM THIS LINE
describe.skip("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

टेस्ट को चालू करने के लिए, .skip को हटाएं, ताकि यह इस तरह दिखे:

describe("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

इसके बाद, फ़ाइल में सबसे ऊपर मौजूद REAL_FIREBASE_PROJECT_ID वैरिएबल ढूंढें और उसे अपने असली Firebase प्रोजेक्ट आईडी में बदलें.:

// CHANGE THIS LINE
const REAL_FIREBASE_PROJECT_ID = "changeme";

अगर आपको अपना प्रोजेक्ट आईडी याद नहीं है, तो Firebase कंसोल में प्रोजेक्ट सेटिंग में जाकर, अपना Firebase प्रोजेक्ट आईडी ढूंढें:

d6d0429b700d2b21.png

16. फ़ंक्शन की जांच करना

इस टेस्ट में Cloud Firestore और Cloud Functions के बीच इंटरैक्शन की पुष्टि की जाती है. इसलिए, इसमें पिछले कोडलैब के टेस्ट की तुलना में ज़्यादा सेटअप की ज़रूरत होती है. आइए, इस टेस्ट के बारे में जानें और देखें कि इसमें क्या उम्मीद की जाती है.

कार्ट बनाना

Cloud Functions, भरोसेमंद सर्वर एनवायरमेंट में काम करते हैं. साथ ही, ये Admin SDK के इस्तेमाल किए जाने वाले सेवा खाते की पुष्टि करने की सुविधा का इस्तेमाल कर सकते हैं. सबसे पहले, initializeApp के बजाय initializeAdminApp का इस्तेमाल करके ऐप्लिकेशन को शुरू करें. इसके बाद, उस कार्ट के लिए DocumentReference बनाएं जिसमें आइटम जोड़े जाएंगे. साथ ही, कार्ट को शुरू करें:

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    ...
  });

फ़ंक्शन को ट्रिगर करना

इसके बाद, फ़ंक्शन को ट्रिगर करने के लिए, हमारे कार्ट दस्तावेज़ के items सब-कलेक्शन में दस्तावेज़ जोड़ें. दो आइटम जोड़ें, ताकि यह पक्का किया जा सके कि फ़ंक्शन में होने वाले जोड़ की जांच की जा रही है.

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    await aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    await aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });

    ...
    });
  });

टेस्ट के लिए उम्मीदें सेट करना

कार्ट दस्तावेज़ में होने वाले किसी भी बदलाव के लिए, लिसनर को रजिस्टर करने के लिए onSnapshot() का इस्तेमाल करें. onSnapshot() एक फ़ंक्शन दिखाता है जिसे आप लिसनर का रजिस्ट्रेशन रद्द करने के लिए कॉल कर सकते हैं.

इस टेस्ट के लिए, दो आइटम जोड़ें जिनकी कुल कीमत 9.98 डॉलर हो. इसके बाद, देखें कि कार्ट में आपकी पसंद के मुताबिक itemCount और totalPrice मौजूद हैं या नहीं. अगर ऐसा है, तो इसका मतलब है कि फ़ंक्शन ने अपना काम कर दिया है.

it("should sum the cost of their items", (done) => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });
    
    // Listen for every update to the cart. Every time an item is added to
    // the cart's subcollection of items, the function updates `totalPrice`
    // and `itemCount` attributes on the cart.
    // Returns a function that can be called to unsubscribe the listener.
    await new Promise((resolve) => {
      const unsubscribe = aliceCartRef.onSnapshot(snap => {
        // If the function worked, these will be cart's final attributes.
        const expectedCount = 2;
        const expectedTotal = 9.98;
  
        // When the `itemCount`and `totalPrice` match the expectations for the
        // two items added, the promise resolves, and the test passes.
        if (snap.data().itemCount === expectedCount && snap.data().totalPrice == expectedTotal) {
          // Call the function returned by `onSnapshot` to unsubscribe from updates
          unsubscribe();
          resolve();
        };
      });
    });
   });
 });

17. टेस्ट चलाएं

ऐसा हो सकता है कि पिछली जांचों के एम्युलेटर अब भी चल रहे हों. अगर ऐसा नहीं है, तो एम्युलेटर चालू करें. कमांड लाइन से, यह कमांड चलाएं

$ firebase emulators:start --import=./seed

एक नया टर्मिनल टैब खोलें (एम्युलेटर को चलने दें) और फ़ंक्शन डायरेक्ट्री में जाएं. ऐसा हो सकता है कि सुरक्षा नियमों की जांच करने के बाद, आपने इसे बंद न किया हो.

$ cd functions

अब यूनिट टेस्ट चलाएं. आपको कुल पांच टेस्ट दिखेंगे:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (82ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (42ms)

  shopping cart items
    ✓ items can be read by the cart owner (40ms)
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    1) should sum the cost of their items

  4 passing (2s)
  1 failing

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

18. कोई फ़ंक्शन लिखें

इस टेस्ट को ठीक करने के लिए, आपको functions/index.js में फ़ंक्शन को अपडेट करना होगा. हालांकि, इस फ़ंक्शन का कुछ हिस्सा लिखा गया है, लेकिन यह पूरा नहीं है. फ़िलहाल, यह फ़ंक्शन इस तरह दिखता है:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 125.98;
      let itemCount = 8;
      try {
        
        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

फ़ंक्शन, कार्ट रेफ़रंस को सही तरीके से सेट कर रहा है. हालांकि, इसके बाद वह totalPrice और itemCount की वैल्यू का हिसाब लगाने के बजाय, उन्हें हार्डकोड की गई वैल्यू में अपडेट कर देता है.

का इस्तेमाल करके, डेटा फ़ेच करना और उसे बार-बार दोहराना

items सबकलेक्शन

items सब-कलेक्शन के लिए, एक नया कॉन्सटेंट itemsSnap शुरू करें. इसके बाद, कलेक्शन में मौजूद सभी दस्तावेज़ों को एक-एक करके देखें.

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }


      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        // ADD LINES FROM HERE
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
        })
        // TO HERE
       
        return cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

totalPrice और itemCount का हिसाब लगाना

सबसे पहले, totalPrice और itemCount की वैल्यू को शून्य पर सेट करें.

इसके बाद, हमारे इटरेशन ब्लॉक में लॉजिक जोड़ें. सबसे पहले, देखें कि आइटम की कीमत दी गई है या नहीं. अगर आइटम की संख्या नहीं बताई गई है, तो इसे डिफ़ॉल्ट रूप से 1 पर सेट करें. इसके बाद, इस संख्या को itemCount के कुल योग में जोड़ें. आखिर में, आइटम की कीमत को उसकी संख्या से गुणा करें और उसे totalPrice के कुल योग में जोड़ें:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      try {
        // CHANGE THESE LINES
        let totalPrice = 0;
        let itemCount = 0;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          // ADD LINES FROM HERE
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = itemData.quantity ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
          // TO HERE
        })

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

सफलता और गड़बड़ी की स्थितियों को डीबग करने में मदद पाने के लिए, लॉगिंग भी जोड़ी जा सकती है:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 0;
      let itemCount = 0;
      try {
        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = (itemData.quantity) ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
        });

        await cartRef.update({
          totalPrice,
          itemCount
        });

        // OPTIONAL LOGGING HERE
        console.log("Cart total successfully recalculated: ", totalPrice);
      } catch(err) {
        // OPTIONAL LOGGING HERE
        console.warn("update error", err);
      }
    });

19. टेस्ट फिर से चलाना

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

$ npm test
> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (306ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (59ms)

  shopping cart items
    ✓ items can be read by the cart owner
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    ✓ should sum the cost of their items (800ms)


  5 passing (1s)

बहुत खूब!

20. स्टोरफ़्रंट यूज़र इंटरफ़ेस का इस्तेमाल करके इसे आज़माएं

आखिरी टेस्ट के लिए, वेब ऐप्लिकेशन ( http://127.0.0.1:5000/) पर वापस जाएं और कार्ट में कोई आइटम जोड़ें.

69ad26cee520bf24.png

पुष्टि करें कि कार्ट में कुल कीमत सही तरीके से अपडेट हो गई है. शानदार!

Recap

आपने Firebase के लिए Cloud Functions और Cloud Firestore के बीच एक जटिल टेस्ट केस को समझा. आपने टेस्ट पास करने के लिए, एक Cloud फ़ंक्शन लिखा. आपने यह भी पुष्टि की है कि नई सुविधा, यूज़र इंटरफ़ेस (यूआई) में काम कर रही है! आपने यह सब लोकल तौर पर किया है. इसके लिए, आपने अपनी मशीन पर एम्युलेटर चलाए हैं.

आपने एक वेब क्लाइंट भी बनाया है, जो लोकल एमुलेटर के साथ काम करता है. साथ ही, डेटा को सुरक्षित रखने के लिए सुरक्षा नियमों को ज़रूरत के मुताबिक बनाया है और लोकल एमुलेटर का इस्तेमाल करके सुरक्षा नियमों की जांच की है.

c6a7aeb91fe97a64.gif