✨ [Feature/vote] implement getting candidates API #78

linirini · 2025-03-24T18:32:56Z

#️⃣ 연관된 이슈

[FEATURE] 투표 후보 목록 조회 API #77

📝 작업 내용

이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

투표 후보지 목록을 조회하여 필요한 모든 정보를 응답으로 담아 전달합니다.
투표 후보지가 아직 등록되어 있지 않다면, 지하철역 추천 캐시로부터 목록을 조회해와 후보지 정보를 저장 후 반환합니다.

📸 스크린샷 (선택)

💬 리뷰 요구사항(선택)

pr 사이즈가 너무 커질 것이 우려되어 우선 후보지 등록 API 관련한 pr을 열었습니다.
이후 개발할 API에 필요하므로, 빠른 리뷰와 머지가 필요합니다..
고민 지점은 코멘트로 공유했습니다.
리팩터링 브랜치 머지하면서 충돌이 발생해서 파일 이동이 많이 섞여 있습니다. 작업 커밋만 모아보시려명 링크를 눌러주세요!

⚙️ [chore/develop] update .gitignore file

…ringBootTest for testing redis

…vote

linirini · 2025-03-24T18:34:22Z

...pi/src/main/java/com/kok/kokapi/station/adapter/out/persistence/RoutePersistenceAdapter.java

