implements PR014 a PR016
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# PR-014 [QUALITY]: Stabilize Workspace Formatting
|
||||
|
||||
## Briefing
|
||||
|
||||
O workspace ja tem uma trilha clara de qualidade com `fmt-check`, `clippy` e `test` no fluxo de CI. Hoje, porem, a barra minima de formatacao nao esta fechando: `cargo fmt -- --check` falha por divergencias de ordenacao de imports e estilo em arquivos ja versionados.
|
||||
|
||||
Esta PR trata esse problema como higiene de base. O objetivo nao e "embelezar codigo", e sim restaurar o contrato de estilo para que a arvore volte a ter um estado formatado, previsivel e mecanico.
|
||||
|
||||
## Problema
|
||||
|
||||
- `cargo fmt -- --check` falha no estado atual do workspace;
|
||||
- ha arquivos versionados que divergem do estilo canonical do `rustfmt`;
|
||||
- enquanto isso existir, o target `ci` deixa de ser confiavel como gate minimo de merge;
|
||||
- a equipe perde sinal: falhas de estilo misturam ruido de higiene com problemas reais de implementacao.
|
||||
|
||||
## Alvo
|
||||
|
||||
- workspace Rust inteiro;
|
||||
- arquivos tocados pelo `rustfmt` que hoje geram diff;
|
||||
- fluxo `fmt-check` definido no `Makefile`.
|
||||
|
||||
## Escopo
|
||||
|
||||
- Rodar `cargo fmt` no workspace e revisar o diff gerado.
|
||||
- Confirmar que as mudancas sao estritamente de formatacao, sem alteracao semantica.
|
||||
- Restaurar `cargo fmt -- --check` para estado verde.
|
||||
- Se necessario, ajustar qualquer arquivo novo ou recente que tenha escapado do padrao.
|
||||
|
||||
## Fora de Escopo
|
||||
|
||||
- Refatorar APIs.
|
||||
- Renomear modulos.
|
||||
- Resolver warnings de `clippy`.
|
||||
- Alterar comportamento de testes ou runtime.
|
||||
|
||||
## Abordagem
|
||||
|
||||
1. Identificar exatamente quais arquivos fazem `fmt-check` falhar.
|
||||
2. Aplicar `cargo fmt` no workspace.
|
||||
3. Revisar diff para garantir ausencia de mudanca comportamental.
|
||||
4. Revalidar com `cargo fmt -- --check`.
|
||||
|
||||
## Criterios de Aceite
|
||||
|
||||
- `cargo fmt -- --check` passa no workspace.
|
||||
- O diff da PR e apenas de formatacao.
|
||||
- Nenhuma logica, assinatura publica ou comportamento de teste muda por causa desta PR.
|
||||
- O target `fmt-check` do `Makefile` volta a ser um gate confiavel.
|
||||
|
||||
## Tests
|
||||
|
||||
- Rodar `cargo fmt -- --check`.
|
||||
- Rodar ao menos `cargo test --workspace --all-targets --all-features --no-fail-fast` se a PR tocar arquivos em crates com testes relevantes, apenas para confirmar ausencia de regressao acidental.
|
||||
|
||||
## Risco
|
||||
|
||||
Baixo. O risco principal e misturar formatacao com mudanca semantica no mesmo diff. A revisao deve ser severa: qualquer alteracao nao mecanica deve sair desta PR.
|
||||
@@ -0,0 +1,68 @@
|
||||
# PR-015 [QUALITY]: Burn Down Clippy Warnings
|
||||
|
||||
## Briefing
|
||||
|
||||
O workspace compila e a suite principal de testes esta saudavel, mas `cargo clippy --workspace --all-features` ainda retorna uma quantidade relevante de warnings. Isso nao e detalhe cosmetico: warnings recorrentes enfraquecem o valor do lint e escondem sinais novos que deveriam chamar atencao imediata.
|
||||
|
||||
Esta PR fecha a divida de lint com foco em warnings claros, mecanicos e de baixo risco. A meta e tornar `clippy` um gate com alta relacao sinal/ruido.
|
||||
|
||||
## Problema
|
||||
|
||||
- `cargo clippy --workspace --all-features` termina com warnings em multiplas crates;
|
||||
- ha uma mistura de problemas triviais e repetitivos:
|
||||
- `new_without_default`;
|
||||
- `collapsible_if`;
|
||||
- `redundant_closure`;
|
||||
- `clone_on_copy`;
|
||||
- `needless_borrow`;
|
||||
- `unnecessary_cast`;
|
||||
- `too_many_arguments`;
|
||||
- `module_inception`;
|
||||
- enquanto o baseline permanecer ruidoso, novos warnings entram sem friccao.
|
||||
|
||||
## Alvo
|
||||
|
||||
- crates do workspace que hoje emitem warnings de `clippy`;
|
||||
- principalmente `prometeu-vm`, `prometeu-system`, `prometeu-host-desktop-winit`, `prometeu-drivers` e `pbxgen-stress`.
|
||||
|
||||
## Escopo
|
||||
|
||||
- Eliminar warnings de `clippy` que tenham correcao local, objetiva e de baixo risco.
|
||||
- Introduzir `Default` onde a recomendacao fizer sentido sem distorcer o modelo de construcao.
|
||||
- Simplificar fluxo de controle e remocoes de ruido sintatico.
|
||||
- Decidir explicitamente o tratamento de warnings que indiquem tradeoff arquitetural real.
|
||||
|
||||
## Fora de Escopo
|
||||
|
||||
- Grandes refactors de design apenas para satisfazer lint.
|
||||
- Mudancas arquiteturais em API publica sem discussao previa.
|
||||
- Reescrever modulos inteiros por motivos esteticos.
|
||||
- Alterar a taxonomia arquitetural do runtime.
|
||||
|
||||
## Abordagem
|
||||
|
||||
1. Classificar warnings em dois grupos:
|
||||
- mecanicos e sem risco;
|
||||
- warnings que tocam modelagem publica ou ergonomia de API.
|
||||
2. Corrigir primeiro o grupo mecanico.
|
||||
3. Para warnings que implicarem decisao de design, escolher uma de duas saidas:
|
||||
- corrigir com justificativa clara;
|
||||
- silenciar localmente com comentario curto e motivo tecnico defensavel.
|
||||
4. Reexecutar `cargo clippy --workspace --all-features` ate baseline limpo ou explicitamente justificado.
|
||||
|
||||
## Criterios de Aceite
|
||||
|
||||
- `cargo clippy --workspace --all-features` termina sem warnings, ou com excecoes locais raras e justificadas no codigo.
|
||||
- Nenhuma mudanca amplia API ou comportamento sem necessidade.
|
||||
- O resultado final aumenta, e nao reduz, a legibilidade do codigo.
|
||||
- Warnings mecanicos recorrentes deixam de existir no baseline.
|
||||
|
||||
## Tests
|
||||
|
||||
- Rodar `cargo clippy --workspace --all-features`.
|
||||
- Rodar `cargo test --workspace --all-targets --all-features --no-fail-fast`.
|
||||
- Se alguma correcao tocar caminho quente do runtime, rodar tambem os testes da crate afetada de forma isolada para facilitar triagem.
|
||||
|
||||
## Risco
|
||||
|
||||
Medio. O risco nao esta no `clippy`; esta em usar o lint como desculpa para refatorar demais. Esta PR deve ser conservadora: eliminar ruido sem inventar arquitetura nova.
|
||||
@@ -0,0 +1,66 @@
|
||||
# PR-016 [CI]: Separate Network-Dependent Debugger Tests
|
||||
|
||||
## Briefing
|
||||
|
||||
Os testes do host debugger passam quando executados em ambiente com permissao normal de socket, mas falham em contexto sandboxado que bloqueia bind de porta TCP. Isso cria um problema de engenharia: a suite parece instavel quando, na pratica, o comportamento observado e uma restricao do ambiente, nao um bug do runtime.
|
||||
|
||||
Esta PR organiza esses testes para que continuem existindo, continuem sendo exigidos, mas sejam executados na pista correta.
|
||||
|
||||
## Problema
|
||||
|
||||
- testes de debugger que dependem de abrir porta TCP falham em ambientes com restricao de bind;
|
||||
- o comando de workspace pode acusar falso negativo quando rodado em sandbox local;
|
||||
- sem separacao de trilha, fica dificil distinguir:
|
||||
- falha real do debugger;
|
||||
- limitacao do ambiente de execucao;
|
||||
- regressao de CI.
|
||||
|
||||
## Alvo
|
||||
|
||||
- testes de `prometeu-host-desktop-winit` que abrem listener TCP;
|
||||
- fluxo de execucao de testes local e de CI;
|
||||
- documentacao de como rodar a suite completa com requisitos de ambiente.
|
||||
|
||||
## Escopo
|
||||
|
||||
- Identificar os testes realmente dependentes de socket.
|
||||
- Separar esses testes por estrategia clara, por exemplo:
|
||||
- suite dedicada;
|
||||
- `#[ignore]` com comando explicito de execucao;
|
||||
- gate por feature ou por condicao de ambiente;
|
||||
- job dedicado de CI fora de sandbox restritivo.
|
||||
- Preservar cobertura funcional do debugger.
|
||||
- Documentar a forma oficial de rodar esses testes.
|
||||
|
||||
## Fora de Escopo
|
||||
|
||||
- Reescrever o debugger para nao usar TCP.
|
||||
- Redesenhar o protocolo de debug.
|
||||
- Remover testes de integracao do debugger.
|
||||
- Introduzir heuristicas silenciosas que "engulam" falhas reais de rede.
|
||||
|
||||
## Abordagem
|
||||
|
||||
1. Catalogar os testes que fazem bind de porta e verificar se todos sao realmente de integracao.
|
||||
2. Escolher uma estrategia explicita de separacao, preferencialmente uma que mantenha os testes presentes no repo e visiveis na CI.
|
||||
3. Ajustar o comando ou job de CI para executar a suite correta no ambiente correto.
|
||||
4. Documentar localmente como um desenvolvedor deve rodar:
|
||||
- suite padrao;
|
||||
- suite completa com debugger/socket.
|
||||
|
||||
## Criterios de Aceite
|
||||
|
||||
- O fluxo padrao de testes nao produz falso negativo por restricao de socket do ambiente.
|
||||
- Os testes de debugger continuam existindo e continuam sendo executados em algum caminho oficial.
|
||||
- A documentacao deixa claro quando e onde a suite de socket deve rodar.
|
||||
- Falhas reais do debugger continuam visiveis e nao sao mascaradas por skip silencioso sem criterio.
|
||||
|
||||
## Tests
|
||||
|
||||
- Rodar o fluxo padrao de testes no ambiente comum do projeto.
|
||||
- Rodar explicitamente a suite de debugger/socket no ambiente habilitado para bind.
|
||||
- Validar que o job ou comando documentado realmente cobre os testes de reconexao, porta aberta, segunda conexao e resume apos disconnect.
|
||||
|
||||
## Risco
|
||||
|
||||
Medio. O risco principal e esconder regressao real atras de condicionais ambientais mal projetadas. A PR deve tratar ambiente como requisito explicito, nunca como desculpa para reduzir cobertura.
|
||||
Reference in New Issue
Block a user