[25.03.16 / TASK-146] Refactor - post service

[Nuung]

🔥 변경 사항

게시글 디테일 정렬 이슈 배포 이후 핫픽스 / 테스트 코드 강화
앞으로 api 로컬 테스팅을 위해서 post.repo.integration.test 를 필수 참조해주세요!!! (readme 에 추가함)

• 해당 테스트는 mocking 없이 DBMS connection 을 맺고 repo 계층의 실제 수행을 테스트 합니다.
• 이에 따라, local DBMS 와 connection 을 맺는다면 테스트로 제공해야 할 TEST CASE 의 값들이 달라져야 합니다.
• 이 때문에 전체 테스트에 이슈가 있을 수 있으니 해당 값 꼭 체크 해야 함다!

🏷 관련 이슈

• 채널톡 문의 참고!!

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

없습니다!

📌 체크리스트

• 기능이 정상적으로 동작하는지 테스트 완료
• 코드 스타일 가이드 준수 여부 확인
• 관련 문서 업데이트 완료 (필요 시) -> 하기 노션 필수 참조 부탁드립니다.

Summary by CodeRabbit

• Chores

  • CI 프로세스 개선을 위해 환경 변수 설정 단계를 추가했습니다.

• Refactor

  • 게시물 조회 및 통계 관련 API의 명칭을 일관성 있게 개선했습니다.

• Tests

  • 게시물 기능의 신뢰성을 높이기 위해 통합 테스트를 도입했습니다.
  • 게시물 서비스에 대한 종합 테스트 스위트를 추가했습니다.

• Documentation

  • 로컬 테스트 지침과 Node.js 버전 요구사항에 대한 문서를 업데이트했습니다.

[notion-workspace]

게시글 디테일 정렬 이슈 배포 이후 핫픽스 / 테스트 코드 강화

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

이 PR은 CI 워크플로우와 코드베이스 전반에 걸쳐 일관성 있는 메서드 명칭 변경 및 SQL 쿼리 개선 작업을 포함합니다. .github/workflows/test-ci.yaml 파일에는 GitHub secrets로부터 환경 변수를 설정하는 새로운 스텝이 추가되었고, Post 관련 컨트롤러, 서비스, 리포지토리, 테스트 및 라우터에서 메서드명이 표준화되었습니다. 또한, PostRepository의 SQL 쿼리 구성 개선과 조건부 날짜 필터링 로직이 도입되었습니다.

Changes

파일(들)	변경 내용 요약
.github/workflows/test-ci.yaml	CI 워크플로우에 GitHub secrets를 사용하여 환경 변수를 설정하는 .env 파일 생성 스텝 추가
src/controllers/post.controller.ts, src/routes/post.router.ts	메서드 명 변경: getAllPost → getAllPosts, getAllPostStatistics → getAllPostsStatistics
src/services/post.service.ts, src/services/__test__/post.service.test.ts	메서드 명 변경: getAllposts → getAllPosts, getAllPostStatistics → getAllPostsStatistics; 파라미터명 수정: postId → postUUUID (getPostByPostUUID)
src/repositories/post.repository.ts	SQL 쿼리 구조 개선: 기본 쿼리와 날짜 필터 쿼리 분리, 조건부 파라미터 포함; findPostByPostUUID의 파라미터명 postId를 postUUUID로 변경
src/repositories/__test__/post.repo.integration.test.ts	PostRepository의 기능을 검증하는 통합 테스트 스위트 추가

Possibly related PRs

• [24.12.30/ TASK-65] feature get post #9: PostController와 PostRepository의 메서드 명 변경 및 기능 추가와 관련된 코드 변경 사항이 포함됨.
• [24.11.24 / TASK-33] Feature - 프로젝트 Init #1: 환경 변수를 설정하는 .env 파일 생성과 관련된 PR로, 데이터베이스 작업에 필요한 환경 변수를 설정하는 데 초점을 맞춤.

Suggested labels

documentation

Suggested reviewers

• six-standard
• cheonHwi

Poem

토끼가 노래해요, 새 코드의 향연
.env 파일이 반짝이며 CI의 문을 열고,
게시글 메서드 이름도 깔끔하게 변했네! 🐇
리포지토리와 서비스가 함께 춤추며,
통합 테스트까지 완벽한 우리 코드의 축제!
두근두근 토끼의 코드 이야기, 모두 모여 축하합시다!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 176e666 and 6089369.

