Control de versiones y plantillas de Remote Config

Las plantillas de Remote Config son conjuntos de parámetros y condiciones en formato JSON que creaste para tu proyecto de Firebase. Puedes crear plantillas de cliente, desde las que tu app recupera valores, y plantillas de servidor, desde las que los clientes del servidor pueden recuperar valores.

Puedes modificar y administrar la plantilla con Firebase console, que muestra el contenido de la plantilla en formato gráfico en las pestañas Pestañas Parámetros y Condiciones.

También puedes usar la API de REST y el SDK de Admin de Remote Config o Firebase CLI para modificar y administrar tu plantilla de cliente.

Este es un ejemplo de un archivo de plantilla de servidor:

{
  "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
  }
}

Puedes realizar estas tareas de administración de versiones con Firebase console:

• Crear una lista con todas las versiones de plantilla almacenadas
• Recuperar una versión específica
• Revertir a una versión de cliente específica
• Borrar plantillas de Remote Config de la página Historial de cambios

Hay un límite total de 300 versiones almacenadas desde el principio por tipo de plantilla (300 plantillas de cliente y 300 plantillas de servidor), que incluyen los números de versión almacenados para las plantillas borradas. Si publicas más de 300 versiones de plantilla por tipo de plantilla durante el ciclo de vida de un proyecto, las versiones más antiguas se borran y se mantiene un máximo de 300 versiones de ese tipo.

Cada vez que actualizas los parámetros, Remote Config crea una nueva plantilla de Remote Config con versión y almacena la anterior como una versión que puedes recuperar o revertir según sea necesario. Los números de versión aumentan de manera secuencial a partir del valor inicial que almacenó Remote Config. Todas las plantillas incluyen un campo version que contiene metadatos sobre esa versión específica.

Puedes borrar las plantillas de Remote Config según sea necesario desde la página Historial de cambios de Remote Config console.

Administra las versiones de plantillas de Remote Config

En esta sección, se describe cómo administrar las versiones de tu plantilla de Remote Config.

Genera una lista con todas las versiones almacenadas de la plantilla de Remote Config

Puedes recuperar una lista de todas las versiones almacenadas de la plantilla de Remote Config. Para ello, sigue estos pasos:

firebase remoteconfig:versions:list

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

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

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

La lista de plantillas incluye los metadatos de todas las versiones almacenadas, entre ellos la hora de actualización, el usuario que la realizó y cómo se hizo. Este es un ejemplo de un elemento de versión:

```json
{
  "versions": [{
    "version_number": "6",
    "update_time": "2022-05-12T02:38:54Z",
    "update_user": {
      "name": "Jane Smith",
      "email": "jane@developer.org",
      "imageUrl": "https://lh3.googleusercontent.com/a-/..."
    },
    "description": "One small change on the console",
    "origin": "CONSOLE",
    "update_type": "INCREMENTAL_UPDATE"
  }]
}
```

Recupera una versión específica de la plantilla de Remote Config

Puedes recuperar cualquier versión específica almacenada de la plantilla de Remote Config. Para recuperar una versión de plantilla almacenada, haz lo siguiente:

firebase remoteconfig:get -v VERSION_NUMBER

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

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());

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

Revierte a una versión almacenada específica de la plantilla de Remote Config

Puedes realizar una reversión a cualquier versión almacenada de la plantilla. Para revertir una plantilla, haz lo siguiente:

firebase remoteconfig:rollback -v VERSION_NUMBER

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

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

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}'

Ten en cuenta que revertir la plantilla crea efectivamente una versión numerada nueva. Por ejemplo, revertir de la versión 10 a la 6 crea una copia nueva de la versión 6, cuya única diferencia con la versión original es que su número de versión será 11. La versión 6 original seguirá almacenada (si no llegó al límite de vencimiento) y la versión 11 de la plantilla será la activa.

Borra una plantilla de Remote Config

Puedes borrar plantillas de Remote Config desde Firebase console. Para borrar una plantilla de Remote Config, sigue estos pasos:

1. Ve a la plantilla que deseas borrar, haz clic en more_vertMás y, luego, selecciona Borrar.

2. Cuando se te solicite confirmar la eliminación, haz clic en Borrar.

Descarga y publica plantillas de Remote Config

Descarga y publica plantillas de Remote Config para integrarlas en tus sistemas de compilación y de control de origen, automatizar las actualizaciones de configuración y mantener los parámetros y valores sincronizados en múltiples proyectos.

Puedes descargar la plantilla de Remote Config activa actualmente desde Firebase console. Luego, puedes actualizar el archivo JSON exportado y publicarlo en el mismo proyecto, o en uno nuevo o existente.

Supongamos que tienes múltiples proyectos que representan diferentes etapas del ciclo de vida del desarrollo de un software, como los entornos de desarrollo, prueba, etapa de pruebas y producción. En este caso, puedes ascender una plantilla completamente probada del entorno de etapa de pruebas a tu entorno de producción si la descargas desde el proyecto de etapa de pruebas y la publicas en el de producción.

