Modelos e controle de versão de configuração remota

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

DESCANSAR

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

Console do Firebase

Na guia Parâmetros , selecione o ícone “relógio” exibido no canto superior direito. Isso abre a página Histórico de alterações , listando todas as versões de modelos armazenadas em um menu de lista à direita.

Os detalhes exibidos para cada versão armazenada incluem informações sobre se as alterações foram originadas na Console, com a API REST, de uma reversão ou se foram alterações incrementais de um salvamento forçado do modelo.

CLI do Firebase

firebase remoteconfig:versions:list

Use a opção --limit para limitar o número de versões retornadas. Passe '0' para buscar todas as versões.

Node.js

Passe getTemplate() sem nenhum argumento para recuperar a versão mais recente do modelo ou, para recuperar uma versão específica, use getTemplateAtVersion() .

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

DESCANSAR

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

O parâmetro URL ?version_number é válido apenas para operações GET ; você não pode usá-lo para especificar números de versão para atualizações. Uma solicitação get semelhante sem o parâmetro ?version_number recuperaria o modelo ativo atual.

Console do Firebase

Por padrão, o painel de detalhes na guia Histórico de alterações exibe o modelo ativo atual. Para visualizar detalhes de outra versão na lista, selecione-a no menu direito.

Você pode visualizar uma comparação detalhada da versão atualmente selecionada e de qualquer outra versão armazenada passando o mouse sobre o menu de contexto de qualquer versão não selecionada e selecionando Comparar com a versão selecionada.

CLI do Firebase

firebase remoteconfig:get -v VERSION_NUMBER

Opcionalmente, você pode gravar a saída em um arquivo especificado com -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());
  }
}

DESCANSAR

Para reverter para um modelo armazenado do Configuração remota, emita um HTTP POST com o método personalizado :rollback e, no corpo da solicitação, a versão específica a ser aplicada. Por exemplo:

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

A resposta contém o conteúdo do modelo armazenado agora ativo, com seus metadados da nova versão.

Console do Firebase

Para versões anteriores do modelo qualificadas para reversão, um botão de opção para reverter para essa versão é exibido no canto superior direito da página Histórico de alterações . Clique e confirme apenas se tiver certeza de que deseja reverter para essa versão e usar esses valores imediatamente para todos os aplicativos e usuários.

CLI do Firebase

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

DESCANSAR

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

Este comando gera a carga JSON em um arquivo e os cabeçalhos (incluindo o ETag) em um arquivo headers separado.

Console do Firebase

1. Na guia Parâmetros ou condições de configuração remota , abra o menu more_vert e selecione Baixar arquivo de configuração atual .
2. Quando solicitado, clique em Baixar arquivo de configuração , escolha o local onde deseja salvar o arquivo e clique em Salvar .

CLI do Firebase

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

DESCANSAR

Valide as atualizações do modelo anexando o parâmetro de URL ?validate_only=true à sua solicitação de publicação:

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

Se o seu modelo foi validado com sucesso, o comando curl retorna o modelo JSON que você enviou e, no arquivo headers salvo, você encontrará um status HTTP/2 200 e uma ETag atualizada com o sufixo -0 . Se o seu modelo não foi validado, você receberá o erro de validação na resposta JSON e seu arquivo headers conterá uma resposta diferente de 200 (e nenhuma 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());
  }
}

DESCANSAR

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 este comando curl , você pode especificar o conteúdo usando o caractere “@”, seguido do nome do arquivo.

Console do Firebase

1. Na guia Parâmetros ou condições da configuração remota , abra o menu more_vert e selecione Publicar de um arquivo .
2. Quando solicitado, clique em Procurar , navegue e selecione o arquivo do Configuração remota que deseja publicar e clique em Selecionar .
3. O arquivo será validado e, se for bem-sucedido, você poderá clicar em Publicar para disponibilizar a configuração imediatamente para seus aplicativos e usuários.

DESCANSAR

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

Use XML , PLIST ou JSON como valor format , dependendo do formato de arquivo que você deseja baixar.

Console do Firebase

1. Na guia Parâmetros , abra o menu more_vert e selecione Baixar valores padrão .
2. Quando solicitado, clique no botão de opção que corresponde ao formato de arquivo que você deseja baixar e clique em Baixar arquivo .