Расширьте присутствие в Cloud Firestore

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

В зависимости от типа создаваемого вами приложения вам может быть полезно определить, какие из ваших пользователей или устройств активно находятся в сети — это также известно как определение «присутствия».

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

Cloud Firestore изначально не поддерживает присутствие, но вы можете использовать другие продукты Firebase для создания системы присутствия.

Решение: Облачные функции с базой данных в реальном времени

Чтобы подключить Cloud Firestore к собственной функции присутствия Firebase Realtime Database, используйте Cloud Functions.

Используйте базу данных Realtime Database для отчета о состоянии соединения, а затем используйте облачные функции для зеркалирования этих данных в Cloud Firestore .

Использование присутствия в базе данных реального времени

Сначала рассмотрим, как традиционная система присутствия работает в базе данных реального времени.

// Fetch the current user's ID from Firebase Authentication.
var uid = firebase.auth().currentUser.uid;

// Create a reference to this user's specific status node.
// This is where we will store data about being online/offline.
var userStatusDatabaseRef = firebase.database().ref('/status/' + uid);

// We'll create two constants which we will write to 
// the Realtime database when this device is offline
// or online.
var isOfflineForDatabase = {
    state: 'offline',
    last_changed: firebase.database.ServerValue.TIMESTAMP,
};

var isOnlineForDatabase = {
    state: 'online',
    last_changed: firebase.database.ServerValue.TIMESTAMP,
};

// Create a reference to the special '.info/connected' path in 
// Realtime Database. This path returns `true` when connected
// and `false` when disconnected.
firebase.database().ref('.info/connected').on('value', function(snapshot) {
    // If we're not currently connected, don't do anything.
    if (snapshot.val() == false) {
        return;
    };

    // If we are currently connected, then use the 'onDisconnect()' 
    // method to add a set which will only trigger once this 
    // client has disconnected by closing the app, 
    // losing internet, or any other means.
    userStatusDatabaseRef.onDisconnect().set(isOfflineForDatabase).then(function() {
        // The promise returned from .onDisconnect().set() will
        // resolve as soon as the server acknowledges the onDisconnect() 
        // request, NOT once we've actually disconnected:
        // https://firebase.google.com/docs/reference/js/firebase.database.OnDisconnect

        // We can now safely set ourselves as 'online' knowing that the
        // server will mark us as offline once we lose connection.
        userStatusDatabaseRef.set(isOnlineForDatabase);
    });
});
index.js

Этот пример — полная система присутствия Realtime Database. Она обрабатывает множественные отключения, сбои и т. д.

Подключение к Cloud Firestore

Чтобы реализовать аналогичное решение в Cloud Firestore используйте тот же код Realtime Database, а затем используйте Cloud Functions для синхронизации Realtime Database и Cloud Firestore .

Если вы еще этого не сделали, добавьте Realtime Database в свой проект и включите указанное выше решение по присутствию.

Далее вы синхронизируете состояние присутствия с Cloud Firestore с помощью следующих методов:

1. Локально, в кэш Cloud Firestore автономного устройства, чтобы приложение знало, что оно находится в автономном режиме.
2. Глобально, используя функцию облака, чтобы все другие устройства, получающие доступ к Cloud Firestore знали, что данное конкретное устройство находится в автономном режиме.

Обновление локального кэша Cloud Firestore

Давайте рассмотрим изменения, необходимые для решения первой задачи — обновления локального кэша Cloud Firestore .

// ...
var userStatusFirestoreRef = firebase.firestore().doc('/status/' + uid);

// Firestore uses a different server timestamp value, so we'll 
// create two more constants for Firestore state.
var isOfflineForFirestore = {
    state: 'offline',
    last_changed: firebase.firestore.FieldValue.serverTimestamp(),
};

var isOnlineForFirestore = {
    state: 'online',
    last_changed: firebase.firestore.FieldValue.serverTimestamp(),
};