También puedes usar este método para migrar parámetros de configuración de un proyecto a otro o propagar un proyecto nuevo con parámetros y valores de un proyecto establecido.

En las plantillas exportadas, no se incluyen los parámetros ni valores de parámetros creados específicamente como variantes en un experimento de A/B Testing.

Para exportar y para importar plantillas de Remote Config, sigue estos pasos:

1. Descarga la plantilla de configuración de Remote Config actual.
2. Valida la plantilla de Remote Config.
3. Publica la plantilla de Remote Config.

Descarga la plantilla actual de Remote Config

Usa el siguiente comando para descargar la plantilla de Remote Config activa en formato JSON:

firebase remoteconfig:get -o filename

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

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

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

Valida la plantilla de Remote Config

En el proceso de validación de la plantilla, se comprueba si hay errores, como claves duplicadas para parámetros y condiciones, nombres de condiciones no válidos, condiciones inexistentes o ETags con errores de formato. Por ejemplo, una solicitud que contiene más claves que la cantidad permitida (2,000) mostraría el mensaje de error Param count too large.

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

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

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

Publica la plantilla de Remote Config

Después de descargar una plantilla, realizar los cambios necesarios en el contenido JSON y validarla, puedes publicarla en un proyecto.

Publicar una plantilla reemplaza toda la plantilla de configuración existente por el archivo actualizado y aumenta la versión de la plantilla en uno. Debido a que se reemplaza toda la configuración, si borras un parámetro del archivo JSON y lo publicas, el parámetro se borra del servidor y deja de estar disponible para los clientes.

Después de la publicación, los cambios en los parámetros y los valores estarán disponibles de inmediato para tus apps y usuarios. Si es necesario, puedes revertir a una versión anterior.

Usa los siguientes comandos para publicar tu plantilla:

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

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

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

Las personalizaciones y condiciones de Remote Config se incluyen en las plantillas descargadas, por lo que es importante tener en cuenta las siguientes limitaciones cuando intentes publicar en un proyecto diferente:

• Las personalizaciones no se pueden importar de un proyecto a otro.

  Por ejemplo, si tienes personalizaciones habilitadas en tu proyecto y descargas y editas una plantilla, puedes publicarla en el mismo proyecto, pero no en otro proyecto, a menos que borres las personalizaciones de la plantilla.

• Las condiciones se pueden importar de un proyecto a otro, pero ten en cuenta que cualquier valor condicional específico (como IDs de app o públicos) debe existir en el proyecto de destino antes de la publicación.

  Por ejemplo, si tienes un parámetro de Remote Config que usa una condición que especifica un valor de plataforma de iOS, la plantilla se puede publicar en otro proyecto, ya que los valores de plataforma son los mismos para cualquier proyecto. Sin embargo, si contiene una condición que depende de un ID de app específico o de un público de usuarios que no existe en el proyecto de destino, la validación fallará.

• Si la plantilla que quieres publicar contiene condiciones que dependen de Google Analytics, Analytics debe estar habilitado en el proyecto de destino.

Descarga los valores predeterminados de la plantilla de Remote Config

Dado que es posible que tu app no siempre esté conectada a Internet, debes configurar los valores predeterminados de la app del cliente para todos los parámetros de Remote Config. Además, debes sincronizar periódicamente los valores predeterminados del cliente de la app y los parámetros predeterminados del backend de Remote Config, ya que pueden cambiar con el tiempo.

Como se describe en los vínculos específicos de la plataforma al final de esta sección, puedes configurar estos valores predeterminados de forma manual en tu app, o bien optimizar este proceso; para ello, descarga los archivos que contengan solo los pares clave-valor para todos los parámetros y sus valores predeterminados en la plantilla activa de Remote Config. Luego, puedes incluir este archivo en tu proyecto y configurar la app para importar estos valores.

Puedes descargar los archivos en formato XML en las apps para Android, en formato de lista de propiedades (plist) en las apps para iOS y en formato JSON en las apps web.

Recomendamos descargar periódicamente los valores predeterminados de Remote Config antes de cualquier versión nueva de la app para asegurarte de que la app y el backend de Remote Config permanezcan sincronizados.

Para descargar un archivo que contiene los valores predeterminados de la plantilla, haz lo siguiente:

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

Si quieres obtener más información para importar valores predeterminados de Remote Config a tu app, consulta los siguientes recursos:

• Configura los valores de parámetros predeterminados en la app para Android

• Configura los valores de parámetros predeterminados en la app para iOS

• Configura los valores de parámetros predeterminados en la app para la Web

• Configura los valores de parámetros predeterminados en la app para Unity

• Configura los valores de parámetros predeterminados en la app para C++