[25.06.19 / TASK-208] Feature - cookie and usermodel update

[Nuung]

🔥 변경 사항

• 쿠키 clear 시 maxAge 는 미래 버전에 삭제됨, 그래서 미리 제거
• 추가로 username / email / thumbnail 업데이트도 마저 대응 개발 필요 (특히 로그인 부분)

🏷 관련 이슈

• 없습니다. PS) @six-standard 기준님, 이 부분 계속 랜덤으로 두시던데 다음 PR 부터는 제거 부탁드려요!

📸 스크린샷 (UI 변경 시 필수)

📌 체크리스트

• 기능이 정상적으로 동작하는지 테스트 완료 => 특히 컨트롤러 계층 최초 테스트 코드 추가
• 코드 스타일 가이드 준수 여부 확인
• 관련 문서 업데이트 완료 (필요 시)

Summary by CodeRabbit

• 신규 테스트

  • 사용자 관련 주요 기능(로그인, 샘플 로그인, 로그아웃, 현재 사용자 조회, 토큰 생성 및 조회)에 대한 단위 테스트가 추가되었습니다.

• 기능 개선

  • 사용자 정보에 username과 thumbnail(프로필 이미지) 필드가 추가되어, 로그인 및 사용자 생성/갱신 시 더 많은 정보가 저장 및 반환됩니다.
  • 쿠키 삭제 시 환경에 따라 옵션이 더 정확하게 적용됩니다.

• 버그 수정

  • 사용자 정보 반환 시 username이나 thumbnail이 없을 때 빈 문자열로 대체되어 일관된 데이터 제공이 보장됩니다.

[notion-workspace]

로그인시 정보 업데이트 추가 / express 버전 deprecated 된 이슈 체크

[coderabbitai]

"""

Walkthrough

이 변경사항은 사용자 컨트롤러와 관련 서비스, 레포지토리, DTO에 대해 username과 thumbnail 필드를 추가 및 확장하며, 쿠키 옵션 처리 방식을 개선합니다. 또한 UserController의 주요 메서드에 대한 포괄적인 단위 테스트가 새롭게 작성되었습니다.

Changes

파일/경로 그룹	변경 요약
src/controllers/test/user.controller.test.ts	UserController의 login, sampleLogin, logout, fetchCurrentUser, createToken, getToken 메서드에 대한 포괄적 단위 테스트 추가
src/controllers/user.controller.ts	cookieOption 메서드가 isClear 파라미터를 받아 쿠키 설정/삭제 옵션 분기, res.clearCookie 호출부 수정, 응답 데이터에 user의 username/thumbnail 사용
src/repositories/user.repository.ts	updateTokens, createUser 메서드에 username, thumbnail 파라미터 추가 및 SQL 쿼리 확장
src/services/user.service.ts	handleUserTokensByVelogUUID, createUser, updateUserTokens에서 username, thumbnail 처리 및 전달 로직 추가
src/types/dto/userWithToken.type.ts	UserWithTokenDto에 username(필수), thumbnail(옵션) 필드 추가 및 생성자/데코레이터 반영
.github/workflows/test-ci.yaml	테스트 CI 환경변수에 AES_KEY_0~AES_KEY_9 추가

Sequence Diagram(s)

sequenceDiagram participant Client participant UserController participant UserService participant UserRepository participant VelogAPI Client->>UserController: login 요청 (access/refresh token) UserController->>VelogAPI: 사용자 정보 요청 VelogAPI-->>UserController: 사용자 정보 (username, thumbnail 등) UserController->>UserService: handleUserTokensByVelogUUID(userData, tokens) UserService->>UserRepository: createUser/updateTokens(uuid, email, username, thumbnail, tokens) UserRepository-->>UserService: User 객체 반환 UserService-->>UserController: User 객체 반환 UserController-->>Client: 쿠키 설정 및 사용자 정보 응답 

Loading

Possibly related PRs

• #17: sampleLogin 메서드 도입 및 관련 서비스/레포지토리 변경, 본 PR 테스트 코드와 직접적 연관.
• #32: UserController의 cookieOption 메서드 관련 변경, 쿠키 옵션 처리 방식 개선과 관련.
• #18: UserRepository의 createUser 메서드에서 email 파라미터 타입 변경 관련, 동일 메서드 수정과 연관.

Suggested reviewers

• six-standard
• ooheunda
• Jihyun3478

Poem

🐰
새로운 username, 썸네일도 추가해
쿠키 옵션도 똑똑하게 바꿨어요
테스트도 빵빵하게 달아
사용자 정보, 더 풍성하게
토큰도 안전하게
오늘도 깡총! 코드를 지켜요
— 코드래빗 드림 🥕
"""

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b27e4d8 and bc956e0.