firebase.database().ref('.info/connected').on('value', function(snapshot) {
    if (snapshot.val() == false) {
        // Instead of simply returning, we'll also set Firestore's state
        // to 'offline'. This ensures that our Firestore cache is aware
        // of the switch to 'offline.'
        userStatusFirestoreRef.set(isOfflineForFirestore);
        return;
    };

    userStatusDatabaseRef.onDisconnect().set(isOfflineForDatabase).then(function() {
        userStatusDatabaseRef.set(isOnlineForDatabase);

        // We'll also add Firestore set here for when we come online.
        userStatusFirestoreRef.set(isOnlineForFirestore);
    });
});
index.js

Благодаря этим изменениям мы теперь гарантируем, что локальное состояние Cloud Firestore всегда будет отражать статус устройства онлайн/офлайн. Это означает, что вы можете прослушивать документ /status/{uid} и использовать данные для изменения вашего пользовательского интерфейса для отображения статуса подключения.

userStatusFirestoreRef.onSnapshot(function(doc) {
    var isOnline = doc.data().state == 'online';
    // ... use isOnline
});
index.js

Обновление Cloud Firestore по всему миру

Хотя наше приложение правильно сообщает о присутствии в сети самому себе, этот статус пока не будет точным в других приложениях Cloud Firestore , поскольку наша запись статуса «офлайн» является локальной и не будет синхронизирована при восстановлении соединения. Чтобы противостоять этому, мы будем использовать облачную функцию, которая отслеживает путь status/{uid} в Realtime Database. Когда значение Realtime Database изменится, оно будет синхронизировано с Cloud Firestore чтобы статусы всех пользователей были правильными.

firebase.firestore().collection('status')
    .where('state', '==', 'online')
    .onSnapshot(function(snapshot) {
        snapshot.docChanges().forEach(function(change) {
            if (change.type === 'added') {
                var msg = 'User ' + change.doc.id + ' is online.';
                console.log(msg);
                // ...
            }
            if (change.type === 'removed') {
                var msg = 'User ' + change.doc.id + ' is offline.';
                console.log(msg);
                // ...
            }
        });
    });
index.js

После развертывания этой функции у вас будет полная система присутствия, работающая с Cloud Firestore . Ниже приведен пример мониторинга всех пользователей, которые подключаются или отключаются с помощью запроса where() .

firebase.firestore().collection('status')
    .where('state', '==', 'online')
    .onSnapshot(function(snapshot) {
        snapshot.docChanges().forEach(function(change) {
            if (change.type === 'added') {
                var msg = 'User ' + change.doc.id + ' is online.';
                console.log(msg);
                // ...
            }
            if (change.type === 'removed') {
                var msg = 'User ' + change.doc.id + ' is offline.';
                console.log(msg);
                // ...
            }
        });
    });
index.js

Ограничения

Использование Realtime Database для добавления присутствия в приложение Cloud Firestore масштабируемо и эффективно, но имеет некоторые ограничения:

• Устранение дребезга — при прослушивании изменений в реальном времени в Cloud Firestore это решение, скорее всего, вызовет несколько изменений. Если эти изменения вызовут больше событий, чем вам нужно, вручную устраните дребезг событий Cloud Firestore .
• Connectivity - эта реализация измеряет подключение к Realtime Database, а не к Cloud Firestore . Если состояние подключения к каждой базе данных не одинаково, это решение может сообщать о неправильном состоянии присутствия.
• Android — на Android база данных Realtime отключается от бэкэнда после 60 секунд бездействия. Бездействие означает отсутствие открытых прослушивателей или ожидающих операций. Чтобы соединение оставалось открытым, мы рекомендуем добавить прослушиватель событий значения к пути помимо .info/connected . Например, вы можете выполнить FirebaseDatabase.getInstance().getReference((new Date()).toString()).keepSynced() в начале каждого сеанса. Для получения дополнительной информации см. Определение состояния соединения .