Skip to content

feat: autodetect dash-qt binary location#297

Merged
QuantumExplorer merged 1 commit into
v0.9-devfrom
feat/autodetect-dash-qt-in-path
May 29, 2025
Merged

feat: autodetect dash-qt binary location#297
QuantumExplorer merged 1 commit into
v0.9-devfrom
feat/autodetect-dash-qt-in-path

Conversation

@lklimek
Copy link
Copy Markdown
Contributor

@lklimek lklimek commented May 29, 2025

This pull request introduces several enhancements to improve the handling of dash-qt executable paths and database settings, as well as refactoring for better code maintainability. The most important changes include adding the which crate for locating executables, modifying the logic for determining default dash-qt paths, and refactoring repeated database update calls into a new save method.

Dependency Updates:

  • Cargo.toml: Added the which crate (version = "7.0.3") to enable system PATH searches for executables.

Enhancements to dash-qt Path Handling:

  • src/app.rs: Updated the logic to use the which crate for locating the dash-qt executable in the system PATH as a default value when no custom path is provided. This includes error handling with logging for failed searches.

Code Refactoring for Database Updates:

  • src/ui/network_chooser_screen.rs: Introduced a new save method in NetworkChooserScreen to encapsulate database update logic for dash-core execution settings. This method improves code reuse and readability.
  • src/ui/network_chooser_screen.rs: Replaced direct database update calls with the new save method in multiple places, including file selection validation, clearing the custom path, and toggling the overwrite dash.conf checkbox. [1] [2]

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances handling of the dash-qt executable path by adding auto-detection via the which crate and refactors repeated database update calls into a new, reusable save method.

  • Introduce which dependency and auto-detect dash-qt in $PATH when no custom path is set.
  • Encapsulate database update logic for dash-core settings in NetworkChooserScreen::save().
  • Replace direct update_dash_core_execution_settings calls with save() for consistency and maintainability.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/app.rs Use which::which to locate dash-qt as default path
src/ui/network_chooser_screen.rs Extract DB updates into save() and replace direct calls
Cargo.toml Added which = "7.0.3" dependency
Comments suppressed due to low confidence (3)

src/ui/network_chooser_screen.rs:94

  • Add unit tests for save() to verify that database update logic behaves correctly across various scenarios (e.g., success and failure cases).
fn save(&self) -> Result<(), String> {

src/ui/network_chooser_screen.rs:164

  • [nitpick] Consider providing more context in the panic message or handling the error gracefully instead of relying on a generic expect message.
self.save().expect("Expected to save db settings");

src/app.rs:196

  • [nitpick] Rename dash_qt to dash_qt_path for clarity since it holds the executable path rather than the executable itself.
let dash_qt = which::which("dash-qt")


/// Save the current settings to the database
///
/// TODO: doesn't save local network settings like password yet.
Copy link

Copilot AI May 29, 2025

Choose a reason for hiding this comment

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

Remove or address the TODO by implementing support for saving local network settings or documenting this limitation explicitly in the method doc.

Copilot uses AI. Check for mistakes.
@QuantumExplorer QuantumExplorer merged commit 62a9c91 into v0.9-dev May 29, 2025
1 check passed
@QuantumExplorer QuantumExplorer deleted the feat/autodetect-dash-qt-in-path branch May 29, 2025 14:53
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.

3 participants