docs: add DDD logical architecture diagram for signing module#445
docs: add DDD logical architecture diagram for signing module#445zengchen1024 wants to merge 1 commit intoreviewfrom
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
CLA Signature Passzengchen1024, thanks for your pull request. All authors of the commits have signed the CLA. 👍 |
Linking Issue Notice@zengchen1024 , the pull request must be linked to at least one issue. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! 此拉取请求旨在通过引入一份详细的架构文档，显著提升对 Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new ARCHITECTURE.md file, providing a comprehensive logical architecture overview for the signing module based on DDD principles. The documentation includes layer descriptions, key design features, main aggregates, core business flows, and both ASCII and Mermaid architecture diagrams. The review comments highlight several inconsistencies between this new documentation and the actual code implementation. Specifically, the documented 'Company Sign CLA' business flow incorrectly states that app.CorpSigningService.Sign() calls watch.SendCLAUpdatedEvent(), and the User aggregate root's UpdatePrivacy() method name in both diagrams does not match the UpdatePrivacyConsent() method in the signing/domain/user.go code.
| ├─ VCService.Verify()（验证码校验） | ||
| ├─ new CorpSigning AR（聚合根创建，触发业务规则） | ||
| ├─ CorpSigningRepo.Add()（MongoDB 持久化） | ||
| └─ watch.SendCLAUpdatedEvent()（发送 Kafka 事件） |
There was a problem hiding this comment.
在“公司签署 CLA”的核心业务流程描述中，文档指出 app.CorpSigningService.Sign() 方法会调用 watch.SendCLAUpdatedEvent()。经核查 signing/app/corp_signing.go 中的代码，Sign 方法实现中并未调用此事件发送函数。此外，CLAUpdatedEvent 从命名上看更适用于 CLA 文档更新场景，而非公司签署场景。这种不一致可能会误导开发者，建议修正文档以反映真实的代码逻辑。
| │ │ │ │ Manager │ │ ┌────────────────────┐ ┌─────────────────┐ │ │ | ||
| │ │ │ │ (Entity) │ │ │ User AR │ │ Link AR │ │ │ | ||
| │ │ │ ├───────────────┤ │ │ ChangePassword() │ │ AddCLA() │ │ │ | ||
| │ │ │ │ Corporation │ │ │ UpdatePrivacy() │ │ FindCLA() │ │ │ |
There was a problem hiding this comment.
在 User 聚合根的 ASCII 架构图中，方法被描述为 UpdatePrivacy()。然而，在领域模型代码 signing/domain/user.go 中，相应的方法是 UpdatePrivacyConsent()。为了确保文档与代码实现的一致性，建议更新此处的图表。如果因为图表宽度限制，可以考虑使用 UpdatePrivacyConsent 或调整图表布局。
| D1["CorpSigning AR\n└ Representative\n└ Manager\n└ Corporation"] | ||
| D2["EmployeeSigning AR\nenable / disable / remove"] | ||
| D3["IndividualSigning AR\nAgreeNewCLA / HasSignedCLA"] | ||
| D4["User AR\nChangePassword / UpdatePrivacy"] |
There was a problem hiding this comment.
在 Mermaid 架构图中，User 聚合根的方法被描述为 UpdatePrivacy。为了与代码 signing/domain/user.go 中的 UpdatePrivacyConsent() 方法保持一致，建议在此处也进行更新，以确保文档的准确性。
| D4["User AR\nChangePassword / UpdatePrivacy"] | |
| D4["User AR\nChangePassword / UpdatePrivacyConsent"] |
|
|||||||||||||||||||
2 participants
描述
相关 Issue
变更类型