saveourtool/save-cloud

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

Open

#1.132 geöffnet am 1. Sept. 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Kotlin (4 Forks)github user discovery
backlogenhancementgood first issuerefactoring

Repository-Metriken

Stars
 (38 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuchen Sie die vorhandenen DTO Klassen (ExecutionDto, UserInfo) und deren Verwendung in Serialisierungskontexten. Forschen Sie, wie @JsonIgnoreType auf @Entity Klassen angewendet werden kann, und erstellen Sie eine benutzerdefinierte detekt Regel, um die Verwendung von DTOs in Controller Methoden zu erzwingen.
Tech Stack
kotlin
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
KotlinJPAserialization
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50