एक से ज़्यादा फ़ंक्शन व्यवस्थित करना

2nd gen 1st gen

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

कोड बेस में फ़ंक्शन व्यवस्थित करना

firebase.json में फ़ंक्शन कॉन्फ़िगरेशन ऑब्जेक्ट की codebase प्रॉपर्टी का इस्तेमाल किया जा सकता है. इससे एक ही रिपॉज़िटरी मोनो रिपो सेटअप के अंदर, कई डेटा स्टोर करने की जगहों या सब-पैकेज में फ़ंक्शन के बड़े कलेक्शन को मैनेज किया जा सकता है:

# firebase.json
"functions": {
  "codebase": "my-codebase"
  # NOTE: Codebase must be less than 63 characters and can contain only
  # lowercase letters, numeric characters, underscores, and dashes.
}

codebase प्रॉपर्टी, Firebase सीएलआई v10.7.1 और इसके बाद के वर्शन में काम करती है.

डेटा स्टोर करने की एक से ज़्यादा जगहों को मैनेज करना

codebase प्रॉपर्टी की मदद से, एक से ज़्यादा डेटा स्टोर करने की जगहों को आसानी से मैनेज किया जा सकता है. आइए, एक ऐसे मामले की जांच करते हैं जहां आपके पास दो अलग-अलग डेटा संग्रह स्थान हैं, जो एक ही Firebase प्रोजेक्ट में फ़ंक्शन डिप्लॉय करते हैं:

$  tree .
├── repoA
│   ├── firebase.json
│   └── functions
│       ├── index.js
│       └── package.json
└── repoB
    ├── firebase.json
    └── functions
        ├── index.js
        └── package.json

कोड बेस एनोटेशन के बिना, Firebase सीएलआई ने आपको डिप्लॉय करते समय, अन्य रिपॉज़िटरी में तय किए गए फ़ंक्शन मिटाने के लिए प्रॉम्प्ट किया होगा:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
The following functions are found in your project but do not exist in your local source code:
        fn1FromRepoB
        fn2FromRepoB
        ...
? Would you like to proceed with deletion? Selecting no will continue the rest of the deployments. (y/N)

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

# repoA/firebase.json
"functions": {
  "codebase": "repo-a"
}

# repoB/firebase.json
"functions": {
  "codebase": "repo-b"
}

कोड बेस एनोटेशन के साथ अब Firebase सीएलआई आपको ऐसे फ़ंक्शन मिटाने का अनुरोध नहीं करता है जो आपके मौजूदा रिपॉज़िटरी (डेटा स्टोर करने की जगह) से बाहर के हैं:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
#  Gleefully ignores functions from repoB
i  functions: creating Node.js 16 function fnFromRepoA (us-central1)...
✔  Deploy Complete!

एक से ज़्यादा सोर्स पैकेज मैनेज करना (मोनो रिपॉज़िटरी)

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

$  tree .
├── firebase.json
├── teamA
│   ├── index.js
│   └── package.json
└── teamB
    ├── index.js
    └── package.json

यह सेटअप इन उदाहरणों के लिए सही है:

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

इस तरह के मॉनरेपो सेटअप के साथ काम करने के लिए, firebase.json में कई फ़ंक्शन कॉन्फ़िगरेशन तय करें:

"functions": [
  {
    "source": "teamA",
    "codebase": "team-a"
  },
  {
    "source": "teamB",
    "codebase": "team-b"
  },
]

इस कॉन्फ़िगरेशन के साथ, Firebase सीएलआई एक ही डिप्लॉयमेंट में सभी पैकेज के फ़ंक्शन को डिप्लॉय करता है:

$ firebase deploy --only functions
i  deploying functions
i  functions: preparing codebase team-a for deployment
i  functions: preparing codebase team-b for deployment
i  functions: creating Node.js 16 function team-a:helloATeam(us-central1)...
i  functions: creating Node.js 16 function team-b:helloBTeam(us-central1)...
...

आपके पास एक खास कोड बेस को डिप्लॉय करने का विकल्प भी है:

$ firebase deploy --only functions:team-b
i  deploying functions
i  functions: preparing codebase team-b for deployment
i  functions: updating Node.js 16 function team-b:helloBTeam(us-central1)...
...

कई फ़ाइलों में फ़ंक्शन लिखें

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

index.js

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

Main.py

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello bar!")

हालांकि, कुछ फ़ंक्शन से इसे मैनेज करना मुश्किल हो सकता है. इसके बजाय, हर फ़ंक्शन के लिए अपने सभी लॉजिक को उसकी फ़ाइल में रखा जा सकता है और सोर्स फ़ाइल का इस्तेमाल, एक्सपोर्ट की सूची के तौर पर किया जा सकता है:

Node.js के लिए

foo.js

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});

bar.js

const functions = require('firebase-functions');
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

index.js

const foo = require('./foo');
const bar = require('./bar');
exports.foo = foo.foo;
exports.bar = bar.bar;

Python

foo.py

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

bar.py

from firebase_functions import https_fn

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

main.py

from fn_impl.foo import *
from fn_impl.bar import *

यह सेटअप इस तरह की प्रोजेक्ट डायरेक्ट्री का स्ट्रक्चर मान लेता है:

my-project
├── firebase.json
└── functions
    ├── fn_impl
    │   ├── __init__.py
    │   ├── foo.py
    │   └── bar.py
    ├── main.py
    └── requirements.txt

fn_impl: कोई भी नाम हो सकता है

__init__.py: ज़रूरी है, लेकिन इसे खाली छोड़ा जा सकता है

ग्रुप फ़ंक्शन

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

metric.js

const functions = require('firebase-functions');
exports.usageStats = functions.https.onRequest((request, response) => {
  // ...
});
exports.nightlyReport = functions.https.onRequest((request, response) => {
  // ...
});

अपनी index.js फ़ाइल में इन फ़ंक्शन को एक्सपोर्ट करते समय, इन्हें किसी ग्रुप में रखा जा सकता है:

index.js

// Export both functions from metrics.js in the "metrics" group:
//  - metrics-usageStats
//  - metrics-nightlyReport
exports.metrics = require('./metrics');

डिप्लॉय किए जाने पर, फ़ंक्शन के नाम के आगे उनके ग्रुप का नाम जोड़ा जाएगा. इसलिए, इस उदाहरण में फ़ंक्शन का नाम metrics-usageStats और metrics-nightlyReport होगा.

फ़ंक्शन को डिप्लॉय करते समय, कार्रवाई को किसी एक ग्रुप तक सीमित किया जा सकता है:

firebase deploy --only functions:metrics

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

अगले चरण

Cloud Functions के बारे में ज़्यादा जानने के लिए, यहां देखें:

• डिपेंडेंसी हैंडल करना.
• फ़ंक्शन डिप्लॉयमेंट और रनटाइम के विकल्पों को मैनेज करें.