saveourtool/save-cloud

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

Open

#1132 aperta il 1 set 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Kotlin (4 fork)github user discovery
backlogenhancementgood first issuerefactoring

Metriche repository

Star
 (38 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina le classi DTO esistenti (ExecutionDto, UserInfo) e il loro utilizzo nei contesti di serializzazione. Indaga su come applicare @JsonIgnoreType alle classi @Entity e crea una regola detekt personalizzata per imporre l'uso di DTO nei metodi del controller.
Tech stack
kotlin
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
KotlinJPAserialization
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50