Backend - Refatoracao

[rafael-ventura]

Backend - Refatoração

Objetivo

Refatorar o backend para melhorar legibilidade, reduzir linhas de código, organizar melhor as pastas e aplicar princípios de Clean Architecture. Além disso, identificar pontos de melhoria e propor soluções que aumentem a eficiência do projeto, garantindo uma estrutura escalável e sustentável.

---

Definições

Contexto Atual:

• O projeto apresenta boas práticas básicas, mas a estrutura das pastas e a organização dos arquivos não refletem adequadamente os princípios de Clean Architecture.
• As responsabilidades estão misturadas entre camadas (Application, Domain, Infrastructure, WebAPI), e alguns controllers têm lógicas que deveriam ser transferidas para serviços ou use cases.
• Há repetição de código em validações e tratamento de erros.
• A lógica de autenticação e middleware pode ser simplificada para maior reuso.

Definições de Melhoria:

• Transformar Application em UseCases para melhor clareza e granularidade de casos de uso.
• Separar melhor as responsabilidades das camadas:
  • API: Rotas, middlewares e controllers.
  • UseCases: Lógica específica de cada caso de uso (um método/endpoint por arquivo, seguindo princípios de Single Responsibility).
  • Domain: Entidades, enums e interfaces.
  • Infrastructure: Implementações de repositórios, serviços de banco de dados, autenticação, envio de email, etc.
• Criar DTOs (Data Transfer Objects) para padronizar entradas e saídas:
  • Input DTOs: Representam os dados de entrada esperados pelos UseCases.
  • Output DTOs: Representam os dados de saída formatados para resposta.
  • Os DTOs serão organizados por entidade, em uma pasta Domain/DTOs/{Entidade}.
• Implementar tratamento de erros centralizado com códigos de status consistentes.
• Organizar arquivos grandes, como ViaService, separando funções em casos de uso específicos (por exemplo, CriarVia, AtualizarVia).
• Padronizar o idioma dos arquivos e métodos para português.

---

Wireframe (Modelo a seguir por enquanto)

A estrutura proposta para pastas será:

src/ ├── Application/ │ └── UseCases/ │ ├── Via/ │ │ ├── CriarVia.ts │ │ ├── AtualizarVia.ts │ │ ├── ExcluirVia.ts │ │ └── ... │ ├── Croqui/ │ │ ├── CriarCroqui.ts │ │ ├── AtualizarCroqui.ts │ │ └── ... │ └── ... ├── Domain/ │ ├── Entities/ │ │ ├── Via.ts │ │ ├── Montanha.ts │ │ └── ... │ ├── DTOs/ │ │ ├── Via/ │ │ │ ├── ViaInput.ts │ │ │ └── ViaOutput.ts │ │ ├── Croqui/ │ │ │ ├── CroquiInput.ts │ │ │ └── CroquiOutput.ts │ │ └── ... │ ├── Interfaces/ │ ├── Enums/ │ └── Errors/ ├── Infrastructure/ │ ├── Repositories/ │ │ ├── ViaRepository.ts │ │ ├── CroquiRepository.ts │ │ └── ... │ ├── Services/ │ │ ├── AuthService.ts │ │ ├── EmailService.ts │ │ └── ... │ └── Config/ │ ├── db.ts │ └── environment.ts

---

Passos

1. Reorganizar a Estrutura de Pastas:

   • [ ] Mover arquivos do diretório Application para o novo diretório UseCases, criando subpastas organizadas por entidade.
   • [ ] Padronizar o idioma de arquivos e métodos para português (e.g., CreateVia → CriarVia).
   • [ ] Alterar o nome da pasta WebAPI para API.

2. Implementar DTOs:

   • [ ] Criar uma pasta Domain/DTOs para armazenar os DTOs.
   • [ ] Criar Input e Output DTOs para cada entidade (e.g., ViaInput, ViaOutput).
   • [ ] Atualizar os UseCases para usar os DTOs em vez de objetos genéricos.

3. Refatorar os Controllers:

   • [ ] Transferir toda lógica de negócio dos controllers para os UseCases correspondentes.
   • [ ] Utilizar os serviços como intermediários para delegar responsabilidade de acesso a dados.

4. Criar Validações Reutilizáveis:

   • [ ] Implementar bibliotecas como Joi ou Zod para centralizar a lógica de validação.
   • [ ] Substituir validações manuais no código por chamadas à camada de validação.

5. Centralizar Tratamento de Erros:

   • [ ] Refatorar a classe HandleErrors para ser utilizada em toda a aplicação.
   • [ ] Substituir os blocos try-catch repetidos nos controllers pelo middleware de erros centralizado.

6. Simplificar Middlewares:

   • [ ] Refatorar o middleware de autenticação para ser mais modular e reutilizável.
   • [ ] Consolidar a lógica de verificação de token no AuthenticateMiddleware.

7. Reduzir Tamanho de Serviços:

   • [ ] Quebrar serviços grandes como ViaService em casos de uso menores e isolados.
   • [ ] Garantir que cada serviço respeite o princípio da responsabilidade única.

8. Refatorar Repositórios:

   • [ ] Garantir que os repositórios tenham métodos genéricos reutilizáveis onde aplicável.
   • [ ] Simplificar consultas SQL no ViaRepository.

9. Adicionar Testes Automatizados:

   • [ ] Garantir cobertura mínima para todas as novas funções.
   • [ ] Implementar testes para os casos de uso recém-criados.

---

Links de Referência

• Clean Architecture by Uncle Bob (Artigo original)
• Clean Architecture na Prática com Node.js (Prático e detalhado)
• Layered Architecture Explained (Conceito de camadas por Martin Fowler)

[rafael-ventura]

Podemos revisar se faz sentido