Управляйте событиями жизненного цикла вашего расширения.

Ваше расширение может включать функции Cloud Tasks , которые срабатывают, когда экземпляр расширения проходит через любое из следующих событий жизненного цикла:

• Экземпляр расширения установлен
• Экземпляр расширения обновлен до новой версии.
• Конфигурация экземпляра расширения изменена

Один из наиболее важных вариантов использования этой функции — заполнение данных . Например, предположим, что вы разрабатываете расширение, которое генерирует миниатюры изображений, загруженных в контейнер Cloud Storage . Основная работа вашего расширения будет выполняться функцией, активируемой событием onFinalize Cloud Storage . Однако обрабатываться будут только изображения, загруженные после установки расширения. Включив в расширение функцию, активируемую событием жизненного цикла onInstall , вы также сможете генерировать миниатюры любых существующих изображений после установки расширения.

Вот некоторые другие варианты использования триггеров событий жизненного цикла:

• Автоматизировать настройку после установки (создание записей базы данных, индексацию и т. д.)
• Если вам нужно опубликовать обратно несовместимые изменения, автоматически переносите данные при обновлении

Краткосрочные обработчики событий жизненного цикла

Если ваша задача может быть полностью выполнена в течение максимальной продолжительности Cloud Functions (9 минут при использовании API первого поколения), вы можете написать обработчик событий жизненного цикла как отдельную функцию, которая срабатывает в очереди задач при событии 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 , разбейте ее на подзадачи и выполняйте каждую подзадачу последовательно, помещая задания в очередь с помощью метода 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);

Вы можете установить следующие состояния:

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 присвоено значение {} , ваше расширение подготовит очередь 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.

Не пытайтесь указать параметры очереди задач, передавая их в 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 используют обработчики событий жизненного цикла для обратного заполнения данных.