Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(): 优化代码[发送验证码] #3190

Merged
merged 1 commit into from
Dec 23, 2024
Merged

feat(): 优化代码[发送验证码] #3190

merged 1 commit into from
Dec 23, 2024

Conversation

KouShenhai
Copy link
Owner

@KouShenhai KouShenhai commented Dec 23, 2024

Summary by Sourcery

新功能:

  • 实现了一个领域事件驱动架构,用于发送验证码通知。
Original summary in English

Summary by Sourcery

New Features:

  • Implemented a domain event-driven architecture for sending captcha notifications.

Summary by CodeRabbit

  • New Features
    • Introduced a new constant for captcha functionality: LAOKOU_CAPTCHA_TOPIC.
  • Bug Fixes
    • Removed the obsolete constant LAOKOU_CAPTCHA_TOPIC from the MqConstant class.
  • Refactor
    • Updated method signatures and constructors across various classes to enhance event handling and identifier management.
    • Removed the AbstractSendCaptchaEventHandler class to streamline captcha event handling.
    • Modified event handler classes to extend from AbstractDomainEventHandler, simplifying dependencies.
  • Chores
    • Adjusted internal logic for captcha creation and event handling across multiple classes.

Copy link

coderabbitai bot commented Dec 23, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a series of modifications across multiple files in the laokou-auth module, focusing on refactoring event handling and captcha-related functionality. The changes primarily involve updating method signatures, modifying class inheritance, and adjusting event creation processes. Key modifications include renaming methods, adding new parameters to constructors and methods, and restructuring how domain events and captcha generation are managed.

Changes

File Change Summary
laokou-gateway/RoutersControllerV3.java Renamed methods saveRouter()saveV3() and removeRouter()removeV3()
laokou-common-i18n/DomainEvent.java Renamed constructor parameter eventIdid
laokou-auth-adapter/AbstractSendCaptchaEventHandler.java Completely removed the abstract class
laokou-auth-adapter/SendMailCaptchaEventHandler.java Extended AbstractDomainEventHandler, simplified constructor, added annotations
laokou-auth-adapter/SendMobileCaptchaEventHandler.java Extended AbstractDomainEventHandler, simplified constructor, added annotations
laokou-auth-app/CaptchaSendCmdExe.java Updated createCaptcha method to include IdGenerator.defaultSnowflakeId()
laokou-auth-domain/DomainService.java Added eventId parameter to createCaptcha method
laokou-auth-domain/DomainFactory.java Modified getAuth() to require aggregateId
laokou-auth-domain/AuthA.java Updated constructors and createCaptcha method to include eventId
laokou-auth-domain/Constant.java Added LAOKOU_CAPTCHA_TOPIC constant
laokou-auth-infrastructure/MqConstant.java Removed LAOKOU_CAPTCHA_TOPIC constant

Poem

🐰 Hop, hop, through code's winding maze,
Refactoring events in clever ways,
Methods renamed, signatures tight,
Captcha handling now shines so bright!
A rabbit's dance of clean design 🔧

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 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 f692eae and b4607bc.

