🔔 푸시 알림 서비스 구현

들어가며

프로토타인 프로젝트의 리팩토링 작업에서 알림 기능을 구조화&설계하기로 결정했다.

우리 프로토타인의 알림은 다음과 같은 2가지 방법일 때 트리거된다:

1. 보유 티켓 개수에 유동적인 변화가 생긴다.
2. 기업에게 패널티를 받을 시에, 해당 사실을 고지해준다.
   (내용: 패널티를 부여한 기업, 간단한 사유)

푸시 알람의 핵심은 사용자가 우리 플랫폼을 사용하고 있지 않아도, 사용자에게 알림을 보내야 한다는 것이다.
그리고 우리의 메인 이슈는 HTTP는 connectionless하다는 거다. (연결한 적이 있어도 끊어버림)
기존의 서버-클라이언트는 양방향 통신을 채택하므로 이런 문제가 생기는 것이다.
그렇다면 푸시 알람은 어떻게 구현하는 것이 좋을까?
나이브하게는 일방적인 단방향 통신을 채택하면 될 것만 같다.

푸시 알람을 구현하는 방법에는 Server-Sent-Event(SSE) 를 사용하는 방식과, Firebase Cloud Messaging(FCM) 을 사용하는 방식이 있다.

현재 우리 요구사항에 더 적합한 구현 방법은 둘 중 무엇일지 고민했다.
먼저 Server-Sent-Event(SSE) 에 대해 알아보자.

Server-Sent-Event 방식

1. 클라이언트가 서버의 이벤트를 구독하기 위한 요청을 보낸다.
2. 서버에서는 클라이언트와 맵핑되는 SSE객체를 생성한다.
3. 서버는 이벤트 스트림을 생성하고, 클라이언트에게 비동기적으로 데이터를 전송한다.

Firebase Cloud Messsaging 방식

Server ↔ FCM ↔ Client
1. 클라이언트가 FCM 서버에서 유저별로 고유한 FCM 토큰을 발급받는다.
2. 서버는 클라이언트로부터 해당 토큰을 전달받고 저장한다.
3. 특정 상황에 메시지에 토큰을 담아서 FCM 서버에 전송 시, FCM이 해당 토큰의 유저에게 메시지를 전송한다.

결과: SSE 채택

🤔 나의 기술적 고민 & 솔루션

⚠️ FCM 서버에 의존한다면, FCM 서버가 다운되었을 때 우리 플랫폼 전체가 다운될 위험이 있었다.

🌟 이를 방지하기 위해서 알림 전송 구현 시에, 나는 SSE를 사용하겠다. 트랜잭션 단위를 분리한 후에, 알림 전송 내역을 SQS Queue에 넣고 스트림 처리를 하려고 한다.

🧪 Unit Test Code 작성- JUnit5, Mockito 라이브러리 이용

package com.prototyne;

import com.prototyne.Users.service.AlarmService.AlarmService;
import com.prototyne.Users.web.controller.AlarmController;
import com.prototyne.config.JwtManager;
import jakarta.servlet.http.HttpServletRequest;
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.web.servlet.mvc.method.annotation.SseEmitter;

import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

@ExtendWith(MockitoExtension.class)
public class AlarmControllerTest {

    @InjectMocks
    private AlarmController alarmController;

    @Mock
    private AlarmService alarmService;

    @Mock
    private JwtManager jwtManager;

    @Test
    void subscribe_shouldReturnSseEmitter() {
        String accessToken = "mockAccessToekn";
        SseEmitter mockEmitter = new SseEmitter();
        HttpServletRequest mockRequest = mock(HttpServletRequest.class);

        given(jwtManager.getToken(any(HttpServletRequest.class))).willReturn(accessToken);
        given(alarmService.subscribe(accessToken)).willReturn(mockEmitter);

        SseEmitter res= alarmController.subscribe(mockRequest);

        assertNotNull(res);
        verify(jwtManager).getToken(any(HttpServletRequest.class));
        verify(alarmService).subscribe(accessToken);
    }



}

더 자세한 테스트 실행결과를 트래킹하기 위해서,
테스트 결과를 확인하는 명령어를 터미널에 입력한다.

gradlew test --info

테스트 결과가 나온다.
build/reports/tests/test/index.html 경로에 있는 html파일을 브라우저로 열어본다.

이렇게 테스트 결과가 나온다.
테스트 컨텍스트는 2개(알림 subscribe api & 전체 @SpringBootTest) 에, 완벽하게 성공했다고 나온다.
각 컨텍스트 별 실행시간을 확인하기 위해, 클래스 별 메트릭을 클릭했다.