📒 Files selected for processing (2)

• src/services/__test__/post.service.test.ts (1 hunks)
• src/services/post.service.ts (4 hunks)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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 (2)

src/services/__test__/post.service.test.ts (1)

21-87: ⚠️ Potential issue

테스트 및 메서드 이름 불일치가 있습니다.

getAllposts 테스트 섹션(21-87줄)에서는 postService.getAllposts()를 호출하고 있지만, 다른 파일의 변경사항을 보면 이 메서드명도 getAllPosts로 표준화되어야 합니다. 테스트 코드의 메서드 호출(53, 86줄)도 이에 맞게 업데이트해야 합니다.

이 부분을 다음과 같이 수정하세요:

- describe('getAllposts', () => {
+ describe('getAllPosts', () => {
  // ...
- const result = await postService.getAllposts(1);
+ const result = await postService.getAllPosts(1);
  // ...
- await expect(postService.getAllposts(1)).rejects.toThrow(errorMessage);
+ await expect(postService.getAllPosts(1)).rejects.toThrow(errorMessage);

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

25-25: ⚠️ Potential issue

메서드 호출 불일치 문제가 있습니다.

컨트롤러 메서드명이 getAllPosts로 변경되었지만, 내부에서는 여전히 this.postService.getAllposts를 호출하고 있습니다. 이는 서비스 메서드명과 일치하지 않는 문제가 있습니다. 서비스의 메서드명도 일관되게 getAllPosts로 변경되어야 합니다.

다음과 같이 수정하세요:

- const result = await this.postService.getAllposts(id, cursor, sort, asc);
+ const result = await this.postService.getAllPosts(id, cursor, sort, asc);

🧹 Nitpick comments (1)

src/repositories/__test__/post.repo.integration.test.ts (1)

431-448: findPostByPostUUID 메서드 테스트가 적절하게 구현되었습니다.

UUID를 사용한 게시물 조회 기능을 검증하는 테스트가 핵심 기능을 잘 검증하고 있습니다:

• 게시물 UUID로 통계 데이터 조회 기능 확인
• 날짜 필터링 적용 검증
• 결과 객체의 구조 검증

다만, 다른 메서드 테스트와 비교하면 테스트 케이스 수가 적은 편입니다. 필요하다면 추가 시나리오(존재하지 않는 UUID, 다양한 날짜 범위 등)에 대한 테스트를 추가하는 것을 고려해볼 수 있습니다.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4312528 and edf8c7c.

📒 Files selected for processing (7)

• .github/workflows/test-ci.yaml (2 hunks)
• src/controllers/post.controller.ts (2 hunks)
• src/repositories/__test__/post.repo.integration.test.ts (1 hunks)
• src/repositories/post.repository.ts (3 hunks)
• src/routes/post.router.ts (2 hunks)
• src/services/__test__/post.service.test.ts (3 hunks)
• src/services/post.service.ts (5 hunks)

🔇 Additional comments (24)

.github/workflows/test-ci.yaml (1)

53-59: 환경 변수 설정 추가, 좋은 개선입니다!

GitHub secrets에서 데이터베이스 연결 정보를 가져와 .env 파일로 설정하는 스텝을 추가한 것은 CI 환경에서 매우 중요한 개선사항입니다. 이를 통해 테스트 및 빌드 프로세스가 필요한 환경 변수에 접근할 수 있게 되었습니다.

src/services/__test__/post.service.test.ts (3)

15-15: ESLint 규칙 비활성화에 대한 명시적 주석 추가, 좋습니다.

타입 단언(type assertion)에 대한 ESLint 규칙을 명시적으로 비활성화하는 주석을 추가한 것은 코드의 의도를 명확히 하는 좋은 방법입니다.

---

102-102: 메서드명 표준화, 일관성 향상입니다.

getAllPostStatistics에서 getAllPostsStatistics로 메서드명을 변경하여 복수형을 사용함으로써 이름 규칙의 일관성을 개선했습니다. 이는 코드 가독성과 유지보수성을 향상시킵니다.

---

117-117: 메서드명 표준화, 일관성 향상입니다.

여기서도 getAllPostStatistics에서 getAllPostsStatistics로 메서드명을 변경하여 표준화된 네이밍 컨벤션을 적용했습니다.

src/routes/post.router.ts (2)

52-52: 메서드명 표준화, 라우터 연결 업데이트

컨트롤러의 메서드명이 getAllPost에서 getAllPosts로 변경됨에 따라 라우터의 연결도 적절히 업데이트되었습니다. 이러한 일관된 변경은 코드베이스 전체의 일관성을 유지하는 데 중요합니다.

---

72-72: 메서드명 표준화, 라우터 연결 업데이트

컨트롤러의 메서드명이 getAllPostStatistics에서 getAllPostsStatistics로 변경됨에 따라 라우터 연결도 적절히 업데이트되었습니다. 이는 표준화된 네이밍 컨벤션을 유지하는 데 필요한 변경사항입니다.

src/controllers/post.controller.ts (3)

16-16: 메서드명 표준화, 일관성 향상

getAllPost에서 getAllPosts로 메서드명을 변경하여 복수형을 사용함으로써 이름 규칙의 일관성을 개선했습니다. 이는 코드 가독성과 유지보수성을 향상시킵니다.

---

41-41: 메서드명 표준화, 일관성 향상

getAllPostStatistics에서 getAllPostsStatistics로 메서드명을 변경하여 복수형을 사용함으로써 이름 규칙의 일관성을 개선했습니다. 이는 코드 가독성과 유지보수성을 향상시킵니다.

---

49-49: 서비스 메서드 호출 업데이트, 일관성 향상

서비스 메서드 호출을 this.postService.getAllPostStatistics에서 this.postService.getAllPostsStatistics로 변경하여 네이밍 컨벤션의 일관성을 유지했습니다. 이는 메서드명 변경에 따른 필수적인 업데이트입니다.

src/repositories/__test__/post.repo.integration.test.ts (5)

17-106: 통합 테스트 설정이 잘 구현되었습니다.

테스트 환경 설정이 매우 체계적으로 구현되었습니다. 실제 데이터베이스와 연결하여 테스트하는 접근 방식이 좋으며, 다음과 같은 점이 인상적입니다:

• 테스트 데이터 ID 정의
• SSL 설정 조건부 적용
• 테스트 데이터 존재 여부 확인 및 경고 로깅
• 적절한 에러 처리 및 연결 종료 로직

테스트 데이터가 없을 경우에도 테스트가 실패하지 않도록 경고 로깅을 추가한 부분이 특히 좋습니다.

---

111-262: findPostsByUserId 메서드에 대한 포괄적인 테스트 케이스가 잘 구현되었습니다.

다양한 시나리오를 테스트하는 체계적인 접근 방식이 좋습니다:

• 기본 조회 기능 검증
• 페이지네이션 메커니즘 검증
• 다양한 정렬 옵션 테스트
• 오름차순/내림차순 정렬 검증
• limit 파라미터 기능 검증
• 커서 기반 페이지네이션의 일관성 검증

특히 충분한 데이터가 없는 경우를 고려하여 조건부 테스트를 구현한 부분이 실무적인 접근으로 좋습니다.

---

269-276: getTotalPostCounts 테스트가 간결하고 명확합니다.

간단하지만 필수적인 검증을 수행하고 있습니다:

• 반환 값이 숫자 타입인지 확인
• 반환 값이 0 이상인지 확인

이 테스트는 간결하면서도 메서드의 핵심 기능을 잘 검증하고 있습니다.

---

281-321: getYesterdayAndTodayViewLikeStats 메서드에 대한 테스트가 체계적입니다.

다음과 같은 다양한 검증 포인트를 포함하고 있어 좋습니다:

• 반환 객체의 구조 검증
• 통계 값이 음수가 아닌지 확인
• 값들이 숫자로 변환 가능한지 확인
• 존재하지 않는 사용자 ID에 대한 기본값 처리 검증

특히 엣지 케이스(존재하지 않는 사용자)를 테스트하는 부분이 잘 고려되었습니다.

---

327-425: findPostByPostId 메서드 테스트가 다양한 시나리오를 포함하고 있습니다.

여러 시나리오와 엣지 케이스에 대한 테스트가 포함되어 있어 좋습니다:

• 기본 조회 기능 검증
• 날짜 범위 필터링 검증
• 날짜 오름차순 정렬 검증
• 존재하지 않는 게시물 ID에 대한 처리 검증
• 날짜 형식 변환 검증
• 통계 값의 타입 검증

데이터가 없는 경우를 고려하여 조건부 테스트를 구현한 접근도 좋습니다.

src/services/post.service.ts (5)

6-6: 생성자 형식이 개선되었습니다.

코드 포맷팅이 일관되게 적용되었습니다.

---

34-34: 메서드명이 일관성 있게 변경되었습니다.

getAllPostStatistics에서 getAllPostsStatistics로 메서드명이 변경되어 복수형을 사용한 명명 규칙이 일관되게 적용되었습니다. 이는 코드 전체의 일관성을 향상시킵니다.

---

48-48: 에러 로그 메시지가 메서드명과 일치하도록 업데이트되었습니다.

메서드명 변경에 맞춰 에러 로그 메시지도 업데이트된 점이 좋습니다.

---

70-70: 매개변수명이 더 명확하게 변경되었습니다.

postId에서 postUUUID로 매개변수명이 변경되어 실제 데이터 타입을 더 잘 반영하게 되었습니다. 이는 코드의 자기 문서화 특성을 향상시킵니다.

---

79-79: 리포지토리 메서드 호출이 업데이트된 매개변수명과 일치하도록 수정되었습니다.

매개변수명 변경에 맞춰 리포지토리 메서드 호출도 적절히 업데이트되었습니다.

src/repositories/post.repository.ts (5)

6-6: 생성자 형식이 개선되었습니다.

코드 포맷팅이 일관되게 적용되었습니다.

---

165-194: 쿼리 구성 로직이 모듈화되어 개선되었습니다.

findPostByPostId 메서드의 SQL 쿼리 구성이 다음과 같이 크게 개선되었습니다:

• 기본 쿼리, 날짜 필터링, 정렬 부분이 명확하게 분리됨
• 날짜 필터링 조건이 존재할 때만 적용되는 로직이 명확해짐
• 최종 쿼리를 각 부분을 조합하여 구성하는 방식으로 가독성 향상
• 매개변수 배열을 조건에 따라 구성하는 방식으로 개선됨

이러한 개선은 코드의 가독성과 유지보수성을 크게 향상시킵니다. 특히 조건부 쿼리 구성이 명확해져 오류 발생 가능성이 줄어들었습니다.

---

197-197: 에러 로그 메시지 형식이 개선되었습니다.

로그 메시지의 형식이 더 일관되게 수정되었습니다. 콜론 뒤에 공백이 제거되어 다른 로그 메시지와 일관된 형식을 유지하게 되었습니다.

---

202-202: 매개변수명이 더 명확하게 변경되었습니다.

postId에서 postUUUID로 매개변수명이 변경되어 실제 데이터 타입을 더 잘 반영하게 되었습니다. 이는 코드의 자기 문서화 특성을 향상시킵니다.

---

217-217: values 배열이 업데이트된 매개변수명과 일치하도록 수정되었습니다.

매개변수명 변경에 맞춰 values 배열도 적절히 업데이트되었습니다.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

33-37: 로컬 테스팅 가이드라인 추가 검토
라인 33부터 37까지 로컬 환경에서 DBMS 연결 시 테스트 케이스 값 변경에 관한 주의를 추가한 점은 매우 유용합니다. 해당 안내 문구가 테스트 수행 시 발생할 수 있는 문제를 미연에 방지할 수 있도록 돕고 있습니다. 다만, 향후 사용자 혼동을 줄이기 위해 예시를 추가하거나 문장을 조금 더 간결하게 다듬는 것을 고려해볼 수 있습니다.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between edf8c7c and 176e666.

📒 Files selected for processing (1)

• README.md (3 hunks)

🔇 Additional comments (2)

README.md (2)

4-4: Node.js 버전 표기 포맷 변경 확인
README 파일에서 필수 Node.js 버전을 node 20+ 형식으로 재포맷한 점은 가독성을 높이는 데 도움이 됩니다. 변경사항이 명확해 보이며, 기존 스타일 가이드와도 부합하는 것 같습니다.

---

55-67: 프로젝트 구조 재정렬 및 설명 강화 검토
프로젝트 구조 섹션에서 디렉터리 트리의 들여쓰기와 주석 수정이 가독성과 이해도를 높이는데 기여하고 있습니다. 각 디렉터리의 역할이 명확히 드러나며, 구조적인 일관성 또한 유지되고 있는 것으로 보입니다.