Tutorial: Atlas Device Sync para C++ com FTXUI

Adicionar uma propriedade ao modelo

Agora que tudo está funcionando como o esperado, é possível adicionar alterações. Neste tutorial, uma propriedade priority é adicionada a cada Item para que os itens possam ser filtrados de acordo com prioridade.

Em um aplicativo de produção, você pode adicionar uma enumeração PriorityLevel para restringir os valores possíveis. Neste tutorial, usaremos uma propriedade de número para simplificar o trabalho com a framework da IU.

Para fazer isso, siga estas etapas:

1. Abra o código do cliente em seu IDE preferido.

2. No diretório state/, abra o arquivo item.hpp.

3. Adicione a seguinte propriedade à estrutura Item:

   int64_t priority;

4. Adicione a nova propriedade priority ao REALM_SCHEMA():

   REALM_SCHEMA(Item, _id, isComplete, summary, owner_id, priority)

   O modelo Item agora deve ser semelhante:

   namespace realm {
   struct Item {
     realm::primary_key<realm::object_id> _id{realm::object_id::generate()};
     bool isComplete;
     std::string summary;
     std::string owner_id;
     int64_t priority;
   };
   REALM_SCHEMA(Item, _id, isComplete, summary, owner_id, priority)
   }  // namespace realm

Adicione um elemento à IU para definir a prioridade

1. No diretório state, vá para home_controller_state.hpp. Adicione uma nova propriedade int sob a propriedade newTaskIsComplete existente. Em seguida, adicione um static const int para armazenar o valor int padrão para essa propriedade.

   A estrutura HomeControllerState agora pode ser semelhante a:

   struct HomeControllerState {
     static const int DEFAULT_TASK_PRIORITY = 3;
     // Used for creating a new task.
     std::string newTaskSummary;
     bool newTaskIsComplete{false};
     int newTaskPriority{DEFAULT_TASK_PRIORITY};
     ...more code here...
   };

2. No diretório controllers, acesse home_controller.hpp. Esse controlador renderiza a exibição principal do aplicativo.

   Importe as bibliotecas de string e vetor:

   #include <string>
   #include <vector>

   Crie uma array de rótulos de string para o novo elemento de prioridade da IU:

   std::vector<std::string> priorityLevelLabels = {
     "Severe", "High", "Medium", "Low"
   };

3. Ainda no diretório controllers, vá para home_controller.cpp. É aqui que adicionamos um elemento de IU para permitir que o usuário defina a prioridade do item. O FTXUI oferece dois elementos de IU que você pode usar para essa funcionalidade: Radiobox ou Dropdown. Neste tutorial, usaremos Dropdown, mas talvez você prefira Radiobox se não gostar da maneira como a IU reflui para renderizar a lista suspensa.

   Adicione esta nova entrada de elemento de IU após a linha auto newTaskCompletionStatus:

   auto newTaskPriorityDropdown = ftxui::Dropdown(
     &priorityLevelLabels,
     &_homeControllerState.newTaskPriority
   );

   No fechamento da função auto saveButton, passe a seleção de prioridade da tarefa para a chamada de função _dbManager.addNew():

   _dbManager.addNew(
     _homeControllerState.newTaskIsComplete,
     _homeControllerState.newTaskSummary,
     _homeControllerState.newTaskPriority);

   Em seguida, adicione uma linha para redefinir a seleção de prioridade com o valor padrão:

   _homeControllerState.newTaskPriority = HomeControllerState::DEFAULT_TASK_PRIORITY;

   Adicione o seletor suspenso ao auto newTaskLayout, que define o layout dos elementos interativos no contêiner da linha do item:

   auto newTaskLayout = ftxui::Container::Horizontal(
     {inputNewTaskSummary, newTaskCompletionStatus, newTaskPriorityDropdown, saveButton});

   Esta seção do seu código agora deve ser semelhante a:

   auto newTaskCompletionStatus = ftxui::Checkbox("Complete", &_homeControllerState.newTaskIsComplete);
   auto newTaskPriorityDropdown = ftxui::Dropdown(
     &priorityLevelLabels,
     &_homeControllerState.newTaskPriority);
   auto saveButton = ftxui::Button("Save", [this] {
     _dbManager.addNew(
       _homeControllerState.newTaskIsComplete,
       _homeControllerState.newTaskSummary,
       _homeControllerState.newTaskPriority);
     _homeControllerState.newTaskSummary = "";
     _homeControllerState.newTaskIsComplete = false;
     _homeControllerState.newTaskPriority = HomeControllerState::DEFAULT_TASK_PRIORITY;
   });
   auto newTaskLayout = ftxui::Container::Horizontal(
     {inputNewTaskSummary, newTaskCompletionStatus, newTaskPriorityDropdown, saveButton});

