Modèles Remote Config et gestion des versions


Les modèles Remote Config sont des ensembles de paramètres et de conditions au format JSON que vous avez créés pour votre projet Firebase. Vous pouvez créer des modèles de client, à partir desquels votre application extrait des valeurs, et des modèles de serveur, à partir desquels les clients de serveur peuvent extraire des valeurs.

Cette section traite des modèles de serveurs. Pour en savoir plus sur les modèles spécifiques au client, cliquez sur Modèles client.

Vous modifiez et gérez le modèle à l'aide de la console Firebase, qui affiche le contenu du modèle au format graphique dans les onglets Parameters (Paramètres) et Conditions (Conditions).

Voici un exemple de fichier de modèle de serveur:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

Vous pouvez effectuer les tâches de gestion des versions suivantes avec la console Firebase:

  • Répertorier toutes les versions de modèle stockées
  • Récupérer une version spécifique
  • Effectuer un rollback vers une version client spécifique
  • Supprimer des modèles Remote Config de la page Historique des modifications

La limite totale est de 300 versions stockées sur toute la durée de vie par type de modèle (300 modèles client et 300 modèles serveur), ce qui inclut les numéros de version stockés pour les modèles supprimés. Si vous publiez plus de 300 versions de modèle par type de modèle au cours de la durée de vie d'un projet, les versions les plus anciennes sont supprimées, ce qui permet de conserver un maximum de 300 versions de ce type.

Chaque fois que vous mettez à jour des paramètres, Remote Config crée un nouveau modèle Remote Config versionné et stocke le modèle précédent en tant que version que vous pouvez récupérer ou à laquelle vous pouvez revenir si nécessaire. Les numéros de version sont incrémentés de manière séquentielle à partir de la valeur initiale stockée par Remote Config. Tous les modèles incluent un champ version, comme illustré, contenant des métadonnées sur cette version spécifique.

Vous pouvez supprimer des modèles Remote Config si nécessaire sur la page Historique des modifications de la console Remote Config.

Gérer les versions de modèles Remote Config

Cette section explique comment gérer les versions de votre modèle Remote Config.

Lister toutes les versions stockées du modèle Remote Config

Vous pouvez récupérer la liste de toutes les versions stockées du modèle Remote Config. Pour ce faire, procédez comme suit :

  1. Dans la console Firebase, ouvrez Remote Config.

  2. Ensuite, dans l'onglet Paramètres, sélectionnez l'icône en forme de horloge en haut à droite.

    La page Historique des modifications s'ouvre et liste toutes les versions de modèle stockées dans un menu de liste sur la droite.

    La liste des modèles inclut les métadonnées de toutes les versions stockées, y compris l'heure de la mise à jour, l'utilisateur qui l'a effectuée et la méthode utilisée.

Récupérer une version spécifique du modèle Remote Config

Vous pouvez récupérer n'importe quelle version stockée spécifique du modèle Remote Config. Pour récupérer une version de modèle stockée:

  1. Ouvrez le volet d'informations de l'historique des modifications.

  2. Pour afficher les détails d'une autre version de la liste, sélectionnez-la dans le menu de droite.

  3. Pour afficher une comparaison détaillée du modèle actif et de toute autre version stockée, pointez sur le menu contextuel d'une version non sélectionnée, puis sélectionnez Comparer avec la version sélectionnée.

Effectuer un rollback vers une version stockée spécifique du modèle Remote Config

Vous pouvez revenir à n'importe quelle version stockée du modèle. Pour annuler un modèle:

  1. Recherchez le bouton d'option en haut à droite de la page Historique des modifications. Ne cliquez et ne confirmez cette opération que si vous êtes sûr de vouloir revenir à cette version et d'utiliser ces valeurs immédiatement pour toutes les applications et tous les utilisateurs.

Notez que cette opération de rollback crée effectivement une nouvelle version numérotée. Par exemple, le rétablissement de la version 10 à la version 6 crée effectivement une nouvelle copie de la version 6, qui ne diffère de l'original que par son numéro de version 11. La version d'origine 6 est toujours stockée, à condition qu'elle n'ait pas expiré, et la version 11 devient le modèle actif.

