[이진용] sprint8#171
Hidden character warning
Conversation
Date : 20260109 Today I work's... Server && Channel make test logic
로그인 로그아웃 기능 추가. 기타 버그 수정
채널 서비스 관련한 업데이트 ResponseDto를 이용하여 채널 서비스를 고도화하였으며 향후 사용자의 마지막 읽은 메시지 내용 등을 추가하는 작업이 필요함.
첨부파일 기능을 추가했다. (아직 테스트중) MVC에 맞게 조금 리팩토링했다. (Service에서 출력하는 기능 제거 등) 메시지 조회 불가능한 버그를 고쳤다. (아직 테스트 중)
joonfluence
left a comment
joonfluence
left a comment
There was a problem hiding this comment.
전체 요약
Docker 컨테이너화, AWS S3 스토리지 연동, ECS 배포, GitHub Actions CI/CD 파이프라인 구축을 다루는 대규모 스프린트입니다. MDCLoggingInterceptor 추가, 커스텀 예외 계층 정비, 테스트 코드 보강 등 전반적인 코드 품질 개선이 인상적입니다. 다만 S3 클라이언트 리소스 누수, @ConditionalOnProperty 잘못된 기본값 설정 등 운영 환경에서 실제 문제를 유발할 수 있는 이슈들이 있어 수정 요청드립니다.
| return id; | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
[P1] get() 메서드에서 S3Client 리소스 누수
S3Client는 Closeable을 구현하므로 반드시 닫아야 합니다. 현재 구현은 매 호출마다 새 클라이언트를 생성하면서 닫지 않아 커넥션 풀/HTTP 리소스가 누수됩니다. put() 메서드는 try-with-resources를 올바르게 쓰고 있는데, 여기서도 동일하게 적용해야 합니다.
단, InputStream과 S3Client의 생명주기가 얽혀 있어 try-with-resources로 감싸면 스트림이 조기에 닫힐 수 있습니다. 아래 P2 코멘트처럼 클라이언트를 싱글턴 필드로 만들어 재사용하는 방식이 근본적인 해결책입니다.
| import software.amazon.awssdk.services.s3.model.GetObjectRequest; | ||
| import software.amazon.awssdk.services.s3.model.PutObjectRequest; | ||
| import software.amazon.awssdk.services.s3.presigner.S3Presigner; | ||
| import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest; |
There was a problem hiding this comment.
[P1] matchIfMissing = true 잘못된 설정
matchIfMissing = true는 프로퍼티가 아예 없을 때도 이 빈을 등록한다는 의미입니다. 즉, discodeit.storage.type을 설정하지 않으면 S3 빈이 기본으로 등록되어 AWS 자격증명 없이 애플리케이션 시작 시 오류가 발생합니다.
| import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest; | |
| @ConditionalOnProperty(name = "discodeit.storage.type", havingValue = "s3") |
| application: | ||
| name: "discodeit" | ||
| profiles: | ||
| active: prod |
There was a problem hiding this comment.
[P2] 기본 application.yml에 prod 프로필 하드코딩
기본 application.yml에 spring.profiles.active: prod를 설정하면, 다른 환경(dev, test)에서 명시적으로 오버라이드하지 않는 한 prod 프로필이 강제 적용됩니다. Spring Boot 공식 권장 방식은 실행 시 -Dspring.profiles.active=prod 또는 환경변수(SPRING_PROFILES_ACTIVE)로 주입하는 것입니다.
또한 같은 파일에 ddl-auto: create가 설정되어 있어, prod 환경에서 실수로 기본 application.yml이 적용되면 테이블이 재생성될 위험이 있습니다. ddl-auto는 최소한 validate나 none으로 설정하거나 프로필별 yml에서만 지정하는 것이 안전합니다.
| this.secretKey = secretKey; | ||
| this.region = region; | ||
| this.bucket = bucket; | ||
| this.expiration = expiration; |
There was a problem hiding this comment.
[P2] S3Client를 요청마다 새로 생성하는 비효율
S3Client는 스레드 안전하며 AWS SDK 공식 문서에서 싱글턴으로 재사용하도록 권장합니다. 요청마다 새 클라이언트를 생성하면 불필요한 HTTP 커넥션 초기화 비용이 반복 발생합니다. 생성자에서 한 번만 초기화하고 필드로 저장하는 방식을 추천드립니다.
private final S3Client s3Client;
private final S3Presigner presigner;
public S3BinaryContentStorage(...) {
AwsBasicCredentials creds = AwsBasicCredentials.create(accessKey, secretKey);
Region r = Region.of(region);
this.s3Client = S3Client.builder()
.region(r)
.credentialsProvider(StaticCredentialsProvider.create(creds))
.build();
this.presigner = S3Presigner.builder()
.region(r)
.credentialsProvider(StaticCredentialsProvider.create(creds))
.build();
}이렇게 하면 getS3Client() 헬퍼 메서드도 제거할 수 있고, get() 메서드의 리소스 누수 문제도 함께 해결됩니다.
| .region(region) | ||
| .credentialsProvider(StaticCredentialsProvider.create(credentials)) | ||
| .build(); | ||
|
|
There was a problem hiding this comment.
[P2] 테스트 실행 순서 미보장으로 인한 잠재적 실패
downloadTest()는 testKey = "test-file.txt"가 S3에 이미 존재한다고 가정하며, 이는 uploadTest()가 먼저 실행된 경우에만 보장됩니다. JUnit 5는 테스트 실행 순서를 보장하지 않습니다. 순서에 의존하는 테스트는 아래처럼 명시적으로 지정해야 합니다.
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
class AWSS3Test {
@Test
@Order(1)
void uploadTest() { ... }
@Test
@Order(2)
void downloadTest() { ... }
}또는 각 테스트가 자체적으로 데이터를 세팅하도록 독립적으로 만드는 방법도 고려해보세요.
| token: ${{ secrets.CODECOV_TOKEN }} | ||
| fail_ci_if_error: true | ||
|
|
||
| build-and-push: |
There was a problem hiding this comment.
[P3] CI 워크플로우에 CD 잡이 포함된 문제
파일명은 test.yml인데 build-and-push와 deploy 잡이 포함되어 있습니다. 더 중요한 문제는 on.push.branches에 이진용-sprint8이 포함되어 있어, 피처 브랜치에 푸시할 때마다 ECS에 실제 배포가 트리거될 수 있습니다.
CI(테스트)와 CD(빌드·배포)를 별도 워크플로우 파일로 분리하고, CD는 release 브랜치 push 이벤트에만 트리거되도록 제한하는 것이 안전합니다.
|
|
||
| return channelMapper.toDto(channelRepository.save(channel), List.of(), Instant.MIN); | ||
| ChannelDto dto = channelMapper.toDto(channelRepository.save(channel), List.of(), Instant.MIN); | ||
| log.info("Public 채널 생성 완료. 채널ID: {}, 채널명: {}", dto.name(), dto.name()); |
There was a problem hiding this comment.
[P3] 로그 오타: dto.name() 두 번 사용
채널 ID 자리에 dto.name()이 잘못 사용되었습니다.
| log.info("Public 채널 생성 완료. 채널ID: {}, 채널명: {}", dto.name(), dto.name()); | |
| log.info("Public 채널 생성 완료. 채널ID: {}, 채널명: {}", dto.id(), dto.name()); |
| POSTGRES_PASSWORD: ${DB_PASSWORD} | ||
| healthcheck: | ||
| test: [ "CMD-SHELL", "pg_isready -U ${DB_USER} -d ${DB_NAME}" ] | ||
| interval: 5s |
There was a problem hiding this comment.
[P4] healthcheck에 retries 미설정
retries 설정이 없어 기본값(3회)이 적용됩니다. DB 기동이 느린 환경에서 앱이 조기에 unhealthy 판정을 받을 수 있으니 명시적으로 설정해 두는 것이 안전합니다.
| interval: 5s | |
| healthcheck: | |
| test: [ "CMD-SHELL", "pg_isready -U ${DB_USER} -d ${DB_NAME}" ] | |
| interval: 5s | |
| timeout: 5s | |
| retries: 5 |
2 participants
요구사항
기본
애플리케이션 컨테이너화
Dockerfile 작성
이미지 빌드 및 실행 테스트
Docker Compose 구성
개발 환경용 docker-compose.yml 파일을 작성합니다.
BinaryContentStorage 고도화 (AWS S3)
AWS S3 버킷 구성
AWS S3 접근을 위한 IAM 구성
AWS S3 테스트
implementation 'software.amazon.awssdk:s3:2.31.7'
AWS S3를 활용한 BinaryContentStorage 고도화
앞서 작성한 테스트 메소드를 참고해 S3BinaryContentStorage를 구현하세요.
discodeit.storage.type 값이 s3인 경우에만 Bean으로 등록되어야 합니다.
S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.
BinaryContentStorage 설정을 유연하게 제어할 수 있도록 application.yaml을 수정하세요.
(-)type: local
(+)type: ${STORAGE_TYPE:local} # local | s3 (기본값: local)
local:
(-)root-path: .discodeit/storage
(+)root-path: ${STORAGE_LOCAL_ROOT_PATH:.discodeit/storage}
AWS 관련 정보는 형상관리하면 안되므로 .env 파일에 작성된 값을 임포트하는 방식으로 설정하세요.
Docker Compose에서도 위 설정을 주입할 수 있도록 수정하세요.
download 메소드는 PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.
AWS를 활용한 배포 (AWS RDS, ECR, ECS)
AWS RDS 구성
보안 그룹에서 인바운드 규칙을 편집하세요.
DataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.
데이터 소스 추가 시 SSH/SSL > Use SSH tunnel 설정을 활성화하세요. 이때 이전에 다운로드한 .pem 파일을 활용하세요.
구성이 완료되면 rds-ssh 인스턴스는 완전히 삭제하여 과금에 유의하세요.
AWS ECR 구성
이미지를 배포할 퍼블릭 레포지토리(discodeit)를 생성하세요.
AWS CLI를 설치하세요.
aws configure 실행 후 앞서 생성한 discodeit IAM 사용자 정보를 입력하세요.
discodeit IAM 사용자가 ECR에 접근할 수 있도록 다음 권한을 부여하세요.
Docker 클라이언트를 배포할 레지스트리에 대해 인증합니다.
멀티플랫폼을 지원하도록 애플리케이션 이미지를 빌드하고, discodeit 레포지토리에 push 하세요.
AWS 콘솔에서 푸시된 이미지를 확인하세요.
AWS ECS 구성
Spring Configuration
SPRING_PROFILES_ACTIVE=prod
Application Configuration
STORAGE_TYPE=s3
AWS_S3_ACCESS_KEY=엑세스_키
AWS_S3_SECRET_KEY=시크릿_키
AWS_S3_REGION=ap-northeast-2
AWS_S3_BUCKET=버킷_이름
AWS_S3_PRESIGNED_URL_EXPIRATION=600
DataSource Configuration
RDS_ENDPOINT=RDS_엔드포인트(포트 포함)
SPRING_DATASOURCE_URL=jdbc:postgresql://${RDS_ENDPOINT}/discodeit
SPRING_DATASOURCE_USERNAME=RDS_유저네임(DataGrip을 통해 생성했던 유저)
SPRING_DATASOURCE_PASSWORD=RDS_비밀번호
JVM Configuration (프리티어 고려)
JVM_OPTS="-Xmx384m -Xms256m -XX:MaxMetaspaceSize=64m -XX:+UseSerialGC"
심화
이미지 최적화하기
GitHub Actions를 활용한 CI/CD 파이프라인 구축
CI(지속적 통합)를 위한 워크플로우를 설정하세요.
.github/workflows/test.yml 파일을 생성하세요.
main 브랜치에 PR이 생성되면 실행되도록 설정하세요.
테스트가 실행하는 Job을 정의하세요.
[CodeCov]를 통해 테스트 커버리지 뱃지를 README에 추가해보세요.
CD(지속적 배포)를 위한 워크플로우를 설정하세요.
.github/workflows/deploy.yml 파일을 생성하세요.
release 브랜치에 코드가 푸시되면 실행되도록 설정하세요.
AWS 정보 설정
GitHub 레포지토리 설정을 통해 시크릿을 추가하세요.
GitHub 레포지토리 설정을 통해 변수를 추가하세요.
Docker 이미지 빌드 및 푸시
ECS 서비스 업데이트
AWS 콘솔을 통해 새로 등록된 태스크 정의로 배포되었는지 확인하세요.
리뷰를 위해 필요한 사항
15.165.43.148
주요 변경사항
스크린샷
멘토에게 @joonfluence