[25.03.20 / TASK-132] Feature - view growth order

[Nuung]

🔥 변경 사항

트래픽 데일리 상승량 순서 정렬

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

📌 체크리스트

• 기능이 정상적으로 동작하는지 테스트 완료
• 코드 스타일 가이드 준수 여부 확인
• 관련 문서 업데이트 완료 (필요 시)

Summary by CodeRabbit

• 새로운 기능

  • 포스트 조회 시, 조회수 성장률을 기준으로 정렬하는 옵션이 추가되어 트렌딩 콘텐츠를 쉽게 파악할 수 있습니다.
  • 포스트에 조회수 및 좋아요의 성장 지표가 제공되어 더욱 풍부한 데이터를 확인할 수 있습니다.
  • 페이지네이션 기능이 개선되어 연속 조회 시 중복 없이 정확한 결과를 전달합니다.

• 문서

  • API 문서에 새로운 정렬 옵션 "viewGrowth"가 업데이트되었습니다.

[notion-workspace]

트래픽 상승 순서 정렬

[coderabbitai]

Walkthrough

이 PR은 PostRepository와 PostService에 새로운 메서드인 findPostsByUserIdWithGrowthMetrics를 추가하고 이에 따른 테스트 케이스를 보완하는 변경 사항입니다. 테스트 스위트는 데이터 조회, 정렬(내림차순 및 오름차순), 페이지네이션, 에러 핸들링을 검증합니다. 또한, getAllposts 메서드에서 sort 매개변수 값에 따라 분기 처리를 적용하도록 로직이 변경되었으며, DTO 타입에 새로운 정렬 옵션인 'viewGrowth'가 반영되었습니다.

Changes

파일	변경 요약
src/repositories/__test__/post.repo.integration.test.ts, src/repositories/__test__/post.repo.test.ts	findPostsByUserIdWithGrowthMetrics 메서드에 대한 통합 및 단위 테스트 스위트 추가 (데이터 조회, 내림차순/오름차순 정렬, 페이지네이션, 에러 핸들링 검증)
src/repositories/post.repository.ts	기존 findPostsByUserId 메서드의 isAsc 파라미터 기본값 변경 및 SQL 조인을 통한 성장 지표(view_growth, like_growth) 계산을 수행하는 findPostsByUserIdWithGrowthMetrics 메서드 추가, 에러 로깅 처리 포함
src/services/post.service.ts	getAllposts 메서드 수정: sort 값이 "viewGrowth"인 경우 신규 메서드 findPostsByUserIdWithGrowthMetrics를 호출하도록 분기 로직 적용
src/types/dto/requests/getAllPostsQuery.type.ts	PostSortType 타입 및 Swagger 스키마에 'viewGrowth' 옵션 추가하여 정렬 기준 확장

Sequence Diagram(s)

sequenceDiagram
    participant U as 사용자
    participant PS as PostService
    participant PR as PostRepository
    
    U->>PS: getAllposts(userId, cursor, sort, isAsc, limit)
    alt sort 값이 "viewGrowth"인 경우
        PS->>PR: findPostsByUserIdWithGrowthMetrics(userId, cursor, isAsc, limit)
    else
        PS->>PR: findPostsByUserId(userId, cursor, sort, isAsc, limit)
    end
    PR-->>PS: posts 및 nextCursor 반환
    PS-->>U: 최종 결과 반환

Loading

Possibly related PRs

• [25.03.16 / TASK-146] Refactor - post service #23: findPostsByUserIdWithGrowthMetrics 메서드의 테스트와 구현 관련 변경 사항이 포함되어 있음.
• [25.01.08 / TASK-97] Feature - get post by UUID #14: 동일 메서드에 대한 테스트 케이스 추가와 관련된 코드 변경 사항이 있음.
• [25.03.09 / TASK-136] Feature - post repo order test, 레포 계층 테스팅과 CI 파이프라인 #20: PostRepository의 새로운 테스트 커버리지 확장을 다룬 PR로, 관련 기능에 대한 검증이 이루어짐.

Suggested labels

bug

Suggested reviewers

• BDlhj
• Jihyun3478
• six-standard

Poem

나는 작은 토끼, 코드 숲을 뛰네
새로운 기능의 향기를 맡으며 달려가네
성장의 비밀을 쫓아 SQL의 길을 걷고
테스트 케이스는 내 발자국처럼 남아
밤하늘의 별빛 아래, 문제들을 귀엽게 잡아내네 🐰✨
앞으로도 달콤한 코드 모험이 계속되길 바라네!
느긋하게 당근을 씹으며, 오늘도 행복한 하루!

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.
  • 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: 0

🧹 Nitpick comments (2)

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

122-212: 트래픽 성장률 기준 게시물 조회 메서드 추가

새로운 메서드 findPostsByUserIdWithGrowthMetrics가 잘 구현되었습니다. 다음과 같은 점이 특히 좋습니다:

1. 어제와 오늘의 데이터를 비교하여 트래픽 성장률을 정확히 계산
2. 커서 기반 페이지네이션 구현
3. 명확한 오류 처리 및 로깅

코드 재사용성을 개선하기 위해 공통 로직(예: 날짜 쿼리 부분)을 별도의 유틸리티 함수로 추출하는 것을 고려해 보세요. 이렇게 하면 향후 유지 관리가 더 쉬워질 수 있습니다.

