🔀 refactor: 알림 관련 api 구현 (#375)

* refactor: 알림 관련 api 구현 * refactor: 제안 알림 내용 수정 * refactor: ci 파일 수정 * refactor: 알림 상태 추가 및 조회 api 분리
spon-us · Aug 30, 2024 · c22b5d1 · c22b5d1
1 parent 8f61643
commit c22b5d1
Show file tree

Hide file tree

Showing 12 changed files with 124 additions and 16 deletions.
diff --git a/.github/workflows/ci_gradle.yml b/.github/workflows/ci_gradle.yml
@@ -31,12 +31,13 @@ jobs:
         shell: bash
 
       - name: Start Docker Compose
-        run: docker compose up -d
+        run: docker compose -f docker-compose-test.yml up -d
 
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Test with Gradle
         run: ./gradlew test
 
       - name: Stop Docker Compose
-        run: docker-compose -f docker-compose-test.yml down
+        run: docker compose -f docker-compose-test.yml down
+
diff --git a/.../main/java/com/sponus/sponusbe/domain/notification/controller/FirebaseTestController.java b/.../main/java/com/sponus/sponusbe/domain/notification/controller/FirebaseTestController.java
@@ -9,8 +9,9 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+import com.sponus.coredomain.domain.notification.NotificationStatus;
 import com.sponus.coredomain.domain.organization.Organization;
-import com.sponus.coreinfrafirebase.FirebaseService;
+import com.sponus.coreinfrafirebase.FirebaseUtil;
 import com.sponus.coreinfrasecurity.annotation.AuthOrganization;
 import com.sponus.sponusbe.domain.notification.dto.request.NotificationTestRequest;
 
@@ -23,12 +24,12 @@
 @RestController
 public class FirebaseTestController {
 
-	private final FirebaseService firebaseService;
+	private final FirebaseUtil firebaseUtil;
 
 	@PostMapping("/fcm")
 	public String testNotification(@RequestBody NotificationTestRequest request,
 		@AuthOrganization Organization organization) throws IOException {
-		// firebaseService.sendMessageTo(organization, request.title(), request.body(), null, null, null);
+		firebaseUtil.sendMessageTo(organization, request.title(), request.body(), null, NotificationStatus.SEND);
 		return "Notification test is successful !";
 	}
 }
diff --git a/...ava/com/sponus/sponusbe/domain/notification/dto/response/NotificationSummaryResponse.java b/...ava/com/sponus/sponusbe/domain/notification/dto/response/NotificationSummaryResponse.java
@@ -3,6 +3,7 @@
 import java.time.LocalDateTime;
 
 import com.sponus.coredomain.domain.notification.Notification;
+import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.propose.Propose;
 
 import lombok.Builder;
@@ -12,22 +13,24 @@ public record NotificationSummaryResponse(
 	Long id,
 	String title,
 	String body,
-	Long organizationId,
-	Long announcementId,
+	String organizationProfile,
+	String organizationName,
 	Long proposeId,
-	Long reportId,
 	boolean isRead,
 	LocalDateTime createdAt,
 	LocalDateTime updatedAt
 ) {
 	public static NotificationSummaryResponse from(Notification notification) {
 		Propose propose = notification.getPropose();
+		Organization organization = notification.getOrganization();
+		String organizationProfile = organization.getImageUrl() != null ? organization.getImageUrl() : null;
 
 		return NotificationSummaryResponse.builder()
 			.id(notification.getId())
 			.title(notification.getTitle())
 			.body(notification.getBody())
-			.organizationId(notification.getOrganization().getId())
+			.organizationName(notification.getOrganization().getName())
+			.organizationProfile(organizationProfile)
 			.proposeId(propose != null ? propose.getId() : null)
 			.isRead(notification.isRead())
 			.createdAt(notification.getCreatedAt())

diff --git a/...rc/main/java/com/sponus/sponusbe/domain/notification/exception/NotificationErrorCode.java b/...rc/main/java/com/sponus/sponusbe/domain/notification/exception/NotificationErrorCode.java
@@ -11,9 +11,12 @@
 @Getter
 @AllArgsConstructor
 public enum NotificationErrorCode implements BaseErrorCode {
+
 	NOTIFICATION_ERROR(HttpStatus.BAD_REQUEST, "NOTI4000", "알림 관련 에러"),
-	NOTIFICATION_NOT_FOUND(HttpStatus.NOT_FOUND, "NOTI4001", "존재하지 않는 알림입니다."),
-	INVALID_ORGANIZATION(HttpStatus.BAD_REQUEST, "NOTI4002", "해당 단체의 알림이 아닙니다.");
+	NOTIFICATION_INVALID(HttpStatus.FORBIDDEN, "NOTI4030", "해당 단체의 알림이 아닙니다."),
+	NOTIFICATION_NOT_FOUND(HttpStatus.NOT_FOUND, "NOTI4040", "존재하지 않는 알림입니다."),
+	NOTIFICATION_IO_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "NOTI5000", "알림 전송 중 I/O 에러가 발생했습니다."),
+	;
 
 	private final HttpStatus httpStatus;
 	private final String code;

diff --git a/.../main/java/com/sponus/sponusbe/domain/organization/controller/OrganizationController.java b/.../main/java/com/sponus/sponusbe/domain/organization/controller/OrganizationController.java
@@ -7,6 +7,7 @@
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ModelAttribute;
+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;
@@ -20,6 +21,7 @@
 import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.organization.enums.OrganizationType;
 import com.sponus.coreinfrasecurity.annotation.AuthOrganization;
+import com.sponus.sponusbe.domain.notification.dto.response.NotificationSummaryResponse;
 import com.sponus.sponusbe.domain.organization.club.service.ClubService;
 import com.sponus.sponusbe.domain.organization.company.service.CompanyService;
 import com.sponus.sponusbe.domain.organization.dto.request.OrganizationCreateRequest;
@@ -122,4 +124,32 @@ public ApiResponse<Void> deleteSearchKeyword(
 		organizationService.deleteSearchKeyword(organization.getId(), request.keyword());
 		return ApiResponse.onSuccess(null);
 	}
+
+	@GetMapping("/notifications/send")
+	public ApiResponse<List<NotificationSummaryResponse>> getSendNotifications(
+		@AuthOrganization Organization organization) {
+		return ApiResponse.onSuccess(organizationQueryService.getSendNotifications(organization));
+	}
+
+	@GetMapping("/notifications/receive")
+	public ApiResponse<List<NotificationSummaryResponse>> getReceivedNotifications(
+		@AuthOrganization Organization organization) {
+		return ApiResponse.onSuccess(organizationQueryService.getReceiveNotifications(organization));
+	}
+
+	@DeleteMapping("/notifications/{notificationId}")
+	public ApiResponse<Void> deleteNotification(
+		@AuthOrganization Organization organization,
+		@PathVariable("notificationId") Long notificationId) {
+		organizationService.deleteNotification(organization, notificationId);
+		return ApiResponse.onSuccess(null);
+	}
+
+	@PatchMapping("/notifications/{notificationId}")
+	public ApiResponse<Void> readNotification(
+		@AuthOrganization Organization organization,
+		@PathVariable("notificationId") Long notificationId) {
+		organizationService.readNotification(organization, notificationId);
+		return ApiResponse.onSuccess(null);
+	}
 }
diff --git a/...c/main/java/com/sponus/sponusbe/domain/organization/service/OrganizationQueryService.java b/...c/main/java/com/sponus/sponusbe/domain/organization/service/OrganizationQueryService.java
@@ -14,13 +14,16 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import com.sponus.coredomain.domain.bookmark.repository.BookmarkRepository;
+import com.sponus.coredomain.domain.notification.NotificationStatus;
+import com.sponus.coredomain.domain.notification.repository.NotificationRepository;
 import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.organization.enums.OrganizationType;
 import com.sponus.coredomain.domain.organization.enums.ProfileStatus;
 import com.sponus.coredomain.domain.organization.repository.OrganizationRepository;
 import com.sponus.coredomain.domain.organization.repository.querydsl.conditions.OrganizationSearchCondition;
 import com.sponus.coreinfraredis.entity.SearchHistory;
 import com.sponus.coreinfraredis.repository.SearchHistoryRepository;
+import com.sponus.sponusbe.domain.notification.dto.response.NotificationSummaryResponse;
 import com.sponus.sponusbe.domain.organization.dto.request.PageCondition;
 import com.sponus.sponusbe.domain.organization.dto.response.OrganizationGetResponse;
 import com.sponus.sponusbe.domain.organization.dto.response.OrganizationSearchResponse;
@@ -38,6 +41,7 @@ public class OrganizationQueryService {
 	private final OrganizationRepository organizationRepository;
 	private final SearchHistoryRepository searchHistoryRepository;
 	private final BookmarkRepository bookmarkRepository;
+	private final NotificationRepository notificationRepository;
 
 	public Boolean verifyName(String name) {
 		return organizationRepository.existsByName(name);
@@ -127,4 +131,19 @@ private SearchHistory findSearchHistory(Long organizationId) {
 		});
 	}
 
+	public List<NotificationSummaryResponse> getSendNotifications(Organization organization) {
+		return notificationRepository.findByOrganizationAndAndStatusOrderByCreatedAtDesc(organization,
+				NotificationStatus.SEND)
+			.stream()
+			.map(NotificationSummaryResponse::from)
+			.toList();
+	}
+
+	public List<NotificationSummaryResponse> getReceiveNotifications(Organization organization) {
+		return notificationRepository.findByOrganizationAndAndStatusOrderByCreatedAtDesc(organization,
+				NotificationStatus.RECEIVE)
+			.stream()
+			.map(NotificationSummaryResponse::from)
+			.toList();
+	}
 }
diff --git a/api/src/main/java/com/sponus/sponusbe/domain/organization/service/OrganizationService.java b/api/src/main/java/com/sponus/sponusbe/domain/organization/service/OrganizationService.java
@@ -5,6 +5,8 @@
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.multipart.MultipartFile;
 
+import com.sponus.coredomain.domain.notification.Notification;
+import com.sponus.coredomain.domain.notification.repository.NotificationRepository;
 import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.organization.club.Club;
 import com.sponus.coredomain.domain.organization.company.Company;
@@ -13,6 +15,8 @@
 import com.sponus.coreinfraredis.entity.SearchHistory;
 import com.sponus.coreinfraredis.repository.SearchHistoryRepository;
 import com.sponus.coreinfras3.S3Service;
+import com.sponus.sponusbe.domain.notification.exception.NotificationErrorCode;
+import com.sponus.sponusbe.domain.notification.exception.NotificationException;
 import com.sponus.sponusbe.domain.organization.dto.request.OrganizationCreateRequest;
 import com.sponus.sponusbe.domain.organization.dto.response.OrganizationImageUploadResponse;
 import com.sponus.sponusbe.domain.organization.exception.OrganizationErrorCode;
@@ -31,6 +35,7 @@ public class OrganizationService {
 	private final S3Service s3Service;
 	private final PasswordEncoder passwordEncoder;
 	private final SearchHistoryRepository searchHistoryRepository;
+	private final NotificationRepository notificationRepository;
 
 	public Long createOrganization(OrganizationCreateRequest request) {
 		Organization organization;
@@ -92,4 +97,22 @@ private SearchHistory findSearchHistory(Long organizationId) {
 			return searchHistoryRepository.save(newSearchHistory);
 		});
 	}
+
+	public void deleteNotification(Organization organization, Long notificationId) {
+		Notification notification = notificationRepository.findById(notificationId)
+			.orElseThrow(() -> new NotificationException(NotificationErrorCode.NOTIFICATION_NOT_FOUND));
+		if (!notification.getOrganization().getId().equals(organization.getId())) {
+			throw new NotificationException(NotificationErrorCode.NOTIFICATION_INVALID);
+		}
+		notificationRepository.delete(notification);
+	}
+
+	public void readNotification(Organization organization, Long notificationId) {
+		Notification notification = notificationRepository.findById(notificationId)
+			.orElseThrow(() -> new NotificationException(NotificationErrorCode.NOTIFICATION_NOT_FOUND));
+		if (!notification.getOrganization().getId().equals(organization.getId())) {
+			throw new NotificationException(NotificationErrorCode.NOTIFICATION_INVALID);
+		}
+		notification.read();
+	}
 }
