신고조치알림 관련 기능 구현 #756

aiaiaiai1 · 2023-10-16T13:05:41Z

🔥 연관 이슈

close: #744

📝 작업 요약

간지나는 ReportActionAlarm 기능을 구현했습니다.

⏰ 소요 시간

10시간? - api명세서 및 테이블 변경으로 인해 시간 소요

🔎 작업 상세 설명

신고조치알림 목록 조회 기능 구현
신고조치알림 상세 조회 기능 구현
게시글 상세조회 추가 요구사항 적용

작성자는 블라인드된 게시글을 조회 할 수있 다.
하지만 투표 결과는 확인 할 수 없다.

🌟 논의 사항

중간에 변동사항들이 있어서 커밋이 지저분 해졌는데 미리 죄송합니다 😭
하지만 작업 내용은 간단합니다 😮

github-actions · 2023-10-16T13:08:04Z

Test Results

378 tests 378 ✔️ 27s ⏱️
118 suites     0 💤
118 files     0 ❌

Results for commit 2f30127.

♻️ This comment has been updated with latest results.

- 작성자는 블라인드된 게시글을 조회할수 있다. - 하지만 블라인드된 게시글의 투표결과는 확인 할 수 없다.

woo-chang

안녕하세요 루쿠 ㅎㅎ 다즐입니다

빠르고 깔끔하게 구현 잘 해주셨네요 👍
몇 가지 소소한 커멘트 남겨두었으니 확인해주시면 감사합니다 :)

woo-chang · 2023-10-16T16:42:49Z

backend/src/main/java/com/votogether/domain/alarm/entity/ReportActionAlarm.java

+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @ManyToOne


fetch 타입 설정이 필요해 보여요 !

빼먹었네요! 감사합니다~

woo-chang · 2023-10-16T16:44:22Z

backend/src/main/java/com/votogether/domain/alarm/entity/ReportActionAlarm.java

+    private boolean isChecked;
+
+    @Builder
+    public ReportActionAlarm(


빌더 생성자는 일관성 있게 private로 설정하는게 어떨까요?

수정했습니다!

woo-chang · 2023-10-16T16:45:12Z

backend/src/main/java/com/votogether/domain/alarm/entity/ReportToAction.java

+@Getter
+@EqualsAndHashCode(of = {"id"}, callSuper = false)
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class ReportToAction extends BaseEntity {


ERD에서 해당 도메인이 삭제된 것으로 이해했는데 맞을까요?

네 맞아요 삭제해두었씁니다

woo-chang · 2023-10-16T16:46:17Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmController.java

+@Validated
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/alarms")


@Validated @RequiredArgsConstructor @RequestMapping("/alarms") @RestController

다른 컨트롤러와 일관성있게 순서를 맞춰주면 감사합니다 :)

woo-chang · 2023-10-16T16:47:15Z

backend/src/main/java/com/votogether/domain/alarm/dto/ReportActionAlarmResponse.java

+public record ReportActionAlarmResponse(
+
+        @Schema(description = "알림 ID", example = "1")


불필요한 공백 발견 👀

woo-chang · 2023-10-16T16:53:21Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmController.java

+            @Auth final Member member
+    ) {
+        final ReportActionResponse response = alarmService.getReportActionAlarm(reportActionAlarmId, member);
+        return ResponseEntity.ok().body(response);


woo-chang · 2023-10-16T16:54:34Z

backend/src/main/java/com/votogether/domain/alarm/service/AlarmService.java

+
+    public ReportActionResponse getReportActionAlarm(final Long reportActionAlarmId, final Member member) {
+        final ReportActionAlarm reportActionAlarm = reportActionAlarmRepository
+                .findByIdAndMember(reportActionAlarmId, member)


id로 찾게되면 member없이도 항상 id를 통해서만 조회되지 않을까요?

member를 추가적으로 찾는 조건으로 넣은 이유가 궁금해요 🤓

api요청으로 사용자가 다른 사용자의 알림을 조회 하는 경우를 막기위해 member조건을 추가해주었습니다!

와 전혀 생각지도 못한 부분인데 꼼꼼하게 구현해주셨네요 대박 배워갑니다 👍👍

이 코멘트를 보고 궁금한 점이 생겼는데 다른 사용자의 알림이 의도적으로 조회가 가능한가요?

백엔드서버로 직접 api를 알림id만 바꾸어 쏘면 조회가 가능할거같아요

woo-chang · 2023-10-16T16:56:34Z

backend/src/main/java/com/votogether/domain/alarm/exception/ReportActionAlarmExceptionType.java

+    }
+}


개행 발견 👀

woo-chang · 2023-10-16T16:57:03Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmControllerDocs.java

+    );
+
+}
+
+