4. Por último, mais para o fim do arquivo home_controller.cpp, adicione o novo elemento de IU ao auto itemListRenderer:

   inputNewTaskSummary->Render() | ftxui::flex,
   newTaskCompletionStatus->Render() | ftxui::center,
   newTaskPriorityDropdown->Render(),
   saveButton->Render(),

   Isso renderiza o novo elemento logo antes do botão Salvar na IU.

Salvar a nova propriedade no banco de dados

1. No diretório managers, acesse database_manager.hpp. Atualize a assinatura da função addNew() para incluir o int newItemPriority que passamos de home_controller.cpp:

   void addNew(
     bool newItemIsComplete,
     std::string newItemSummary,
     int newItemPriority);

2. Agora acesse database_manager.cpp e atualize a implementação de addNew() . Adicione int newItemProperty aos argumentos da função:

   void DatabaseManager::addNew(
     bool newItemIsComplete,
     std::string newItemSummary,
     int newItemPriority) {
     ...implementation...
     }

   Adicione uma nova linha na função para definir o valor da propriedade priority quando salvamos Item no banco de dados:

   .priority = newItemPriority

   Sua implementação addNew() agora deve ser semelhante a:

   void DatabaseManager::addNew(bool newItemIsComplete, std::string newItemSummary, int newItemPriority) {
     auto item = realm::Item {
       .isComplete = newItemIsComplete,
       .summary = std::move(newItemSummary),
       .owner_id = _userId,
       .priority = newItemPriority
     };
     _database->write([&]{
       _database->add(std::move(item));
     });
   }

Executar e testar

Nesse ponto, crie e execute o aplicativo novamente. No diretório de compilação, recrie o executável com as alterações feitas:

cmake --build .

E execute o aplicativo:

./sync_todo /path-to-file/atlasConfig.json

Faça login usando a conta que você criou neste tutorial. Você verá o único item que criou anteriormente. Adicione um novo item e você verá que agora pode definir a prioridade. Escolha High para a prioridade e salve o item.

Agora volte para a página de dados do Atlas em seu navegador e atualize a coleção do Item. Você deve agora visualizar o novo Item com o campo priority adicionado e configurado para 1. O item existente não tem um campo priority.

clique para ampliar

Atualizar a assinatura

Para alterar a assinatura, acesse o diretório managers e abra o arquivo database_manager.cpp. Atualize a consulta para incluir documentos cuja prioridade seja igual ou menor que 1. Isso deve incluir apenas itens de prioridade "Severe" (0) ou "High" (1).

if (!subs.find(_myItemSubscriptionName)) {
  subs.add<realm::Item>(
    _myItemSubscriptionName,
    [&](auto &item){
      return item.owner_id == _userId && item.priority <= 1;
    }
  );
}

Executar e testar

Execute o aplicativo novamente. Faça login usando a conta que você criou neste tutorial. Na caixa Subscription, pressione a opção Switch to Mine. Após um momento inicial em que o SDK ressincroniza a coleção de documentos, você verá apenas o novo item de alta prioridade que você criou. Talvez seja necessário mover o mouse ou usar a tecla de seta para fazer com que a interface do usuário seja renderizada novamente com os novos itens que foram sincronizados em segundo plano.

O documento Item que você criou inicialmente não é exibido no dispositivo, porque ele não tem um campo priority. Se quiser que esse item seja sincronizado com o dispositivo, você pode editar o documento na interface do usuário do Atlas e adicionar um valor para o campo priority.

Se quiser testar ainda mais a funcionalidade, crie Itens de várias prioridades. Você verá um novo item com uma prioridade mais baixa aparecer brevemente na lista de itens e depois desaparecer. O manipulador de erros de sincronização fornece uma mensagem que descreve esse comportamento:

A sync error occurred. Message:
"Client attempted a write that is not allowed; it has been reverted"

Nesse cenário, o SDK cria o Item localmente, sincroniza com o backend e, em seguida, reverte a gravação porque ele não atende às regras de assinatura.