+ // 공통으로 사용되는 날짜 관련 SQL 쿼리를 생성하는 유틸리티 함수
+ private getTodayStatsSubquery() {
+   return `
+     SELECT post_id, daily_view_count, daily_like_count, date
+     FROM posts_postdailystatistics
+     WHERE (date AT TIME ZONE 'Asia/Seoul' AT TIME ZONE 'UTC')::date = (NOW() AT TIME ZONE 'UTC')::date
+   `;
+ }
+
+ private getYesterdayStatsSubquery() {
+   return `
+     SELECT post_id, daily_view_count, daily_like_count, date
+     FROM posts_postdailystatistics
+     WHERE (date AT TIME ZONE 'Asia/Seoul' AT TIME ZONE 'UTC')::date = (NOW() AT TIME ZONE 'UTC' - INTERVAL '1 day')::date
+   `;
+ }

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

297-313: 오름차순 정렬 테스트가 적절합니다.

오름차순 정렬 테스트가 잘 구현되어 있습니다. 다만, 코드 가독성을 높이기 위해 주석을 추가하는 것이 좋겠습니다.

-          return post.view_growth >= result.posts[index - 1].view_growth;
+          // 오름차순 정렬이므로 현재 값이 이전 값보다 크거나 같아야 함
+          return post.view_growth >= result.posts[index - 1].view_growth;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6ba4531 and f32c459.

📒 Files selected for processing (5)

• src/repositories/__test__/post.repo.integration.test.ts (1 hunks)
• src/repositories/__test__/post.repo.test.ts (1 hunks)
• src/repositories/post.repository.ts (3 hunks)
• src/services/post.service.ts (1 hunks)
• src/types/dto/requests/getAllPostsQuery.type.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

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

src/exception/index.ts (1) (1)

• DBError (2-2)

🔇 Additional comments (7)

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

10-16: 조건부 로직 추가로 성장률 정렬 지원

새로운 viewGrowth 정렬 옵션을 위한 조건부 로직이 잘 구현되었습니다. 이 변경으로 사용자 요구사항에 맞게 트래픽 성장률에 따른 정렬이 가능해졌습니다.

src/types/dto/requests/getAllPostsQuery.type.ts (1)

10-11: Swagger 문서 및 타입 정의에 viewGrowth 옵션 추가

PostSortType에 새로운 정렬 옵션 viewGrowth가 추가되었고, Swagger 문서에도 적절히 반영되었습니다. 타입 시스템을 통해 안전하게 새 기능을 사용할 수 있습니다.

Also applies to: 16-17, 19-19

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

8-14: findPostsByUserId 메서드의 isAsc 파라미터에 기본값 설정

isAsc 파라미터에 기본값 false를 부여하여 내림차순 정렬을 기본값으로 설정했습니다. 이는 사용자 경험 측면에서 적절한 변경입니다.

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

61-160: 트래픽 성장률 조회 메서드에 대한 테스트 케이스 추가

findPostsByUserIdWithGrowthMetrics 메서드에 대한 포괄적인 테스트 케이스가 잘 구현되었습니다. 다음 측면들이 테스트되고 있어 코드의 신뢰성을 높입니다:

1. 성장률 데이터 반환 기능
2. 내림차순 정렬 확인
3. 커서 기반 페이지네이션
4. 오류 처리

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

265-278: 테스트 구조가 명확하고 적절합니다.

새로운 findPostsByUserIdWithGrowthMetrics 메서드에 대한 테스트 스위트가 잘 구성되어 있습니다. 첫 번째 테스트는 기본 기능을 검증하고 있으며, 반환된 결과가 예상되는 속성(posts, nextCursor, view_growth, like_growth)을 모두 포함하고 있는지 확인합니다.

---

280-295: 내림차순 정렬 테스트가 적절합니다.

트래픽 성장률(view_growth)을 기준으로 내림차순 정렬이 제대로 작동하는지 검증하는 테스트입니다. 데이터가 충분하지 않은 경우를 고려한 조건부 로직도 잘 구현되어 있습니다.

---

315-344: 페이지네이션 테스트가 체계적으로 구현되어 있습니다.

페이지네이션 기능에 대한 테스트가 매우 체계적으로 구현되어 있습니다. 아래 사항을 검증하고 있습니다:

1. 제한된 결과를 조회할 때 nextCursor가 제공되는지
2. nextCursor를 사용한 다음 페이지 조회가 가능한지
3. 두 페이지 간에 중복된 항목이 없는지

이는 페이지네이션 기능의 견고성을 보장하는 중요한 테스트입니다.

[six-standard]

코드 잘 읽었습니다!

좋았던 점

• 테스트 코드덕분에 전체적으로 어떤 동작을 할 지 예측할 수 있었습니다.
• findPostsByUserIdWithGrowthMetrics를 따로 분리해둬서 추후 유지보수에 도움이 될 것 같습니다!
  • findPostsByUserId에 다 합쳤을 경우 보기 조금 어렵지 않았을까 싶습니다

[Jihyun3478]

좋았던 점

• 각 기능별 테스트코드가 세밀하게 구현되어 있어, 전체적인 흐름을 이해하기 수월했습니다!
• SQL문 구현하는게 실무에서 더욱 중요하다고 들었던 터라, 조인 쿼리 구현하신 부분이 인상 깊었습니다!