Renforcez votre présence dans Cloud Firestore

Selon le type d'application que vous créez, il peut s'avérer utile de détecter lesquels de vos utilisateurs ou appareils sont activement en ligne, autrement dit détection de « présence ».

Par exemple, si vous créez une application telle qu'un réseau social ou déployez une flotte d'appareils IoT, vous pouvez utiliser ces informations pour afficher une liste d'amis en ligne et libres de discuter, ou trier vos appareils IoT par « dernière connexion ». ".

Cloud Firestore ne prend pas en charge la présence de manière native, mais vous pouvez exploiter d'autres produits Firebase pour créer un système de présence.

Solution : Fonctions cloud avec base de données en temps réel

Pour connecter Cloud Firestore à la fonctionnalité de présence native de Firebase Realtime Database, utilisez Cloud Functions.

Utilisez Realtime Database pour signaler l'état de la connexion, puis utilisez Cloud Functions pour mettre en miroir ces données dans Cloud Firestore.

Utiliser la présence dans la base de données en temps réel

Tout d’abord, considérons comment fonctionne un système de présence traditionnel dans Realtime Database.

la toile

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

Cet exemple est un système complet de présence de base de données en temps réel. Il gère plusieurs déconnexions, plantages, etc.

Connexion à Cloud Firestore

Pour implémenter une solution similaire dans Cloud Firestore, utilisez le même code de base de données en temps réel, puis utilisez Cloud Functions pour synchroniser la base de données en temps réel et Cloud Firestore.

Si vous ne l'avez pas déjà fait, ajoutez Realtime Database à votre projet et incluez la solution de présence ci-dessus.

Vous allez ensuite synchroniser l'état de présence avec Cloud Firestore via les méthodes suivantes :

  1. Localement, dans le cache Cloud Firestore de l'appareil hors ligne afin que l'application sache qu'il est hors ligne.
  2. À l'échelle mondiale, utiliser une fonction Cloud afin que tous les autres appareils accédant à Cloud Firestore sachent que cet appareil spécifique est hors ligne.

Mettre à jour le cache local de Cloud Firestore

Jetons un coup d'œil aux modifications nécessaires pour résoudre le premier problème : mettre à jour le cache local de Cloud Firestore.

la toile

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

Avec ces changements, nous sommes désormais assurés que l'état local du Cloud Firestore reflétera toujours l'état en ligne/hors ligne de l'appareil. Cela signifie que vous pouvez écouter le document /status/{uid} et utiliser les données pour modifier votre interface utilisateur afin de refléter l'état de la connexion.

la toile

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

Mise à jour de Cloud Firestore à l'échelle mondiale

Bien que notre application se signale correctement la présence en ligne, ce statut ne sera pas encore précis dans d'autres applications Cloud Firestore, car notre écriture de statut "hors ligne" est uniquement locale et ne sera pas synchronisée lorsqu'une connexion est restaurée. Pour contrer cela, nous utiliserons une fonction Cloud qui surveille le chemin status/{uid} dans la base de données en temps réel. Lorsque la valeur de la base de données en temps réel change, la valeur sera synchronisée avec Cloud Firestore afin que les statuts de tous les utilisateurs soient corrects.

Noeud.js

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

Une fois que vous aurez déployé cette fonction, vous disposerez d'un système de présence complet fonctionnant avec Cloud Firestore. Vous trouverez ci-dessous un exemple de surveillance de tous les utilisateurs qui se connectent ou se déconnectent à l’aide d’une requête where() .

la toile

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

Limites

L'utilisation de Realtime Database pour ajouter de la présence à votre application Cloud Firestore est évolutive et efficace, mais présente certaines limites :

  • Anti-rebond : lors de l'écoute des modifications en temps réel dans Cloud Firestore, cette solution est susceptible de déclencher plusieurs modifications. Si ces modifications déclenchent plus d'événements que vous ne le souhaitez, annulez manuellement les événements Cloud Firestore.
  • Connectivité : cette implémentation mesure la connectivité à la base de données en temps réel, et non à Cloud Firestore. Si l'état de connexion à chaque base de données n'est pas le même, cette solution peut signaler un état de présence incorrect.
  • Android : sur Android, la base de données en temps réel se déconnecte du backend après 60 secondes d'inactivité. L'inactivité signifie qu'il n'y a pas d'écouteurs ouverts ni d'opérations en attente. Pour maintenir la connexion ouverte, nous vous recommandons d'ajouter un écouteur d'événement de valeur à un chemin autre que .info/connected . Par exemple, vous pouvez faire FirebaseDatabase.getInstance().getReference((new Date()).toString()).keepSynced() au début de chaque session. Pour plus d'informations, consultez Détection de l'état de connexion .