saveourtool/save-cloud

Don't use `@Entity`s directly for (de)serialization, use DTOs instead

Open

#1.132 aberto em 1 de set. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (1 assignee)Kotlin (4 forks)github user discovery
backlogenhancementgood first issuerefactoring

Métricas do repositório

Stars
 (38 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Certain classes can be marked as opted-out of serialization (maybe @JsonIgnoreType?) and their usages in transport replaced with

  • Execution -> ExecutionDto
  • User -> UserInfo (consider #1130 as an example of why this is needed)

Another idea would be to create a custom detekt rule that would check that

  • methods annotated with various @...Mapping return not-@Entity class or Mono
  • bodyValue(), ObjectMapper.writeValue etc. are used with not-@Entity classes

Guia do colaborador

Direção de pesquisa
Examine as classes DTO existentes (ExecutionDto, UserInfo) e seu uso em contextos de serialização. Investigue como aplicar @JsonIgnoreType às classes @Entity e crie uma regra detekt personalizada para forçar o uso de DTOs em métodos de controller.
Pilha de tecnologia
kotlin
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
KotlinJPAserialization
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50