[FEAT] 웹소켓을 활용한 정보 공유 파이프라인 구현

build.gradle

@@ -42,6 +42,9 @@ dependencies {
     runtimeOnly 'com.mysql:mysql-connector-j'
     annotationProcessor 'org.projectlombok:lombok'
 
+    // Websocket
+    implementation 'org.springframework.boot:spring-boot-starter-websocket'
+
     // JWT
     implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
     implementation 'io.jsonwebtoken:jjwt-impl:0.11.5'

src/main/java/com/debatetimer/config/CorsConfig.java

@@ -1,39 +1,24 @@
 package com.debatetimer.config;
 
-import com.debatetimer.exception.custom.DTInitializationException;
-import com.debatetimer.exception.errorcode.InitializationErrorCode;
-import org.springframework.beans.factory.annotation.Value;
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.web.servlet.config.annotation.CorsRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 @Configuration
+@RequiredArgsConstructor
+@EnableConfigurationProperties(CorsProperties.class)
 public class CorsConfig implements WebMvcConfigurer {
 
-    private final String[] corsOrigin;
-
-    public CorsConfig(@Value("${cors.origin}") String[] corsOrigin) {
-        validate(corsOrigin);
-        this.corsOrigin = corsOrigin;
-    }
-
-    private void validate(String[] corsOrigin) {
-        if (corsOrigin == null || corsOrigin.length == 0) {
-            throw new DTInitializationException(InitializationErrorCode.CORS_ORIGIN_EMPTY);
-        }
-        for (String origin : corsOrigin) {
-            if (origin == null || origin.isBlank()) {
-                throw new DTInitializationException(InitializationErrorCode.CORS_ORIGIN_STRING_BLANK);
-            }
-        }
-    }
+    private final CorsProperties corsProperties;
 
     @Override
     public void addCorsMappings(CorsRegistry registry) {
         registry.addMapping("/**")
-                .allowedOriginPatterns(corsOrigin)
+                .allowedOriginPatterns(corsProperties.getCorsOrigin())
                 .allowedMethods(
                         HttpMethod.GET.name(),
                         HttpMethod.POST.name(),

src/main/java/com/debatetimer/config/CorsProperties.java

@@ -0,0 +1,31 @@
+package com.debatetimer.config;
+
+import com.debatetimer.exception.custom.DTInitializationException;
+import com.debatetimer.exception.errorcode.InitializationErrorCode;
+import lombok.Getter;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+
+@Getter
+@ConfigurationProperties(prefix = "cors.origin")
+public class CorsProperties {
+
+    private final String[] corsOrigin;
+
+    //TODO 머지될 때 dev, prod secret 갱신 필요
+    public CorsProperties(String[] corsOrigin) {
+        validate(corsOrigin);
+        this.corsOrigin = corsOrigin;
+    }
+
+    private void validate(String[] corsOrigin) {
+        if (corsOrigin == null || corsOrigin.length == 0) {
+            throw new DTInitializationException(InitializationErrorCode.CORS_ORIGIN_EMPTY);
+        }
+        for (String origin : corsOrigin) {
+            if (origin == null || origin.isBlank()) {
+                throw new DTInitializationException(InitializationErrorCode.CORS_ORIGIN_STRING_BLANK);
+            }
+        }
+    }
+}

src/main/java/com/debatetimer/config/sharing/WebSocketAuthMemberResolver.java

@@ -0,0 +1,41 @@
+package com.debatetimer.config.sharing;
+
+import com.debatetimer.controller.auth.AuthMember;
+import com.debatetimer.controller.tool.jwt.AuthManager;
+import com.debatetimer.exception.custom.DTClientErrorException;
+import com.debatetimer.exception.errorcode.ClientErrorCode;
+import com.debatetimer.service.auth.AuthService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.core.MethodParameter;
+import org.springframework.http.HttpHeaders;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class WebSocketAuthMemberResolver implements HandlerMethodArgumentResolver {
+
+    private final AuthManager authManager;
+    private final AuthService authService;
+
+    @Override
+    public boolean supportsParameter(MethodParameter parameter) {
+        return parameter.hasParameterAnnotation(AuthMember.class);
+    }
+
+    @Override
+    public Object resolveArgument(MethodParameter parameter, Message<?> message) {
+        StompHeaderAccessor accessor = StompHeaderAccessor.wrap(message);
+        String token = accessor.getFirstNativeHeader(HttpHeaders.AUTHORIZATION);
+
+        if (token == null) {
+            throw new DTClientErrorException(ClientErrorCode.UNAUTHORIZED_MEMBER);
+        }
+
+        String email = authManager.resolveAccessToken(token);
+        return authService.getMember(email);
+    }
+}
+

src/main/java/com/debatetimer/config/sharing/WebSocketConfig.java

@@ -0,0 +1,38 @@
+package com.debatetimer.config.sharing;
+
+import com.debatetimer.config.CorsProperties;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
+import org.springframework.messaging.simp.config.MessageBrokerRegistry;
+import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
+import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
+import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
+
+@Configuration
+@RequiredArgsConstructor
+@EnableWebSocketMessageBroker
+public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
+
+    private final CorsProperties corsProperties;
+    private final WebSocketAuthMemberResolver webSocketAuthMemberResolver;
+
+    @Override
+    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
+        resolvers.add(webSocketAuthMemberResolver);
+    }
+
+    @Override
+    public void configureMessageBroker(MessageBrokerRegistry registry) {
+        registry.enableSimpleBroker("/room", "/chairman");
+        registry.setApplicationDestinationPrefixes("/app");
+    }
+
+    @Override
+    public void registerStompEndpoints(StompEndpointRegistry registry) {
+        registry.addEndpoint("/ws")
+                .setAllowedOriginPatterns(corsProperties.getCorsOrigin())
+                .withSockJS();
+    }
+}

src/main/java/com/debatetimer/controller/sharing/SharingController.java

@@ -0,0 +1,25 @@
+package com.debatetimer.controller.sharing;
+
+import com.debatetimer.controller.auth.AuthMember;
+import com.debatetimer.domain.member.Member;
+import com.debatetimer.dto.sharing.request.SharingRequest;
+import com.debatetimer.dto.sharing.response.SharingResponse;
+import org.springframework.messaging.handler.annotation.DestinationVariable;
+import org.springframework.messaging.handler.annotation.MessageMapping;
+import org.springframework.messaging.handler.annotation.Payload;
+import org.springframework.messaging.handler.annotation.SendTo;
+import org.springframework.stereotype.Controller;
+
+@Controller
+public class SharingController {
+
+    @MessageMapping("/event/{roomId}")
+    @SendTo("/room/{roomId}")
+    public SharingResponse share(
+            @AuthMember Member member,
+            @DestinationVariable(value = "roomId") long roomId,
+            @Payload SharingRequest request
+    ) {
+        return new SharingResponse(request.time());
+    }
+}

src/main/java/com/debatetimer/dto/sharing/request/ChairmanSharingRequest.java

@@ -0,0 +1,7 @@
+package com.debatetimer.dto.sharing.request;
+
+public record ChairmanSharingRequest(
+        long roomId
+) {
+
+}

src/main/java/com/debatetimer/dto/sharing/request/SharingRequest.java

@@ -0,0 +1,9 @@
+package com.debatetimer.dto.sharing.request;
+
+import java.time.LocalDateTime;
+
+public record SharingRequest(
+        LocalDateTime time
+) {
+
+}

src/main/java/com/debatetimer/dto/sharing/response/SharingResponse.java

@@ -0,0 +1,9 @@
+package com.debatetimer.dto.sharing.response;
+
+import java.time.LocalDateTime;
+
+public record SharingResponse(
+        LocalDateTime time
+) {
+
+}

src/main/java/com/debatetimer/event/sharing/RoomSubscribeListener.java

@@ -0,0 +1,47 @@
+package com.debatetimer.event.sharing;
+
+import com.debatetimer.dto.sharing.request.ChairmanSharingRequest;
+import com.debatetimer.exception.custom.DTClientErrorException;
+import com.debatetimer.exception.errorcode.ClientErrorCode;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.event.EventListener;
+import org.springframework.messaging.simp.SimpMessagingTemplate;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.stereotype.Component;
+import org.springframework.web.socket.messaging.SessionSubscribeEvent;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class RoomSubscribeListener {
+
+    private static final String AUDIENCE_SUBSCRIBE_PREFIX = "/room/";
+    private static final String CHAIRMAN_CHANNEL_PREFIX = "/chairman/";
+
+    private final SimpMessagingTemplate messagingTemplate;
+
+    @EventListener
+    public void handleSubscribeEvent(SessionSubscribeEvent event) {
+        StompHeaderAccessor accessor = StompHeaderAccessor.wrap(event.getMessage());
+        String destination = accessor.getDestination();
+        if (destination == null) {
+            return;
+        }
+
+        if (destination.startsWith(AUDIENCE_SUBSCRIBE_PREFIX)) {
+            long roomId = parseRoomId(destination);
+            messagingTemplate.convertAndSend(CHAIRMAN_CHANNEL_PREFIX + roomId, new ChairmanSharingRequest(roomId));
+        }
+    }
+
+    private long parseRoomId(String destination) {
+        try {
+            String parsedRoomId = destination.substring(AUDIENCE_SUBSCRIBE_PREFIX.length());
+            return Long.parseLong(parsedRoomId);
+        } catch (NumberFormatException exception) {
+            throw new DTClientErrorException(ClientErrorCode.INVALID_ROOM_ID);
+        }
+    }
+}
+

src/main/java/com/debatetimer/exception/errorcode/ClientErrorCode.java

@@ -53,6 +53,8 @@ public enum ClientErrorCode implements ResponseErrorCode {
     ALREADY_DONE_POLL(HttpStatus.BAD_REQUEST, "이미 완료된 투표 입니다"),
     ALREADY_VOTED_PARTICIPANT(HttpStatus.BAD_REQUEST, "이미 참여한 투표자 입니다"),
 
+    INVALID_ROOM_ID(HttpStatus.BAD_REQUEST, "잘못된 roomId 값입니다"),
+
     TABLE_NOT_FOUND(HttpStatus.NOT_FOUND, "토론 테이블을 찾을 수 없습니다."),
     NOT_TABLE_OWNER(HttpStatus.UNAUTHORIZED, "테이블을 소유한 회원이 아닙니다."),
     POLL_NOT_FOUND(HttpStatus.NOT_FOUND, "투표를 찾을 수 없습니다."),

src/main/resources/application-dev.yml

@@ -21,7 +21,9 @@ spring:
     baseline-version: 1
 
 cors:
-  origin: ${secret.cors.origin}
+  origin:
+    cors-origin:
+      - ${secret.cors.origin}
 
 oauth:
   client_id: ${secret.oauth.client_id}

src/main/resources/application-prod.yml

@@ -20,7 +20,9 @@ spring:
     baseline-version: 1
 
 cors:
-  origin: ${secret.cors.origin}
+  origin:
+    cors-origin:
+      - ${secret.cors.origin}
 
 oauth:
   client_id: ${secret.oauth.client_id}

src/test/java/com/debatetimer/BaseStompTest.java

@@ -0,0 +1,76 @@
+package com.debatetimer;
+
+import com.debatetimer.fixture.HeaderGenerator;
+import com.debatetimer.fixture.entity.MemberGenerator;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.messaging.converter.MappingJackson2MessageConverter;
+import org.springframework.messaging.converter.MessageConverter;
+import org.springframework.messaging.simp.stomp.StompSession;
+import org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter;
+import org.springframework.web.socket.client.standard.StandardWebSocketClient;
+import org.springframework.web.socket.messaging.WebSocketStompClient;
+import org.springframework.web.socket.sockjs.client.SockJsClient;
+import org.springframework.web.socket.sockjs.client.Transport;
+import org.springframework.web.socket.sockjs.client.WebSocketTransport;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public abstract class BaseStompTest {
+
+    private static final String SOCKET_ENDPOINT = "/ws";
+
+    protected StompSession stompSession;
+
+    @LocalServerPort
+    private int port;
+
+    private final String url;
+
+    private final WebSocketStompClient websocketClient;
+
+    @Autowired
+    protected MemberGenerator memberGenerator;
+
+    @Autowired
+    protected HeaderGenerator headerGenerator;
+
+    public BaseStompTest() {
+        List<Transport> transports = List.of(new WebSocketTransport(new StandardWebSocketClient()));
+        this.websocketClient = new WebSocketStompClient(new SockJsClient(transports));
+        this.websocketClient.setMessageConverter(buildMessageConverter());
+        this.url = "ws://localhost:";
+    }
+
+    private MessageConverter buildMessageConverter() {
+        MappingJackson2MessageConverter converter = new MappingJackson2MessageConverter();
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.registerModule(new JavaTimeModule());
+        objectMapper.findAndRegisterModules();
+        converter.setObjectMapper(objectMapper);
+        return converter;
+    }
+
+    @BeforeEach
+    public void connect() throws ExecutionException, InterruptedException, TimeoutException {
+        this.stompSession = this.websocketClient
+                .connectAsync(url + port + SOCKET_ENDPOINT, new StompSessionHandlerAdapter() {
+                })
+                .get(3, TimeUnit.SECONDS);
+    }
+
+    @AfterEach
+    public void disconnect() {
+        if (this.stompSession.isConnected()) {
+            this.stompSession.disconnect();
+        }
+    }
+}