saveourtool/save-cloud

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

Open

#1 132 ouverte le 1 sept. 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)Kotlin (4 forks)github user discovery
backlogenhancementgood first issuerefactoring

Métriques du dépôt

Stars
 (38 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez les classes DTO existantes (ExecutionDto, UserInfo) et leur utilisation dans les contextes de sérialisation. Étudiez comment appliquer @JsonIgnoreType aux classes @Entity et créez une règle detekt personnalisée pour imposer l'utilisation de DTO dans les méthodes de contrôleur.
Stack technique
kotlin
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
KotlinJPAserialization
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50