Шаблоны удаленной конфигурации и управление версиями

Шаблоны Remote Config — это наборы параметров и условий в формате JSON, созданные вами для вашего проекта Firebase. Вы можете создать клиентские шаблоны, из которых ваше приложение будет получать значения, и серверные шаблоны, из которых клиенты сервера смогут получать значения.

Вы можете изменять и управлять шаблоном с помощью консоли Firebase , которая отображает содержимое шаблона в графическом формате вВкладки «Параметры» и «Условия» .

Вы также можете использовать REST API Remote Config и Admin SDK или Firebase CLI для изменения и управления вашим клиентским шаблоном.

Вот пример файла шаблона сервера:

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

С помощью консоли Firebase вы можете выполнять следующие задачи по управлению версиями:

• Список всех сохраненных версий шаблонов
• Получить конкретную версию
• Откат к конкретной версии клиента
• Удалить шаблоны Remote Config со страницы истории изменений

Общее количество хранимых версий для каждого типа шаблона за весь срок службы ограничено 300 (300 клиентских шаблонов и 300 серверных шаблонов), включая номера версий удалённых шаблонов. Если в течение жизненного цикла проекта вы публикуете более 300 версий шаблона для каждого типа шаблона, самые ранние версии удаляются, и таким образом сохраняется максимум 300 версий этого типа.

При каждом обновлении параметров Remote Config создаёт новый шаблон Remote Config с новой версией и сохраняет предыдущий шаблон как версию, к которой можно вернуться или восстановить её при необходимости. Номера версий последовательно увеличиваются от начального значения, сохранённого Remote Config . Все шаблоны включают поле version , как показано, содержащее метаданные об этой конкретной версии.

При необходимости вы можете удалить шаблоны Remote Config изИстория измененийстраницу на консоли Remote Config .

Управление версиями шаблонов Remote Config

В этом разделе описывается, как управлять версиями шаблона Remote Config .

Список всех сохраненных версий шаблона Remote Config

Вы можете получить список всех сохранённых версий шаблона Remote Config . Для этого:

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

Список шаблонов включает метаданные всех сохранённых версий, включая время обновления, имя пользователя, выполнившего обновление, и способ его создания. Вот пример элемента версии:

```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"
  }]
}
```

Получить конкретную версию шаблона Remote Config

Вы можете получить любую сохранённую версию шаблона Remote Config . Чтобы получить сохранённую версию шаблона:

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

Откат к определенной сохраненной версии шаблона Remote Config

Вы можете вернуться к любой сохранённой версии шаблона. Чтобы откатить шаблон:

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

Обратите внимание, что эта операция отката фактически создаёт новую пронумерованную версию. Например, откат с версии 10 до версии 6 фактически создаёт новую копию версии 6, отличающуюся от исходной только номером 11. Исходная версия 6 сохраняется, если её срок действия не истёк, а версия 11 становится активным шаблоном.

Удалить шаблон Remote Config

Вы можете удалить шаблоны Remote Config из консоли Firebase . Чтобы удалить шаблон Remote Config :

1. Переключитесь на шаблон, который вы хотите удалить, нажмите more_vert «Ещё» , затем выберите «Удалить» .

2. При появлении запроса на подтверждение удаления нажмите Удалить .

Загрузите и опубликуйте шаблоны Remote Config

Загрузите и опубликуйте шаблоны Remote Config , чтобы интегрировать их в свои системы управления исходным кодом и сборки, автоматизировать обновления конфигураций и синхронизировать параметры и значения в нескольких проектах.

Вы можете загрузить текущий активный шаблон Remote Configиз консоли Firebase .Затем вы можете обновить экспортированный JSON-файл и опубликовать его в том же проекте или опубликовать его в новом или существующем проекте.

Предположим, у вас есть несколько проектов, представляющих разные этапы жизненного цикла разработки программного обеспечения, такие как среды разработки, тестирования, промежуточной среды и производственной среды. В этом случае вы можете перенести полностью протестированный шаблон из промежуточной среды в производственную среду, загрузив его из промежуточного проекта и опубликовав в производственном проекте.

Этот метод также можно использовать для переноса конфигураций из одного проекта в другой или для заполнения нового проекта параметрами и значениями из существующего проекта.