📒 Files selected for processing (2)

• .github/workflows/test-ci.yaml (1 hunks)
• src/controllers/__test__/user.controller.test.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/test-ci.yaml

🚧 Files skipped from review as they are similar to previous changes (1)

• src/controllers/test/user.controller.test.ts

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: build-and-test (22)
• GitHub Check: build-and-test (20)
• GitHub Check: build-and-test (23)
• GitHub Check: build-and-test (21)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch feature/cookie-and-usermodel-update

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🔭 Outside diff range comments (1)

src/services/user.service.ts (1)

65-73: 신규 유저 생성 시 평문 토큰이 DB에 잠시 저장됨

1. createUser → 평문 토큰 저장
2. 곧바로 updateUserTokens 로 암호화 토큰 재저장

두 번의 DB 라운드트립과 평문 저장 노출이 발생합니다.

암호화 후 한 번의 INSERT 로 처리하면 보안·성능 양쪽에서 이득입니다. 필요하다면 encryptTokens 호출을 분리해 createUser 이전에 수행하는 구조로 리팩터링을 제안드립니다.

🧹 Nitpick comments (6)

src/types/dto/userWithToken.type.ts (1)

16-18: thumbnail 필드에 문자열 검증이 누락됨

thumbnail 역시 문자열 입력이 예상됩니다. @IsString() 데코레이터를 추가해 일관된 검증을 유지해 주세요.

 @IsOptional() + @IsString() thumbnail: string | null = null;

src/controllers/user.controller.ts (1)

24-37: clearCookie 시 만료 값 설정 고려

일부 브라우저는 maxAge 가 없더라도 쿠키를 완전히 제거하지 않을 수 있습니다.
isClear 일 때 expires: new Date(0) 를 추가하면 호환성이 향상됩니다.

src/services/user.service.ts (1)

59-61: thumbnail 널 병합 뒤 세미콜론 누락

코드상 문제는 없지만 ESLint 규칙(semicolons)을 사용한다면 경고가 발생할 수 있습니다. 한 줄 주석 뒤 세미콜론을 추가해 두는 편이 깔끔합니다.

src/repositories/user.repository.ts (1)

45-54: SET 절에 컬럼이 추가된 만큼 DB 인덱스 검토

email, username 으로 조회하는 기능이 이미 있거나 향후 생길 경우 복합 인덱스를 고려해 주세요.
지금 단계에서 코드 오류는 없으므로 참고만 하시면 됩니다.

src/controllers/__test__/user.controller.test.ts (2)

11-14: 자동 모킹된 클래스 인스턴스 사용 주의

jest.mock('@/services/user.service') 로 자동 모킹하면 생성자·메서드가 자동으로 jest.fn() 으로 대체됩니다. 현재처럼 실제 인스턴스를 new로 만들면 타입은 맞지만 내부 구현이 없으므로 예기치 않은 호출 누락이 발생할 수 있습니다.

명시적 팩토리로 필요한 메서드만 mock 구현을 리턴하거나, jest.mocked(UserService.prototype) 을 사용해 spyOn 방식으로 부분 모킹하는 구조를 고려해 주세요.

---

56-63: 환경 변수 복원 누락

테스트마다 process.env.NODE_ENV 값을 변경하지만 afterEach 에서 원래 값을 복원하지 않습니다.
다른 테스트 파일에 영향이 갈 수 있으니 이전 값을 저장했다가 복구해 주세요.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f139b91 and 6dfe9cc.

