Skip to content

fix(query): Ensure progress is reset and results are cleared if the query string is empty (fixes #266). #267

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

Merged
merged 2 commits into from
May 14, 2025

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented May 12, 2025

Description

Ensure progress is reset and query results are cleared and if the query string is empty.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  1. Launched debug server and loaded the log viewer with the demo file in the README.
  2. Switched to the Query tab in the left panel. Entered query "123" and observed results shown.
  3. Emptied the query input box and observed the results cleared together with the progress bar.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the handling of query progress and results reset when starting a new query, ensuring progress is reset and previous results are cleared immediately.

Copy link

coderabbitai bot commented May 12, 2025

Walkthrough

The startQuery method in the query controller slice was updated to call setQueryProgress and clearQueryResults at the beginning of its execution, before checking if the query string matches the default query string. No other changes to method logic or public interfaces were made.

Changes

File Change Summary
src/stores/queryStore/createQueryControllerSlice.ts Moved calls to setQueryProgress and clearQueryResults to the start of the startQuery method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QueryControllerSlice
    participant LogFileManagerProxy

    User->>QueryControllerSlice: startQuery(queryString)
    QueryControllerSlice->>QueryControllerSlice: setQueryProgress(default)
    QueryControllerSlice->>QueryControllerSlice: clearQueryResults()
    alt queryString == defaultQueryString
        QueryControllerSlice-->>User: return (do nothing)
    else
        QueryControllerSlice->>LogFileManagerProxy: startQuery(queryString)
        LogFileManagerProxy-->>QueryControllerSlice: result/error
        QueryControllerSlice-->>User: handle result or error
    end
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14082f5 and 056d302.

📒 Files selected for processing (1)
  • src/stores/queryStore/createQueryControllerSlice.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/stores/queryStore/createQueryControllerSlice.ts
🔇 Additional comments (2)
src/stores/queryStore/createQueryControllerSlice.ts (2)

47-47: Simple addition of setQueryProgress to destructuring.

The addition of setQueryProgress to the destructured state is appropriate as it's needed for the new functionality.


52-54: Good fix that ensures consistent UI state when query is empty.

This change effectively addresses issue #266 by ensuring that the progress is reset and query results are cleared even when the query string is empty. Previously, these actions weren't performed for empty queries, which could leave stale results in the UI.

The added code properly resets the state before checking the query string value, ensuring a consistent user experience regardless of whether the query continues or returns early.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

@junhaoliao junhaoliao changed the title fix(query): Ensure progress is reset and query results are cleared and if the query string is empty. fix(query): Ensure progress is reset and query results are cleared and if the query string is empty (fixes #266). May 12, 2025
@junhaoliao junhaoliao requested a review from Henry8192 May 13, 2025 04:48
@junhaoliao junhaoliao marked this pull request as ready for review May 13, 2025 04:53
@junhaoliao junhaoliao requested a review from a team as a code owner May 13, 2025 04:53
Copy link
Collaborator

@Henry8192 Henry8192 left a comment

Choose a reason for hiding this comment

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

LGTM.

@junhaoliao junhaoliao changed the title fix(query): Ensure progress is reset and query results are cleared and if the query string is empty (fixes #266). fix(query): Ensure query progress is reset and results are cleared and if the query string is empty (fixes #266). May 14, 2025
@junhaoliao junhaoliao changed the title fix(query): Ensure query progress is reset and results are cleared and if the query string is empty (fixes #266). fix(query): Ensure progress is reset and results are cleared and if the query string is empty (fixes #266). May 14, 2025
@junhaoliao junhaoliao changed the title fix(query): Ensure progress is reset and results are cleared and if the query string is empty (fixes #266). fix(query): Ensure progress is reset and results are cleared if the query string is empty (fixes #266). May 14, 2025
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.

2 participants