Control de versiones y plantillas de Remote Config

La plantilla de Remote Config es la configuración en el servidor de los parámetros y las condiciones en formato JSON que creaste para tu proyecto de Firebase. Puedes modificar y administrar la plantilla con Firebase console, que muestra el contenido en formato gráfico en las pestañas Parámetros y Condiciones. También puedes usar las API de backend de Remote Config para modificar y administrar la configuración.

Este es un ejemplo de un archivo de plantilla:

  {
    "conditions": [
      {
        "name": "ios",
        "expression": "device.os == 'ios'"
      }
    ],
    "parameters": {
      "welcome_message": {
        "defaultValue": {
          "value": "Welcome to this sample app"
        },
        "conditionalValues": {
          "ios": {
            "value": "Welcome to this sample iOS app"
          }
        }
      },
      "welcome_message_caps": {
        "defaultValue": {
          "value": "false"
        }
      },
      "header_text": {
        "defaultValue": {
          "useInAppDefault": true
        }
      }
    },
    "version": {
      "versionNumber": "28",
      "updateTime": "2020-05-14T18:39:38.994Z",
      "updateUser": {
        "email": "user@google.com"
      },
      "updateOrigin": "CONSOLE",
      "updateType": "INCREMENTAL_UPDATE"
    }
  }

Cada vez que actualizas los parámetros, Remote Config crea una versión nueva de la plantilla de Remote Config y almacena la anterior a fin de que puedas recuperarla o revertirla 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.

Con Firebase console o las API de backend de Remote Config, puedes realizar las siguientes tareas de administración de versiones:

  • Enumerar todas las versiones de plantilla almacenadas
  • Recuperar una versión específica
  • Revertir a una versión específica

Cuando administres las plantillas de Remote Config, ten en cuenta los límites de vencimiento: 90 días desde que fueron creadas o un máximo de 300 versiones almacenadas. Si quieres almacenar o revertir a una plantilla que supere esos límites, guárdala y almacénala manualmente. La plantilla activa de Remote Config que usa tu app no vence; sin embargo, si ha estado activa durante más de 90 días desde su creación y se reemplaza con una actualización, no se podrá recuperar debido al límite de vencimiento.

Administra las versiones de plantilla de Remote Config con Firebase console

Firebase console ofrece una interfaz gráfica que permite crear listas con las versiones de las plantillas, consultar sus detalles y, si es necesario, revertirlas a una versión anterior. Para hacerlo, sigue estos pasos:

  1. 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.

  2. Según la configuración predeterminada, se muestra la plantilla activa en el panel de detalles. Para ver los detalles de otra versión de la lista, selecciónala en el menú de la derecha.

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

  3. 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.

  4. En la esquina superior derecha, se muestra un botón de opciones que podrás usar para revertir las plantillas aptas a versiones anteriores. Haz clic en el botón y confirma la operación solo si estás seguro de que quieres realizarla y usar esos valores de inmediato en todos los usuarios y las apps.

Administra las versiones de la plantilla de Remote Config con las API de backend

En esta sección se describe cómo administrar las versiones de la plantilla de Remote Config con la API de REST y el SDK de Firebase Admin. Si quieres obtener más detalles para crear, modificar y guardar plantillas de manera programática, consulta Modifica Remote Config de manera programática.

Enumera todas las versiones almacenadas de la plantilla de Remote Config

Con las API de backend de Remote Config, puedes recuperar una lista de todas las versiones almacenadas de la plantilla de Remote Config. Por ejemplo:

Node.js

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

REST

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

La respuesta incluye los metadatos de todas las versiones almacenadas, entre ellos la hora de actualización, el usuario que la realizó y si se hizo mediante la consola o la API de REST. Aquí encontrarás un ejemplo de un elemento de versión:

{
  "versions": [{
    "version_number": "6",
    "update_time": "2018-05-12T02:38:54Z",
    "update_user": {
      "email": "jane@developer.org",
    },
    "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

Con las API de backend de Remote Config, puedes recuperar las versiones almacenadas de la plantilla de Remote Config. Pasa getTemplate() sin argumentos a fin de recuperar la versión más reciente de la plantilla o usa getTemplateAtVersion() para recuperar una versión específica. Por ejemplo:

Node.js

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

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

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 de obtención similar sin el parámetro ?version_number, se recuperará la plantilla activa actual.

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

Con las API de backend de Remote Config, puedes revertir a cualquier versión almacenada de la plantilla. Por ejemplo:

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

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>" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'</pre>

La respuesta incluye el contenido de la plantilla almacenada que está activa y los metadatos de su versión nueva.

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.