이상한 개행이 있어요 🥲

개행 빌런이였네요 ㅋㅋ

woo-chang · 2023-10-16T16:58:40Z

backend/src/main/java/com/votogether/domain/post/service/PostQueryService.java


+        if (post.isWriter(loginMember) && post.isHidden()) {


tjdtls690

루쿠 고생하셨어요!
몇 가지 리뷰 남겼습니다 :)

tjdtls690 · 2023-10-17T05:09:32Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmController.java

+
+    @RequestMapping("/report")
+    public ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
+            @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,


@RequestParam 는 생략해도 될 것 같아요 :)

다른 컨트롤러에서는 @RequestParam을 생략하지 않고 명시해두어서 여기서도 따로 생략하지는 않았습니다!

생각해보니 다 붙이고 있었네요...ㅋㅋ

tjdtls690 · 2023-10-17T05:10:42Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmController.java

+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/alarms")
+public class AlarmController implements AlarmControllerDocs {


조회에 관한 API만 존재하니 AlarmController -> AlarmCommandController 로 바꿔야 할 것 같아요.

tjdtls690 · 2023-10-17T05:14:47Z

backend/src/main/java/com/votogether/domain/alarm/service/AlarmService.java

+    private final ReportActionAlarmRepository reportActionAlarmRepository;
+
+    public List<ReportActionAlarmResponse> getReportActionAlarms(final Member member, final int page) {
+        final PageRequest pageRequest = PageRequest.of(page, 10, Sort.by(Sort.Direction.DESC, "createdAt"));


일관성과 가독성을 위해서 10을

private static final int BASIC_PAGE_SIZE = 10;

이렇게 상수화 해주는 것은 어떨까요.

tjdtls690 · 2023-10-17T05:16:19Z

backend/src/main/java/com/votogether/domain/alarm/dto/ReportActionAlarmResponse.java

+
+        @Schema(description = "신고조치 세부정보")
+        ReportActionResponse detail
+


위에 다즐도 적어주셨지만, record의 파라미터 적는 곳에선 앞 뒤 공백이 없어야 하는 것으로 알고 있습니다 :)

tjdtls690 · 2023-10-17T05:28:13Z

backend/src/main/java/com/votogether/domain/post/service/PostQueryService.java

+        if (post.isWriter(loginMember) && post.isHidden()) {
+            return PostResponse.ofUser(
+                    loginMember,
+                    post,
+                    postCategoryRepository.findAllByPost(post),
+                    post.getFirstContentImage(),
+                    post.getPostOptions(),
+                    voteRepository.findByMemberAndPostOptionPost(loginMember, post)
+            );
+        }
+
+        validateHiddenPost(post);
        return PostResponse.ofUser(
                loginMember,
                post,


return PostResponse.ofUser( loginMember, post, postCategoryRepository.findAllByPost(post), post.getFirstContentImage(), post.getPostOptions(), voteRepository.findByMemberAndPostOptionPost(loginMember, post) );

이 부분이 완전히 바로 밑에 return문과 중복되는 것으로 보여서 따로 메서드로 빼는 것은 어떨까요??

보니까 PostQueryService의 가장 밑에 있는 메서드인 convertToResponses 에서도 위의 return문과 완전 똑같은 로직이 존재하는데, 그거까지 같이 처리할 겸, 위 return문을 메서드로 분리해 보는 것이 좋을 것 같아요 :)

메서드 추출해서 중복 제거해보았습니다 훨씬 깔끔해졌네요 ㅎㅎ

woo-chang

생각지도 못한 부분에서 예외가 발생할 수 있다는 점을 배워갈 수 있었습니다 👍

잘 구현해주셔서 approve 하도록 할께요 ㅎㅎ 수고하셨습니다 :)

