Control de versiones y plantillas de Remote Config

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

Firebase console

En la pestaña Parámetros, selecciona el ícono de reloj que se muestra en la esquina superior derecha. Esta acción abrirá la página Historial de cambios, en la que encontrarás una lista de todas las versiones almacenadas de la plantilla en un menú de lista ubicado en el lado derecho.

Los detalles que se muestran de cada versión almacenada incluyen información que determina si los cambios se originaron en Console, con la API de REST, por una reversión o si fueron cambios incrementales de la plantilla que se guardaron de manera forzosa.

Firebase CLI

firebase remoteconfig:versions:list

Usa la opción --limit para limitar la cantidad de versiones que se muestran. Pasa “0” para recuperar todas las versiones.

Node.js

Pasa getTemplate() sin argumentos a fin de obtener la versión más reciente de la plantilla o usa getTemplateAtVersion() para recuperar una versión específica.

// 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

El parámetro de URL ?version_number solo es válido para las operaciones GET, no puedes usarlo con el fin de especificar números de versión de las actualizaciones. Si usas una solicitud get similar sin el parámetro ?version_number, se recuperará la plantilla activa actual.

Firebase console

De forma predeterminada, se muestra la plantilla activa actual en el panel de detalles de la pestaña Historial de cambios. Para ver los detalles de otra versión de la lista, selecciónala en el menú de la derecha.

Puedes ver las diferencias detalladas entre la versión actual seleccionada y cualquier otra versión almacenada. Para ello, coloca el cursor sobre el menú contextual de cualquier versión que no esté elegida y selecciona Comparar con la versión seleccionada.

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

De manera opcional, puedes escribir el resultado en un archivo especificado con -o, FILENAME.

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

Para revertir a una plantilla almacenada de Remote Config, realiza una solicitud HTTP POST con el método personalizado :rollback. Incluye en el cuerpo de la solicitud la versión específica a la que quieres revertir. Por ejemplo:

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 respuesta incluye el contenido de la plantilla almacenada que está activa y los metadatos de su versión nueva.

Firebase console

En la esquina superior derecha de la página Historial de cambios, se muestra un botón de opciones que podrás usar para elegir entre las plantillas aptas a las que puedes revertir. Haz clic en el botón y confirma la operación solo si estás seguro de que quieres realizar la reversión y usar esos valores de inmediato en todos los usuarios y las apps.

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

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

Este comando envía la carga útil JSON a un archivo y los encabezados (incluida la Etag) a un archivo headers independiente.

Firebase console

1. Desde la pestaña Remote Config Parameters or Conditions, abre el more_vertMenú y selecciona Descargar archivo de configuración actual.
2. Cuando se te solicite, haz clic en Descargar archivo de configuración, elige la ubicación en la que deseas guardar el archivo y, luego, haz clic en Guardar.

Firebase CLI

firebase remoteconfig:get -o filename

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

Adjunta el parámetro de URL ?validate_only=true a tu solicitud de publicación para validar las actualizaciones de plantillas:

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 tu plantilla se validó correctamente, el comando curl muestra la plantilla JSON que enviaste y, en el archivo headers guardado, encontrarás un estado HTTP/2 200 y una ETag actualizada con el sufijo -0. Si no se validó tu plantilla, recibirás el error de validación en la respuesta JSON y tu archivo headers contendrá una respuesta que no es 200 (y ninguna ETag).

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

Para el comando curl, puedes especificar el contenido mediante el carácter “@” seguido del nombre del archivo.

Firebase console

1. Desde la pestaña Remote Config Parameters or Conditions, abre el more_vertMenú y selecciona Publicar desde un archivo.
2. Cuando se te solicite, haz clic en Explorar, navega hasta el archivo de Remote Config que quieres publicar y haz clic en Seleccionar.
3. El archivo se validará y, si se ejecuta correctamente, puedes hacer clic en Publicar a fin de que la configuración esté disponible inmediatamente para tus apps y usuarios.

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'

Usa XML, PLIST o JSON como el valor de format, según el formato de archivo que desees descargar.

Firebase console

1. En la pestaña Parameters, abre el more_vertmenú y selecciona Download default values.
2. Cuando se te solicite, haz clic en el botón de selección que corresponde al formato de archivo que deseas descargar y, luego, selecciona Download file.