Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: GH-87 fix scan dialog inconsistencies #94

Conversation

matiasdaloia
Copy link
Collaborator

@matiasdaloia matiasdaloia commented Feb 19, 2025

Summary by CodeRabbit

  • Documentation

    • Updated the changelog for version 0.6.1 with comprehensive release details and comparison links.
  • New Features

    • Introduced a new path-joining utility to streamline file path constructions.
    • Enhanced the scan dialog by allowing its open state to be controlled externally for improved usability.
  • Bug Fixes

    • Resolved issues with scan dialog animations, path selections, and unintended resets to default values.

@matiasdaloia matiasdaloia self-assigned this Feb 19, 2025
@matiasdaloia matiasdaloia added bug Something isn't working enhancement New feature or request labels Feb 19, 2025
@matiasdaloia matiasdaloia linked an issue Feb 19, 2025 that may be closed by this pull request
Copy link

coderabbitai bot commented Feb 19, 2025

Walkthrough

The changes update the project’s version documentation with a new 0.6.1 entry detailing bug fixes and a consolidation of path-building within the ScanDialog. A new JoinPaths method is added to the App struct (in Go) to facilitate path concatenation. The ScanDialog component now accepts an open prop and has its directory selection logic revised—renaming handlers and invoking a new helper for updating paths. Additionally, the ScanDialog rendering in the root route is modified to use the new prop. Corresponding WailsJS interface files in TypeScript and JavaScript are updated to expose the new JoinPaths functionality.

Changes

File(s) Change Details
CHANGELOG.md Added version 0.6.1 entry with fixes for scan dialog animation, path building, and default value resetting, plus consolidation of scan root path generation functionality.
app.go Added new method JoinPaths(elements []string) string to the App struct using filepath.Join.
frontend/src/components/ScanDialog.tsx
frontend/src/routes/root.tsx
Updated ScanDialog component: added open prop, renamed handleSelectDirectory to handleSelectScanRoot, integrated new helper updatePathWhenScanRootChanges using JoinPaths, improved error logging, and adjusted initialization logic.
frontend/wailsjs/go/main/App.d.ts
frontend/wailsjs/go/main/App.js
Added exported function JoinPaths to the WailsJS layer, exposing the new path joining functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SD as ScanDialog
    participant App
    participant FS as File System

    User->>SD: Opens ScanDialog (via open prop)
    SD->>SD: Initializes using updatePathWhenScanRootChanges
    User->>SD: Selects scan root directory
    SD->>App: Calls JoinPaths with directory components
    App->>FS: Joins paths using filepath.Join
    FS-->>App: Returns concatenated path
    App-->>SD: Updated path
    SD-->>User: Displays updated results and settings paths
Loading

Poem

Oh, I’m a rabbit with a skip in my step,
Coding paths together with a clever prep.
ScanDialog now dances with an “open” charm,
Joining paths so nicely, causing no harm.
I hop with cheer at each new code line,
Celebrating changes that purely shine!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

13-22: Add period after "etc".

The changelog entries are well-documented and follow the Keep a Changelog format. However, there's a minor style issue.

Apply this diff to fix the style issue:

-Use a single function to get all scan root derived paths in ScanDialog (results path, settings path, etc)
+Use a single function to get all scan root derived paths in ScanDialog (results path, settings path, etc.)
🧰 Tools
🪛 LanguageTool

[style] ~21-~21: In American English, abbreviations like “etc.” require a period.
Context: ...canDialog (results path, settings path, etc) ## [0.6.0] 2024-02-03 ### Added - Ad...

(ETC_PERIOD)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 593b442 and bef035b.

📒 Files selected for processing (6)
  • CHANGELOG.md (2 hunks)
  • app.go (2 hunks)
  • frontend/src/components/ScanDialog.tsx (8 hunks)
  • frontend/src/routes/root.tsx (1 hunks)
  • frontend/wailsjs/go/main/App.d.ts (1 hunks)
  • frontend/wailsjs/go/main/App.js (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[style] ~21-~21: In American English, abbreviations like “etc.” require a period.
Context: ...canDialog (results path, settings path, etc) ## [0.6.0] 2024-02-03 ### Added - Ad...

(ETC_PERIOD)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: unit_tests
  • GitHub Check: integration-tests
🔇 Additional comments (12)
app.go (1)

217-219: LGTM! Clean implementation of path joining.

The implementation correctly uses filepath.Join from the standard library, ensuring cross-platform compatibility for path concatenation.

frontend/wailsjs/go/main/App.d.ts (1)

16-16: LGTM! Type declaration matches backend implementation.

The TypeScript declaration correctly defines the JoinPaths function signature, maintaining consistency with other declarations.

frontend/wailsjs/go/main/App.js (1)

25-27: LGTM! Implementation follows established patterns.

The JavaScript implementation correctly bridges to the Go backend, maintaining consistency with other functions.

frontend/src/routes/root.tsx (1)

76-76: LGTM! Improved dialog state management.

The change to use the open prop follows React best practices for controlled components, making the dialog state management more explicit and predictable.

frontend/src/components/ScanDialog.tsx (7)

37-37: LGTM!

The import of JoinPaths is correctly added and used in the new path concatenation functionality.


53-56: LGTM!

The open prop is correctly added to the interface, improving the dialog's state management.


58-58: LGTM!

The function signature is correctly updated to include the open prop.


84-86: LGTM!

Error handling is improved with specific error messages for better debugging.


94-113: LGTM!

The new updatePathWhenScanRootChanges function is well-implemented with proper error handling and follows DRY principles by consolidating path updates.


199-199: LGTM!

The initialization is correctly updated to use the new path update function and properly depends on initialScanRoot.

Also applies to: 210-210


242-242: LGTM!

The Dialog component correctly uses the new open prop for state management.

CHANGELOG.md (1)

67-68: LGTM!

The version comparison links are correctly added.

@matiasdaloia matiasdaloia merged commit a17f34c into main Feb 19, 2025
4 checks passed
@matiasdaloia matiasdaloia deleted the fix/mdaloia/87-inconsistency-constructing-settings-scan-results-paths branch February 19, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistency constructing settings & scan results paths
1 participant