[FIX/#300] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #306

yummygyudon · 2025-01-16T17:45:24Z

In Progress...

Last Modified 2025.01.17 02:40

Related Issue 🚀

closed [FIX] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #300

Work Description ✏️

API Request / Response 요구사항 변경 반영
구현상 오류 수정 반영
🚨 DB Schema 업데이트 필요!!!! 🚨 (진행 후에 머지해야 합니다.)

PR Point 📸

※ Alarm 도메인 대규모 개편

1) Embedded 도입

2) `intendAt` 개념 도입

※ Alarm Web Hook API (from. Lambda Alarm Server)

related Issue : Push Notification Server - Issue#30

"발송 상태"에 대한 상태 변경 기능 구현

예약 알림 식별 기준 값을 `notificationId` -> `alarmId`으로 변경함에 따라 API 요구사항을 변경했습니다.

Content 관심사를 분리하여 관리할 수 있도록 Embedded Entity로 구현했습니다. - 생성자 팩토리 함수를 제공하여 필요한 링크 유형에 따른 객체 생성이 가능하도록 했습니다.

발송 대상에 대한 관심사를 분리하기 위해 Embedded Entity를 구현했습니다.

private static 팩토리 메서드를 제공했습니다. - `isSupportedAppLink` : 입력된 link가 지원되는 앱 링크 경로인지 검사합니다.

Util 클래스에 정의되어 있는 "앱링크 유효성 검사" 메서드를 통해 AppLink 컨텐츠 객체 생성자 메서드에서 유효성 검사를 진행합니다.

- Failure : 지원하지 않는 앱링크에 대한 에러 - Success : 상태값 업데이트에 대한 성공

개편된 Domain Entity로 변경했습니다.

쓰임에 따라 슈퍼 타입 Interface `AlarmRequest`를 구현한 후, `InstantAlarmRequest` / `ScheduleAlarmRequest` 구현체를 구현하여 관심사에 따른 관심사 분리 & 타입 안정적으로 사용하도록 했습니다. - 통일성 있는 행위에 대한 메서드를 정의 및 구현할 수 있습니다. - 알림 발송 역할을 담당하는 객체는 메서드는 `AlarmRequest` 타입 객체만 파라미터로 받을 수 있도록 합니다. - 알림 발송 구현체는 `InstantAlarmRequest` / `ScheduleAlarmRequest`만을 활용할 수 있습니다.

EventBridge의 경우, 다양한 도메인에서 활용될 수 있기 때문에 이름에 쓰임과 의도를 명확히 표현하기 위해 이름을 수정했습니다. - 이전 구현체 대비 코드 절약이 가능한 소스 코드는 편집했습니다.

height · 2025-01-16T17:45:27Z

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

기존 본 어플리케이션 서버 기준(`LocalDateTime.now()`) 등록되는 구조를 실제 알림서버에서 성공한 시점이 등록되는 구조로 변경했습니다.

sung-silver

중요한 리뷰가 하나 있어서 request changed 요청드립니다!!

operation-api/src/main/java/org/sopt/makers/operation/web/alarm/api/AlarmApiController.java

.../src/main/java/org/sopt/makers/operation/web/alarm/dto/request/AlarmScheduleSendRequest.java

...ion-api/src/main/java/org/sopt/makers/operation/web/alarm/dto/response/AlarmGetResponse.java

operation-api/src/main/java/org/sopt/makers/operation/web/alarm/service/AlarmServiceImpl.java

...ation-external/src/main/java/org/sopt/makers/operation/client/alarm/ScheduleAlarmSender.java

...n-external/src/main/java/org/sopt/makers/operation/client/alarm/dto/InstantAlarmRequest.java

operation-external/src/main/java/org/sopt/makers/operation/client/alarm/InstantAlarmSender.java

