Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/prod-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: make application.properties 파일 생성
run: |
## create application.yml
mkdir ./src/main/resources
mkdir -p ./src/main/resources
cd ./src/main/resources

# application.yml 파일 생성
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/prod-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
- name: make application.properties 파일 생성
run: |
## create application.yml
mkdir ./src/main/resources
mkdir -p ./src/main/resources
cd ./src/main/resources

# application.yml 파일 생성
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import org.runnect.server.common.constant.TokenStatus;
import org.runnect.server.common.constant.ErrorStatus;
import lombok.RequiredArgsConstructor;
import org.slf4j.MDC;
import org.runnect.server.common.module.check.TypeChecker;
import org.runnect.server.user.exception.authException.InvalidAccessTokenException;
import org.runnect.server.user.exception.authException.NullAccessTokenException;
Expand Down Expand Up @@ -76,6 +77,7 @@ public Object resolveArgument(@NotNull MethodParameter parameter, ModelAndViewCo
&& request.getMethod().equals("GET")
&& VISITOR_POSSIBLE_URLS.contains(removeLastPathSegment(request.getRequestURI()))){
// 방문자모드 허용 api에 대한 요청이 맞는지 검증
MDC.put("userId", String.valueOf(VISITOR_ID));
return VISITOR_ID;
}

Expand All @@ -92,7 +94,9 @@ public Object resolveArgument(@NotNull MethodParameter parameter, ModelAndViewCo
final String tokenContents = jwtService.getJwtContents(accessToken);

try {
return Long.parseLong(tokenContents);
Long userId = Long.parseLong(tokenContents);
MDC.put("userId", String.valueOf(userId));
return userId;
} catch (NumberFormatException e) {
throw new NotFoundUserException(ErrorStatus.NOT_FOUND_USER_EXCEPTION, ErrorStatus.NOT_FOUND_USER_EXCEPTION.getMessage());
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package org.runnect.server.config.logging;

import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.runnect.server.common.constant.TokenStatus;
import org.runnect.server.config.jwt.JwtService;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

/**
* 요청마다 traceId를 발급해 MDC에 담아둔다.
* 로그 패턴에 %X{traceId}를 포함시키면(logback-spring.xml), 여러 요청이 뒤섞인 로그에서도
* 같은 traceId로 특정 요청의 흐름만 추적할 수 있다.
*
* userId는 @UserId 파라미터가 없는 요청(토큰 재발급, 배너 등)에서도 로그에 남도록
* 여기서 best-effort로 한 번 더 채운다. 실제 인증 검증/방문자 모드 처리는 UserIdResolver가
* 맡고, 그 결과가 이후 이 값을 덮어쓴다.
*/
@Slf4j
@Component
@RequiredArgsConstructor
public class MdcLoggingFilter implements Filter {

private static final String TRACE_ID_KEY = "traceId";
private static final int TRACE_ID_LENGTH = 8;
private static final String USER_ID_KEY = "userId";

private final JwtService jwtService;

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
String traceId = UUID.randomUUID().toString().substring(0, TRACE_ID_LENGTH);
try {
MDC.put(TRACE_ID_KEY, traceId);
HttpServletRequest httpRequest = (HttpServletRequest) request;
populateUserIdBestEffort(httpRequest);
log.info("{} {}", httpRequest.getMethod(), httpRequest.getRequestURI());
chain.doFilter(request, response);
} finally {
MDC.remove(TRACE_ID_KEY);
MDC.remove(USER_ID_KEY);
}
}

private void populateUserIdBestEffort(HttpServletRequest request) {
String accessToken = request.getHeader("accessToken");
if (accessToken == null) {
return;
}
try {
if (jwtService.verifyToken(accessToken) == TokenStatus.TOKEN_VALID) {
MDC.put(USER_ID_KEY, jwtService.getJwtContents(accessToken));
}
} catch (RuntimeException e) {
// 로깅 목적의 best-effort 파싱이므로 실패해도 요청 처리는 계속 진행한다.
}
}
}
30 changes: 30 additions & 0 deletions src/main/resources/logback-spring.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>

<property name="LOG_DIR" value="./logs"/>
<property name="LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] [userId=%X{userId}] %-5level [%thread] %logger{36} - %msg%n"/>

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/runnect-server.log</file>
<encoder>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_DIR}/runnect-server.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>

<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="FILE"/>
</root>

</configuration>
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import static org.mockito.Mockito.when;

import javax.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.runnect.server.common.constant.TokenStatus;
Expand All @@ -15,6 +16,7 @@
import org.runnect.server.user.exception.authException.NullAccessTokenException;
import org.runnect.server.user.exception.authException.TimeExpiredAccessTokenException;
import org.runnect.server.user.exception.userException.NotFoundUserException;
import org.slf4j.MDC;
import org.springframework.core.MethodParameter;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.web.context.request.NativeWebRequest;
Expand All @@ -36,6 +38,11 @@ void setUp() {
methodParameter = mock(MethodParameter.class);
}

@AfterEach
void tearDown() {
MDC.clear();
}

private NativeWebRequest webRequestWith(String accessToken, String refreshToken, String method, String uri) {
HttpServletRequest servletRequest = mock(HttpServletRequest.class);
when(servletRequest.getHeader("accessToken")).thenReturn(accessToken);
Expand Down Expand Up @@ -65,12 +72,13 @@ private NativeWebRequest webRequestWith(String accessToken, String refreshToken,
}

@Test
void 방문자_모드_허용_URL이면_VISITOR_ID를_반환한다() {
void 방문자_모드_허용_URL이면_VISITOR_ID를_반환하고_MDC에_채운다() {
NativeWebRequest webRequest = webRequestWith("visitor", "visitor", "GET", "/api/public-course/123");

Object result = userIdResolver.resolveArgument(methodParameter, null, webRequest, null);

assertThat(result).isEqualTo(VISITOR_ID);
assertThat(MDC.get("userId")).isEqualTo(String.valueOf(VISITOR_ID));
}

@Test
Expand All @@ -92,14 +100,15 @@ private NativeWebRequest webRequestWith(String accessToken, String refreshToken,
}

@Test
void 유효한_토큰이면_userId를_반환한다() {
void 유효한_토큰이면_userId를_반환하고_MDC에_채운다() {
when(jwtService.verifyToken("valid")).thenReturn(TokenStatus.TOKEN_VALID);
when(jwtService.getJwtContents("valid")).thenReturn("42");
NativeWebRequest webRequest = webRequestWith("valid", "refresh", "GET", "/api/user");

Object result = userIdResolver.resolveArgument(methodParameter, null, webRequest, null);

assertThat(result).isEqualTo(42L);
assertThat(MDC.get("userId")).isEqualTo("42");
}

@Test
Expand Down
Loading