@@ -19,6 +18,7 @@
 @RequiredArgsConstructor
 public class RoutePersistenceAdapter implements SaveRoutePort, RetrieveRoutePort {

+    public static final List<String> ROUTE_ONE_LIST = List.of("경부선", "경인선", "경원선", "장항선");


1호선 네이밍 통일 관련 작업을 코드 레벨에 반영했습니다!

linirini · 2025-03-24T18:34:39Z

kok-api/src/main/java/com/kok/kokapi/station/application/service/StationService.java

@@ -153,4 +164,17 @@ private double calculateDistance(Point p1, Station station) {
        // 유클리드 거리 공식 적용
        return Math.sqrt(Math.pow(lat2 - lat1, 2) + Math.pow(lon2 - lon1, 2));
    }
+
+    @Override
+    @Cacheable(value = "recommendStations", cacheManager = "stationCacheManager", key = "#roomId")


캐시에서 지하철 추천 목록을 조회해옵니다.

이부분 저랑 좀 맞춰보죠!

linirini · 2025-03-24T18:35:22Z

kok-api/src/main/java/com/kok/kokapi/vote/adapter/in/dto/response/CandidateResponse.java

+        Station station,
+        List<Route> routes,
+        TmapPublicTransportationParsedResponse transportationParsedResponse,
+        List<CommentResponse> comments //comment 도메인 구현 시 List<Comment>로 교체


응답 정의를 위해 우선 CommentResponse를 생성하였습니다.
추후에 댓글 추가/조회 API가 구현된다면 해당 usecase를 사용하여 관련 응답을 반영 예정입니다.

linirini · 2025-03-24T18:36:56Z

kok-api/src/main/java/com/kok/kokapi/vote/adapter/in/dto/response/RouteResponse.java

+
+public record RouteResponse(
+    String name
+    //TODO: String color


이 부분이 고민됩니다.
호선 색깔 정보를 함께 반환해야하는데, 색깔 정보를 따로 DB에서 저장하지 않고 있다보니 Tmap API를 통해서만 색깔 정보를 조회할 수 있어요.
어떻게 처리하면 좋을지 두분의 의견이 필요합니다..ㅜㅜ

Git에서 리뷰할 때는 코드 스니펫만 보이고 전체 로직을 보기가 좀 힘들어서 그런데 공공데이터 API를 호출해서 저장한 DB에는 호선에 대한 색상 정보가 없고 Tmap API를 호출해서 호선 색상 정보를 받아와야해서 고민이신걸까요?
음,, 몇가지 방법이 떠오르는건

Tmap API를 호출하는 시점에서 호선 색깔 정보를 같이 캐싱하는 방법. 이렇게 하면 DB에도 별도 컬럼 추가할 필요도 없고 API 호출을 최소화할 수 있고 구현도 간단함. Spring 캐시 또는 Redis Cache 어떤 것이든 괜찮을 것 같아요.

DB에 컬럼을 추가하고 받아온 색상 정보를 DB에 업데이트하는 방법

지하철 색상 정보가 그렇게 변경되는 정보가 아니기 때문에 정적 파일 등으로 추가하고 반환하는 방법

등이 있을 것 같아요! 전체 로직은 봐야하겠지만 전 캐싱이 제일 좋을 것 같습니다 😄

호선색깔 필요없다고 하셨습니다 (디자이너 피셜)

linirini · 2025-03-24T18:38:28Z

kok-api/src/main/java/com/kok/kokapi/vote/adapter/out/persistence/VoteCommandRedisAdapter.java

+
+@Repository
+@RequiredArgsConstructor
+public class VoteCommandRedisAdapter implements SaveVotePort {


투표 결과를 저장하는 Adapter입니다! 해당 어댑터는 추후 투표 생성 API를 개발하면서 변경될 가능성이 높기 때문에 이번 pr에선 리뷰하지 않는 것을 권장합니다 ㅎㅎ

linirini · 2025-03-24T18:40:30Z

kok-api/src/test/java/com/kok/kokapi/station/application/service/StationServiceTest.java

@@ -39,4 +49,37 @@ void doesNotSaveStationsIfAlreadyExists() {
        // then
        assertThat(stationRepository.findAll()).hasSize(1);
    }
+
+    //TODO: 적절한 테스트 방법이 떠오르지 않아요.


그렇습니다...

yunyoung1819

리뷰 남겨놓았습니다 👍
PR 보니까 작업하신 부분이 많네요! 투표 API 구현하느라 고생하셨습니다. 😄

yunyoung1819 · 2025-03-26T15:13:33Z

kok-api/src/main/java/com/kok/kokapi/vote/adapter/in/dto/response/RouteResponse.java

+
+public record RouteResponse(
+    String name
+    //TODO: String color


Git에서 리뷰할 때는 코드 스니펫만 보이고 전체 로직을 보기가 좀 힘들어서 그런데 공공데이터 API를 호출해서 저장한 DB에는 호선에 대한 색상 정보가 없고 Tmap API를 호출해서 호선 색상 정보를 받아와야해서 고민이신걸까요?
음,, 몇가지 방법이 떠오르는건

Tmap API를 호출하는 시점에서 호선 색깔 정보를 같이 캐싱하는 방법. 이렇게 하면 DB에도 별도 컬럼 추가할 필요도 없고 API 호출을 최소화할 수 있고 구현도 간단함. Spring 캐시 또는 Redis Cache 어떤 것이든 괜찮을 것 같아요.

DB에 컬럼을 추가하고 받아온 색상 정보를 DB에 업데이트하는 방법

지하철 색상 정보가 그렇게 변경되는 정보가 아니기 때문에 정적 파일 등으로 추가하고 반환하는 방법

등이 있을 것 같아요! 전체 로직은 봐야하겠지만 전 캐싱이 제일 좋을 것 같습니다 😄

minseokey · 2025-03-27T08:44:27Z

kok-core/src/main/java/com/kok/kokcore/vote/domain/Candidate.java

이 Candidate는 Redis에서 보관중인 내용을 투표 시작 시점에 가져가서 저장하는 용도인가요?

맞아요! 투표 시작 시점을 명확하게 알 수 없기 때문에, 후보지 조회 서비스에서 존재하지 않는다면 캐시에서 값을 가져와서 저장하고, 캐시를 지우도록 구현했어요!

minseokey · 2025-03-27T08:53:42Z

kok-api/src/main/java/com/kok/kokapi/station/application/service/StationService.java

@@ -153,4 +164,17 @@ private double calculateDistance(Point p1, Station station) {
        // 유클리드 거리 공식 적용
        return Math.sqrt(Math.pow(lat2 - lat1, 2) + Math.pow(lon2 - lon1, 2));
    }
+
+    @Override
+    @Cacheable(value = "recommendStations", cacheManager = "stationCacheManager", key = "#roomId")


이부분 저랑 좀 맞춰보죠!

minseokey · 2025-03-27T08:54:09Z

kok-api/src/main/java/com/kok/kokapi/vote/adapter/in/dto/response/RouteResponse.java

+
+public record RouteResponse(
+    String name
+    //TODO: String color


호선색깔 필요없다고 하셨습니다 (디자이너 피셜)

minseokey · 2025-03-27T08:54:46Z

LGTM~~!

minseokey · 2025-03-29T05:55:29Z

kok-api/src/main/java/com/kok/kokapi/station/application/service/StationService.java

@@ -193,22 +187,10 @@ private double calculateDistance(Point p1, Station station) {
        return Math.sqrt(Math.pow(lat2 - lat1, 2) + Math.pow(lon2 - lon1, 2));
    }

-    @Override


좋습니다. 삭제로직은 급한거 아니니까 런칭 이후로 보시죠!

minseokey · 2025-03-29T05:56:40Z

확인 했습니다!

yunyoung1819

고생하셨습니다 👍

yunyoung1819 and others added 14 commits February 11, 2025 23:42

Merge pull request #24 from depromeet/develop

7f4dfe3

⚙️ [chore/develop] update .gitignore file

✨ feat: create domain for voting

96ca485

✅ test: create RedisDatabaseCleaner And change RepositoryTest into Sp…

e59015f

…ringBootTest for testing redis

🔧 config: fix ddl type error

9614e56

✨ feat: implement port for saving candidate

567cff1

✨ feat: implement port for saving votes

72276ea

✨ feat: implement port for loading candidates

b59d4cd

✨ feat: implement checking if candidates exists

df0ba6a

✨ feat: implement getting recommended stations from cache

5c44a26

Merge branch 'develop', remote-tracking branch 'origin' into feature/…

19511ac

…vote

♻️ refactor: move getting recommended stations from adapter to service

dc41579

❇️ feat: implement get candidate usecase

dee7f45

❇️ feat: implement get candidate Facade service and Controller

9da74b5

❇️ feat: add updating route names into "1호선"

d8b37e6

linirini added ✨ Feature new feature 🥇 Urgency 1 긴급도 높음 labels Mar 24, 2025

linirini added this to the 2차 MVP milestone Mar 24, 2025

linirini requested review from yunyoung1819 and minseokey March 24, 2025 18:32

linirini self-assigned this Mar 24, 2025

linirini linked an issue Mar 24, 2025 that may be closed by this pull request

[FEATURE] 투표 후보 목록 조회 API #77

Closed

4 tasks

linirini commented Mar 24, 2025

View reviewed changes

linirini added 3 commits March 26, 2025 00:17

❇️ feat: implement deleting cache of recommended Stations

15af6ff

❇️ feat: delete cached recommended stations after saving candidates

b1444c6

♻️ refactor: refactor key-format for candidate

bad648c

linirini added 3 commits March 26, 2025 09:35

Merge branch 'develop' into feature/vote

e70c739

Merge branch 'develop' into feature/vote

b659c98

♻️ refactor: merge conflict

d412b39

yunyoung1819 reviewed Mar 26, 2025

View reviewed changes

minseokey approved these changes Mar 27, 2025

View reviewed changes

linirini added 3 commits March 28, 2025 10:37

♻️ refactor: remove route response

76c3deb

Merge branch 'develop' into feature/vote

dcf9e4f

♻️ refactor: use Station Facade Service for finding candidates

2d40888

minseokey approved these changes Mar 29, 2025

View reviewed changes

yunyoung1819 approved these changes Mar 29, 2025

View reviewed changes

linirini merged commit bb3a9d8 into develop Mar 29, 2025
2 checks passed

linirini deleted the feature/vote branch March 29, 2025 06:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ [Feature/vote] implement getting candidates API #78

✨ [Feature/vote] implement getting candidates API #78

linirini commented Mar 24, 2025 •

edited

Loading

linirini Mar 24, 2025

linirini Mar 24, 2025

minseokey Mar 27, 2025

linirini Mar 24, 2025

linirini Mar 24, 2025

yunyoung1819 Mar 26, 2025

minseokey Mar 27, 2025

linirini Mar 24, 2025

linirini Mar 24, 2025

yunyoung1819 left a comment •

edited

Loading

yunyoung1819 Mar 26, 2025

minseokey Mar 27, 2025

linirini Mar 28, 2025

minseokey Mar 27, 2025

minseokey Mar 27, 2025

minseokey commented Mar 27, 2025

minseokey Mar 29, 2025

linirini Mar 29, 2025

minseokey commented Mar 29, 2025

yunyoung1819 left a comment

✨ [Feature/vote] implement getting candidates API #78

✨ [Feature/vote] implement getting candidates API #78

Conversation

linirini commented Mar 24, 2025 • edited Loading

#️⃣ 연관된 이슈

📝 작업 내용

📸 스크린샷 (선택)

💬 리뷰 요구사항(선택)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yunyoung1819 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minseokey commented Mar 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minseokey commented Mar 29, 2025

yunyoung1819 left a comment

Choose a reason for hiding this comment

linirini commented Mar 24, 2025 •

edited

Loading

yunyoung1819 left a comment •

edited

Loading