आपके एक्सटेंशन में Cloud Tasks फ़ंक्शन शामिल हो सकते हैं. ये फ़ंक्शन तब ट्रिगर होते हैं, जब एक्सटेंशन का कोई इंस्टेंस, लाइफ़साइकल के इनमें से किसी इवेंट से गुज़रता है:
- एक्सटेंशन का एक इंस्टेंस इंस्टॉल किया गया है
- एक्सटेंशन के किसी इंस्टेंस को नए वर्शन में अपडेट किया जाता है
- एक्सटेंशन इंस्टेंस के कॉन्फ़िगरेशन में बदलाव किया गया है
इस सुविधा का सबसे अहम इस्तेमाल, डेटा को बैकफ़िल करना है. उदाहरण के लिए, मान लें कि आपको एक ऐसा एक्सटेंशन बनाना है जो Cloud Storage बकेट में अपलोड की गई इमेज के थंबनेल की झलक जनरेट करता है. आपके एक्सटेंशन का मुख्य काम, onFinalize Cloud Storage इवेंट से ट्रिगर होने वाले फ़ंक्शन में किया जाएगा.
हालांकि, एक्सटेंशन इंस्टॉल करने के बाद अपलोड की गई इमेज ही प्रोसेस की जाएंगी. अपने एक्सटेंशन में onInstall लाइफ़साइकल इवेंट से ट्रिगर होने वाला फ़ंक्शन शामिल करके, एक्सटेंशन इंस्टॉल होने पर मौजूदा इमेज की थंबनेल झलक भी जनरेट की जा सकती हैं.
लाइफ़साइकल इवेंट ट्रिगर के इस्तेमाल के कुछ अन्य उदाहरण यहां दिए गए हैं:
- इंस्टॉल करने के बाद के सेटअप को ऑटोमेट करना (डेटाबेस रिकॉर्ड बनाना, इंडेक्स करना वगैरह)
- अगर आपको ऐसे बदलाव पब्लिश करने हैं जो पुराने सिस्टम के साथ काम नहीं करते, तो अपडेट होने पर डेटा को अपने-आप माइग्रेट होने दें
कम समय तक चलने वाले लाइफ़साइकल इवेंट हैंडलर
अगर आपका टास्क, ज़्यादा से ज़्यादा Cloud Functions अवधि (पहली जनरेशन के एपीआई का इस्तेमाल करके नौ मिनट) में पूरी तरह से चल सकता है, तो लाइफ़साइकल इवेंट हैंडलर को एक फ़ंक्शन के तौर पर लिखा जा सकता है. यह फ़ंक्शन, टास्क सूची onDispatch इवेंट पर ट्रिगर होता है:
export const myTaskFunction = functions.tasks.taskQueue()
.onDispatch(async () => {
// Complete your lifecycle event handling task.
// ...
// When processing is complete, report status to the user (see below).
});
इसके बाद, अपने एक्सटेंशन की extension.yaml फ़ाइल में, ये काम करें:
अपने फ़ंक्शन को एक्सटेंशन रिसॉर्स के तौर पर रजिस्टर करें. इसके लिए,
taskQueueTriggerप्रॉपर्टी सेट करें. अगरtaskQueueTriggerको खाली मैप ({}) पर सेट किया जाता है, तो आपका एक्सटेंशन डिफ़ॉल्ट सेटिंग का इस्तेमाल करके, Cloud Tasks सूची को प्रावधान करेगा. आपके पास इन सेटिंग को ट्यून करने का विकल्प भी है.resources: - name: myTaskFunction type: firebaseextensions.v1beta.function description: >- Describe the task performed when the function is triggered by a lifecycle event properties: location: ${LOCATION} taskQueueTrigger: {}अपने फ़ंक्शन को एक या उससे ज़्यादा लाइफ़साइकल इवेंट के लिए, हैंडलर के तौर पर रजिस्टर करें:
resources: - ... lifecycleEvents: onInstall: function: myTaskFunction processingMessage: Resizing your existing images onUpdate: function: myOtherTaskFunction processingMessage: Setting up your extension onConfigure: function: myOtherTaskFunction processingMessage: Setting up your extensionइनमें से किसी भी इवेंट के लिए फ़ंक्शन रजिस्टर किए जा सकते हैं:
onInstall,onUpdate, औरonConfigure. ये सभी इवेंट ज़रूरी नहीं हैं.सुझाव: अगर आपके एक्सटेंशन को काम करने के लिए प्रोसेसिंग टास्क की ज़रूरत नहीं है, तो उपयोगकर्ता के कॉन्फ़िगर किया गया पैरामीटर जोड़ें. इससे उपयोगकर्ता यह चुन सकते हैं कि उन्हें इसे चालू करना है या नहीं.
उदाहरण के लिए, यहां दिया गया पैरामीटर जोड़ें:
params: - param: DO_BACKFILL label: Backfill existing images description: > Should existing, unresized images in the Storage bucket be resized as well? type: select options: - label: Yes value: true - label: No value: falseअगर आपके फ़ंक्शन में पैरामीटर को
falseपर सेट किया गया है, तो जल्दी बाहर निकलें:export const myTaskFunction = functions.tasks.taskQueue() .onDispatch(async () => { if (!process.env.DO_BACKFILL) { await runtime.setProcessingState( "PROCESSING_COMPLETE", "Existing images were not resized." ); return; } // Complete your lifecycle event handling task. // ... });
लंबे समय तक चलने वाले टास्क पूरे करना
अगर आपका टास्क ज़्यादा से ज़्यादा Cloud Functions की अवधि में पूरा नहीं हो सकता, तो टास्क को सबटास्क में बांटें. इसके बाद, Admin SDK के TaskQueue.enqueue() तरीके का इस्तेमाल करके, जॉब को सूची में जोड़कर हर सबटास्क को क्रम से पूरा करें.
उदाहरण के लिए, मान लें कि आपको Cloud Firestore का डेटा बैकफ़िल करना है. क्वेरी कर्सर का इस्तेमाल करके, दस्तावेज़ के कलेक्शन को अलग-अलग हिस्सों में बांटा जा सकता है. चंक को प्रोसेस करने के बाद, शुरुआती ऑफ़सेट को आगे बढ़ाएं और दूसरे फ़ंक्शन को सूची में जोड़ें. इसके लिए, नीचे दिया गया तरीका अपनाएं:
import { getFirestore } from "firebase-admin/firestore";
import { getFunctions } from "firebase-admin/functions";
exports.backfilldata = functions.tasks.taskQueue().onDispatch(async (data) => {
// When a lifecycle event triggers this function, it doesn't pass any data,
// so an undefined offset indicates we're on our first invocation and should
// start at offset 0. On subsequent invocations, we'll pass an explicit
// offset.
const offset = data["offset"] ?? 0;
// Get a batch of documents, beginning at the offset.
const snapshot = await getFirestore()
.collection(process.env.COLLECTION_PATH)
.startAt(offset)
.limit(DOCS_PER_BACKFILL)
.get();
// Process each document in the batch.
const processed = await Promise.allSettled(
snapshot.docs.map(async (documentSnapshot) => {
// Perform the processing.
})
);
// If we processed a full batch, there are probably more documents to
// process, so enqueue another invocation of this function, specifying
// the offset to start with.
//
// If we processed less than a full batch, we're done.
if (processed.length == DOCS_PER_BACKFILL) {
const queue = getFunctions().taskQueue(
"backfilldata",
process.env.EXT_INSTANCE_ID
);
await queue.enqueue({
offset: offset + DOCS_PER_BACKFILL,
});
} else {
// Processing is complete. Report status to the user (see below).
}
});
पिछले सेक्शन में बताए गए तरीके से, फ़ंक्शन को अपने extension.yaml में जोड़ें.
रिपोर्टिंग स्टेटस
जब डेटा प्रोसेस करने वाले सभी फ़ंक्शन पूरे हो जाएं, चाहे वे सही तरीके से पूरे हुए हों या उनमें कोई गड़बड़ी हुई हो, तो Admin SDK के एक्सटेंशन रनटाइम के तरीकों का इस्तेमाल करके, टास्क की स्थिति की जानकारी दें. उपयोगकर्ता, Firebase कंसोल में एक्सटेंशन की ज़्यादा जानकारी वाले पेज पर यह स्थिति देख सकते हैं.
सफलतापूर्वक पूरा होना और नुकसान न पहुंचाने वाली गड़बड़ियां
काम पूरा होने और नुकसान न पहुंचाने वाली गड़बड़ियों (ऐसी गड़बड़ियां जिनकी वजह से एक्सटेंशन काम करना बंद नहीं करता) की रिपोर्ट करने के लिए, Admin SDK के setProcessingState() एक्सटेंशन रनटाइम तरीके का इस्तेमाल करें:
import { getExtensions } from "firebase-admin/extensions";
// ...
getExtensions().runtime().setProcessingState(processingState, message);
ये स्टेटस सेट किए जा सकते हैं:
| नुकसान न पहुंचाने वाली गड़बड़ी की स्थितियां | |
|---|---|
PROCESSING_COMPLETE |
टास्क पूरा होने की जानकारी देने के लिए, इसका इस्तेमाल करें. उदाहरण: getExtensions().runtime().setProcessingState( "PROCESSING_COMPLETE", `Backfill complete. Successfully processed ${numSuccess} documents.` ); |
PROCESSING_WARNING |
इसका इस्तेमाल, कुछ हद तक सफल होने की जानकारी देने के लिए करें. उदाहरण: getExtensions().runtime().setProcessingState( "PROCESSING_WARNING", `Backfill complete. ${numSuccess} documents processed successfully.` + ` ${numFailed} documents failed to process. ${listOfErrors}.` + ` ${instructionsToFixTheProblem}` ); |
PROCESSING_FAILED |
उन गड़बड़ियों की शिकायत करने के लिए इस्तेमाल करें जिनकी वजह से टास्क पूरा नहीं हो पाता, लेकिन एक्सटेंशन का इस्तेमाल किया जा सकता है. उदाहरण: getExtensions().runtime().setProcessingState( "PROCESSING_FAILED", `Backfill failed. ${errorMsg} ${optionalInstructionsToFixTheProblem}.` ); ऐसी गड़बड़ियों की शिकायत करने के लिए जिनकी वजह से एक्सटेंशन का इस्तेमाल नहीं किया जा सकता,
|
NONE |
टास्क का स्टेटस मिटाने के लिए, इसका इस्तेमाल करें. आपके पास कंसोल से स्टेटस मैसेज को हटाने के लिए, इसका इस्तेमाल करने का विकल्प है. उदाहरण के लिए, getExtensions().runtime().setProcessingState("NONE"); |
गंभीर गड़बड़ियां
अगर कोई ऐसी गड़बड़ी होती है जो एक्सटेंशन को काम करने से रोकती है—उदाहरण के लिए, सेटअप का कोई ज़रूरी टास्क पूरा न होना—तो setFatalError() का इस्तेमाल करके, गंभीर गड़बड़ी की शिकायत करें:
import { getExtensions } from "firebase-admin/extensions";
// ...
getExtensions().runtime().setFatalError(`Post-installation setup failed. ${errorMessage}`);
टास्क की सूची को ट्यून करना
अगर taskQueueTrigger प्रॉपर्टी को {} पर सेट किया जाता है, तो एक्सटेंशन का इंस्टेंस इंस्टॉल होने पर, आपका एक्सटेंशन डिफ़ॉल्ट सेटिंग के साथ Cloud Tasks की सूची उपलब्ध कराएगा. इसके अलावा, टास्क सूची की कॉनकरेंसी की सीमाओं और फिर से कोशिश करने के व्यवहार को ट्यून किया जा सकता है. इसके लिए, आपको कुछ खास वैल्यू देनी होंगी:
resources:
- name: myTaskFunction
type: firebaseextensions.v1beta.function
description: >-
Perform a task when triggered by a lifecycle event
properties:
location: ${LOCATION}
taskQueueTrigger:
rateLimits:
maxConcurrentDispatches: 1000
maxDispatchesPerSecond: 500
retryConfig:
maxAttempts: 100 # Warning: setting this too low can prevent the function from running
minBackoffSeconds: 0.1
maxBackoffSeconds: 3600
maxDoublings: 16
lifecycleEvents:
onInstall:
function: myTaskFunction
processingMessage: Resizing your existing images
onUpdate:
function: myTaskFunction
processingMessage: Setting up your extension
onConfigure:
function: myOtherTaskFunction
processingMessage: Setting up your extension
इन पैरामीटर के बारे में ज़्यादा जानने के लिए, Google Cloud के दस्तावेज़ में Cloud Tasks की सूची कॉन्फ़िगर करना देखें.
टास्क सूची के पैरामीटर को taskQueue() में पास करके, उन्हें तय करने की कोशिश न करें.
इन सेटिंग को अनदेखा कर दिया जाता है. इनकी जगह, extension.yaml में मौजूद कॉन्फ़िगरेशन और डिफ़ॉल्ट कॉन्फ़िगरेशन का इस्तेमाल किया जाता है.
उदाहरण के लिए, यह काम नहीं करेगा:
export const myBrokenTaskFunction = functions.tasks
// DON'T DO THIS IN AN EXTENSION! THESE SETTINGS ARE IGNORED.
.taskQueue({
retryConfig: {
maxAttempts: 5,
minBackoffSeconds: 60,
},
rateLimits: {
maxConcurrentDispatches: 1000,
maxDispatchesPerSecond: 10,
},
})
.onDispatch(
// ...
);
extension.yaml में मौजूद taskQueueTrigger प्रॉपर्टी, किसी एक्सटेंशन के टास्क की सूची को कॉन्फ़िगर करने का एकमात्र तरीका है.
उदाहरण
storage-resize-images,
firestore-bigquery-export,
और firestore-translate-text
के आधिकारिक एक्सटेंशन, डेटा को बैकफ़िल करने के लिए लाइफ़साइकल इवेंट हैंडलर का इस्तेमाल करते हैं.