Supprimer un modèle Remote Config

Vous pouvez supprimer des modèles Remote Config à partir de la console Firebase. Pour supprimer un modèle Remote Config:

1. Sur la page Remote Config Paramètres, cliquez sur Historique des modifications.
  1. Activez le modèle que vous souhaitez supprimer, cliquez sur Autres, puis sélectionnez Supprimer.

  2. Lorsque vous êtes invité à confirmer la suppression, cliquez sur Supprimer.

Télécharger et publier des modèles Remote Config

Téléchargez et publiez des modèles Remote Config pour les intégrer à votre système de contrôle des sources et de compilation, automatiser les mises à jour de configuration et synchroniser les paramètres et les valeurs entre plusieurs projets.

Vous pouvez télécharger le modèle Remote Config actifdepuis la console Firebase. Vous pouvez ensuite mettre à jour le fichier JSON exporté et le publier dans le même projet, ou dans un projet nouveau ou existant.

Imaginons que vous disposiez de plusieurs projets représentant différentes étapes du cycle de développement de votre logiciel, comme les environnements de développement, de test, de préproduction et de production. Dans ce cas, vous pouvez promouvoir un modèle entièrement testé de votre environnement de préproduction vers votre environnement de production en le téléchargeant à partir de votre projet de préproduction et en le publiant dans votre projet de production.

Vous pouvez également utiliser cette méthode pour migrer des configurations d'un projet à un autre, ou pour renseigner un nouveau projet avec les paramètres et les valeurs d'un projet existant.

Les paramètres et leurs valeurs créés spécifiquement en tant que variantes dans un test A/B Testing ne sont pas inclus dans les modèles exportés.

Pour exporter et importer des modèles Remote Config:

  1. Téléchargez le modèle de configuration Remote Config actuel.
  2. Validez le modèle Remote Config.
  3. Publiez le modèle Remote Config.

Télécharger le modèle Remote Config actuel

Utilisez la commande suivante pour télécharger le modèle Remote Config actif au format JSON:

  1. Dans l'onglet Remote Config Paramètres ou conditions, ouvrez le menu, puis sélectionnez Télécharger le fichier de configuration actuel.
  2. Lorsque vous y êtes invité, cliquez sur Télécharger le fichier de configuration, choisissez l'emplacement où vous souhaitez enregistrer le fichier, puis cliquez sur Enregistrer.

Valider le modèle Remote Config

Les modèles de serveur sont validés lorsque vous essayez de publier à partir de la console Firebase. Notez que les conditions "Utilisateur d'un pourcentage aléatoire" peuvent être importées, mais toute condition non prise en charge générera une erreur lors de l'importation. Si vous essayez de publier un modèle qui a été exporté à l'origine à partir d'un modèle client, veillez d'abord à supprimer toutes les conditions spécifiques au client.

Publier le modèle Remote Config

Après avoir téléchargé un modèle, apporté les modifications nécessaires au contenu JSON et validé celui-ci, vous pouvez le publier dans un projet.

La publication d'un modèle remplace l'intégralité du modèle de configuration existant par le fichier mis à jour et incrémente la version du modèle de un. Étant donné que l'ensemble de la configuration est remplacé, si vous supprimez un paramètre du fichier JSON et le publiez, il est supprimé du serveur et n'est plus disponible pour les clients.

Une fois publiées, les modifications apportées aux paramètres et aux valeurs sont immédiatement disponibles pour vos applications et vos utilisateurs. Si nécessaire, vous pouvez effectuer un rollback vers une version précédente.

Pour publier votre modèle, exécutez les commandes suivantes:

  1. Dans l'onglet Remote Config Paramètres ou conditions, ouvrez le menu, puis sélectionnez Publier à partir d'un fichier.
  2. Lorsque vous y êtes invité, cliquez sur Parcourir, accédez au fichier Remote Config que vous souhaitez publier, puis cliquez sur Sélectionner.
  3. Le fichier sera validé. Si la validation aboutit, vous pouvez cliquer sur Publish (Publier) pour rendre la configuration immédiatement disponible pour vos applications et vos utilisateurs.

Étapes suivantes