शुरू करें: अपने पहले फ़ंक्शन लिखें, टेस्ट करें, और डिप्लॉय करें

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

• "मैसेज जोड़ें" फ़ंक्शन, एक ऐसा यूआरएल दिखाता है जो टेक्स्ट वैल्यू स्वीकार करता है और उसे Cloud Firestore में लिखता है.
• "कैपिटल लेटर में बदलें" फ़ंक्शन, Cloud Firestore लिखने पर ट्रिगर होता है और टेक्स्ट को कैपिटल लेटर में बदलता है.

यहां फ़ंक्शन वाला पूरा सैंपल कोड दिया गया है:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});
index.js

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()


@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")


@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

इस ट्यूटोरियल के बारे में जानकारी

हमने इस सैंपल के लिए Cloud Firestore और एचटीटीपी ट्रिगर किए गए फ़ंक्शन चुने हैं. इसकी एक वजह यह है कि इन बैकग्राउंड ट्रिगर को Firebase Local Emulator Suite के ज़रिए अच्छी तरह से टेस्ट किया जा सकता है. यह टूलसेट, Realtime Database, Cloud Storage, PubSub, Auth, और एचटीटीपी कॉल किए जा सकने वाले ट्रिगर के साथ भी काम करता है. Remote Config और TestLab ट्रिगर जैसे अन्य बैकग्राउंड ट्रिगर की इंटरैक्टिव तरीके से जांच की जा सकती है. इसके लिए, इस पेज पर नहीं बताए गए टूलसेट का इस्तेमाल किया जा सकता है.

इस ट्यूटोरियल के इन सेक्शन में, सैंपल बनाने, उसकी जांच करने, और उसे डिप्लॉय करने का तरीका बताया गया है.

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

अपना एनवायरमेंट और Firebase CLI सेट अप करना

प्रोजेक्ट शुरू करना

Firebase के लिए Cloud Functions एसडीके टूल को शुरू करने पर, एक खाली प्रोजेक्ट बनता है. इसमें डिपेंडेंसी और कुछ सैंपल कोड होता है. अगर Node.js का इस्तेमाल किया जा रहा है, तो फ़ंक्शन बनाने के लिए TypeScript या JavaScript में से किसी एक को चुना जा सकता है. इस ट्यूटोरियल के लिए, आपको Cloud Firestore को भी शुरू करना होगा.

अपने प्रोजेक्ट को शुरू करने के लिए:

1. ब्राउज़र से लॉग इन करने और Firebase CLI की पुष्टि करने के लिए, firebase login चलाएं.
2. अपने Firebase प्रोजेक्ट की डायरेक्ट्री पर जाएं.
3. firebase init firestore रन करें. इस ट्यूटोरियल के लिए, Firestore के नियमों और इंडेक्स फ़ाइलों के लिए प्रॉम्प्ट मिलने पर, डिफ़ॉल्ट वैल्यू स्वीकार की जा सकती हैं. अगर आपने इस प्रोजेक्ट में अब तक Cloud Firestore का इस्तेमाल नहीं किया है, तो आपको Firestore के लिए शुरुआती मोड और जगह भी चुननी होगी. इसके बारे में Cloud Firestore का इस्तेमाल शुरू करना लेख में बताया गया है.
4. firebase init functions रन करें. सीएलआई, आपसे मौजूदा कोडबेस चुनने या नया कोडबेस शुरू करने और उसका नाम डालने के लिए कहता है. शुरुआत में, डिफ़ॉल्ट जगह पर मौजूद एक कोडबेस काफ़ी होता है. हालांकि, बाद में जब आपका कोडबेस बड़ा हो जाता है, तब आपको कोडबेस में फ़ंक्शन व्यवस्थित करने की ज़रूरत पड़ सकती है.

5. सीएलआई में, भाषा से जुड़ी सहायता के लिए ये विकल्प मिलते हैं:

   • JavaScript
   • TypeScript
   • Python

   इस ट्यूटोरियल के लिए, JavaScript या Python चुनें. TypeScript में लिखने के लिए, TypeScript की मदद से फ़ंक्शन लिखना लेख पढ़ें.

6. सीएलआई की मदद से, डिपेंडेंसी इंस्टॉल की जा सकती हैं. अगर आपको डिपेंडेंसी को किसी दूसरे तरीके से मैनेज करना है, तो इस अनुरोध को अस्वीकार किया जा सकता है.

इन कमांड के पूरा होने के बाद, आपके प्रोजेक्ट का स्ट्रक्चर ऐसा दिखेगा:

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # Main source file for your Cloud Functions code
      |
      +- node_modules/ # Directory where your dependencies (declared in
                        # package.json) are installed

myproject
+- .firebaserc    # Hidden file that helps you quickly switch between
|                 # projects with `firebase use`
|
+- firebase.json  # Describes properties for your project
|
+- functions/     # Directory containing all your functions code
      |
      +- main.py      # Main source file for your Cloud Functions code
      |
      +- requirements.txt  #  List of the project's modules and packages 
      |
      +- venv/ # Directory where your dependencies are installed

