अनेक समारोहों का आयोजन करें


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

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

आप एकल रिपॉजिटरी मोनोरेपो सेटअप के भीतर एकाधिक रिपॉजिटरी या उप-पैकेज में फ़ंक्शन के बड़े संग्रह को प्रबंधित करने के लिए 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 प्रॉपर्टी फायरबेस सीएलआई v10.7.1 और इसके बाद के संस्करण में समर्थित है।

एकाधिक रिपॉजिटरी का प्रबंधन करना

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

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

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

$ (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"
}

कोडबेस एनोटेशन के साथ, फायरबेस सीएलआई अब आपको आपके तत्काल रिपॉजिटरी के बाहर परिभाषित कार्यों को हटाने के लिए संकेत नहीं देता है:

$ (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 प्रॉपर्टी एक ही रिपॉजिटरी में एकाधिक स्रोत पैकेजों के प्रबंधन को सरल बनाने में मदद कर सकती है। आइए एक ऐसे मामले की जांच करें जहां आपके पास कई उप-पैकेजों में फैली फ़ंक्शन परिभाषाओं के साथ एक फायरबेस प्रोजेक्ट निर्देशिका है:

$  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 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)...
...

एकाधिक फ़ाइलों में फ़ंक्शंस लिखें

क्लाउड फ़ंक्शंस के साथ शुरुआत करते समय आप अपने पहले कुछ फ़ंक्शंस को एक ही फ़ाइल में रख सकते हैं:

सूचकांक.जे.एस

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!")

कुछ से अधिक कार्यों के साथ इसे प्रबंधित करना कठिन हो सकता है। इसके बजाय, आप प्रत्येक फ़ंक्शन के लिए अपने सभी तर्क अपनी फ़ाइल में रख सकते हैं और निर्यात की सूची के रूप में अपनी स्रोत फ़ाइल का उपयोग कर सकते हैं:

नोड.जे.एस

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;

अजगर

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 : आवश्यक है, लेकिन खाली हो सकता है

समूह कार्य

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

मेट्रिक्स.जेएस


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

अगले कदम

क्लाउड फ़ंक्शंस के बारे में अधिक जानने के लिए देखें: