Modèles Remote Config et gestion des versions

Console Firebase

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.

Les détails affichés pour chaque version stockée incluent des informations indiquant si les modifications proviennent de la console, de l'API REST, d'un rollback ou s'il s'agit de modifications incrémentielles à partir d'un enregistrement forcé du modèle.

CLI Firebase

firebase remoteconfig:versions:list

Utilisez l'option --limit pour limiter le nombre de versions renvoyées. Réussir "0" pour récupérer toutes les versions.

Node.js

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Java

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

REST

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:listVersions

Console Firebase

Par défaut, le volet d'informations de l'onglet Historique des modifications affiche le modèle actif actuel. Pour afficher les détails d'une autre version de la liste, sélectionnez-la dans le menu de droite.

Vous pouvez afficher les différences détaillées entre la version actuellement sélectionnée et toute autre version stockée en passant la souris sur le menu contextuel de la version non sélectionnée et en sélectionnant Comparer avec la version sélectionnée.

CLI Firebase

firebase remoteconfig:get -v VERSION_NUMBER

Vous pouvez éventuellement écrire la sortie dans un fichier spécifié avec -o, FILENAME.

Node.js

Transmettez getTemplate() sans argument pour récupérer la dernière version du modèle. Pour récupérer une version spécifique, utilisez getTemplateAtVersion().

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

REST

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

Le paramètre d'URL ?version_number n'est valide que pour les opérations GET. vous ne pouvez pas l'utiliser pour spécifier des numéros de version pour les mises à jour. Une requête get similaire sans le paramètre ?version_number récupérerait le modèle actif actuel.

Console Firebase

Pour les versions précédentes de modèle pouvant être annulées, un bouton d'option permettant de revenir à cette version s'affiche 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.

CLI Firebase

firebase remoteconfig:rollback -v VERSION_NUMBER

Node.js

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Java

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

REST

Pour effectuer un rollback vers un modèle Remote Config stocké, envoyez une requête HTTP POST avec la méthode personnalisée :rollback et, dans le corps de la requête, la version spécifique à appliquer. Exemple :

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

La réponse contient le contenu du modèle stocké désormais actif, avec ses métadonnées de nouvelle version.

Console Firebase

1. Dans l'onglet Remote Config Paramètres ou conditions, ouvrez le more_vertMenu, 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, puis sélectionnez l'emplacement où vous souhaitez enregistrer le fichier, puis cliquez sur Enregistrer.

CLI Firebase

firebase remoteconfig:get -o filename

Node.js

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

REST

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

Cette commande génère la charge utile JSON dans un seul fichier, et les en-têtes (y compris l'ETag) dans un fichier headers distinct.

Node.js

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

Java

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

REST

Ajoutez le paramètre d'URL ?validate_only=true pour valider les mises à jour du modèle à votre requête de publication:

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig?validate_only=true -d @filename

Si votre modèle a bien été validé, la commande curl renvoie la du modèle JSON que vous avez envoyé. Dans le fichier headers enregistré, vous trouverez un état HTTP/2 200 et un ETag mis à jour avec le suffixe -0. Si votre modèle n'a pas été validé, vous recevrez l'erreur de validation dans la réponse JSON et votre fichier headers contiendra une réponse autre que 200 (et aucune ETag).

Console Firebase

1. Dans l'onglet Remote Config Paramètres ou conditions, ouvrez le more_vertmenu, puis sélectionnez Publier à partir d'un fichier.
2. Lorsque vous y êtes invité, cliquez sur Parcourir, accédez à l'onglet 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.

Node.js

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

Java

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

REST

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

Pour cette commande curl, vous pouvez spécifier le contenu à l'aide du caractère "@", suivi du nom du fichier.

REST

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

Utilisez XML, PLIST ou JSON comme valeur format, en fonction du format de fichier que vous souhaitez télécharger.

Console Firebase

1. Dans l'onglet Paramètres, ouvrez le menu more_vert, puis sélectionnez Télécharger les valeurs par défaut.
2. Lorsque vous y êtes invité, cochez la case d'option correspondant au fichier. format que vous souhaitez télécharger, puis cliquez sur Télécharger le fichier.