feat: 알림 읽음 처리 (#170)

m-a-king · web-flow · commit bed04c808e3b · 2024-12-07T20:41:55.000+09:00
* feat(ExceptionMessage): 알림 예외 메시지 추가

* refactor(NotificationQueryController): 컨트롤러 클래스 rename

* feat(NotificationQueryService): transaction readonly 설정

* feat(NotificationIdsRequestDto): 읽음 처리할 알림 아이디 리스트 요청 DTO 추가

* feat(NotificationRepository): 알림 아이디 기준 알림 조회 추가

- 1건, N건

* feat(NotificationCommandService): 읽음 처리 추가

- 1건, N건.
- 쪽지 수신자와 읽음 요청 유저 아이디 검증 추가.

* feat(NotificationCommandController): 읽음 처리 엔드포인트

- 1건, N건

* test(NotificationCommandService): 읽음 처리 테스트

* test(NotificationRepository): 알림 조회 테스트 추가

* style(개행): 잠재적 git 이슈 방지

* refactor: 코드 리뷰 테스트 수정

* fix: import 문제 해결
diff --git a/src/main/java/com/somemore/auth/controller/UserInfoQueryController.java b/src/main/java/com/somemore/auth/controller/UserInfoQueryController.java
@@ -11,7 +11,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import static com.somemore.global.exception.ExceptionMessage.INVALID_TOKEN;
+import static com.somemore.auth.jwt.exception.JwtErrorType.INVALID_TOKEN;
 
 @RestController
 @RequiredArgsConstructor
@@ -26,7 +26,7 @@ public ApiResponse<UserInfoResponseDto> getUserInfoBySCH() {
         String role = authentication.getAuthorities().stream()
                 .findFirst()
                 .map(GrantedAuthority::getAuthority)
-                .orElseThrow(() -> new BadRequestException(INVALID_TOKEN));
+                .orElseThrow(() -> new BadRequestException(INVALID_TOKEN.getMessage()));
 
         return ApiResponse.ok(200,
                 new UserInfoResponseDto(userId, role),
diff --git a/src/main/java/com/somemore/global/exception/ExceptionMessage.java b/src/main/java/com/somemore/global/exception/ExceptionMessage.java
@@ -8,7 +8,6 @@
 @Getter
 public enum ExceptionMessage {
 
-    INVALID_TOKEN("잘못된 엑세스 토큰입니다"),
     NOT_EXISTS_CENTER("존재하지 않는 기관입니다."),
     NOT_EXISTS_COMMUNITY_BOARD("존재하지 않는 게시글입니다."),
     UNAUTHORIZED_COMMUNITY_BOARD("해당 게시글에 권한이 없습니다."),
@@ -34,6 +33,8 @@ public enum ExceptionMessage {
     DUPLICATE_APPLICATION("이미 신청한 봉사 모집 공고입니다."),
     UNAUTHORIZED_VOLUNTEER_APPLY("해당 지원에 권한이 없습니다."),
     RECRUIT_BOARD_ALREADY_COMPLETED("이미 종료된 봉사 활동입니다."),
+    NOT_EXISTS_NOTIFICATION("존재하지 않는 알림입니다."),
+    UNAUTHORIZED_NOTIFICATION("해당 알림에 권한이 없습니다."),
     VOLUNTEER_APPLY_LIST_MISMATCH("봉사 지원 목록과 요청된 봉사 지원 목록이 일치하지 않습니다."),
     RECRUIT_BOARD_ID_MISMATCH("모든 봉사 신청이 동일한 모집글 ID를 가져야 합니다."),
 
diff --git a/src/main/java/com/somemore/notification/controller/NotificationCommandController.java b/src/main/java/com/somemore/notification/controller/NotificationCommandController.java
@@ -0,0 +1,49 @@
+package com.somemore.notification.controller;
+
+import com.somemore.auth.annotation.CurrentUser;
+import com.somemore.global.common.response.ApiResponse;
+import com.somemore.notification.dto.NotificationIdsRequestDto;
+import com.somemore.notification.usecase.NotificationCommandUseCase;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.security.access.annotation.Secured;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.UUID;
+
+@Tag(name = "Notification Command API", description = "알림 읽음 처리 API")
+@RequiredArgsConstructor
+@RequestMapping("/api/notification")
+@RestController
+public class NotificationCommandController {
+
+    private final NotificationCommandUseCase notificationCommandUseCase;
+
+    @Secured({"ROLE_VOLUNTEER", "ROLE_CENTER"})
+    @Operation(summary = "알림(1개) 읽음 처리", description = "알림 1개를 읽음 처리합니다.")
+    @PatchMapping("/read/{notificationId}")
+    public ApiResponse<String> markSingleNotification(
+            @CurrentUser UUID userId,
+            @PathVariable Long notificationId
+    ) {
+        notificationCommandUseCase.markSingleNotificationAsRead(userId, notificationId);
+        return ApiResponse.ok("알림 1개 읽음 처리 성공");
+    }
+
+    @Secured({"ROLE_VOLUNTEER", "ROLE_CENTER"})
+    @Operation(summary = "알림(N개) 읽음 처리", description = "알림 N개를 읽음 처리합니다.")
+    @PostMapping("/read/multiple")
+    public ApiResponse<String> markMultipleNotifications(
+            @CurrentUser UUID userId,
+            @RequestBody NotificationIdsRequestDto notificationIds
+    ) {
+        notificationCommandUseCase.markMultipleNotificationsAsRead(userId, notificationIds);
+        return ApiResponse.ok("알림 N개 읽음 처리 성공");
+    }
+}
diff --git a/src/main/java/com/somemore/notification/controller/NotificationQueryController.java b/src/main/java/com/somemore/notification/controller/NotificationQueryController.java
@@ -15,11 +15,11 @@
 import java.util.List;
 import java.util.UUID;
 
-@Tag(name = "Notification API", description = "알림 API")
+@Tag(name = "Notification Query API", description = "알림 조회 API")
 @RequiredArgsConstructor
 @RequestMapping("/api/notification")
 @RestController
-public class NotificationController {
+public class NotificationQueryController {
 
     private final NotificationQueryUseCase notificationQueryUseCase;
 
diff --git a/src/main/java/com/somemore/notification/dto/NotificationIdsRequestDto.java b/src/main/java/com/somemore/notification/dto/NotificationIdsRequestDto.java
@@ -0,0 +1,18 @@
+package com.somemore.notification.dto;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+
+import java.util.List;
+
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+@Builder
+public record NotificationIdsRequestDto(
+
+        @Schema(description = "읽음 처리할 알림 아이디 리스트",
+                example = "[1, 2, 3, 4, 5]")
+        List<Long> ids
+) {
+}
diff --git a/src/main/java/com/somemore/notification/repository/NotificationRepository.java b/src/main/java/com/somemore/notification/repository/NotificationRepository.java
@@ -4,13 +4,20 @@
 import org.springframework.stereotype.Repository;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 @Repository
 public interface NotificationRepository {
 
     Notification save(Notification notification);
 
+    Optional<Notification> findById(Long id);
+
+    List<Notification> findAllByIds(List<Long> ids);
+
     List<Notification> findByReceiverIdAndUnread(UUID userId);
     List<Notification> findByReceiverIdAndRead(UUID userId);
+
+    void deleteAllInBatch();
 }
diff --git a/src/main/java/com/somemore/notification/repository/NotificationRepositoryImpl.java b/src/main/java/com/somemore/notification/repository/NotificationRepositoryImpl.java
@@ -8,6 +8,7 @@
 import org.springframework.stereotype.Repository;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 @Repository
@@ -24,6 +25,16 @@ public Notification save(Notification notification) {
         return notificationJpaRepository.save(notification);
     }
 
+    @Override
+    public Optional<Notification> findById(Long id) {
+        return notificationJpaRepository.findById(id);
+    }
+
+    @Override
+    public List<Notification> findAllByIds(List<Long> ids) {
+        return notificationJpaRepository.findAllById(ids);
+    }
+
     @Override
     public List<Notification> findByReceiverIdAndUnread(UUID receiverId) {
         return queryFactory.selectFrom(notification)
@@ -40,6 +51,11 @@ public List<Notification> findByReceiverIdAndRead(UUID receiverId) {
                 .fetch();
     }
 
+    @Override
+    public void deleteAllInBatch() {
+        notificationJpaRepository.deleteAllInBatch();
+    }
+
     private static BooleanExpression eqReceiverId(UUID userId) {
         return notification.receiverId.eq(userId);
     }
diff --git a/src/main/java/com/somemore/notification/service/NotificationCommandService.java b/src/main/java/com/somemore/notification/service/NotificationCommandService.java
@@ -0,0 +1,53 @@
+package com.somemore.notification.service;
+
+import com.somemore.global.exception.BadRequestException;
+import com.somemore.notification.domain.Notification;
+import com.somemore.notification.dto.NotificationIdsRequestDto;
+import com.somemore.notification.repository.NotificationRepository;
+import com.somemore.notification.usecase.NotificationCommandUseCase;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.List;
+import java.util.UUID;
+
+import static com.somemore.global.exception.ExceptionMessage.NOT_EXISTS_NOTIFICATION;
+import static com.somemore.global.exception.ExceptionMessage.UNAUTHORIZED_NOTIFICATION;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+@Transactional
+public class NotificationCommandService implements NotificationCommandUseCase {
+
+    private final NotificationRepository notificationRepository;
+
+    @Override
+    public void markSingleNotificationAsRead(UUID userId, Long notificationId) {
+        Notification notification = notificationRepository.findById(notificationId)
+                .orElseThrow(() -> new BadRequestException(NOT_EXISTS_NOTIFICATION));
+
+        validateNotificationOwnership(userId, notification.getReceiverId());
+
+        notification.markAsRead();
+    }
+
+    @Override
+    public void markMultipleNotificationsAsRead(UUID userId, NotificationIdsRequestDto notificationIds) {
+        List<Notification> notifications = notificationRepository.findAllByIds(notificationIds.ids());
+
+        notifications.forEach(notification ->
+                validateNotificationOwnership(userId, notification.getReceiverId()));
+
+        notifications.forEach(Notification::markAsRead);
+    }
+
+    private void validateNotificationOwnership(UUID userId, UUID receiverId) {
+        if (!receiverId.equals(userId)) {
+            throw new BadRequestException(UNAUTHORIZED_NOTIFICATION);
+        }
+    }
+
+}
diff --git a/src/main/java/com/somemore/notification/service/NotificationQueryService.java b/src/main/java/com/somemore/notification/service/NotificationQueryService.java
@@ -7,13 +7,15 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
 
 import java.util.List;
 import java.util.UUID;
 
 @Slf4j
 @Service
 @RequiredArgsConstructor
+@Transactional(readOnly = true)
 public class NotificationQueryService implements NotificationQueryUseCase {
 
     private final NotificationRepository notificationRepository;
diff --git a/src/main/java/com/somemore/notification/usecase/NotificationCommandUseCase.java b/src/main/java/com/somemore/notification/usecase/NotificationCommandUseCase.java
@@ -0,0 +1,11 @@
+package com.somemore.notification.usecase;
+
+import com.somemore.notification.dto.NotificationIdsRequestDto;
+
+import java.util.UUID;
+
+public interface NotificationCommandUseCase {
+
+    void markSingleNotificationAsRead(UUID userId, Long notificationId);
+    void markMultipleNotificationsAsRead(UUID userId, NotificationIdsRequestDto notificationIds);
+}
diff --git a/src/test/java/com/somemore/notification/repository/NotificationRepositoryTest.java b/src/test/java/com/somemore/notification/repository/NotificationRepositoryTest.java
@@ -9,7 +9,9 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -22,29 +24,21 @@ class NotificationRepositoryTest extends IntegrationTestSupport {
 
     private UUID receiverId;
 
+    private List<Long> savedNotificationIds;
+
     @BeforeEach
     void setup() {
         receiverId = UUID.randomUUID();
+        savedNotificationIds = new ArrayList<>();
 
-        for (int i = 0; i < 10; i++) {
-            Notification unreadNotification = Notification.builder()
-                    .title("Unread Notification")
-                    .type(NotificationSubType.NOTE_BLAH_BLAH)
-                    .receiverId(receiverId)
-                    .relatedId(1L)
-                    .build();
-
-            Notification readNotification = Notification.builder()
-                    .title("Read Notification")
-                    .type(NotificationSubType.REVIEW_BLAH_BLAH)
-                    .receiverId(receiverId)
-                    .relatedId(2L)
-                    .build();
-
-            readNotification.markAsRead();
+        for (long i = 1; i <= 10; i++) {
+            Notification unreadNotification = createNotification(i, false);
+            Notification readNotification = createNotification(i * 100, true);
 
             notificationRepository.save(unreadNotification);
             notificationRepository.save(readNotification);
+
+            savedNotificationIds.add(unreadNotification.getId()); // 저장된 ID 캡처
         }
     }
 
@@ -56,7 +50,6 @@ void findByReceiverIdAndUnread() {
 
         // then
         assertThat(notifications).hasSize(10);
-        assertThat(notifications.getFirst().getTitle()).isEqualTo("Unread Notification");
         assertThat(notifications.getFirst().isRead()).isFalse();
     }
 
@@ -68,7 +61,6 @@ void findByReceiverIdAndRead() {
 
         // then
         assertThat(notifications).hasSize(10);
-        assertThat(notifications.getFirst().getTitle()).isEqualTo("Read Notification");
         assertThat(notifications.getFirst().isRead()).isTrue();
     }
 
@@ -85,16 +77,41 @@ void findByReceiverIdAndUnread_noNotifications() {
         assertThat(notifications).isEmpty();
     }
 
+    @DisplayName("알림 아이디로 알림을 조회한다.")
+    @Test
+    void findById() {
+        // given
+        // when
+        Optional<Notification> notifications = notificationRepository.findById(savedNotificationIds.getFirst());
+
+        // then
+        assertThat(notifications).isNotEmpty();
+    }
+
     @DisplayName("알림이 없는 사용자의 읽은 알림을 조회하면 빈 리스트를 반환한다.")
     @Test
-    void findByReceiverIdAndRead_noNotifications() {
+    void findAllByIds() {
         // given
-        UUID unknownReceiverId = UUID.randomUUID();
+        notificationRepository.deleteAllInBatch();
 
         // when
-        List<Notification> notifications = notificationRepository.findByReceiverIdAndRead(unknownReceiverId);
+        List<Notification> notifications = notificationRepository.findAllByIds(savedNotificationIds);
 
         // then
         assertThat(notifications).isEmpty();
     }
+
+    private Notification createNotification(long i, boolean isRead) {
+        Notification notification = Notification.builder()
+                .title("Notification")
+                .type(NotificationSubType.NOTE_BLAH_BLAH)
+                .receiverId(receiverId)
+                .relatedId(i + 1)
+                .build();
+
+        if (isRead) {
+            notification.markAsRead();
+        }
+        return notification;
+    }
 }
diff --git a/src/test/java/com/somemore/notification/service/NotificationCommandServiceTest.java b/src/test/java/com/somemore/notification/service/NotificationCommandServiceTest.java
