Premiers pas avec Remote Config sur le Web

Vous pouvez utiliser Firebase Remote Config pour définir des paramètres dans votre application et mettre à jour leurs valeurs dans le cloud. Vous pouvez ainsi modifier l'apparence et le comportement de votre application sans distribuer de mise à jour d'application. Ce guide vous explique comment commencer et fournit un exemple de code que vous pouvez cloner ou télécharger depuis le dépôt GitHub firebase/quickstart-js.

Étape 1 : Ajouter et initialiser le SDK Remote Config

1. Si ce n'est pas déjà fait, installez le SDK Firebase JS et initialisez Firebase.

2. Ajoutez le Remote Config JS SDK et initialisez Remote Config :

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();

Cet objet permet de stocker les valeurs de paramètre par défaut dans l'application, d'extraire les valeurs de paramètre mises à jour à partir du backend Remote Configet de contrôler le moment où les valeurs extraites sont mises à la disposition de votre application.

Étape 2 : Définir un intervalle d'extraction minimal

Lors du développement, il est recommandé de définir un intervalle d'extraction minimal relativement faible. Pour en savoir plus, consultez Limitations pour plus d'informations.

// The default and recommended production fetch interval for Remote Config is 12 hours
remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

Étape 3 : Définir les valeurs de paramètre par défaut dans l'application

Vous pouvez définir des valeurs de paramètre par défaut dans l'application dans l'objet Remote Config. Ainsi, votre application se comporte comme prévu avant de se connecter au backend Remote Config, et des valeurs par défaut sont disponibles si aucune n'est définie dans le backend.

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
rc_set_default_values.js

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
index.js

Si vous avez déjà configuré les valeurs de paramètre du backend Remote Config, vous pouvez télécharger un fichier JSON généré qui inclut toutes les valeurs par défaut et l'inclure dans votre app bundle :

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

gcloud auth print-access-token

Les exemples suivants montrent deux façons différentes d'importer et de définir des valeurs par défaut dans votre application. Le premier exemple utilise fetch, qui envoie une requête HTTP au fichier par défaut inclus dans votre app bundle :

  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;
  

L'exemple suivant utilise require, qui compile les valeurs dans votre application au moment de la compilation :

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

Étape 4 : Obtenir les valeurs de paramètre à utiliser dans votre application

Vous pouvez désormais obtenir les valeurs de paramètre à partir de l'objet Remote Config. Si vous définissez ultérieurement des valeurs dans le backend, extrayez-les, puis activez-les. Ces valeurs seront alors disponibles pour votre application. Pour obtenir ces valeurs, appelez la getValue() méthode, en fournissant la clé de paramètre comme argument.

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");
rc_get_values.js

const val = remoteConfig.getValue("welcome_messsage");
index.js

Étape 5 : Définir les valeurs des paramètres

À l'aide de la Firebase console ou des Remote Config backend API, vous pouvez créer des valeurs par défaut côté serveur qui remplacent les valeurs dans l'application en fonction de la logique conditionnelle ou du ciblage utilisateur souhaités. Cette section vous explique comment créer ces valeurs dans la Firebase console étapes.

1. Dans la console Firebase, accédez à la page DevOps & Engagement > Remote Config > Parameters.

2. Définissez des paramètres portant les mêmes noms que ceux que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacera la valeur par défaut dans l'application) et des valeurs conditionnelles. Pour en savoir plus, consultez Remote Config Paramètres et Conditions.

3. Si vous utilisez des conditions de signal personnalisées, définissez les attributs et leurs valeurs. L'exemple suivant montre comment définir une condition de signal personnalisée.

     let customSignals = {
        "city": "Tokyo",
        "preferred_event_category": "sports"
     }
   
     setCustomSignals(config, customSignals);

Étape 6 : Extraire et activer les valeurs

1. Pour extraire les valeurs de paramètre du Remote Config backend, appelez la fetchConfig() méthode. Toutes les valeurs que vous définissez dans le backend sont extraites et mises en cache dans l' Remote Config objet.
2. Pour mettre les valeurs de paramètre extraites à la disposition de votre application, appelez la activate() méthode.

Si vous souhaitez extraire et activer des valeurs en un seul appel, utilisez fetchAndActivate() comme illustré dans cet exemple :

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
rc_fetch_config_callback.js

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
index.js

Étant donné que ces valeurs de paramètre mises à jour affectent le comportement et l'apparence de votre application, vous devez activer les valeurs extraites à un moment qui garantit une expérience fluide pour votre utilisateur, par exemple la prochaine fois qu'il ouvre votre application. Pour en savoir plus et obtenir des exemples, consultez Stratégies de chargement de Remote Config.

Étape 7 : Écouter les mises à jour en temps réel

Une fois que vous avez extrait les valeurs de paramètre, vous pouvez utiliser Remote Config en temps réel pour écouter les mises à jour du backend Remote Config. Real-time Remote Config signale aux appareils connectés lorsque des mises à jour sont disponibles et extrait automatiquement les modifications après la publication d'une nouvelle Remote Config version.

1. Dans votre application, utilisez onConfigUpdate pour commencer à écouter les mises à jour et extraire automatiquement toutes les nouvelles valeurs de paramètre. Implémentez le rappel next pour activer la configuration mise à jour.

     onConfigUpdate(remoteConfig, {
        next: (configUpdate) => {
           console.log("Updated keys:", configUpdate.getUpdatedKeys());
           if (configUpdate.getUpdatedKeys().has("welcome_message")) {
              activate(remoteConfig).then(() => {
              showWelcomeMessage();
              });
           }
        },
        error: (error) => {
           console.log("Config update error:", error);
        },
        complete: () => {
           console.log("Listening stopped.");
        }
     });

2. La prochaine fois que vous publierez une nouvelle version de votre Remote Config, les appareils qui exécutent votre application et écoutent les modifications appelleront le gestionnaire d'achèvement.

Limitations

Si une application extrait des données trop souvent dans un court laps de temps, les appels d'extraction peuvent être limités. Dans ce cas, le SDK génère une erreur FETCH_THROTTLE. Nous vous recommandons d'intercepter cette erreur et de réessayer en mode d'intervalle exponentiel entre les tentatives, en attendant des intervalles plus longs entre les requêtes d'extraction suivantes.

Lors du développement d'une application, vous pouvez actualiser le cache très fréquemment (plusieurs fois par heure) pour itérer rapidement lors du développement et du test de votre application. Pour permettre une itération rapide sur un projet avec de nombreux développeurs, vous pouvez ajouter temporairement une propriété avec un intervalle d'extraction minimal faible (Settings.minimumFetchIntervalMillis) dans votre application.

L'intervalle d'extraction de production par défaut et recommandé pour Remote Config est de 12 heures. Cela signifie que les configurations ne seront extraites du backend qu'une seule fois dans une fenêtre de 12 heures, quel que soit le nombre d'appels d'extraction réellement effectués. Plus précisément, l'intervalle d'extraction minimal est déterminé dans l'ordre suivant :

1. Le paramètre dans Settings.minimumFetchIntervalMillis.
2. La valeur par défaut de 12 heures.