[참고 PR](#306)

.../src/main/java/org/sopt/makers/operation/web/alarm/dto/request/AlarmScheduleSendRequest.java

hyunw9

고생하셨습니다아 ~

operation-domain/src/main/java/org/sopt/makers/operation/alarm/domain/AlarmTargetPart.java

yummygyudon added 23 commits January 17, 2025 02:35

[MODIFY] API PathVariable 값 변경

a6d06f7

예약 알림 식별 기준 값을 `notificationId` -> `alarmId`으로 변경함에 따라 API 요구사항을 변경했습니다.

[MODIFY] Alarm 관련 도메인 이름 변경 및 재정의

f9980f4

[FEAT] AlarmContent Entity 구현 (Embedded)

dee0fa2

Content 관심사를 분리하여 관리할 수 있도록 Embedded Entity로 구현했습니다. - 생성자 팩토리 함수를 제공하여 필요한 링크 유형에 따른 객체 생성이 가능하도록 했습니다.

[FEAT] AlarmTarget Entity 구현 (Embedded)

d19cc3f

발송 대상에 대한 관심사를 분리하기 위해 Embedded Entity를 구현했습니다.

[REFACTOR] 관심사 분리 반영 개편 AlarmEntity 구현

0b0bbb2

[FEAT] 알림 관련 상수 Util 클래스 정의

833d5b8

private static 팩토리 메서드를 제공했습니다. - `isSupportedAppLink` : 입력된 link가 지원되는 앱 링크 경로인지 검사합니다.

[REFACTOR] AppLink 컨텐츠 생성자 유효성 검사 추가

b0db63e

Util 클래스에 정의되어 있는 "앱링크 유효성 검사" 메서드를 통해 AppLink 컨텐츠 객체 생성자 메서드에서 유효성 검사를 진행합니다.

[ADD] Alarm 관련 Success/Failure Code 항목 추가

f8b09c8

- Failure : 지원하지 않는 앱링크에 대한 에러 - Success : 상태값 업데이트에 대한 성공

[REFACTOR] DB String Data to List Converter 등록

52dd41a

[MODIFY] 알림 생성 Response DTO 필드명 변경 및 파라미터 Entity 타입 변경

98650d7

개편된 Domain Entity로 변경했습니다.

[REFACTOR] 즉시/예약 발송 알림 생성 요청 DTO 내 개편 Domain Entity 반영

9533aaf

[CHORE] Member Domain인 Part Enum 패키지 이동

2e59cb7

[ADD] AlarmLinkType Enum 클래스 한글 이름 name 필드 추가

2890d87

[ADD] Alarm Target String Target Id List 주입 Setter 메서드 추가

2832efe

[REFACTOR] Alarm Entity 개편에 따른 QueryDSL 소스 코드 변경

d4d63a9

[REFACTOR] 알림 즉시 발송/예약 발송 구현체 개편

e626318

[CHORE] Success/Failure Code 개행 및 주석 추가

3a21d94

[FIX] API 요청/응답 DTO 요구사항 수정 반영

f0741af

[FIX] Alarm API 스펙 변경에 따른 DTO 및 Service Layer 메시지 객체 타입 변경 반영

483d024

[CHORE] Alarm Service Layer 작업 과정 내 자잘한 Enum 메서드 수정

84aa953

[REFACTOR] 변경된 요구사항 반영 Service Layer 수정 구현

06e8433

yummygyudon requested review from hyunw9 and sung-silver January 16, 2025 17:45

yummygyudon self-assigned this Jan 16, 2025

yummygyudon linked an issue Jan 16, 2025 that may be closed by this pull request

[FIX] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #300

Closed

6 tasks

pull-request-size bot added the size/XXL label Jan 16, 2025

[FIX] 푸시 알림 서버 요구 스펙에 맞춘 EventBridge 요청 DTO 변경

51ea667

yummygyudon added 3 commits January 17, 2025 16:16

[FIX] 푸시 알림 서버 요구 스펙에 맞춘 Web Hook 수신 Response DTO 반영 및 수신 API 정의

780fd55

[REFACTOR] Alarm Entity 실제 전송 시점 값(sendAt) 기준 변경

b77561e

기존 본 어플리케이션 서버 기준(`LocalDateTime.now()`) 등록되는 구조를 실제 알림서버에서 성공한 시점이 등록되는 구조로 변경했습니다.

[FEAT] 예약 알림 상태 및 전송 시간 업데이트 Service Layer 메서드 구현

53335ef

sung-silver requested changes Jan 17, 2025

View reviewed changes

yummygyudon added 3 commits January 18, 2025 19:27

[FIX] 즉시/예약 알림 발송 POST API @RequestBody 추가

c9978e0

[REFACTOR] Request/Response에 사용되는 DateTime Format 상수 선언

42ffa6a

[CHORE] 코드 스타일 리뷰 반영

4eeb48c

[참고 PR](#306)

sung-silver approved these changes Jan 18, 2025

View reviewed changes

.../src/main/java/org/sopt/makers/operation/web/alarm/dto/request/AlarmScheduleSendRequest.java Show resolved Hide resolved

hyunw9 approved these changes Jan 18, 2025

View reviewed changes

operation-domain/src/main/java/org/sopt/makers/operation/alarm/domain/AlarmTargetPart.java Show resolved Hide resolved

[FIX] AlarmTarget Enum 데이터 @Enumerated 추가

19b12b4

yummygyudon merged commit feb9836 into develop Jan 19, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX/#300] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #306

[FIX/#300] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #306

yummygyudon commented Jan 16, 2025

height bot commented Jan 16, 2025

sung-silver left a comment

hyunw9 left a comment

[FIX/#300] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #306

[FIX/#300] 웹 어드민 푸시 알림 기능 수정 / 예약 기능 구현 수정 #306

Conversation

yummygyudon commented Jan 16, 2025

Related Issue 🚀

Work Description ✏️

PR Point 📸

※ Alarm 도메인 대규모 개편

1) Embedded 도입

2) intendAt 개념 도입

※ Alarm Web Hook API (from. Lambda Alarm Server)

"발송 상태"에 대한 상태 변경 기능 구현

height bot commented Jan 16, 2025

sung-silver left a comment

Choose a reason for hiding this comment

hyunw9 left a comment

Choose a reason for hiding this comment

2) `intendAt` 개념 도입