[DP-522] 구독 & 알림 스프린트 PROD 배포

.gitignore

@@ -50,6 +50,7 @@ src/main/resources/application-open-ai.yml
 src/main/resources/application-opensearch-local.yml
 src/main/resources/application-opensearch-dev.yml
 src/main/resources/application-opensearch-prod.yml
+
 src/test/resources/application-storage-s3.yml
 src/test/resources/application-storage-s3-prod.yml
 src/test/resources/application-open-ai.yml

build.gradle

@@ -107,6 +107,7 @@ dependencies {
 test {
     useJUnitPlatform()
     outputs.dir snippetsDir
+    jvmArgs '-Xmx1024m', '-Xms512m'
 }
 
 clean {

deploy-dev.sh

@@ -22,4 +22,5 @@ echo "> Build Docker image"
 docker build -t "$APP_NAME" "$REPOSITORY"
 
 echo "> Run the Docker container"
-docker run -d -p 8080:8080 --name "$APP_NAME" "$APP_NAME"
+
+docker run -d -p 8080:8080 --name "$APP_NAME" "$APP_NAME"

deploy-prod.sh

@@ -22,4 +22,5 @@ echo "> Build Docker image"
 docker build -t "$APP_NAME" "$REPOSITORY"
 
 echo "> Run the Docker container"
-docker run -d -p 8080:8080 --name "$APP_NAME" -v /home/ubuntu/pinpoint-agent-3.0.0:/pinpoint-agent "$APP_NAME"
+
+docker run -d -p 8080:8080 --name "$APP_NAME" -v /home/ubuntu/pinpoint-agent-3.0.0:/pinpoint-agent "$APP_NAME"

src/docs/asciidoc/api/mypage/mypage.adoc

@@ -6,3 +6,4 @@ include::exit-member.adoc[]
 include::exit-survey.adoc[]
 include::record-exit-survey.adoc[]
 include::comment-get.adoc[]
+include::subscribed-companies.adoc[]

src/docs/asciidoc/api/mypage/subscribed-companies.adoc

@@ -0,0 +1,34 @@
+[[Subscribed-Companies]]
+== 회원이 구독한 기업 목록 조회 API(GET: /devdevdev/api/v1/mypage/subscriptions/companies)
+
+* 모든 회원은 자신이 구독한 기업 목록을 조회할 수 있다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/subscribed-companies/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/subscribed-companies/request-headers.adoc[]
+
+==== HTTP Request Query Parameters Fields
+
+include::{snippets}/subscribed-companies/query-parameters.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/subscribed-companies/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/subscribed-companies/response-fields.adoc[]
+
+=== 예외
+
+==== HTTP Response
+
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+
+include::{snippets}/subscribed-companies-not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/get-notification-popup.adoc

@@ -0,0 +1,36 @@
+[[Get-Notification-Popup]]
+== 알림 팝업 조회 API (GET: /devdevdev/api/v1/notifications/popup)
+
+* 회원이 알림 팝업 리스트를 조회한다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/get-notification-popup/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/get-notification-popup/request-headers.adoc[]
+
+==== HTTP Request Query Parameters
+
+include::{snippets}/get-notification-popup/query-parameters.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/get-notification-popup/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/get-notification-popup/response-fields.adoc[]
+
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+
+include::{snippets}/not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/get-notification-unread-count.adoc

@@ -0,0 +1,32 @@
+[[Get-Notification-Unread-Count]]
+== 알림 개수 조회 API (GET: /devdevdev/api/v1/notifications/unread-count)
+
+* 회원이 읽지 않은 알림의 총 개수를 조회한다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/get-notification-unread-count/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/get-notification-unread-count/request-headers.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/get-notification-unread-count/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/get-notification-unread-count/response-fields.adoc[]
+
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+
+include::{snippets}/not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/get-notifications.adoc

@@ -0,0 +1,37 @@
+[[Get-Notifications]]
+== 알림 페이지 조회 API (GET: /devdevdev/api/v1/notifications/page)
+
+* 회원은 알림 페이지에서 자신에게 온 알림을 무한스크롤링으로 조회할 수 있다.
+* (추후 추가) 알림 유형에 따라 필터링하여 조회할 수 있다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/get-notifications/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/get-notifications/request-headers.adoc[]
+
+==== HTTP Request Query Parameters
+
+include::{snippets}/get-notifications/query-parameters.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/get-notifications/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/get-notifications/response-fields.adoc[]
+
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+
+include::{snippets}/not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/notification.adoc

@@ -0,0 +1,9 @@
+= 알림
+
+include::notifications.adoc[]
+include::publish-notifications.adoc[]
+include::read-notification.adoc[]
+include::read-all-notification.adoc[]
+include::get-notifications.adoc[]
+include::get-notification-popup.adoc[]
+include::get-notification-unread-count.adoc[]

src/docs/asciidoc/api/notification/notifications.adoc

@@ -0,0 +1,74 @@
+[[Notifications]]
+== 실시간 알림 수신 API(GET: /devdevdev/api/v1/notifications)
+
+* 회원이 알림을 실시간으로 수신한다.
+* 알림 처리 방식은 https://developer.mozilla.org/ko/docs/Web/API/Server-sent_events/Using_server-sent_events[Server-Sent Events]를 사용한다.
+** 5분의 타임아웃, 30초 마다 heartbeat 를 전송한다.
+* *기술블로그 알림 시나리오*
+** SSE 구독 상태인 경우
+1. SSE 구독
+2. 읽지 않은 알림이 있는 경우
+a. `"읽지 않은 알림이 %d개 있어요!"` 전송
+b. 새로운 글 발행
+c. `"%s에서 새로운 기슬블로그 %d개가 올라왔어요!"` 전송
+3. 읽지 않은 알림이 없는 경우
+a. 새로운 글 발행
+b. `"%s에서 새로운 기슬블로그 %d개가 올라왔어요!"` 전송
+** SSE 구독 상태가 아닌 경우
+1. 새로운 글 발행
+2. SSE 구독
+a. `"읽지 않은 알림이 %d개 있어요!"` 전송
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/notifications/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/notifications/request-headers.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/notifications/http-response.adoc[]
+
+==== HTTP Response Header Fields
+
+include::{snippets}/notifications/response-headers.adoc[]
+
+==== HTTP Response Body
+
+include::{snippets}/notifications/response-body.adoc[]
+
+|===
+|Path |Type |Optional |Description |Format
+
+|data
+|Object
+|
+|알림
+|
+
+|message
+|String
+|
+|알림 메시지
+|
+
+|createdAt
+|String
+|
+|알림 발생 일시
+|'yyyy-MM-dd'T'HH:mm:ss.SSSZ'
+|===
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+* `유효하지 않은 회원 입니다.`: 회원이 유효하지 않은 경우
+
+include::{snippets}/not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/publish-notifications.adoc

@@ -0,0 +1,41 @@
+[[Publish-Notifications]]
+== 알림 생성 API(POST: /devdevdev/api/v1/notifications/{channel})
+
+* 알림을 생성한다.
+** service-name, api-key 가 일치 하지 않으면 호출 할 수 없다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/publish-notifications/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/publish-notifications/request-headers.adoc[]
+
+==== HTTP Request Fields
+
+include::{snippets}/publish-notifications/request-fields.adoc[]
+
+==== HTTP Request Path Parameters Fields
+
+include::{snippets}/publish-notifications/path-parameters.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/publish-notifications/http-response.adoc[]
+
+==== HTTP Response Body Fields
+
+include::{snippets}/publish-notifications/response-fields.adoc[]
+
+=== 예외
+
+==== HTTP Response
+
+* `올바른 입력 값이 아닙니다.`: 잘못된 알림 채널을 입력한 경우
+* `접근할 수 없는 권한 입니다.`: 서비스 이름과 api-key가 일치하지 않는 경우
+* `지원하는 서비스가 아닙니다.`: 지원하는 서비스가 아닌 경우
+
+include::{snippets}/publish-notifications-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/read-all-notification.adoc

@@ -0,0 +1,33 @@
+[[Read-All-Notifications]]
+== 모든 알림 읽기 API (PATCH: /devdevdev/api/v1/notifications/read-all)
+
+* 회원이 자신에게 온 모든 알림을 읽기 처리한다.
+* 회원이 읽을 알림이 하나도 없어도 예외가 발생하지 않고 성공한다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/read-all-notifications/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/read-all-notifications/request-headers.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/read-all-notifications/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/read-all-notifications/response-fields.adoc[]
+
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+
+include::{snippets}/not-found-member-exception/response-body.adoc[]

src/docs/asciidoc/api/notification/read-notification.adoc

@@ -0,0 +1,36 @@
+[[Read-Notification]]
+== 단건 알림 읽기 API (PATCH: /devdevdev/api/v1/notifications/{notificationId}/read)
+
+* 회원이 자신에게 온 단건 알림을 읽기 처리한다.
+
+=== 정상 요청/응답
+
+==== HTTP Request
+
+include::{snippets}/read-notification/http-request.adoc[]
+
+==== HTTP Request Header Fields
+
+include::{snippets}/read-notification/request-headers.adoc[]
+
+==== HTTP Request Path Parameters
+
+include::{snippets}/read-notification/path-parameters.adoc[]
+
+==== HTTP Response
+
+include::{snippets}/read-notification/http-response.adoc[]
+
+==== HTTP Response Fields
+
+include::{snippets}/read-notification/response-fields.adoc[]
+
+=== 예외
+
+==== HTTP Response
+
+* `익명 회원은 사용할 수 없는 기능 입니다.`: 익명 회원인 경우
+* `회원을 찾을 수 없습니다.`: 회원이 존재하지 않는 경우
+* `존재하지 않는 알림입니다.`: 알림이 존재하지 않거나 회원의 알림이 아닐 경우
+
+include::{snippets}/read-notification-not-found/response-body.adoc[]