Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Criar versão que conversa com a api em padrão Rest do novo protocolo integrado #47

Open
12 of 13 tasks
wellington-palmeira opened this issue Aug 9, 2024 · 4 comments
Open
12 of 13 tasks
Assignees
Labels
Nova versão Sugestões de melhoria para nova versão do PI
Milestone

Comments

@wellington-palmeira
Copy link
Collaborator

wellington-palmeira commented Aug 9, 2024

Sua solicitação de melhoria está relacionada a um problema? Por favor descreva.
Uma nova versão do Protocolo Integrado está em andamento e faz-se necessário a adaptação do código atual de modo que consiga se integrar à nova api que agora está em padrão Rest.


Pré-requisitos
Por tratar-se de uma primeira modificação no módulo do PI, faz-se necessário algumas pré-atividades:

  • preparação de instância local de sei;
  • instalação do módulo atual do pi ainda em padrão soap;
  • configuração da IDE para depuração do código via xdebug;
  • preparar ambiente local do novo protocolo integrado para permitir os testes de integração e depuração;

Descreva a solução que você gostaria
Que o módulo consiga se integrar ao novo protocolo integrado que agora tem uma api em padrão Rest, alguns pontos que serão analisados e ajustados:

  • Revisar as atuais variáveis de ambiente adequando para o novo padrão de autenticação;
  • Adaptação das chamadas atuais em soap para o padrão Rest alterando a biblioteca sendo utilizada atualmente, assim como o padrão de endpoint e corpo das chamadas que agora utilizarão padrão jwt de autenticação e chamadas com corpo em padrão json;
  • Revisão da rotina atual com relação a execução das consultas na base do sei para preparação dos dados em lote que são enviados, analisando a possibilidade de melhoria e/ou correção de performance nas consultas, assim como na execução das chamadas em lote da api;
  • Preparação de ambiente local com grande quantidade de andamentos para teste de resiliência da api para cenários conhecidos de instâncias de sei com altíssimo fluxo de dados;
  • Revisão da rotina de agendamento visando identificar pontos atuais que tem levado a falhas e resultados intermitentes;

Critérios de Aceite

  • Evidências do módulo enviando dados para uma instância do novo protocolo integrado que agora tem uma api Rest.
  • Que o módulo consiga se integrar ao novo protocolo integrado que agora tem uma api em padrão Rest, alguns pontos que serão analisados e ajustados:
  • Revisar as atuais variáveis de ambiente adequando para o novo padrão de autenticação;
  • Adaptação das chamadas atuais em soap para o padrão Rest alterando a biblioteca sendo utilizada atualmente, assim como o padrão de endpoint e corpo das chamadas que agora utilizarão padrão jwt de autenticação e chamadas com corpo em padrão json;
  • Revisão da rotina atual com relação a execução das consultas na base do sei para preparação dos dados em lote que são enviados, analisando a possibilidade de melhoria e/ou correção de performance nas consultas, assim como na execução das chamadas em lote da api;
  • Preparação de ambiente local com grande quantidade de andamentos para teste de resiliência da api para cenários conhecidos de instâncias de sei com altíssimo fluxo de dados;
  • Preparação de ambiente local com grande quantidade de andamentos para teste de resiliência da api para cenários conhecidos de instâncias de sei com altíssimo fluxo de dados;

Definição de Pronto (D.O.R. - Definition of Ready)

  • preparação de instância local de sei;
  • instalação do módulo atual do pi ainda em padrão soap;
  • configuração da IDE para depuração do código via xdebug;
  • Time de desenvolvimento ciente do trabalho que precisa ser realizado.

Definição de Feito (D.O.D.Definition of Done)

  • Evidências dos testes realizados.
  • Documentação técnica.
@wellington-palmeira wellington-palmeira changed the title Criar versão que conversa com a nova api em padrão Rest do novo protocolo integrado Criar versão que conversa com a api em padrão Rest do novo protocolo integrado Aug 9, 2024
@wellington-palmeira wellington-palmeira added the Nova versão Sugestões de melhoria para nova versão do PI label Aug 9, 2024
@amelquia amelquia added this to the 4.0.0 milestone Aug 12, 2024
@wellington-palmeira
Copy link
Collaborator Author

wellington-palmeira commented Aug 30, 2024

image

image

image

image

os prints acima demonstram alguns dados já chegando em uma base local da nova versão do PI com a Api Rest.

os critérios de aceite abaixo:

Evidências do módulo enviando dados para uma instância do novo protocolo integrado que agora tem uma api Rest.

Adaptação das chamadas atuais em soap para o padrão Rest alterando a biblioteca sendo utilizada atualmente, assim como o padrão de endpoint e corpo das chamadas que agora utilizarão padrão jwt de autenticação e chamadas com corpo em padrão json;

contém uma ressalva ainda não resolvida relacionada ao Encoding, ao converter os dados para o padrão json em utf-8 esta ocorrendo a perda de caracteres com acentuação como no exemplo abaixo:

image

não consegui ainda também efetuar testes mais robustos simulando grande quantidade de dados e efetuando a completa conferência das estruturas de dados gerados referentes a Documentos, Interessados, Protocolos Anteriores e Relacionados e Historico de documentos.

@amelquia
Copy link

amelquia commented Sep 2, 2024

02/09/24
Planejamento da Sprint 23
Issue movida para continuação dos itens faltantes para a sprint 23.
Nova estimativa: 03 dias.

@amelquia
Copy link

amelquia commented Sep 4, 2024

02/09/24 - Daily
Sem impedimentos. Foi corrigido o principal item que era referente aos caracteres acentuados, e, segue fazendo mais alguns testes.

@amelquia
Copy link

@caduvieira issue disponível para revisão técnica.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Nova versão Sugestões de melhoria para nova versão do PI
Projects
None yet
Development

No branches or pull requests

2 participants