tjdtls690

역시 ㅡ 쿠 ㅡ
꼼꼼한 테스트 코드와 유효성 검증이 좋았습니다 ㅎ

jeomxon

멋지게 구현해주셨네요!
사소한 궁금증 코멘트로 남겨보았습니다 :)

jeomxon · 2023-10-17T07:23:19Z

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmCommandController.java

+    @RequestMapping("/report")
+    public ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
+            @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,
+            @Auth final Member member


P2
일관성 있게 loginMember로 변경하는 것이 좋아보입니다.

jeomxon · 2023-10-17T07:27:07Z

backend/src/main/java/com/votogether/domain/alarm/service/AlarmService.java

+        final PageRequest pageRequest = PageRequest.of(page, BASIC_PAGE_SIZE,
+                Sort.by(Sort.Direction.DESC, "createdAt"));
+        final List<ReportActionAlarm> reportActionAlarms = reportActionAlarmRepository
+                .findByMember(member, pageRequest);


Q
Repository에 메서드명에 orderBy로 날짜 정렬을 하는 것과 Pageable을 통해서 정렬하는 방식의 차이는 무엇인가요?

이런방법이...! JPA 학습 부족입니다 ㅎㅎ

jeomxon · 2023-10-17T07:28:12Z

backend/src/main/java/com/votogether/domain/alarm/service/AlarmService.java

