अपने एक्सटेंशन के लाइफ़साइकल इवेंट मैनेज करना

आपके एक्सटेंशन में Cloud Tasks फ़ंक्शन शामिल हो सकता है यह तब ट्रिगर होता है, जब कोई एक्सटेंशन इंस्टेंस इनमें से किसी से भी गुज़रता है लाइफ़साइकल इवेंट:

• एक्सटेंशन का एक इंस्टेंस इंस्टॉल किया गया
• एक्सटेंशन का एक इंस्टेंस, नए वर्शन में अपडेट किया गया है
• एक्सटेंशन इंस्टेंस का कॉन्फ़िगरेशन बदल गया है

इस सुविधा का सबसे ज़रूरी इस्तेमाल, डेटा बैकफ़िल करना है. इसके लिए उदाहरण के लिए, मान लें कि एक ऐसा एक्सटेंशन बनाया जा रहा है जो थंबनेल की झलक इमेज को Cloud Storage बकेट में अपलोड किया गया. आपके एक्सटेंशन का मुख्य काम onFinalize Cloud Storage इवेंट से ट्रिगर होने वाले फ़ंक्शन में किया जाएगा. हालांकि, एक्सटेंशन इंस्टॉल होने के बाद अपलोड की गई इमेज ही प्रोसेस किया गया. अपने एक्सटेंशन में इससे ट्रिगर होने वाला फ़ंक्शन शामिल करने पर onInstall लाइफ़साइकल इवेंट के दौरान, किसी इवेंट के थंबनेल की झलक भी जनरेट की जा सकती है एक्सटेंशन इंस्टॉल होने पर, मौजूदा इमेज.

लाइफ़साइकल इवेंट ट्रिगर के इस्तेमाल के कुछ अन्य उदाहरण भी शामिल हैं:

• पोस्ट-इंस्टॉल सेटअप को ऑटोमेट करना (डेटाबेस रिकॉर्ड बनाना, इंडेक्स करना वगैरह)
• अगर आपको पुराने सिस्टम के साथ काम न करने वाले बदलावों को पब्लिश करना है, तो अपने-आप माइग्रेट हो जाएं अपडेट का डेटा

कम समय तक चलने वाले लाइफ़साइकल इवेंट हैंडलर

अगर आपका काम पूरी तरह से ज़्यादा से ज़्यादा Cloud Functions अवधि (9 मिनट) के लिए, फ़र्स्ट-जनरेशन एपीआई का इस्तेमाल किया जा रहा है, तो अपने लाइफ़साइकल इवेंट को लिखा जा सकता है हैंडलर का इस्तेमाल एक फ़ंक्शन के तौर पर करें, जो टास्क सूची 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 फ़ाइल में, ये काम करें:

1. अपने फ़ंक्शन को 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: {}
   

2. एक या उससे ज़्यादा लाइफ़साइकल इवेंट के लिए, अपने फ़ंक्शन को हैंडलर के तौर पर रजिस्टर करें:

   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. ये सभी इवेंट ज़रूरी नहीं हैं.

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

   उदाहरण के लिए, इस तरह का पैरामीटर जोड़ें:

   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 अवधि में पूरा नहीं हो सकता, तो टास्क को सबटास्क में बांटा जा सकता है. साथ ही, हर सबटास्क को क्रम से लगाया जा सकता है एडमिन 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 में फ़ंक्शन जोड़ें, जैसा कि पिछला सेक्शन.

रिपोर्टिंग की स्थिति

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

सफल पूर्ण और साधारण त्रुटियां

सफलतापूर्वक पूर्ण होने और साधारण गड़बड़ियों की रिपोर्ट करने के लिए (ऐसी गड़बड़ियां जो दिखाई नहीं देती हैं एक्सटेंशन को काम न करने वाली स्थिति में रखता है), तो Admin SDK के setProcessingState() एक्सटेंशन रनटाइम का तरीका:

import { getExtensions } from "firebase-admin/extensions";

// ...

getExtensions().runtime().setProcessingState(processingState, message);

इन स्थितियों को सेट किया जा सकता है:

getExtensions().runtime().setProcessingState(
  "PROCESSING_COMPLETE",
  `Backfill complete. Successfully processed ${numSuccess} documents.`
);

getExtensions().runtime().setProcessingState(
  "PROCESSING_WARNING",
  `Backfill complete. ${numSuccess} documents processed successfully.`
    + ` ${numFailed} documents failed to process. ${listOfErrors}.`
    + ` ${instructionsToFixTheProblem}`
);

getExtensions().runtime().setProcessingState(
  "PROCESSING_FAILED",
  `Backfill failed. ${errorMsg} ${optionalInstructionsToFixTheProblem}.`
);

getExtensions().runtime().setProcessingState("NONE");

गंभीर गड़बड़ियां

अगर कोई ऐसी गड़बड़ी होती है जो एक्सटेंशन को काम करने से रोकती है—इसके लिए उदाहरण के लिए, कोई आवश्यक सेटअप कार्य विफल हो रहा हो— setFatalError():

import { getExtensions } from "firebase-admin/extensions";

// ...

getExtensions().runtime().setFatalError(`Post-installation setup failed. ${errorMessage}`);

टास्क सूची को ट्यून किया जा रहा है

अगर taskQueueTrigger प्रॉपर्टी को {} पर सेट किया जाता है, तो आपका एक्सटेंशन ये काम करेगा एक्सटेंशन इस्तेमाल करते समय, डिफ़ॉल्ट सेटिंग के साथ क्लाउड टास्क की सूची का प्रावधान करें इंस्टेंस इंस्टॉल हो. इसके अलावा, टास्क सूची के कई हिस्सों को एक साथ ले जाने की सुविधा का इस्तेमाल भी किया जा सकता है सीमाओं और फिर से कोशिश करने के लिए कोई वैल्यू दें:

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

क्लाउड टास्क की सूचियां कॉन्फ़िगर करना देखें देखें.

टास्क सूची के पैरामीटर को 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 एक्सटेंशन, डेटा को बैकफ़िल करने के लिए, लाइफ़साइकल इवेंट हैंडलर का इस्तेमाल करते हैं.