ज़रूरी मॉड्यूल इंपोर्ट करें और ऐप्लिकेशन शुरू करें

सेटअप के टास्क पूरे करने के बाद, सोर्स डायरेक्ट्री खोली जा सकती है. साथ ही, यहां दिए गए सेक्शन में बताए गए तरीके से कोड जोड़ा जा सकता है. इस सैंपल के लिए, आपके प्रोजेक्ट को Cloud Functions और Admin SDK मॉड्यूल इंपोर्ट करने होंगे. अपनी सोर्स फ़ाइल में, इस तरह की लाइनें जोड़ें:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

// The Firebase Admin SDK to access Firestore.
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

initializeApp();
index.js

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()
main.py

इन लाइनों से ज़रूरी मॉड्यूल लोड होते हैं. साथ ही, admin ऐप्लिकेशन इंस्टेंस शुरू होता है, जिसमें Cloud Firestore बदलाव किए जा सकते हैं. Admin SDK की सुविधा जहां भी उपलब्ध है वहां इसका इस्तेमाल किया जा सकता है. जैसे, FCM, Authentication, और Firebase Realtime Database के लिए यह सुविधा उपलब्ध है. यह Cloud Functions का इस्तेमाल करके Firebase को इंटिग्रेट करने का एक बेहतरीन तरीका है.

प्रोजेक्ट शुरू करने पर, Firebase CLI टूल, Firebase Admin SDK और Firebase SDK को Cloud Functions मॉड्यूल के लिए अपने-आप इंस्टॉल कर देता है. अपने प्रोजेक्ट में तीसरे पक्ष की लाइब्रेरी जोड़ने के बारे में ज़्यादा जानने के लिए, डिपेंडेंसी मैनेज करना लेख पढ़ें.

"मैसेज जोड़ें" फ़ंक्शन जोड़ना

"add message" फ़ंक्शन के लिए, अपनी सोर्स फ़ाइल में ये लाइनें जोड़ें:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await getFirestore()
      .collection("messages")
      .add({original: original});
  // Send back a message that we've successfully written the message
  res.json({result: `Message with ID: ${writeResult.id} added.`});
});
index.js

@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")
main.py

"मैसेज जोड़ें" फ़ंक्शन एक एचटीटीपी एंडपॉइंट है. एंडपॉइंट पर किए गए किसी भी अनुरोध के नतीजे के तौर पर, अनुरोध और जवाब के ऑब्जेक्ट को आपके प्लैटफ़ॉर्म के अनुरोध हैंडलर (onRequest() या on_request) को पास किया जाता है.

एचटीटीपी फ़ंक्शन, सिंक्रोनस होते हैं. ये कॉल किए जा सकने वाले फ़ंक्शन की तरह ही होते हैं. इसलिए, आपको जवाब जितनी जल्दी हो सके भेजना चाहिए. साथ ही, Cloud Firestore का इस्तेमाल करके काम को बाद के लिए शेड्यूल करना चाहिए. "add message" एचटीटीपी फ़ंक्शन, एचटीटीपी एंडपॉइंट को टेक्स्ट वैल्यू पास करता है और उसे /messages/:documentId/original पाथ के तहत डेटाबेस में डालता है.

"make uppercase" फ़ंक्शन जोड़ना

"make uppercase" फ़ंक्शन के लिए, अपनी सोर्स फ़ाइल में ये लाइनें जोड़ें:

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

  // Access the parameter `{documentId}` with `event.params`
  logger.log("Uppercasing", event.params.documentId, original);

  const uppercase = original.toUpperCase();

  // You must return a Promise when performing
  // asynchronous tasks inside a function
  // such as writing to Firestore.
  // Setting an 'uppercase' field in Firestore document returns a Promise.
  return event.data.ref.set({uppercase}, {merge: true});
});
index.js

@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

"make uppercase" फ़ंक्शन तब काम करता है, जब Cloud Firestore में लिखा जाता है. इससे यह तय होता है कि किस दस्तावेज़ को सुना जाना है. बेहतर परफ़ॉर्मेंस के लिए, आपको ज़्यादा से ज़्यादा सटीक जानकारी देनी चाहिए.

ब्रेसिज़—उदाहरण के लिए, {documentId}—"पैरामीटर" को घेरते हैं. ये वाइल्डकार्ड होते हैं, जो कॉलबैक में मैच किया गया डेटा दिखाते हैं. Cloud Firestore, नए मैसेज जोड़े जाने पर हर बार कॉलबैक को ट्रिगर करता है.

Node.js में, इवेंट-ड्रिवन फ़ंक्शन जैसे कि Cloud Firestore इवेंट एसिंक्रोनस होते हैं. कॉलबैक फ़ंक्शन को null, कोई ऑब्जेक्ट या Promise में से कोई एक वैल्यू दिखानी चाहिए. अगर आपने कोई वैल्यू नहीं दिखाई है, तो फ़ंक्शन का समय खत्म हो जाएगा. इससे गड़बड़ी का पता चलेगा और फिर से कोशिश की जाएगी. सिंक, एसिंक, और प्रॉमिस देखें.

