Merge pull request #89 from TaskFlow-CLAP/clap-64

CLAP-64 알림 목록 조회 API 구현

Author: starboxxxx

src/main/java/clap/server/adapter/inbound/web/dto/notification/FindNotificationListResponse.java

@@ -0,0 +1,26 @@
+package clap.server.adapter.inbound.web.dto.notification;
+
+
+import clap.server.adapter.outbound.persistense.entity.notification.constant.NotificationType;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import java.time.LocalDateTime;
+
+public record FindNotificationListResponse(
+        @Schema(description = "알림 고유 ID", example = "1")
+        Long notificationId,
+        @Schema(description = "알림에 해당하는 작업 고유 ID", example = "1")
+        Long taskId,
+        @Schema(description = "알림 유형", example = "COMMENT or TASK_REQUESTED or STATUS_SWITCHED or " +
+                                                    "PROCESSOR_ASSIGNED or PROCESSOR_CHANGED")
+        NotificationType notificationType,
+        @Schema(description = "알림 받는 회원 고유 ID", example = "1")
+        Long receiverId,
+        @Schema(description = "알림 제목", example = "VM 생성해주세요")
+        String taskTitle,
+        @Schema(description = "알림 내용", example = "진행 중 or 담당자 이름 등등")
+        String message,
+        @Schema(description = "알림 생성 시간", example = "2025-01-24 14:58")
+        LocalDateTime createdAt
+) {
+}

src/main/java/clap/server/adapter/inbound/web/notification/FindNotificationController.java

@@ -0,0 +1,44 @@
+package clap.server.adapter.inbound.web.notification;
+
+import clap.server.adapter.inbound.security.SecurityUserDetails;
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import clap.server.application.port.inbound.notification.FindNotificationListUsecase;
+import clap.server.common.annotation.architecture.WebAdapter;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Pageable;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "알림 관리 - 조회")
+@WebAdapter
+@RestController
+@RequestMapping("/api/notifications")
+@RequiredArgsConstructor
+public class FindNotificationController {
+
+    private final FindNotificationListUsecase findNotificationListUsecase;
+
+    @Operation(summary = "알림 목록 조회 API")
+    @Parameters({
+            @Parameter(name = "page", description = "조회할 목록 페이지 번호(0부터 시작)", example = "0", required = false),
+            @Parameter(name = "size", description = "조회할 목록 페이지 당 개수", example = "5", required = false)
+    })
+    @GetMapping
+    public ResponseEntity<Page<FindNotificationListResponse>> findNotificationList(
+            @AuthenticationPrincipal SecurityUserDetails securityUserDetails,
+            @RequestParam(defaultValue = "0") int page,
+            @RequestParam(defaultValue = "5") int size) {
+        Pageable pageable = PageRequest.of(page, size);
+        return ResponseEntity.ok(findNotificationListUsecase.findNotificationList(securityUserDetails.getUserId(), pageable));
+    }
+}

src/main/java/clap/server/adapter/outbound/persistense/NotificationPersistenceAdapter.java

@@ -0,0 +1,28 @@
+package clap.server.adapter.outbound.persistense;
+
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import clap.server.adapter.outbound.persistense.mapper.NotificationPersistenceMapper;
+import clap.server.adapter.outbound.persistense.repository.notification.NotificationRepository;
+import clap.server.application.mapper.NotificationMapper;
+import clap.server.application.port.outbound.notification.LoadNotificationPort;
+import clap.server.common.annotation.architecture.PersistenceAdapter;
+import clap.server.domain.model.notification.Notification;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
+@PersistenceAdapter
+@RequiredArgsConstructor
+public class NotificationPersistenceAdapter implements LoadNotificationPort {
+
+    private final NotificationRepository notificationRepository;
+    private final NotificationPersistenceMapper notificationPersistenceMapper;
+
+
+    @Override
+    public Page<FindNotificationListResponse> findAllByReceiverId(Long receiverId, Pageable pageable) {
+        Page<Notification> notificationList = notificationRepository.findAllByReceiver_MemberId(receiverId, pageable)
+                .map(notificationPersistenceMapper::toDomain);
+        return notificationList.map(NotificationMapper::toFindNoticeListResponse);
+    }
+}

src/main/java/clap/server/adapter/outbound/persistense/mapper/NotificationPersistenceMapper.java

@@ -0,0 +1,18 @@
+package clap.server.adapter.outbound.persistense.mapper;
+
+import clap.server.adapter.outbound.persistense.entity.notification.NotificationEntity;
+import clap.server.adapter.outbound.persistense.mapper.common.PersistenceMapper;
+import clap.server.domain.model.notification.Notification;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+
+@Mapper(componentModel = "spring", uses = {TaskPersistenceMapper.class, MemberPersistenceMapper.class})
+public interface NotificationPersistenceMapper extends PersistenceMapper<NotificationEntity, Notification> {
+    @Override
+    @Mapping(source = "read", target = "isRead")
+    Notification toDomain(final NotificationEntity entity);
+
+    @Override
+    @Mapping(source = "read", target = "isRead")
+    NotificationEntity toEntity(final Notification notification);
+}

src/main/java/clap/server/adapter/outbound/persistense/repository/notification/NotificationRepository.java

