Tworzenie obecności w Cloud Firestore

W zależności od typu tworzonej aplikacji przydatne może być wykrywanie, którzy użytkownicy lub które urządzenia są aktywnie online, czyli wykrywanie „obecności”.

Jeśli na przykład tworzysz aplikację taką jak sieć społecznościowa lub wdrażasz flotę urządzeń IoT, możesz użyć tych informacji, aby wyświetlić listę znajomych, którzy są online i mogą rozmawiać, lub posortować urządzenia IoT według daty ostatniej aktywności.

Cloud Firestore nie obsługuje natywnie obecności, ale możesz wykorzystać inne usługi Firebase, aby utworzyć system obecności.

Rozwiązanie: Cloud Functions z Bazą danych czasu rzeczywistego

Aby połączyć Cloud Firestore z natywną funkcją obecności w Bazie danych czasu rzeczywistego Firebase, użyj Cloud Functions.

Użyj Bazy danych czasu rzeczywistego do raportowania stanu połączenia, a następnie użyj Cloud Functions do odzwierciedlenia tych danych w Cloud Firestore.

Korzystanie z informacji o obecności w bazie danych czasu rzeczywistego

Najpierw zastanów się, jak działa tradycyjny system obecności w bazie danych czasu rzeczywistego.

Sieć

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

Ten przykład przedstawia kompletny system obecności w bazie danych czasu rzeczywistego. Obsługuje wielokrotne rozłączenia, awarie itp.

Łączę z: Cloud Firestore

Aby wdrożyć podobne rozwiązanie w Cloud Firestore, użyj tego samego kodu Bazy danych czasu rzeczywistego, a następnie użyj Cloud Functions, aby zsynchronizować Bazę danych czasu rzeczywistego i Cloud Firestore.

Jeśli jeszcze nie korzystasz z Bazy danych czasu rzeczywistego, dodaj ją do projektu i uwzględnij powyższe rozwiązanie do sprawdzania obecności.

Następnie zsynchronizujesz stan obecności z Cloud Firestore za pomocą tych metod:

  1. Lokalnie, w pamięci podręcznej Cloud Firestore urządzenia offline, aby aplikacja wiedziała, że jest offline.
  2. Globalnie, za pomocą funkcji w Cloud Functions, dzięki czemu wszystkie inne urządzenia uzyskujące dostęp do Cloud Firestore wiedzą, że to konkretne urządzenie jest offline.

Funkcje zalecane w tym samouczku nie mogą działać w aplikacji klienckiej. Muszą zostać wdrożone w Cloud Functions for Firebase i wymagają logiki po stronie serwera z pakietu Firebase Admin SDK. Szczegółowe instrukcje znajdziesz w dokumentacji Cloud Functions.

Aktualizuję lokalną pamięć podręczną, której używa Cloud Firestore

Przyjrzyjmy się zmianom wymaganym do rozwiązania pierwszego problemu – aktualizacji lokalnej pamięci podręcznej Cloud Firestore.

Sieć

// ...
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);
    });
});

Dzięki tym zmianom stan lokalny Cloud Firestore będzie zawsze odzwierciedlać stan online/offline urządzenia. Oznacza to, że możesz nasłuchiwać dokumentu /status/{uid} i używać danych do zmiany interfejsu, aby odzwierciedlić stan połączenia.

Sieć

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

Aktualizuję Cloud Firestore globalnie

Chociaż nasza aplikacja prawidłowo zgłasza obecność w internecie, ten stan nie będzie jeszcze dokładny w innych aplikacjach Cloud Firestore, ponieważ nasz zapis stanu „offline” jest tylko lokalny i nie zostanie zsynchronizowany po przywróceniu połączenia. Aby temu zapobiec, użyjemy funkcji w Cloud Functions, która obserwuje ścieżkę status/{uid} w Bazie danych czasu rzeczywistego. Gdy wartość w bazie danych czasu rzeczywistego ulegnie zmianie, zostanie zsynchronizowana z Cloud Firestore, aby stany wszystkich użytkowników były prawidłowe.

Node.js

const functions = require('firebase-functions/v1');
const { initializeApp } = require('firebase-admin/app');
const { getFirestore } = require('firebase-admin/firestore');
initializeApp();

// Since this code will be running in the Cloud Functions environment
// we call initialize Firestore without any arguments because it
// detects authentication from the environment.
const firestore = getFirestore();

// Create a new function which is triggered on changes to /status/{uid}
// Note: This is a Realtime Database trigger, *not* Firestore.
exports.onUserStatusChanged = functions.database.ref('/status/{uid}').onUpdate(
    async (change, context) => {
      // Get the data written to Realtime Database
      const eventStatus = change.after.val();

      // Then use other event data to create a reference to the
      // corresponding Firestore document.
      const userStatusFirestoreRef = firestore.doc(`status/${context.params.uid}`);

      // It is likely that the Realtime Database change that triggered
      // this event has already been overwritten by a fast change in
      // online / offline status, so we'll re-read the current data
      // and compare the timestamps.
      const statusSnapshot = await change.after.ref.once('value');
      const status = statusSnapshot.val();
      functions.logger.log(status, eventStatus);
      // If the current timestamp for this data is newer than
      // the data that triggered this event, we exit this function.
      if (status.last_changed > eventStatus.last_changed) {
        return null;
      }

      // Otherwise, we convert the last_changed field to a Date
      eventStatus.last_changed = new Date(eventStatus.last_changed);

      // ... and write it to Firestore.
      return userStatusFirestoreRef.set(eventStatus);
    });

Po wdrożeniu tej funkcji będziesz mieć kompletny system obecności działający z Cloud Firestore. Poniżej znajdziesz przykład monitorowania użytkowników, którzy przechodzą w tryb online lub offline, za pomocą zapytania where().

Sieć

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);
                // ...
            }
        });
    });

Ograniczenia

Używanie Bazy danych czasu rzeczywistego do dodawania obecności do aplikacji Cloud Firestore jest skalowalne i skuteczne, ale ma pewne ograniczenia:

  • Debouncing – podczas nasłuchiwania zmian w czasie rzeczywistym w Cloud Firestore to rozwiązanie prawdopodobnie wywoła wiele zmian. Jeśli te zmiany wywołują więcej zdarzeń, niż chcesz, ręcznie ogranicz zdarzenia Cloud Firestore.
  • Łączność – ta implementacja mierzy połączenie z bazą danych Realtime Database, a nie z Cloud Firestore. Jeśli stan połączenia z każdą bazą danych nie jest taki sam, to rozwiązanie może zgłaszać nieprawidłowy stan obecności.
  • Android – na Androidzie Baza danych czasu rzeczywistego rozłącza się z backendem po 60 sekundach braku aktywności. Brak aktywności oznacza brak otwartych detektorów lub oczekujących operacji. Aby połączenie pozostało otwarte, zalecamy dodanie detektora zdarzeń wartości do ścieżki innej niż .info/connected. Na przykład na początku każdej sesji możesz wykonać FirebaseDatabase.getInstance().getReference((new Date()).toString()).keepSynced(). Więcej informacji znajdziesz w artykule Detecting Connection State (Wykrywanie stanu połączenia).