Триггеры Cloud Firestore

2-го поколения 1-го поколения

С помощью Cloud Functions вы можете обрабатывать события в Cloud Firestore без необходимости обновления клиентского кода. Изменения в Cloud Firestore можно вносить через интерфейс снимков документа или через Admin SDK .

В типичном жизненном цикле функция Cloud Firestore выполняет следующие действия:

1. Ожидает изменений в определенном документе.
2. Срабатывает при возникновении события и выполняет свои задачи.
3. Получает объект данных, содержащий моментальный снимок данных, хранящихся в указанном документе. Для событий записи или обновления объект данных содержит два моментальных снимка, представляющих состояние данных до и после события-триггера.

Расстояние между экземпляром Firestore и местоположением функции может привести к значительной задержке в сети. Для оптимизации производительности рекомендуется указывать местоположение функции везде, где это применимо.

Триггеры функции Cloud Firestore

Пакет SDK Cloud Functions for Firebase экспортирует объект functions.firestore , который позволяет создавать обработчики, привязанные к определенным событиям Cloud Firestore.

Тип события	Курок
onCreate	Срабатывает при первой записи в документ.
onUpdate	Срабатывает, когда документ уже существует и в нем изменилось какое-либо значение.
onDelete	Срабатывает при удалении документа с данными.
onWrite	Срабатывает при срабатывании onCreate , onUpdate или onDelete .

Примечание: События Cloud Firestore срабатывают только при изменении документа. Обновление документа Cloud Firestore, данные в котором не изменялись (запись без операции), не генерирует событие обновления или записи. Невозможно добавлять события к определённым полям.

Если у вас еще нет проекта с поддержкой Cloud Functions for Firebase , прочтите статью Начало работы: написание и развертывание первых функций , чтобы настроить и оборудовать свой проект Cloud Functions for Firebase .

Написание функций, запускаемых Cloud Firestore

Определить триггер функции

Чтобы определить триггер Cloud Firestore, укажите путь к документу и тип события:

Node.js

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

Пути к документам могут ссылаться либо на конкретный документ , либо на подстановочный шаблон .

Важно: пути к документам не должны содержать косых черт.

Укажите один документ

Если вы хотите инициировать событие для любого изменения в определенном документе, то вы можете использовать следующую функцию.

Node.js

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

Укажите группу документов с помощью подстановочных знаков

Если вы хотите прикрепить триггер к группе документов, например, к любому документу в определенной коллекции, то вместо идентификатора документа используйте {wildcard} :

Node.js

// Listen for changes in all documents in the 'users' collection
exports.useWildcard = functions.firestore
    .document('users/{userId}')
    .onWrite((change, context) => {
      // If we set `/users/marie` to {name: "Marie"} then
      // context.params.userId == "marie"
      // ... and ...
      // change.after.data() == {name: "Marie"}
    });
index.js

В этом примере при изменении любого поля в документе users оно сопоставляется с подстановочным знаком userId .

Если документ в users имеет подколлекции и поле в одном из документов этих подколлекций изменяется, подстановочный знак userId не активируется.

Подстановочные знаки извлекаются из пути к документу и сохраняются в context.params . Вы можете определить любое количество подстановочных знаков для замены явных идентификаторов коллекций или документов, например:

Node.js

// Listen for changes in all documents in the 'users' collection and all subcollections
exports.useMultipleWildcards = functions.firestore
    .document('users/{userId}/{messageCollectionId}/{messageId}')
    .onWrite((change, context) => {
      // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
      // context.params.userId == "marie";
      // context.params.messageCollectionId == "incoming_messages";
      // context.params.messageId == "134";
      // ... and ...
      // change.after.data() == {body: "Hello"}
    });
index.js

Примечание: Ваш триггер всегда должен указывать на документ, даже если вы используете подстановочный знак. Например, users/{userId}/{messageCollectionId} недопустим, поскольку {messageCollectionId} — это коллекция. Однако users/{userId}/{messageCollectionId}/{messageId} допустим, поскольку {messageId} всегда будет указывать на документ.

Триггеры событий

Запустить функцию при создании нового документа

Вы можете активировать функцию при каждом создании нового документа в коллекции, используя обработчик onCreate() с подстановочным знаком . В этом примере функция вызывает createUser каждый раз при добавлении нового профиля пользователя:

Node.js