📒 Files selected for processing (11)
  • laokou-cloud/laokou-gateway/src/main/java/org/laokou/gateway/web/RoutersControllerV3.java (1 hunks)
  • laokou-common/laokou-common-i18n/src/main/java/org/laokou/common/i18n/dto/DomainEvent.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/AbstractSendCaptchaEventHandler.java (0 hunks)
  • laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMailCaptchaEventHandler.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMobileCaptchaEventHandler.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-app/src/main/java/org/laokou/auth/command/CaptchaSendCmdExe.java (2 hunks)
  • laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/ability/DomainService.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/factory/DomainFactory.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/AuthA.java (4 hunks)
  • laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/Constant.java (1 hunks)
  • laokou-service/laokou-auth/laokou-auth-infrastructure/src/main/java/org/laokou/auth/common/constant/MqConstant.java (0 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

@KouShenhai KouShenhai merged commit 8f87575 into master Dec 23, 2024
9 of 13 checks passed
Copy link

sourcery-ai bot commented Dec 23, 2024

审核指南由 Sourcery 提供

此拉取请求通过引入领域事件模式并利用 RocketMQ 进行消息传递来重构发送验证码功能。它移除了事件处理程序中对邮件和短信服务的直接依赖,而是将事件发布到 RocketMQ。更改还包括更新领域模型以支持事件生成和处理。

新验证码发送流程的时序图

sequenceDiagram
    participant Client
    participant CaptchaSendCmdExe
    participant AuthA
    participant DomainService
    participant RocketMQ
    participant SendMailCaptchaEventHandler
    participant SendMobileCaptchaEventHandler

    Client->>CaptchaSendCmdExe: 请求验证码
    CaptchaSendCmdExe->>AuthA: 创建认证聚合
    CaptchaSendCmdExe->>DomainService: createCaptcha(eventId, auth, captcha)
    DomainService->>AuthA: getCaptcha()
    DomainService->>AuthA: checkTenant()
    DomainService->>AuthA: createCaptcha(eventId)
    AuthA->>CaptchaSendCmdExe: 返回领域事件
    CaptchaSendCmdExe->>RocketMQ: 发布事件 (异步)
    RocketMQ-->>SendMailCaptchaEventHandler: 处理邮件验证码事件
    RocketMQ-->>SendMobileCaptchaEventHandler: 处理手机验证码事件
Loading

验证码事件处理结构的类图

classDiagram
    class AbstractDomainEventHandler {
        <<abstract>>
        +handleDomainEvent(DomainEvent)
    }

    class SendMailCaptchaEventHandler {
        +handleDomainEvent(DomainEvent)
    }

    class SendMobileCaptchaEventHandler {
        +handleDomainEvent(DomainEvent)
    }

    class AuthA {
        -String username
        -String password
        -String tenantCode
        -CaptchaE captchaE
        +createCaptcha(Long eventId)
        +getCaptcha(CaptchaE)
    }

    class DomainEvent {
        +Long id
        +Long tenantId
        +Long userId
        +Long aggregateId
        +String topic
        +String tag
        +int version
        +String payload
        +String type
        +String sourcePrefix
    }

    AbstractDomainEventHandler <|-- SendMailCaptchaEventHandler
    AbstractDomainEventHandler <|-- SendMobileCaptchaEventHandler
    AuthA ..> DomainEvent: creates
Loading

文件级更改

更改 详情 文件
重构发送验证码逻辑以使用领域事件和 RocketMQ。
  • 移除对 MailServiceSmsService 的直接依赖。
  • 引入 AbstractDomainEventHandler 并实现 handleDomainEvent 方法。
  • 添加 RocketMQ 消息监听器注解。
  • 更新 AuthA 以发布 SendCaptchaEvent
  • 修改 CaptchaSendCmdExe 以通过 rocketMQDomainEventPublisher 发布事件。
  • 更新 DomainService 以接受事件 ID 并在创建验证码时使用它。
  • 更新 DomainFactory 以在创建 AuthA 实例时需要聚合 ID。
  • 移除 AbstractSendCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMailCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMobileCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/AuthA.java
laokou-service/laokou-auth/laokou-auth-app/src/main/java/org/laokou/auth/command/CaptchaSendCmdExe.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/ability/DomainService.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/factory/DomainFactory.java
移动 LAOKOU_CAPTCHA_TOPIC 常量。
  • LAOKOU_CAPTCHA_TOPICMqConstant 移动到 Constant 类。
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/Constant.java
laokou-service/laokou-auth/laokou-auth-infrastructure/src/main/java/org/laokou/auth/common/constant/MqConstant.java
更新 DomainEvent 构造函数。
  • DomainEvent 构造函数中添加 id 参数并将其分配给 super.id 字段。
laokou-common/laokou-common-i18n/src/main/java/org/laokou/common/i18n/dto/DomainEvent.java
重命名网关 API 端点。
  • saveRouter 重命名为 saveV3
  • removeRouter 重命名为 removeV3
laokou-cloud/laokou-gateway/src/main/java/org/laokou/gateway/web/RoutersControllerV3.java

提示和命令

与 Sourcery 互动

  • 触发新审核: 在拉取请求中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审核评论。
  • 从审核评论生成 GitHub 问题: 通过回复审核评论请求 Sourcery 从中创建问题。
  • 生成拉取请求标题: 在拉取请求标题中任意位置写 @sourcery-ai 以随时生成标题。
  • 生成拉取请求摘要: 在拉取请求正文中任意位置写 @sourcery-ai summary 以随时生成 PR 摘要。您也可以使用此命令指定摘要应插入的位置。

自定义您的体验

访问您的仪表板以:

  • 启用或禁用审核功能,如 Sourcery 生成的拉取请求摘要、审核指南等。
  • 更改审核语言。
  • 添加、删除或编辑自定义审核说明。
  • 调整其他审核设置。

获取帮助

Original review guide in English

Reviewer's Guide by Sourcery

This pull request refactors the send captcha feature by introducing a Domain Event pattern and leveraging RocketMQ for message delivery. It removes direct dependencies on mail and SMS services within the event handlers, instead publishing events to RocketMQ. The changes also include updates to the domain model to support event generation and handling.

Sequence diagram for the new captcha sending flow

sequenceDiagram
    participant Client
    participant CaptchaSendCmdExe
    participant AuthA
    participant DomainService
    participant RocketMQ
    participant SendMailCaptchaEventHandler
    participant SendMobileCaptchaEventHandler

    Client->>CaptchaSendCmdExe: Request captcha
    CaptchaSendCmdExe->>AuthA: Create auth aggregate
    CaptchaSendCmdExe->>DomainService: createCaptcha(eventId, auth, captcha)
    DomainService->>AuthA: getCaptcha()
    DomainService->>AuthA: checkTenant()
    DomainService->>AuthA: createCaptcha(eventId)
    AuthA->>CaptchaSendCmdExe: Return with domain events
    CaptchaSendCmdExe->>RocketMQ: Publish events (ASYNC)
    RocketMQ-->>SendMailCaptchaEventHandler: Handle mail captcha event
    RocketMQ-->>SendMobileCaptchaEventHandler: Handle mobile captcha event
Loading

Class diagram for the captcha event handling structure

classDiagram
    class AbstractDomainEventHandler {
        <<abstract>>
        +handleDomainEvent(DomainEvent)
    }

    class SendMailCaptchaEventHandler {
        +handleDomainEvent(DomainEvent)
    }

    class SendMobileCaptchaEventHandler {
        +handleDomainEvent(DomainEvent)
    }

    class AuthA {
        -String username
        -String password
        -String tenantCode
        -CaptchaE captchaE
        +createCaptcha(Long eventId)
        +getCaptcha(CaptchaE)
    }

    class DomainEvent {
        +Long id
        +Long tenantId
        +Long userId
        +Long aggregateId
        +String topic
        +String tag
        +int version
        +String payload
        +String type
        +String sourcePrefix
    }

    AbstractDomainEventHandler <|-- SendMailCaptchaEventHandler
    AbstractDomainEventHandler <|-- SendMobileCaptchaEventHandler
    AuthA ..> DomainEvent: creates
Loading

File-Level Changes

Change Details Files
Refactored sending captcha logic to use Domain Events and RocketMQ.
  • Removed direct dependencies on MailService and SmsService.
  • Introduced AbstractDomainEventHandler and implemented handleDomainEvent method.
  • Added RocketMQ message listener annotations.
  • Updated AuthA to publish SendCaptchaEvent.
  • Modified CaptchaSendCmdExe to publish events via rocketMQDomainEventPublisher.
  • Updated DomainService to accept an event ID and use it when creating a captcha.
  • Updated DomainFactory to require an aggregate ID when creating an AuthA instance.
  • Removed AbstractSendCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMailCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-adapter/src/main/java/org/laokou/auth/consumer/handler/SendMobileCaptchaEventHandler.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/AuthA.java
laokou-service/laokou-auth/laokou-auth-app/src/main/java/org/laokou/auth/command/CaptchaSendCmdExe.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/ability/DomainService.java
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/factory/DomainFactory.java
Moved LAOKOU_CAPTCHA_TOPIC constant.
  • Moved LAOKOU_CAPTCHA_TOPIC from MqConstant to Constant class.
laokou-service/laokou-auth/laokou-auth-domain/src/main/java/org/laokou/auth/model/Constant.java
laokou-service/laokou-auth/laokou-auth-infrastructure/src/main/java/org/laokou/auth/common/constant/MqConstant.java
Updated DomainEvent Constructor.
  • Added id parameter to DomainEvent constructor and assigned it to the super.id field.
laokou-common/laokou-common-i18n/src/main/java/org/laokou/common/i18n/dto/DomainEvent.java
Renamed Gateway API Endpoints.
  • Renamed saveRouter to saveV3.
  • Renamed removeRouter to removeV3.
laokou-cloud/laokou-gateway/src/main/java/org/laokou/gateway/web/RoutersControllerV3.java

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KouShenhai - 我已经审查了你的更改 - 这里有一些反馈:

总体评论

  • SendMailCaptchaEventHandler 和 SendMobileCaptchaEventHandler 中的 handleDomainEvent() 方法是空的。需要实现这些方法以正确处理验证码事件,否则消息将被静默丢弃。
这是我在审查期间查看的内容
  • 🟡 一般问题:发现2个问题
  • 🟢 安全性:一切看起来都很好
  • 🟢 测试:一切看起来都很好
  • 🟢 复杂性:一切看起来都很好
  • 🟢 文档:一切看起来都很好

Sourcery 对开源项目免费 - 如果你喜欢我们的评论,请考虑分享它们 ✨
帮助我变得更有用!请点击每条评论上的 👍 或 👎,我将使用反馈来改进你的评论。
Original comment in English

Hey @KouShenhai - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The handleDomainEvent() methods in both SendMailCaptchaEventHandler and SendMobileCaptchaEventHandler are empty. These need to be implemented to properly handle the captcha events, otherwise messages will be silently dropped.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

}