Параметры и значения параметров, созданные специально как варианты в эксперименте A/B Testing не включаются в экспортируемые шаблоны.

Чтобы экспортировать и импортировать шаблоны Remote Config :

1. Загрузите текущий шаблон конфигурации Remote Config .
2. Проверьте шаблон Remote Config .
3. Опубликуйте шаблон Remote Config .

Загрузите текущий шаблон удаленной конфигурации

Для загрузки активного шаблона Remote Config в формате 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

Проверьте шаблон удаленной конфигурации

Процесс проверки шаблона проверяет наличие ошибок, таких как дублирование ключей для параметров и условий, недопустимые имена условий или несуществующие условия, а также некорректный формат ETag. Например, запрос, содержащий больше допустимого количества ключей (2000), вернёт сообщение об ошибке 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

Опубликовать шаблон Remote Config

После загрузки шаблона, внесения необходимых изменений в содержимое JSON и его проверки вы можете опубликовать его в проекте.

Публикация шаблона заменяет весь существующий шаблон конфигурации обновлённым файлом и увеличивает версию шаблона на единицу. Поскольку заменяется вся конфигурация, удаление параметра из JSON-файла и его публикация удаляют этот параметр с сервера и делают его недоступным для клиентов.

После публикации изменения параметров и значений сразу становятся доступны вашим приложениям и пользователям. При необходимости вы можете вернуться к предыдущей версии .

Для публикации шаблона используйте следующие команды:

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

Персонализации и условия Remote Config включены в загружаемые шаблоны, поэтому важно помнить о следующих ограничениях при попытке публикации в другом проекте:

• Персонализации нельзя импортировать из проекта в проект.

  Например, если в вашем проекте включены персонализации, а вы загрузили и отредактировали шаблон, вы можете опубликовать его в том же проекте, но не сможете опубликовать его в другом проекте, пока не удалите персонализации из шаблона.

• Условия можно импортировать из проекта в проект, но учтите, что любые конкретные условные значения (например, идентификаторы приложений или аудитории) должны существовать в целевом проекте до публикации.

  Например, если у вас есть параметр Remote Config , который использует условие, указывающее значение платформы iOS , шаблон можно опубликовать в другом проекте, поскольку значения платформы одинаковы для всех проектов. Однако, если он содержит условие, зависящее от конкретного идентификатора приложения или аудитории пользователей, которых нет в целевом проекте, валидация завершится неудачей.

• Если шаблон, который вы планируете опубликовать, содержит условия, зависящие от Google Analytics , в целевом проекте необходимо включить Analytics .

Загрузить шаблоны Remote Config по умолчанию

Поскольку ваше приложение может быть не всегда подключено к Интернету, вам следует настроить значения по умолчанию для всех параметров Remote Config на стороне клиента. Также следует периодически синхронизировать значения по умолчанию на стороне клиента приложения и значения по умолчанию на стороне сервера Remote Config , поскольку они могут меняться со временем.

Как описано в ссылках для конкретных платформ в конце этого раздела, вы можете вручную задать эти значения по умолчанию в своём приложении или упростить этот процесс, загрузив файлы, содержащие только пары «ключ-значение» для всех параметров и их значения по умолчанию в активном шаблоне Remote Config . Затем вы можете включить этот файл в свой проект и настроить приложение для импорта этих значений.

Вы можете загрузить эти файлы в формате XML для приложений Android, в формате списка свойств (plist) для приложений iOS и в формате JSON для веб-приложений.

Мы рекомендуем периодически загружать настройки Remote Config по умолчанию перед выпуском любого нового приложения, чтобы гарантировать синхронизацию вашего приложения и бэкэнда Remote Config .

Чтобы загрузить файл, содержащий шаблоны по умолчанию:

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

Дополнительную информацию об импорте значений Remote Config по умолчанию в ваше приложение см. в разделе:

• Установка значений параметров по умолчанию в приложении для Android

• Установка значений параметров по умолчанию в приложении для iOS

• Установить значения параметров приложения по умолчанию для веб-браузера

• Установите значения параметров по умолчанию в приложении для Unity

• Установка значений параметров по умолчанию в приложении для C++