feat(settings): add development debug page - #2047
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a development-only Debug page in Settings, moves mock controls from About, gates related main-process routes, and updates typed navigation, localization, documentation, architecture baselines, and renderer tests. ChangesDevelopment debug tooling
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
src/renderer/settings/components/DebugSettings.vue (1)
68-129: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDuplicate try/catch/toast pattern across three action handlers.
startGuidedOnboarding,mockDownloadedUpdate, andclearMockUpdateall repeat the same shape: call client, check a boolean, toast on falsy, catch+log+toast on throw. Extracting a shared helper would cut duplication and make it trivial to add a consistent busy/disabled guard to all three buttons (currently onlycreateMockChatguards against re-entrant clicks viaisCreatingMockChat).♻️ Suggested helper
+const runMockAction = async ( + action: () => Promise<boolean>, + failureMessageKey: string, + logLabel: string +) => { + try { + const ok = await action() + if (!ok) { + showToastError(t(failureMessageKey)) + } + } catch (error) { + console.error(`[DebugSettings] ${logLabel}`, error) + showToastError(error instanceof Error ? error.message : t(failureMessageKey)) + } +} + -const mockDownloadedUpdate = async () => { - try { - const updated = await upgradeClient.mockDownloadedUpdate() - if (!updated) { - showToastError(t('settings.debug.unavailableDescription')) - } - } catch (error) { - console.error('[DebugSettings] Failed to create mock update', error) - showToastError(error instanceof Error ? error.message : t('settings.debug.guidance.failed')) - } -} +const mockDownloadedUpdate = () => + runMockAction( + upgradeClient.mockDownloadedUpdate, + 'settings.debug.unavailableDescription', + 'Failed to create mock update' + )🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/renderer/settings/components/DebugSettings.vue` around lines 68 - 129, Extract the repeated action handling from startGuidedOnboarding, mockDownloadedUpdate, and clearMockUpdate into a shared helper that performs the client call, falsy-result toast, error logging, and error toast. Update each handler to use the helper while preserving its existing client method and translation messages, and add a consistent busy/re-entrancy guard for these three actions alongside the existing createMockChat guard.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/renderer/src/i18n/da-DK/settings.json`:
- Around line 3188-3204: The settings.debug block remains English in all
affected locale bundles. Add complete, natural translations for every
settings.debug.* value in src/renderer/src/i18n/da-DK/settings.json (lines
3188-3204), src/renderer/src/i18n/de-DE/settings.json (lines 3179-3195),
src/renderer/src/i18n/es-ES/settings.json (lines 3179-3195),
src/renderer/src/i18n/fa-IR/settings.json (lines 3188-3204),
src/renderer/src/i18n/fr-FR/settings.json (lines 3188-3204), and
src/renderer/src/i18n/he-IL/settings.json (lines 3188-3204), covering all
titles, descriptions, labels, and failure messages while preserving the existing
JSON structure and keys.
In `@src/renderer/src/i18n/id-ID/settings.json`:
- Around line 3178-3195: Translate every user-facing string in the debug
subtree, including description, unavailableTitle, unavailableDescription, splash
labels and failure text, and guidance labels and failure text, in
src/renderer/src/i18n/id-ID/settings.json lines 3178-3195,
src/renderer/src/i18n/it-IT/settings.json lines 3178-3195,
src/renderer/src/i18n/ja-JP/settings.json lines 3187-3204,
src/renderer/src/i18n/ko-KR/settings.json lines 3187-3204,
src/renderer/src/i18n/ms-MY/settings.json lines 3178-3195,
src/renderer/src/i18n/pl-PL/settings.json lines 3178-3195, and
src/renderer/src/i18n/pt-BR/settings.json lines 3187-3204, preserving the
existing JSON keys and structure while using Indonesian, Italian, Japanese,
Korean, Malay, Polish, and Brazilian Portuguese respectively.
In `@src/renderer/src/i18n/ru-RU/settings.json`:
- Around line 3188-3204: Translate every newly added settings.debug string into
its target language while preserving the existing keys and JSON structure: in
src/renderer/src/i18n/ru-RU/settings.json#L3188-L3204 use Russian, in
src/renderer/src/i18n/tr-TR/settings.json#L3179-L3195 use Turkish, and in
src/renderer/src/i18n/vi-VN/settings.json#L3179-L3195 use Vietnamese.
---
Nitpick comments:
In `@src/renderer/settings/components/DebugSettings.vue`:
- Around line 68-129: Extract the repeated action handling from
startGuidedOnboarding, mockDownloadedUpdate, and clearMockUpdate into a shared
helper that performs the client call, falsy-result toast, error logging, and
error toast. Update each handler to use the helper while preserving its existing
client method and translation messages, and add a consistent busy/re-entrancy
guard for these three actions alongside the existing createMockChat guard.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 011746f2-b785-4ad9-98d1-6003402a80f3
📒 Files selected for processing (57)
docs/features/debug-tooling/plan.mddocs/features/debug-tooling/spec.mddocs/features/debug-tooling/tasks.mdsrc/main/desktop/routes.tssrc/main/upgrade/routes.tssrc/renderer/settings/App.vuesrc/renderer/settings/components/AboutUsSettings.vuesrc/renderer/settings/components/DebugSettings.vuesrc/renderer/settings/main.tssrc/renderer/settings/settingsRouteComponents.tssrc/renderer/src/i18n/da-DK/routes.jsonsrc/renderer/src/i18n/da-DK/settings.jsonsrc/renderer/src/i18n/de-DE/routes.jsonsrc/renderer/src/i18n/de-DE/settings.jsonsrc/renderer/src/i18n/en-US/routes.jsonsrc/renderer/src/i18n/en-US/settings.jsonsrc/renderer/src/i18n/es-ES/routes.jsonsrc/renderer/src/i18n/es-ES/settings.jsonsrc/renderer/src/i18n/fa-IR/routes.jsonsrc/renderer/src/i18n/fa-IR/settings.jsonsrc/renderer/src/i18n/fr-FR/routes.jsonsrc/renderer/src/i18n/fr-FR/settings.jsonsrc/renderer/src/i18n/he-IL/routes.jsonsrc/renderer/src/i18n/he-IL/settings.jsonsrc/renderer/src/i18n/id-ID/routes.jsonsrc/renderer/src/i18n/id-ID/settings.jsonsrc/renderer/src/i18n/it-IT/routes.jsonsrc/renderer/src/i18n/it-IT/settings.jsonsrc/renderer/src/i18n/ja-JP/routes.jsonsrc/renderer/src/i18n/ja-JP/settings.jsonsrc/renderer/src/i18n/ko-KR/routes.jsonsrc/renderer/src/i18n/ko-KR/settings.jsonsrc/renderer/src/i18n/ms-MY/routes.jsonsrc/renderer/src/i18n/ms-MY/settings.jsonsrc/renderer/src/i18n/pl-PL/routes.jsonsrc/renderer/src/i18n/pl-PL/settings.jsonsrc/renderer/src/i18n/pt-BR/routes.jsonsrc/renderer/src/i18n/pt-BR/settings.jsonsrc/renderer/src/i18n/ru-RU/routes.jsonsrc/renderer/src/i18n/ru-RU/settings.jsonsrc/renderer/src/i18n/tr-TR/routes.jsonsrc/renderer/src/i18n/tr-TR/settings.jsonsrc/renderer/src/i18n/vi-VN/routes.jsonsrc/renderer/src/i18n/vi-VN/settings.jsonsrc/renderer/src/i18n/zh-CN/routes.jsonsrc/renderer/src/i18n/zh-CN/settings.jsonsrc/renderer/src/i18n/zh-HK/routes.jsonsrc/renderer/src/i18n/zh-HK/settings.jsonsrc/renderer/src/i18n/zh-TW/routes.jsonsrc/renderer/src/i18n/zh-TW/settings.jsonsrc/shared/contracts/events/settings.events.tssrc/shared/contracts/routes/system.routes.tssrc/shared/settingsNavigation.tssrc/types/i18n.d.tstest/renderer/components/AboutUsSettings.test.tstest/renderer/components/DebugSettings.test.tstest/renderer/components/SettingsNavigationDebug.test.ts
💤 Files with no reviewable changes (1)
- src/renderer/settings/components/AboutUsSettings.vue
# Conflicts: # test/main/provider/modelConfig.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
UI
Before:
After:
Validation
pnpm run formatpnpm run i18npnpm run lintpnpm run typecheckpnpm exec vitest run --config vitest.config.renderer.ts test/renderer/components/AboutUsSettings.test.ts test/renderer/components/DebugSettings.test.ts test/renderer/components/SettingsNavigationDebug.test.tsSummary by CodeRabbit