saveourtool/save-cloud

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

Open

#1,132 opened on Sep 1, 2022

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

Repository metrics

Stars
 (38 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Examine existing DTO classes (ExecutionDto, UserInfo) and their usage in serialization contexts. Investigate how @JsonIgnoreType can be applied to @Entity classes and create a custom detekt rule to enforce DTO usage in controller methods.
Tech stack
kotlin
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinJPAserialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50