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

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

Для изменения и управления шаблоном можно использовать консоль Firebase . Перейдите в раздел DevOps & Engagement > Remote Config, чтобы просмотреть содержимое шаблона в графическом формате.Страница параметров и страница условий .

Вы также можете использовать REST API и Admin SDK Remote Config или 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 (перейдите в раздел DevOps & Engagement > Remote Config ):

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

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

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

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

Управление версиями шаблонов 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 . Вот как удалить шаблон:

1. В консоли Firebase перейдите на страницу DevOps & Engagement > Remote Config > Parameters .

2. Нажмите history . Изменить историю .

3. Переключитесь на шаблон, который хотите удалить, и нажмите more_vert More , затем выберите Delete .

4. Когда появится запрос на подтверждение удаления, нажмите «Удалить» .

Загрузите и опубликуйте шаблоны 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

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

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

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 , поскольку они могут меняться со временем.

As described in the platform-specific links at the end of this section, you can manually set these defaults in your app or you can streamline this process by downloading files that contain only the key-value pairs for all parameters and their default values in the active Remote Config template. You can then include this file in your project and configure your app to import these values.

Вы можете загрузить эти файлы в формате 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++.