จัดการเหตุการณ์ในวงจรของส่วนขยาย

ส่วนขยายของคุณอาจมีฟังก์ชัน Cloud Tasks ที่ทริกเกอร์เมื่ออินสแตนซ์ส่วนขยายผ่านเหตุการณ์วงจรชีวิตของส่วนขยายต่อไปนี้

ติดตั้งอินสแตนซ์ของส่วนขยายแล้ว
อินสแตนซ์ของส่วนขยายได้รับการอัปเดตเป็นเวอร์ชันใหม่
มีการเปลี่ยนแปลงการกำหนดค่าอินสแตนซ์ส่วนขยาย

กรณีการใช้งานที่สําคัญที่สุดอย่างหนึ่งของฟีเจอร์นี้คือการทดแทนข้อมูล ตัวอย่างเช่น สมมติว่าคุณกำลังสร้างส่วนขยายที่สร้างตัวอย่างภาพขนาดย่อของรูปภาพที่อัปโหลดไปยังที่เก็บข้อมูล Cloud Storage งานหลักของส่วนขยายจะดำเนินการในฟังก์ชันที่ทริกเกอร์โดยเหตุการณ์ onFinalize Cloud Storage อย่างไรก็ตาม ระบบจะประมวลผลเฉพาะรูปภาพที่อัปโหลดหลังจากติดตั้งส่วนขยายเท่านั้น เมื่อรวมฟังก์ชันที่เรียกใช้โดย onInstallLifecycle Event ไว้ในส่วนขยาย คุณยังสร้างตัวอย่างภาพขนาดย่อของรูปภาพที่มีอยู่ได้เมื่อติดตั้งส่วนขยาย

กรณีการใช้งานอื่นๆ ของทริกเกอร์เหตุการณ์ในวงจร ได้แก่

ตั้งค่าหลังการติดตั้งโดยอัตโนมัติ (การสร้างระเบียนฐานข้อมูล การจัดทําดัชนี ฯลฯ)
หากคุณจำเป็นต้องเผยแพร่การเปลี่ยนแปลงที่เข้ากันไม่ได้กับเวอร์ชันก่อน ให้ย้ายข้อมูลโดยอัตโนมัติเมื่อมีการอัปเดต

เครื่องจัดการเหตุการณ์อายุการใช้งานสั้น

หากงานทํางานได้จนเสร็จสมบูรณ์ภายในระยะเวลา Cloud Functions สูงสุด (9 นาทีเมื่อใช้ API รุ่นที่ 1) คุณจะเขียนตัวแฮนเดิลเหตุการณ์วงจรชีวิตของคุณได้โดยใช้ฟังก์ชันเดียวที่ทริกเกอร์เหตุการณ์ 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: {}
```
ลงทะเบียนฟังก์ชันของคุณเป็นตัวแฮนเดิลสําหรับเหตุการณ์ในวงจรอย่างน้อย 1 รายการ ดังนี้
```
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 เหตุการณ์เหล่านี้ทั้งหมดเป็นตัวเลือกที่ไม่บังคับ

หมายเหตุ: ระบบจะตั้งค่าข้อความที่คุณระบุที่นี่เป็นสถานะการประมวลผลของส่วนขยายในคอนโซล Firebase โดยอัตโนมัติเมื่อเรียกใช้ฟังก์ชัน หากต้องการอัปเดตหรือล้างสถานะการประมวลผลเมื่อฟังก์ชันทำงานเสร็จแล้ว ให้เรียกใช้ setProcessingState() ตามที่อธิบายไว้ในส่วนสถานะการรายงาน

แนะนำ: หากส่วนขยายไม่จำเป็นต้องทำงานในการประมวลผล ให้เพิ่มพารามิเตอร์ที่กำหนดค่าโดยผู้ใช้เพื่อให้ผู้ใช้เลือกว่าจะเปิดใช้หรือไม่

เช่น เพิ่มพารามิเตอร์ดังต่อไปนี้

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 สูงสุด ให้แบ่งงานเป็นงานย่อยและดำเนินงานย่อยแต่ละงานตามลำดับโดยจัดคิวงานด้วยเมธอด TaskQueue.enqueue() ของ Admin SDK

ตัวอย่างเช่น สมมติว่าคุณต้องการทดแทนข้อมูล 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

การดำเนินการเสร็จสมบูรณ์และข้อผิดพลาดที่ไม่ร้ายแรง

หากต้องการรายงานข้อผิดพลาดที่ร้ายแรงและไม่ร้ายแรง (ข้อผิดพลาดที่ไม่ได้ทำให้ส่วนขยายอยู่ในสถานะไม่ทำงาน) ให้ใช้setProcessingState()เมธอดรันไทม์ของส่วนขยาย Admin SDK ดังนี้

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}.` ); หากต้องการรายงานข้อผิดพลาดที่ทำให้ส่วนขยายใช้งานไม่ได้ ให้โทรไปที่ `setFatalError()`
`NONE`	ใช้เพื่อล้างสถานะของงาน คุณสามารถใช้คำสั่งนี้เพื่อล้างข้อความสถานะออกจากคอนโซล (เช่น หลังจากผ่านไประยะหนึ่งนับตั้งแต่การตั้งค่า `PROCESSING_COMPLETE`) ก็ได้ ตัวอย่าง 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

โปรดดูรายละเอียดเกี่ยวกับพารามิเตอร์เหล่านี้ที่หัวข้อกำหนดค่าคิว Cloud Tasks ในเอกสารของ Google Cloud

อย่าพยายามระบุพารามิเตอร์คิวงานโดยส่งพารามิเตอร์เหล่านั้นไปยัง 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(
    // ...
  );

พร็อพเพอร์ตี้ taskQueueTrigger ใน extension.yaml เป็นวิธีเดียวในการกำหนดค่าคิวงานของส่วนขยาย

ตัวอย่าง

ส่วนขยาย storage-resize-images, firestore-bigquery-export และ firestore-translate-text อย่างเป็นทางการทั้งหมดใช้ตัวแฮนเดิลเหตุการณ์ในวงจรเพื่อทดแทนข้อมูล