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

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

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

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

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

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

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

Если ваша задача может полностью выполняться в течение максимальной продолжительности облачных функций (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 пустую карту ( {} ), ваше расширение создаст очередь облачных задач, используя настройки по умолчанию; Вы можете дополнительно настроить эти параметры .

    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);

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

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

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.

Примеры

Официальные storage-resize-images , firestore-bigquery-export и firestore-translate-text используют обработчики событий жизненного цикла для заполнения данных.