exports.createUser = functions.firestore
    .document('users/{userId}')
    .onCreate((snap, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = snap.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

Запустить функцию при обновлении документа

Вы также можете активировать функцию, которая будет срабатывать при обновлении документа, используя функцию onUpdate() с подстановочным знаком . В этом примере функция вызывает updateUser если пользователь изменяет свой профиль:

Node.js

exports.updateUser = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

Запустить функцию при удалении документа

Вы также можете вызвать функцию при удалении документа, используя функцию onDelete() с подстановочным знаком . В этом примере функция вызывает deleteUser , когда пользователь удаляет свой профиль:

Node.js

exports.deleteUser = functions.firestore
    .document('users/{userID}')
    .onDelete((snap, context) => {
      // Get an object representing the document prior to deletion
      // e.g. {'name': 'Marie', 'age': 66}
      const deletedValue = snap.data();

      // perform desired operations ...
    });
index.js

Запустить функцию для всех изменений в документе

Если тип события не важен, вы можете отслеживать все изменения в документе Cloud Firestore, используя функцию onWrite() с подстановочным знаком . В этом примере функция вызывает modifyUser при создании, обновлении или удалении пользователя:

Node.js

exports.modifyUser = functions.firestore
    .document('users/{userID}')
    .onWrite((change, context) => {
      // Get an object with the current document value.
      // If the document does not exist, it has been deleted.
      const document = change.after.exists ? change.after.data() : null;

      // Get an object with the previous document value (for update or delete)
      const oldDocument = change.before.data();

      // perform desired operations ...
    });
index.js

Чтение и запись данных

При срабатывании функции создается снимок данных, связанных с событием. Вы можете использовать этот снимок для чтения или записи данных в документ, вызвавший событие, или использовать Firebase Admin SDK для доступа к другим частям базы данных.

Данные о событиях

Чтение данных

При срабатывании функции может потребоваться получить данные из документа, который был обновлён, или данные до обновления. Получить предыдущие данные можно с помощью метода change.before.data() , который содержит снимок документа до обновления. Аналогично, change.after.data() содержит снимок состояния документа после обновления.

Node.js

exports.updateUser2 = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the current document
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();
    });
index.js

Вы можете получить доступ к свойствам так же, как к любому другому объекту. Кроме того, для доступа к определённым полям можно использовать функцию get :

Node.js

// Fetch data using standard accessors
const age = snap.data().age;
const name = snap.data()['name'];

// Fetch data using built in accessor
const experience = snap.get('experience');
index.js

Запись данных

Каждый вызов функции связан с определённым документом в базе данных Cloud Firestore. Вы можете получить доступ к этому документу как к DocumentReference в свойстве ref снимка, возвращаемого вашей функцией.

Этот DocumentReference взят из Cloud Firestore Node.js SDK и включает такие методы, как update() , set() и remove() чтобы вы могли легко изменить документ, который вызвал функцию.

Node.js

// Listen for updates to any `user` document.
exports.countNameChanges = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Retrieve the current and previous value
      const data = change.after.data();
      const previousData = change.before.data();

      // We'll only update if the name has changed.
      // This is crucial to prevent infinite loops.
      if (data.name == previousData.name) {
        return null;
      }

      // Retrieve the current count of name changes
      let count = data.name_change_count;
      if (!count) {
        count = 0;
      }

      // Then return a promise of a set operation to update the count
      return change.after.ref.set({
        name_change_count: count + 1
      }, {merge: true});
    });
index.js

Примечание: При записи данных в тот же документ, который вызвал функцию, существует риск создания бесконечного цикла. Будьте осторожны и убедитесь, что вы безопасно выходите из функции, когда изменения не требуются.

Данные за пределами события-триггера

Cloud Functions выполняются в доверенной среде, то есть они авторизованы как учётная запись службы в вашем проекте. Вы можете выполнять чтение и запись с помощью Firebase Admin SDK :

Node.js

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();

exports.writeToFirestore = functions.firestore
  .document('some/doc')
  .onWrite((change, context) => {
    db.doc('some/otherdoc').set({ ... });
  });

Примечание: Операции чтения и записи, выполняемые в Cloud Functions не контролируются вашими правилами безопасности, они могут получать доступ к любой части вашей базы данных.

Ограничения

Обратите внимание на следующие ограничения для триггеров Cloud Firestore для Cloud Functions:

• Для работы Cloud Functions (1-го поколения) требуется существующая база данных (default) в собственном режиме Firestore. Она не поддерживает именованные базы данных Cloud Firestore или режим Datastore. В таких случаях для настройки событий используйте Cloud Functions (2-го поколения).
• Порядок не гарантируется. Быстрые изменения могут привести к вызову функций в неожиданном порядке.
• События доставляются как минимум один раз, но одно событие может привести к нескольким вызовам функций. Избегайте зависимости от механики «точно один раз» и пишите идемпотентные функции .
• Для работы Cloud Firestore в режиме хранилища данных требуется Cloud Functions (2-го поколения). Cloud Functions (1-го поколения) не поддерживает режим хранилища данных.
• Триггер связан с одной базой данных. Вы не можете создать триггер, соответствующий нескольким базам данных.
• Удаление базы данных не приводит к автоматическому удалению всех триггеров для этой базы данных. Триггер перестаёт отправлять события, но продолжает существовать до тех пор, пока вы его не удалите .
• Если размер сопоставленного события превышает максимальный размер запроса , событие может быть не доставлено в Cloud Functions (1-го поколения).
  • События, не доставленные из-за размера запроса, регистрируются в журналах платформы и учитываются при расчете использования журнала для проекта.
  • Эти журналы можно найти в обозревателе журналов с сообщением «Событие не может быть доставлено в облачную функцию из-за превышения лимита размера для 1-го поколения...» с указанием уровня серьёзности error . Имя функции можно найти в поле functionName . Если значение поля receiveTimestamp всё ещё не истекло в течение часа, вы можете определить фактическое содержимое события, прочитав соответствующий документ со снимком до и после временной метки.
  • Чтобы избежать такой каденции, вы можете:
    • Миграция и обновление до Cloud Functions (2-го поколения)
    • Уменьшить размер документа
    • Удалить соответствующие Cloud Functions
  • Вы можете отключить ведение журнала с помощью исключений , но учтите, что нежелательные события все равно не будут доставлены.