@Override
protected void handleDomainEvent(DomainEvent domainEvent) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): handleDomainEvent 方法是空的,这可能导致事件被静默丢弃。

实现正确的事件处理逻辑以确保邮件验证码事件被正确处理。

Original comment in English

issue (bug_risk): The handleDomainEvent method is empty, which could lead to silently dropped events.

Implement proper event handling logic to ensure mail captcha events are processed correctly.

// return smsService.send(event.getUuid(), 5);
// }
@Override
protected void handleDomainEvent(DomainEvent domainEvent) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): handleDomainEvent 方法是空的,可能导致移动验证码事件丢失。

实现正确的事件处理逻辑以确保移动验证码事件被正确处理。

Original comment in English

issue (bug_risk): The handleDomainEvent method is empty, potentially causing mobile captcha events to be lost.

Implement proper event handling logic to ensure mobile captcha events are processed correctly.

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 15.26%. Comparing base (ce218b4) to head (b4607bc).
Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
...n/java/org/laokou/common/i18n/dto/DomainEvent.java 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##             master    #3190   +/-   ##
=========================================
  Coverage     15.26%   15.26%           
  Complexity       66       66           
=========================================
  Files            85       85           
  Lines          1382     1382           
  Branches        109      109           
=========================================
  Hits            211      211           
  Misses         1145     1145           
  Partials         26       26           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant