refactor: 重构 OpenRouter API 客户端并改进 AI 翻译功能 #49

shadowfish07 · 2025-06-29T06:48:57Z

Summary by CodeRabbit

新功能
- 增加了测试数据生成工具类，便于创建书签和标签的测试数据。
- 新增了 OpenRouter 和 Readeck API 客户端的单元测试，提升了代码可靠性。
功能改进
- OpenRouter API 客户端现在支持自定义 http.Client，并增加了资源释放方法。
- 书签详情视图模型新增了设置仓库依赖，并在翻译前校验 API Key 配置，未配置时会提示错误。
- 路由依赖注入更新，支持更多依赖传递。
Bug 修复
- 设置页面移除了 API Key 输入框的校验，提升了表单灵活性。
测试
- 新增并完善了 OpenRouter 和 Readeck API 客户端的单元测试及相关 Mock 类，覆盖多种场景和异常情况。
杂项
- 调整了发布规则，refactor 类型的提交将不再触发版本号变更。

在书签详情视图模型中添加对OpenRouter API密钥的检查，如果未配置则阻止翻译操作移除AI设置屏幕中API密钥的必填验证，改为在翻译时检查 close #39

添加ReadeckApiClient的单元测试，包括配置测试、书签操作测试和标签测试添加测试用的书签和标签数据类TestBookmarkData和TestLabelData 生成Mockito模拟类用于HTTP客户端测试

添加 http.Client 参数以支持自定义 HTTP 客户端新增 dispose 方法用于释放 http.Client 资源替换所有直接使用 http 为使用 _httpClient

移除未使用的HTTP-Referer头并添加mock测试文件

coderabbitai · 2025-06-29T06:49:03Z

Walkthrough

本次变更主要对 OpenRouter API 客户端的构造方式进行了增强，允许通过依赖注入自定义 HTTP 客户端，并增加了资源释放方法。Bookmark 详情 ViewModel 增加了对 SettingsRepository 的依赖，并在翻译前校验 API Key 配置。测试代码大量补充了单元测试和模拟实现。

Changes

文件/分组	变更摘要
.releaserc.json	调整“refactor”类型提交消息的发布规则，不再触发版本递增。
lib/data/service/openrouter_api_client.dart	构造函数支持注入 http.Client，内部全部使用实例化的客户端，增加 dispose() 方法释放资源。
lib/routing/router.dart	BookmarkDetailViewModel 构造函数注入依赖数量由 3 增加到 4。
lib/ui/bookmarks/view_models/bookmark_detail_viewmodel.dart	构造函数新增 SettingsRepository 参数，翻译前校验 OpenRouter API Key 是否配置。
lib/ui/settings/widgets/ai_settings_screen.dart	移除了 API Key 输入框的校验函数，保存前不再校验该字段。
test/fixtures/test_data.dart	新增 TestBookmarkData 和 TestLabelData，便于生成 Bookmark 和 Label 的测试数据。
test/unit/data/service/openrouter_api_client_test.dart	新增 OpenRouterApiClient 的单元测试，包括配置、接口调用、异常处理、参数与头部校验等。
test/unit/data/service/openrouter_api_client_test.mocks.dart	新增 OpenRouterApiClient 相关依赖的 mock 实现，支持 http.Client 和 SharedPreferencesService。
test/unit/data/service/readeck_api_client_test.dart	新增 ReadeckApiClient 的单元测试，覆盖配置、书签获取/更新/删除、标签、文章内容等多场景。
test/unit/data/service/readeck_api_client_test.mocks.dart	新增 ReadeckApiClient 相关 http.Client 的 mock 实现。

Sequence Diagram(s)

sequenceDiagram
    participant ViewModel as BookmarkDetailViewModel
    participant SettingsRepo as SettingsRepository
    participant APIClient as OpenRouterApiClient
    participant HTTP as http.Client

    ViewModel->>SettingsRepo: 获取 OpenRouter API Key
    alt API Key 未配置
        ViewModel-->>ViewModel: 抛出“未配置 API Key”异常
    else API Key 已配置
        ViewModel->>APIClient: 发起翻译请求
        APIClient->>HTTP: 发送 HTTP 请求
        HTTP-->>APIClient: 返回响应
        APIClient-->>ViewModel: 返回翻译结果
    end

Possibly related PRs

shadowfish07/ReadeckAPP#38: 初始实现 OpenRouterApiClient 并集成 AI 翻译功能，本次 PR 直接修改了该类，增强了 HTTP 客户端注入与资源管理能力。

Suggested labels

enhancement

Poem

小兔挥笔写新篇，
客户端注入更灵便。
资源释放不再难，
测试覆盖广又全。
配置校验保安全，
代码进步乐无边！
🐇✨

📜 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 da86932 and 3103c2d.

📒 Files selected for processing (10)

.releaserc.json (1 hunks)
lib/data/service/openrouter_api_client.dart (6 hunks)
lib/routing/router.dart (1 hunks)
lib/ui/bookmarks/view_models/bookmark_detail_viewmodel.dart (3 hunks)
lib/ui/settings/widgets/ai_settings_screen.dart (0 hunks)
test/fixtures/test_data.dart (2 hunks)
test/unit/data/service/openrouter_api_client_test.dart (1 hunks)
test/unit/data/service/openrouter_api_client_test.mocks.dart (1 hunks)
test/unit/data/service/readeck_api_client_test.dart (1 hunks)
test/unit/data/service/readeck_api_client_test.mocks.dart (1 hunks)

💤 Files with no reviewable changes (1)

lib/ui/settings/widgets/ai_settings_screen.dart

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 测试覆盖要求：Repository 层和 ViewModel 层 100% 覆盖，关键 Widget UI 测试，Command 执行流程测试，Result 处理逻辑测试。

lib/routing/router.dart (1)

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 依赖注入必须使用 provider，并通过构造函数注入 Repository 等依赖，依赖注入配置应集中在 lib/config/dependencies.dart。

lib/ui/bookmarks/view_models/bookmark_detail_viewmodel.dart (2)

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 依赖注入必须使用 provider，并通过构造函数注入 Repository 等依赖，依赖注入配置应集中在 lib/config/dependencies.dart。

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: ReadeckApp 项目采用 MVVM + Repository Pattern 架构，所有页面都应有对应的 View 和 ViewModel，ViewModel 持有 Repository 的引用，Repository 可被多个 ViewModel 共享，Service 专注于单一数据源。

test/unit/data/service/openrouter_api_client_test.dart (2)

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 测试覆盖要求：Repository 层和 ViewModel 层 100% 覆盖，关键 Widget UI 测试，Command 执行流程测试，Result 处理逻辑测试。

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 所有可能失败的操作都必须返回 result_dart 的 Result 类型，确保统一的错误处理和结果传递。

test/unit/data/service/readeck_api_client_test.dart (2)

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 测试覆盖要求：Repository 层和 ViewModel 层 100% 覆盖，关键 Widget UI 测试，Command 执行流程测试，Result 处理逻辑测试。

Learnt from: CR
PR: shadowfish07/ReadeckAPP#0
File: .trae/rules/project_rules.md:0-0
Timestamp: 2025-06-23T18:59:13.029Z
Learning: 所有可能失败的操作都必须返回 result_dart 的 Result 类型，确保统一的错误处理和结果传递。

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

GitHub Check: Test

🔇 Additional comments (15)

.releaserc.json (1)

23-23: 配置更改符合语义化版本管理最佳实践

将 refactor 类型的提交从触发补丁版本变更为不触发版本发布是合理的，因为重构通常只是改进代码质量而不改变功能。

test/unit/data/service/readeck_api_client_test.mocks.dart (1)

1-283: 自动生成的 Mock 文件实现完整

Mockito 生成的 HTTP 客户端模拟实现涵盖了所有必要的 HTTP 方法，为单元测试提供了完整的支持。文件结构符合 Mockito 标准。

lib/data/service/openrouter_api_client.dart (4)

13-16: 依赖注入实现得当

构造函数增强允许注入 HTTP 客户端，同时提供默认值保持向后兼容性。这为单元测试提供了良好的可测试性支持。

20-20: 添加私有字段管理 HTTP 客户端

通过私有字段管理注入的 HTTP 客户端实例，确保整个类中一致使用同一个客户端。

23-26: 资源释放方法实现正确

添加 dispose() 方法确保 HTTP 客户端资源得到正确释放，符合资源管理最佳实践。

98-98: HTTP 客户端调用统一化

所有 HTTP 调用已从顶级函数改为使用注入的 _httpClient 实例，确保了一致性和可测试性。

Also applies to: 190-190, 272-272, 367-367, 410-410

lib/routing/router.dart (1)

201-201: 依赖注入正确添加 SettingsRepository

为 BookmarkDetailViewModel 添加 SettingsRepository 依赖注入，支持 API 密钥验证功能。依赖注入模式符合项目架构要求。

lib/ui/bookmarks/view_models/bookmark_detail_viewmodel.dart (4)

7-7: 正确导入 SettingsRepository

添加必要的依赖导入以支持 API 密钥验证功能。

11-16: 构造函数正确接受新依赖

ViewModel 构造函数已更新以接受 SettingsRepository 参数，符合依赖注入模式和项目架构要求。

49-49: 添加私有字段管理依赖

通过私有字段管理 SettingsRepository 依赖，确保类内部访问的一致性。

239-244: API 密钥验证逻辑实现得当

在翻译前检查 OpenRouter API Key 配置，提供清晰的错误提示。验证逻辑正确处理了错误情况和空值情况，确保只有在正确配置时才进行翻译。

test/fixtures/test_data.dart (1)

57-163: 测试数据类实现良好！

新增的 TestBookmarkData 和 TestLabelData 类遵循了现有的测试数据模式，提供了灵活的工厂方法来创建测试实例。实现正确且完整。

test/unit/data/service/openrouter_api_client_test.dart (1)

1-739: OpenRouter API 客户端测试套件实现出色！

测试覆盖全面，包括：

配置状态验证

流式和同步 API 调用

错误处理场景（网络错误、格式错误、未配置等）

参数传递和请求头验证

资源清理

测试结构清晰，遵循了单元测试最佳实践。

test/unit/data/service/openrouter_api_client_test.mocks.dart (1)

1-585: 自动生成的 Mock 文件

这是 Mockito 自动生成的文件，无需手动修改。

test/unit/data/service/readeck_api_client_test.dart (1)

1-540: Readeck API 客户端测试实现优秀！

测试套件全面覆盖了所有 API 操作：

配置验证和更新

书签的增删改查操作

标签管理

文章内容获取

错误处理（包括网络错误、空内容、资源未找到等）

资源清理

特别值得称赞的是对查询参数、标签操作和阅读进度验证的详细测试。

✨ Finishing Touches

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in Comment
Commit Unit Tests in branch issue-39

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

🪧 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 auto-generate unit tests to generate unit tests 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.

codecov · 2025-06-29T06:50:25Z

Codecov Report

Attention: Patch coverage is 57.14286% with 6 lines in your changes missing coverage. Please review.

Project coverage is 10.09%. Comparing base (335373d) to head (3103c2d).
Report is 7 commits behind head on beta.

Files with missing lines	Patch %	Lines
...okmarks/view_models/bookmark_detail_viewmodel.dart	0.00%	4 Missing ⚠️
lib/data/service/openrouter_api_client.dart	88.88%	1 Missing ⚠️
lib/routing/router.dart	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##            beta      #49      +/-   ##
=========================================
+ Coverage   2.17%   10.09%   +7.91%     
=========================================
  Files         58       58              
  Lines       3403     3408       +5     
=========================================
+ Hits          74      344     +270     
+ Misses      3329     3064     -265

Flag	Coverage Δ
unittests	`10.09% <57.14%> (+7.91%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

shadowfish07 added 5 commits June 29, 2025 12:16

chore: 更新.releaserc.json中refactor类型的发布配置

c6ac1f5

fix(ai翻译): 添加OpenRouter API密钥检查并移除AI设置验证

fef3b7e

在书签详情视图模型中添加对OpenRouter API密钥的检查，如果未配置则阻止翻译操作移除AI设置屏幕中API密钥的必填验证，改为在翻译时检查 close #39

test(api): 添加Readeck API客户端单元测试及测试数据

89e7fa5

添加ReadeckApiClient的单元测试，包括配置测试、书签操作测试和标签测试添加测试用的书签和标签数据类TestBookmarkData和TestLabelData 生成Mockito模拟类用于HTTP客户端测试

refactor(openrouter_api_client): 使用自定义 http.Client 并添加 dispose 方法

0b66b7e

添加 http.Client 参数以支持自定义 HTTP 客户端新增 dispose 方法用于释放 http.Client 资源替换所有直接使用 http 为使用 _httpClient

test(openrouter_api_client): 添加OpenRouter API客户端单元测试

3103c2d

移除未使用的HTTP-Referer头并添加mock测试文件

shadowfish07 merged commit 740ccb7 into beta Jun 29, 2025
4 checks passed

shadowfish07 deleted the issue-39 branch June 29, 2025 06:58

This was referenced Jun 30, 2025

Enhances settings and data management #56

Merged

AI 翻译、OpenRouter配置和一批bugfix+重构优化 #59

Merged

coderabbitai bot mentioned this pull request Aug 17, 2025

feat: 实现书签分享功能与滚动动效FAB #73

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: 重构 OpenRouter API 客户端并改进 AI 翻译功能 #49

refactor: 重构 OpenRouter API 客户端并改进 AI 翻译功能 #49

Uh oh!

shadowfish07 commented Jun 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 29, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jun 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refactor: 重构 OpenRouter API 客户端并改进 AI 翻译功能 #49

refactor: 重构 OpenRouter API 客户端并改进 AI 翻译功能 #49

Uh oh!

Conversation

shadowfish07 commented Jun 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shadowfish07 commented Jun 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jun 29, 2025 •

edited

Loading