diff --git a/api/src/main/java/com/sponus/sponusbe/domain/propose/service/ProposeService.java b/api/src/main/java/com/sponus/sponusbe/domain/propose/service/ProposeService.java
@@ -1,14 +1,17 @@
 package com.sponus.sponusbe.domain.propose.service;
 
+import java.io.IOException;
 import java.time.LocalDateTime;
 
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import com.sponus.coredomain.domain.notification.NotificationStatus;
 import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.organization.repository.OrganizationRepository;
 import com.sponus.coredomain.domain.propose.Propose;
 import com.sponus.coredomain.domain.propose.repository.ProposeRepository;
+import com.sponus.coreinfrafirebase.FirebaseUtil;
 import com.sponus.sponusbe.domain.organization.exception.OrganizationErrorCode;
 import com.sponus.sponusbe.domain.organization.exception.OrganizationException;
 import com.sponus.sponusbe.domain.propose.dto.request.ProposeCreateRequest;
@@ -27,6 +30,7 @@ public class ProposeService {
 
 	private final ProposeRepository proposeRepository;
 	private final OrganizationRepository organizationRepository;
+	private final FirebaseUtil firebaseUtil;
 
 	public ProposeCreateResponse createPropose(Organization organization, ProposeCreateRequest request) {
 
@@ -52,6 +56,17 @@ public ProposeCreateResponse createPropose(Organization organization, ProposeCre
 		// 	.count();
 
 		final Propose propose = proposeRepository.save(request.toEntity(organization, target));
+		try {
+			firebaseUtil.sendMessageTo(
+				target,
+				organization.getName() + "(으)로부터 제안이 왔어요!",
+				"이메일을 확인하고 기업과 컨택해 보세요.",
+				propose,
+				NotificationStatus.RECEIVE
+			);
+		} catch (IOException ex) {
+			log.error("[*] Failed to send notification to organization: " + target.getName(), ex);
+		}
 		return ProposeCreateResponse.from(propose);
 	}
 }
diff --git a/core/core-domain/src/main/java/com/sponus/coredomain/domain/notification/Notification.java b/core/core-domain/src/main/java/com/sponus/coredomain/domain/notification/Notification.java
@@ -50,6 +50,9 @@ public class Notification extends BaseEntity {
 	@ColumnDefault("false")
 	private boolean isRead;
 
+	@Column(name = "notification_status", nullable = false)
+	private NotificationStatus status;
+
 	@ManyToOne(fetch = FetchType.LAZY)
 	@JoinColumn(name = "organization_id", foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT))
 	private Organization organization;
@@ -66,7 +69,7 @@ public void setPropose(Propose propose) {
 		this.propose = propose;
 	}
 
-	public void setRead(boolean read) {
-		isRead = read;
+	public void read() {
+		isRead = true;
 	}
 }
diff --git a/...re-domain/src/main/java/com/sponus/coredomain/domain/notification/NotificationStatus.java b/...re-domain/src/main/java/com/sponus/coredomain/domain/notification/NotificationStatus.java
@@ -0,0 +1,5 @@
+package com.sponus.coredomain.domain.notification;
+
+public enum NotificationStatus {
+	RECEIVE, SEND
+}
diff --git a/...ain/java/com/sponus/coredomain/domain/notification/repository/NotificationRepository.java b/...ain/java/com/sponus/coredomain/domain/notification/repository/NotificationRepository.java
@@ -5,8 +5,10 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import com.sponus.coredomain.domain.notification.Notification;
+import com.sponus.coredomain.domain.notification.NotificationStatus;
 import com.sponus.coredomain.domain.organization.Organization;
 
 public interface NotificationRepository extends JpaRepository<Notification, Long> {
-	List<Notification> findByOrganizationOrderByCreatedAtDesc(Organization organization);
+	List<Notification> findByOrganizationAndAndStatusOrderByCreatedAtDesc(Organization organization,
+		NotificationStatus status);
 }
diff --git a/...us/coreinfrafirebase/FirebaseService.java → ...ponus/coreinfrafirebase/FirebaseUtil.java b/...us/coreinfrafirebase/FirebaseService.java → ...ponus/coreinfrafirebase/FirebaseUtil.java
@@ -12,6 +12,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.auth.oauth2.GoogleCredentials;
 import com.sponus.coredomain.domain.notification.Notification;
+import com.sponus.coredomain.domain.notification.NotificationStatus;
 import com.sponus.coredomain.domain.notification.repository.NotificationRepository;
 import com.sponus.coredomain.domain.organization.Organization;
 import com.sponus.coredomain.domain.propose.Propose;
@@ -28,7 +29,7 @@
 @Slf4j
 @Component
 @RequiredArgsConstructor
-public class FirebaseService {
+public class FirebaseUtil {
 
 	@Value("${firebase.fcmUrl}")
 	private String fcmUrl;
@@ -45,14 +46,16 @@ public class FirebaseService {
 
 	private final RedisUtil redisUtil;
 
-	public void sendMessageTo(Organization targetOrganization, String title, String body, Propose propose) throws
+	public void sendMessageTo(Organization targetOrganization, String title, String body, Propose propose,
+		NotificationStatus status) throws
 		IOException {
 
 		String token = getFcmToken(targetOrganization.getEmail());
 
 		Notification notification = Notification.builder()
 			.title(title)
 			.body(body)
+			.status(status)
 			.build();
 
 		notification.setOrganization(targetOrganization);