@@ -1,9 +1,14 @@
 package clap.server.adapter.outbound.persistense.repository.notification;
 
 import clap.server.adapter.outbound.persistense.entity.notification.NotificationEntity;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
+
 @Repository
 public interface NotificationRepository extends JpaRepository<NotificationEntity, Long> {
+
+    Page<NotificationEntity> findAllByReceiver_MemberId(Long receiverId, Pageable pageable);
 }

src/main/java/clap/server/application/mapper/NotificationMapper.java

@@ -0,0 +1,20 @@
+package clap.server.application.mapper;
+
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import clap.server.domain.model.notification.Notification;
+
+public class NotificationMapper {
+    private NotificationMapper() {throw  new IllegalArgumentException();}
+
+    public static FindNotificationListResponse toFindNoticeListResponse(Notification notification) {
+        return new FindNotificationListResponse(
+                notification.getNotificationId(),
+                notification.getTask().getTaskId(),
+                notification.getType(),
+                notification.getReceiver().getMemberId(),
+                notification.getTask().getTitle(),
+                notification.getMessage() != null ? notification.getMessage() : null,
+                notification.getCreatedAt()
+        );
+    }
+}

src/main/java/clap/server/application/port/inbound/notification/FindNotificationListUsecase.java

@@ -0,0 +1,9 @@
+package clap.server.application.port.inbound.notification;
+
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
+public interface FindNotificationListUsecase {
+    Page<FindNotificationListResponse> findNotificationList(Long receiverId, Pageable pageable);
+}

src/main/java/clap/server/application/port/outbound/notification/LoadNotificationPort.java

@@ -1,8 +1,10 @@
 package clap.server.application.port.outbound.notification;
 
-import clap.server.domain.model.notification.Notification;
-import java.util.Optional;
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
 
 public interface LoadNotificationPort {
-    Optional<Notification> findById(Long id);
+    Page<FindNotificationListResponse> findAllByReceiverId(Long receiverId, Pageable pageable);
 }

src/main/java/clap/server/application/service/notification/FindNotificationListService.java

@@ -0,0 +1,24 @@
+package clap.server.application.service.notification;
+
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import clap.server.application.port.inbound.notification.FindNotificationListUsecase;
+import clap.server.application.port.outbound.notification.LoadNotificationPort;
+import clap.server.common.annotation.architecture.ApplicationService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.transaction.annotation.Transactional;
+
+@ApplicationService
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+public class FindNotificationListService implements FindNotificationListUsecase {
+
+    private final LoadNotificationPort loadNotificationPort;
+
+
+    @Override
+    public Page<FindNotificationListResponse> findNotificationList(Long receiverId, Pageable pageable) {
+        return loadNotificationPort.findAllByReceiverId(receiverId, pageable);
+    }
+}

src/test/java/clap/server/notification/NotificationServiceTest.java

@@ -0,0 +1,67 @@
+package clap.server.notification;
+
+import clap.server.adapter.inbound.web.dto.notification.FindNotificationListResponse;
+import clap.server.adapter.outbound.persistense.entity.notification.constant.NotificationType;
+import clap.server.application.port.outbound.notification.LoadNotificationPort;
+import clap.server.application.service.notification.FindNotificationListService;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+import org.springframework.data.domain.Pageable;
+
+import java.time.LocalDateTime;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(MockitoExtension.class)
+public class NotificationServiceTest {
+
+    @Mock
+    private LoadNotificationPort loadNotificationPort;
+
+    @InjectMocks
+    private FindNotificationListService findNotificationListService;
+
+
+    @Test
+    public void testFindNotificationList() {
+        //Given
+        // 목록 조회 테스트이므로 여러개의 데이터를 List에 저장
+        FindNotificationListResponse findNotificationListResponse = new FindNotificationListResponse(
+                1L, 1L, NotificationType.PROCESSOR_ASSIGNED, 1L, "VM 생성해주세요", "이규동", LocalDateTime.now()
+        );
+        FindNotificationListResponse findNotificationListResponse2 = new FindNotificationListResponse(
+                1L, 1L, NotificationType.PROCESSOR_CHANGED, 1L, "VM 생성해주세요", "이규동", LocalDateTime.now()
+        );
+        FindNotificationListResponse findNotificationListResponse3 = new FindNotificationListResponse(
+                1L, 1L, NotificationType.STATUS_SWITCHED, 1L, "VM 생성해주세요", "진행중", LocalDateTime.now()
+        );
+
+        List<FindNotificationListResponse> notificationList = List.of(
+                findNotificationListResponse, findNotificationListResponse2, findNotificationListResponse3
+        );
+
+        Page<FindNotificationListResponse> page = new PageImpl<>(notificationList);
+        Pageable pageable = Pageable.ofSize(3);
+
+        //Mock
+        when(loadNotificationPort.findAllByReceiverId(1L, pageable)).thenReturn(page);
+
+        //When
+        Page<FindNotificationListResponse> result = findNotificationListService.findNotificationList(1L, pageable);
+
+        //Then
+        Assertions.assertEquals(3, result.getContent().size());
+
+        Assertions.assertEquals("VM 생성해주세요", result.getContent().get(0).taskTitle());
+        Assertions.assertEquals("VM 생성해주세요", result.getContent().get(1).taskTitle());
+        Assertions.assertEquals("VM 생성해주세요", result.getContent().get(2).taskTitle());
+    }
+}