🔀 :: [#616] - RedisLimitAdapter 리펙토링

[dolong2]

개요

• RedisLimitAdapter 리펙토링합니다.
  • ReidsClient를 내부에서 생성하도록 수정

작업내용

• RedisClient Bean 제거
• RedisLimitAdapter에서 RedisConnectionFactory를 주입받도록 수정
• init을 통해서 bucketProxy를 초기화하도록 수정
• RedisLimitAdapterTest 추가

체크리스트

탬플릿외에 필요한 항목이 있으면 추가해주세요.

• 로컬에서 빌드가 성공하나요?
• 추가(수정)한 코드가 정상적으로 동작하나요?
• pr 타켓 브랜치가 맞게 설정되어 있나요?
• pr에서 작업할 내용만 작업됐나요?
• 기존 API와 호환되지 않는 사항이 있나요?

Summary by CodeRabbit

• 리팩터링

  • Redis 연결 방식이 변경되어, Redis 관련 설정 및 어댑터의 생성자와 내부 구현이 개선되었습니다.

• 테스트

  • Redis 기반 속도 제한 기능에 대한 새로운 테스트가 추가되었습니다.

[coderabbitai]

Walkthrough

Redis 클라이언트의 생성 및 주입 방식이 변경되었습니다. 기존에는 RedisConfig에서 RedisClient 빈을 제공했으나, 이제 RedisLimitAdapter가 RedisConnectionFactory를 받아 내부적으로 RedisClient를 생성합니다. 또한, RedisLimitAdapter에 대한 단위 테스트가 새로 추가되었습니다.

Changes

파일/경로 요약	변경 내용 요약
src/main/kotlin/com/dcd/server/infrastructure/global/config/RedisConfig.kt	RedisClient 관련 import 및 redisClient() 빈 메서드 삭제
src/main/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapter.kt	생성자 파라미터를 RedisClient에서 RedisConnectionFactory로 변경, 내부에서 RedisClient 생성 방식으로 수정
src/test/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapterTest.kt	RedisLimitAdapter에 대한 BehaviorSpec 기반 테스트 클래스 신규 추가

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RedisLimitAdapter
    participant RedisConnectionFactory
    participant RedisClient
    participant Redis

    Client->>RedisLimitAdapter: 생성자 호출 (RedisConnectionFactory 주입)
    RedisLimitAdapter->>RedisConnectionFactory: host/port 정보 추출
    RedisLimitAdapter->>RedisClient: RedisClient 생성
    RedisLimitAdapter->>Redis: Bucket4j ProxyManager 초기화
    Client->>RedisLimitAdapter: consumer/resolveToken 메서드 호출
    RedisLimitAdapter->>Redis: 토큰 소비 및 제한 체크

Loading

Possibly related PRs

• 🔀 :: [#614] - Redis를 사용한 리미터 구현 #615: RedisClient 빈을 제거하고 RedisLimitAdapter가 내부적으로 RedisClient를 생성하도록 변경한 PR로, 이번 변경과 직접적으로 연관됨.
• 🔀 :: [#557] - Redis 관련 설정을 하나의 객체에서 관리하도록 수정 #558: RedisConfig에서 redissonClient 빈을 추가하고 RedissonConfig 클래스를 제거하는 PR로, Redis 클라이언트 빈 관리 측면에서 관련 있음.

Suggested labels

:two: Priority: 중, :hammer: Refactor

Poem

🐇
Redis의 길을 새로이 열었네,
빈은 사라지고, 어댑터가 맡았네.
테스트도 추가해 신뢰를 더하고,
깔끔한 코드에 토끼도 춤추네!
🥕✨

✨ 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.
  • 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 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: 5

🧹 Nitpick comments (4)

src/test/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapterTest.kt (2)

13-15: 테스트 클래스 의존성 주입 방식 검토 필요

생성자 주입을 통해 RedisLimitAdapter를 받고 있는데, 테스트 격리를 위해 각 테스트마다 독립적인 인스턴스를 사용하는 것을 고려해보세요.

---

16-29: 테스트 커버리지를 개선하세요.

현재 테스트는 용량 초과 시 false 반환만 검증하고 있습니다. 다음과 같은 추가 테스트 케이스를 고려해보세요:

1. 용량 내에서 토큰 소비 시 true 반환 검증
2. 시간 경과 후 토큰 재충전 검증
3. 다른 키에 대한 독립적인 토큰 관리 검증

given("테스트할 Limit 어노테이션이 주어지고") {
    val targetLimitAnnotation = Limit(target = "test")

+   `when`("용량 내에서 토큰을 소비할때") {
+       then("반환값이 true여야함") {
+           redisLimitAdapter.consumer(targetLimitAnnotation.target, targetLimitAnnotation) shouldBe true
+       }
+   }

    `when`("어노테이션에 설정된 횟수 초과로 토큰을 소비할때") {
        val capacity = targetLimitAnnotation.capacity
        for (i in 0 until capacity) {
            redisLimitAdapter.consumer(targetLimitAnnotation.target, targetLimitAnnotation)
        }

        then("반환값이 false여야함") {
            redisLimitAdapter.consumer(targetLimitAnnotation.target, targetLimitAnnotation) shouldBe false
        }
    }
}

src/main/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapter.kt (2)

21-21: 생성자 파라미터 명명 개선

파라미터명이 지역 변수로만 사용되므로 더 명확한 이름을 사용하는 것을 고려해보세요.

-    redisConnectionFactory: RedisConnectionFactory
+    private val redisConnectionFactory: RedisConnectionFactory

---

31-31: 연결 문자열 보안 강화

하드코딩된 Redis URI 스키마 대신 보다 안전한 방법을 사용하는 것을 고려해보세요. 특히 프로덕션 환경에서 인증이 필요한 경우를 대비해야 합니다.

더 유연한 URI 생성 방식:

val redisUri = if (connectionFactory.password != null) {
    "redis://:${connectionFactory.password}@$hostName:$port"
} else {
    "redis://$hostName:$port"
}
val redisClient = RedisClient.create(redisUri)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 31600d5 and 6e6cbc1.

📒 Files selected for processing (3)

• src/main/kotlin/com/dcd/server/infrastructure/global/config/RedisConfig.kt (0 hunks)
• src/main/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapter.kt (1 hunks)
• src/test/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapterTest.kt (1 hunks)

💤 Files with no reviewable changes (1)

• src/main/kotlin/com/dcd/server/infrastructure/global/config/RedisConfig.kt

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

• GitHub Check: Build and Test

🔇 Additional comments (1)

src/main/kotlin/com/dcd/server/infrastructure/global/thirdparty/bucket4j/RedisLimitAdapter.kt (1)

21-21: 의존성 주입 개선을 승인합니다.

RedisConnectionFactory를 통한 의존성 주입으로 변경한 것은 좋은 개선입니다. 이는 더 유연한 Redis 연결 설정을 가능하게 합니다.