अपने फ़ंक्शन के एक्ज़ीक्यूशन का सिम्युलेशन करना

Firebase Local Emulator Suite की मदद से, ऐप्लिकेशन को Firebase प्रोजेक्ट में डिप्लॉय करने के बजाय, अपनी लोकल मशीन पर बनाया और टेस्ट किया जा सकता है. हमारा सुझाव है कि डेवलपमेंट के दौरान, स्थानीय तौर पर टेस्टिंग ज़रूर करें. इसकी एक वजह यह है कि इससे कोडिंग की गड़बड़ियों का जोखिम कम हो जाता है. इन गड़बड़ियों की वजह से, प्रोडक्शन एनवायरमेंट में लागत लग सकती है. उदाहरण के लिए, इनफ़िनिट लूप.

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

1. firebase emulators:start चलाएं और Emulator Suite UI के यूआरएल के लिए आउटपुट देखें. यह डिफ़ॉल्ट रूप से localhost:4000 पर होता है. हालाँकि, इसे आपके कंप्यूटर पर किसी दूसरे पोर्ट पर होस्ट किया जा सकता है. Emulator Suite UI खोलने के लिए, उस यूआरएल को अपने ब्राउज़र में डालें.

2. एचटीटीपी फ़ंक्शन के यूआरएल के लिए, firebase emulators:start कमांड का आउटपुट देखें. यह http://localhost:5001/MY_PROJECT/us-central1/addMessage जैसा दिखेगा. हालांकि, इसमें ये अंतर होंगे:

   1. MY_PROJECT की जगह आपका प्रोजेक्ट आईडी दिखेगा.
   2. आपकी लोकल मशीन पर पोर्ट अलग हो सकता है.

3. फ़ंक्शन के यूआरएल के आखिर में क्वेरी स्ट्रिंग ?text=uppercaseme जोड़ें. यह कुछ ऐसा दिखना चाहिए: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. इसके अलावा, "uppercaseme" मैसेज को अपनी पसंद के मुताबिक मैसेज में बदला जा सकता है.

4. अपने ब्राउज़र में यूआरएल को नए टैब में खोलकर, नया मैसेज बनाएं.

5. Emulator Suite UI में फ़ंक्शन के असर देखें:

   1. लॉग टैब में, आपको नए लॉग दिखेंगे. इनसे पता चलेगा कि आपके एचटीटीपी फ़ंक्शन सही तरीके से काम कर रहे हैं:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

   2. Firestore टैब में, आपको एक ऐसा दस्तावेज़ दिखेगा जिसमें आपका ओरिजनल मैसेज और मैसेज का अपरकेस वर्शन होगा. अगर आपका ओरिजनल मैसेज "uppercaseme" था, तो आपको "UPPERCASEME" दिखेगा.

फ़ंक्शन को प्रोडक्शन एनवायरमेंट में डिप्लॉय करना

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

ट्यूटोरियल पूरा करने के लिए, अपने फ़ंक्शन डिप्लॉय करें. इसके बाद, उन्हें लागू करें.

1. अपने फ़ंक्शन डिप्लॉय करने के लिए, यह कमांड चलाएं:

    firebase deploy --only functions
    

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

   Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
   

   यूआरएल में आपका प्रोजेक्ट आईडी और HTTP फ़ंक्शन के लिए क्षेत्र की जानकारी शामिल होती है. हालांकि, आपको अभी इसके बारे में चिंता करने की ज़रूरत नहीं है, लेकिन कुछ प्रोडक्शन एचटीटीपी फ़ंक्शन के लिए location तय करना ज़रूरी है, ताकि नेटवर्क की लेटेन्सी को कम किया जा सके.

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

2. सीएलआई से मिले यूआरएल का इस्तेमाल करके, टेक्स्ट क्वेरी पैरामीटर जोड़ें और उसे ब्राउज़र में खोलें:

   https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
   

   यह फ़ंक्शन, ब्राउज़र को उस डेटाबेस की जगह पर मौजूद Firebase कंसोल पर रीडायरेक्ट करता है जहां टेक्स्ट स्ट्रिंग सेव की गई है. यह राइट इवेंट, "make uppercase" फ़ंक्शन को ट्रिगर करता है. यह फ़ंक्शन, स्ट्रिंग का अपरकेस वर्शन लिखता है.

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

प्रोडक्शन में, फ़ंक्शन की परफ़ॉर्मेंस को ऑप्टिमाइज़ किया जा सकता है. साथ ही, कम से कम और ज़्यादा से ज़्यादा इंस्टेंस सेट करके लागत को कंट्रोल किया जा सकता है. इन रनटाइम विकल्पों के बारे में ज़्यादा जानने के लिए, स्केलिंग के व्यवहार को कंट्रोल करना लेख पढ़ें.

अगले चरण

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

Cloud Functions के बारे में ज़्यादा जानने के लिए, यह भी किया जा सकता है:

• Cloud Functions के इस्तेमाल के उदाहरणों के बारे में पढ़ें.
• Cloud Functions कोडलैब आज़माएं.
• GitHub पर कोड के सैंपल देखना और उन्हें चलाना