📒 Files selected for processing (5)

• src/controllers/__test__/user.controller.test.ts (1 hunks)
• src/controllers/user.controller.ts (5 hunks)
• src/repositories/user.repository.ts (4 hunks)
• src/services/user.service.ts (6 hunks)
• src/types/dto/userWithToken.type.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: build-and-test (20)
• GitHub Check: build-and-test (23)
• GitHub Check: build-and-test (22)
• GitHub Check: build-and-test (21)

🔇 Additional comments (1)

src/types/dto/userWithToken.type.ts (1)

27-33: 생성자 시그니처 변경에 따른 호출부 확인 필요

파라미터가 두 개 늘어났습니다. 기존 호출 코드가 컴파일-타임 오류 없이 빌드되는지, 또 리플렉션 기반 생성(예: plainToInstance)에 영향이 없는지 전역 검색으로 확인해 주세요.
필요하다면 오버로드나 default 값을 고려해도 좋습니다.

[six-standard]

🔥 변경 사항

• 쿠키 clear 시 maxAge 는 미래 버전에 삭제됨, 그래서 미리 제거
• 추가로 username / email / thumbnail 업데이트도 마저 대응 개발 필요 (특히 로그인 부분)

🏷 관련 이슈

• 없습니다. PS) @six-standard 기준님, 이 부분 계속 랜덤으로 두시던데 다음 PR 부터는 제거 부탁드려요!

📸 스크린샷 (UI 변경 시 필수)

📌 체크리스트

• 기능이 정상적으로 동작하는지 테스트 완료 => 특히 컨트롤러 계층 최초 테스트 코드 추가
• 코드 스타일 가이드 준수 여부 확인
• 관련 문서 업데이트 완료 (필요 시)

Summary by CodeRabbit

• 신규 테스트

  • 사용자 관련 주요 기능(로그인, 샘플 로그인, 로그아웃, 현재 사용자 조회, 토큰 생성 및 조회)에 대한 단위 테스트가 추가되었습니다.

• 기능 개선

  • 사용자 정보에 username과 thumbnail(프로필 이미지) 필드가 추가되어, 로그인 및 사용자 생성/갱신 시 더 많은 정보가 저장 및 반환됩니다.
  • 쿠키 삭제 시 환경에 따라 옵션이 더 정확하게 적용됩니다.

• 버그 수정

  • 사용자 정보 반환 시 username이나 thumbnail이 없을 때 빈 문자열로 대체되어 일관된 데이터 제공이 보장됩니다.

이슈 부분에 태스크 ID를 둬야 하는건가 싶어서 습관적으로 계속 두고 있었는데, 되짚어보면 다른 분들의 PR에는 거의 X였으니 자각을 못 하고 있었던 것 같네요;;
다음부터는 필요할 때만 채워두겠습니다. 죄송합니다!

[six-standard]

코드 잘 읽었습니다!

좋았던 점

• jsdoc이 추가된 부분들이 몇 부분 있던데, 확실히 이해에 도움이 되었습니다.
• undefined 방어 등 세세하게 오류가 발생할 수 있는 부분들을 고려해 두신점이 보기 좋았습니다!

[Jihyun3478]

코드 잘 읽었습니다. 고생하셨습니다~!!

좋았던 점

• cookieOption(true)로 maxAge 없이 설정한다는 점을 명시해주신 부분이 좋았습니다!
• email, username, thumbnail에 대한 null 처리가 명확히 되어있어서 좋았습니다!

[ooheunda]

코드 잘 봤습니다! 고생 많으셨습니다~! 👍 🔥

좋았던 점

• 다른 분들께서도 짚어주셨다시피 적절한 주석과 빈 값 처리가 좋았습니다!
• 개인적으로 평소에 잘 작성하지 않았던 컨트롤러 계층 테스트 코드도 보게 되어서 좋았습니다!! 인증/인가 작업엔 컨트롤러 계층도 확실히 써 두는게 좋을 것 같네요! 모킹, 테스트 케이스들 다 꼼꼼히 챙겨주신 부분도 너무 좋았습니다.