fix(tui): keep onboarding marker in codewhale home#3302
Conversation
Fresh onboarding previously selected ~/.deepseek/.onboarded whenever ~/.codewhale/.onboarded did not already exist, so marking onboarding complete could recreate the legacy DeepSeek directory on new installs. Prefer ~/.codewhale by default while preserving existing legacy markers for migrated users. Fixes Hmbown#3240 Reported by @Final527. Co-authored-by: Final527 <33980030+Final527@users.noreply.github.com>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
nightt5879
left a comment
nightt5879
left a comment
There was a problem hiding this comment.
Self-review:
- Scope is limited to
crates/tui/src/tui/onboarding/mod.rs; no release, package, or provider surfaces changed. - Fresh-install path now defaults to
~/.codewhale/.onboarded, so completing onboarding no longer recreates~/.deepseek/for #3240. - Backward compatibility is preserved: an existing
~/.deepseek/.onboardedmarker is still reused, and.codewhalewins when both markers exist. - Regression coverage was added for fresh install, legacy marker preservation, and primary-over-legacy behavior.
- Local checks passed for formatting, focused onboarding tests,
cargo check -p codewhale-tui --all-features --locked, CI-equivalent workspace clippy, andgit diff --check.
![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 refactors the onboarding marker path logic by introducing helper functions (marker_path_with_home and mark_onboarded_at_home) and adding comprehensive unit tests to verify the behavior of primary (.codewhale) and legacy (.deepseek) marker files. The feedback suggests replacing dirs::home_dir() with crate::config::effective_home_dir() to ensure consistent and robust home directory resolution across the application.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| pub fn default_marker_path() -> Option<PathBuf> { | ||
| dirs::home_dir().map(|home| { | ||
| let primary = home.join(".codewhale").join(".onboarded"); | ||
| if primary.exists() { | ||
| return primary; | ||
| } | ||
| home.join(".deepseek").join(".onboarded") | ||
| }) | ||
| dirs::home_dir().map(|home| marker_path_with_home(&home)) | ||
| } |
There was a problem hiding this comment.
To ensure consistency across the application, we should use crate::config::effective_home_dir() instead of dirs::home_dir(). effective_home_dir() is more robust as it checks environment variables like HOME and USERPROFILE before falling back to dirs::home_dir(). This prevents issues where configuration files are loaded from one directory while the onboarding marker is read from or written to another.
| pub fn default_marker_path() -> Option<PathBuf> { | |
| dirs::home_dir().map(|home| { | |
| let primary = home.join(".codewhale").join(".onboarded"); | |
| if primary.exists() { | |
| return primary; | |
| } | |
| home.join(".deepseek").join(".onboarded") | |
| }) | |
| dirs::home_dir().map(|home| marker_path_with_home(&home)) | |
| } | |
| pub fn default_marker_path() -> Option<PathBuf> { | |
| crate::config::effective_home_dir().map(|home| marker_path_with_home(&home)) | |
| } |
| pub fn mark_onboarded() -> std::io::Result<PathBuf> { | ||
| let path = default_marker_path().ok_or_else(|| { | ||
| let home = dirs::home_dir().ok_or_else(|| { | ||
| std::io::Error::new(std::io::ErrorKind::NotFound, "Home directory not found") | ||
| })?; | ||
| mark_onboarded_at_home(&home) | ||
| } |
There was a problem hiding this comment.
To ensure consistency across the application, we should use crate::config::effective_home_dir() instead of dirs::home_dir(). effective_home_dir() is more robust as it checks environment variables like HOME and USERPROFILE before falling back to dirs::home_dir(). This prevents issues where configuration files are loaded from one directory while the onboarding marker is read from or written to another.
| pub fn mark_onboarded() -> std::io::Result<PathBuf> { | |
| let path = default_marker_path().ok_or_else(|| { | |
| let home = dirs::home_dir().ok_or_else(|| { | |
| std::io::Error::new(std::io::ErrorKind::NotFound, "Home directory not found") | |
| })?; | |
| mark_onboarded_at_home(&home) | |
| } | |
| pub fn mark_onboarded() -> std::io::Result<PathBuf> { | |
| let home = crate::config::effective_home_dir().ok_or_else(|| { | |
| std::io::Error::new(std::io::ErrorKind::NotFound, "Home directory not found") | |
| })?; | |
| mark_onboarded_at_home(&home) | |
| } |
The provider registry drift check expects the TUI config layer to spell out the documented Hugging Face env precedence. Check HUGGINGFACE_API_KEY before the HF_TOKEN fallback in the active-provider auth probe.
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
Address Gemini review feedback by resolving the onboarding marker home through the TUI config home helper instead of dirs::home_dir directly. This keeps onboarding state aligned with the rest of CodeWhale's home-dir resolution.
|
Addressed the Gemini review feedback in |
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
|
Marking this as a v0.8.63 candidate from release triage. Please keep the landing criteria strict: green CI, focused scope, and no unrelated cleanup. |
2 participants
Summary
~/.codewhale/.onboarded).~/.deepseek/.onboardedmarkers for migrated users, while preferring.codewhalewhen both exist.Root Cause
default_marker_path()only returned the CodeWhale marker when~/.codewhale/.onboardedalready existed. On a fresh install it selected~/.deepseek/.onboarded, andmark_onboarded()then created the legacy directory at runtime.Fixes #3240. Reported by @Final527.
Validation
cargo fmt --all -- --checkcargo test -p codewhale-tui --bin codewhale-tui tui::onboarding::tests::cargo check -p codewhale-tui --all-features --lockedcargo clippy --workspace --all-features --locked -- -D warnings -A clippy::uninlined_format_args -A clippy::too_many_arguments -A clippy::unnecessary_map_or -A clippy::assertions_on_constantsgit diff --checkI also attempted
cargo test --workspace --all-features --lockedlocally. The default Windows temp dir is under a host-levelC:\.git, which makes unrelated session-manager temp workspaces resolve to the same root repository. MovingTEMP/TMPtoD:\codex-tempcleared that local session-scope failure, but the full run still hit host-specific pandoc/SHGetFolderPath and environment-sensitive config failures. The focused regression tests and CI-equivalent lint/check commands above pass locally; CI should provide the isolated full-suite result.