Триггеры Cloud Firestore


С помощью 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 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

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

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

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

  • Cloud Functions (1-го поколения) требует существующую базу данных "(по умолчанию)" в собственном режиме Firestore. Он не поддерживает именованные базы данных Cloud Firestore или режим Datastore. Используйте Cloud Functions (2-го поколения) для настройки событий в таких случаях.
  • Порядок не гарантируется. Быстрые изменения могут привести к вызовам функций в неожиданном порядке.
  • События доставляются по крайней мере один раз, но одно событие может привести к нескольким вызовам функций. Избегайте зависимости от механики exact-once и пишите идемпотентные функции .
  • Cloud Firestore в режиме Datastore требует Cloud Functions (2-го поколения). Cloud Functions (1-го поколения) не поддерживает режим Datastore.
  • Триггер связан с одной базой данных. Вы не можете создать триггер, который соответствует нескольким базам данных.
  • Удаление базы данных не приводит к автоматическому удалению триггеров для этой базы данных. Триггер прекращает доставку событий, но продолжает существовать до тех пор, пока вы его не удалите .
  • Если сопоставленное событие превышает максимальный размер запроса , событие может не быть доставлено в Cloud Functions (1-го поколения).
    • События, не доставленные из-за размера запроса, регистрируются в журналах платформы и учитываются при подсчете использования журнала для проекта.
    • Эти журналы можно найти в Logs Explorer с сообщением "Event cannot delivery to Cloud function due to size exceeding the limit for 1st gen..." о серьезности error . Имя функции можно найти в поле functionName . Если поле receiveTimestamp все еще находится в пределах часа с текущего момента, можно вывести фактическое содержимое события, прочитав рассматриваемый документ со снимком до и после временной метки.
    • Чтобы избежать такой каденции, вы можете:
      • Миграция и обновление до Cloud Functions (2-го поколения)
      • Уменьшить размер документа
      • Удалить соответствующие Cloud Functions
    • Вы можете отключить ведение журнала с помощью исключений , но учтите, что нежелательные события все равно не будут доставлены.