+
+    public ReportActionResponse getReportActionAlarm(final Long reportActionAlarmId, final Member member) {
+        final ReportActionAlarm reportActionAlarm = reportActionAlarmRepository
+                .findByIdAndMember(reportActionAlarmId, member)


이 코멘트를 보고 궁금한 점이 생겼는데 다른 사용자의 알림이 의도적으로 조회가 가능한가요?

jeomxon · 2023-10-17T07:29:18Z

backend/src/test/java/com/votogether/domain/alarm/controller/AlarmCommandControllerTest.java

+
+        // when
+        List<ReportActionAlarmResponse> results = RestAssuredMockMvc
+                .when().get("/alarms/report?page=0")


P2
queryParam()을 사용해볼 수 있을 것 같아요.

감사합니다~

jeomxon · 2023-10-17T07:30:17Z

backend/src/test/java/com/votogether/domain/alarm/controller/AlarmCommandControllerTest.java

+                .then().log().all()
+                .status(HttpStatus.OK)
+                .extract()
+                .as(new ParameterizedTypeReference<List<ReportActionAlarmResponse>>() {


Q
TypeRef를 사용할 수도 있지 않나요? 어떤 차이가 있나요?

간단한 방식이 있었네요!
저도 궁금해서 지피티에 물어보니 TypeRef는 RestAssured 라이브러리에서 제공되고
ParameterizedTypeReference는 Spring Framework에서 제공된다고 하네요

aiaiaiai1 added 13 commits October 14, 2023 22:56

feat: (#744) 테이블 엔티티 생성

dcb37f6

feat: (#744) 신고조치알림목록 조회 api 구현

e16c998

test: (#744) 테스트코드 추가

4a17eea

refactor: (#744) 메서드명 수정

3e44754

refactor: (#744) 코드 리포맷팅

873c036

refactor: (#744) api 명세 수정으로 인한 dto 수정

510929c

feat: (#744) 신고조치알림 상세조회 api 구현

5c29ee3

test: (#744) 리파지터리 테스트 추가

cbc6a77

fix: (#744) list set으로 수정

3bc198f

refactor: (#744) dto 필드명 수정

8aa93bb

refactor: (#744) 테이블 삭제 및 컬럼추가로 인한 수정사항 변경

16a4b72

test: (#744) 컨트롤러 테스트 추가

684e4bb

refactor: (#744) 예외 변환

4468b95

aiaiaiai1 added 2 commits October 16, 2023 23:10

feat: (#744) swagger 추가

ae0a76a

feat: (#744) 게시글 조회 추가된 요구사항 적용

a479894

- 작성자는 블라인드된 게시글을 조회할수 있다. - 하지만 블라인드된 게시글의 투표결과는 확인 할 수 없다.

aiaiaiai1 changed the title ~~Feat/#744~~ 신고조치알림 관련 기능 구현 Oct 16, 2023

aiaiaiai1 requested review from jeomxon, woo-chang and tjdtls690 October 16, 2023 14:49

aiaiaiai1 self-assigned this Oct 16, 2023

aiaiaiai1 added BE 🐾 개발 🚨 우선 순위 높음 labels Oct 16, 2023

aiaiaiai1 added this to the 6차 데모데이 milestone Oct 16, 2023

woo-chang requested changes Oct 16, 2023

View reviewed changes

tjdtls690 requested changes Oct 17, 2023

View reviewed changes

aiaiaiai1 added 3 commits October 17, 2023 14:50

refactor: (#744) 개행 정리 및 컨벤션 적용

e3024ef

refactor: (#744) 트랜잭션 어노테이션 및 fetch 타입 설정

be9dc76

refactor: (#744) swagger 어노테이션 추가

50a23c4

aiaiaiai1 added 4 commits October 17, 2023 14:57

refactor: (#744) 테이블 삭제로 인한 엔티티 삭제

7a43d49

refactor: (#744) 응답 방식 수정

b63e1df

refactor: (#744) 클래스 이름 수정 및 상수화

34c90f2

refactor: (#744) 메서드 추출로 중복 제거

2f30127

woo-chang approved these changes Oct 17, 2023

View reviewed changes

tjdtls690 approved these changes Oct 17, 2023

View reviewed changes

aiaiaiai1 merged commit 103b90c into dev Oct 17, 2023
3 checks passed

tjdtls690 deleted the feat/#744 branch October 17, 2023 07:10

jeomxon reviewed Oct 17, 2023

View reviewed changes

aiaiaiai1 mentioned this pull request Oct 18, 2023

커넥션풀 관련 설정 추가 + 회원탈퇴시 fk 관련 삭제 로직 추가 #784

Merged

		public record ReportActionAlarmResponse(

		@Schema(description = "알림 ID", example = "1")


		@Schema(description = "신고조치 세부정보")
		ReportActionResponse detail

신고조치알림 관련 기능 구현 #756

신고조치알림 관련 기능 구현 #756

Conversation

aiaiaiai1 commented Oct 16, 2023 • edited Loading

🔥 연관 이슈

📝 작업 요약

⏰ 소요 시간

🔎 작업 상세 설명

🌟 논의 사항

github-actions bot commented Oct 16, 2023 • edited Loading

Test Results

woo-chang left a 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

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

aiaiaiai1 Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tjdtls690 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aiaiaiai1 Oct 17, 2023 • 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

woo-chang left a comment

Choose a reason for hiding this comment

tjdtls690 left a comment • edited Loading

Choose a reason for hiding this comment

jeomxon left a 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

Choose a reason for hiding this comment

aiaiaiai1 commented Oct 16, 2023 •

edited

Loading

github-actions bot commented Oct 16, 2023 •

edited

Loading

aiaiaiai1 Oct 17, 2023 •

edited

Loading

aiaiaiai1 Oct 17, 2023 •

edited

Loading

tjdtls690 left a comment •

edited

Loading