Skip to content

Reproduce result clear issue #3580

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Conversation

Jack251970
Copy link
Contributor

@Jack251970 Jack251970 commented May 24, 2025

Reproduce #3567.

Steps

  • Open Flow.
  • Input one character.
  • Clear it.
  • The results are not cleared.

This comment has been minimized.

Copy link

gitstream-cm bot commented May 24, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

Copy link
Contributor

coderabbitai bot commented May 24, 2025

📝 Walkthrough

Walkthrough

A private integer field, cancelIndex, was added to the MainViewModel class. The asynchronous method UpdateActionAsync now increments cancelIndex and cancels the second query requesting to clear existing results. The clearing flag is propagated through the update pipeline and used in ResultsViewModel.AddResults to optionally clear results even if cancellation is requested.

Changes

File(s) Change Summary
Flow.Launcher/ViewModel/MainViewModel.cs Added cancelIndex field; updated UpdateActionAsync and QueryTaskAsync to track and cancel the second clear request; passed clearing flag to Results.AddResults.
Flow.Launcher/ViewModel/ResultsViewModel.cs Modified AddResults method to accept optional shouldClearExistingResults parameter; clears results on cancellation if flag is true.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • taooceros

Poem

In the warren of code, a new rule appears,
To clear results wisely, and calm bunny fears.
With a hop and a skip, cancelIndex keeps track,
No more redundant clears hopping back to back.
The flow now is smoother, as rabbits all cheer! 🐇✨

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

Copy link
Contributor

@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: 1

🧹 Nitpick comments (1)
Flow.Launcher/ViewModel/MainViewModel.cs (1)

197-197: Consider renaming and documenting the field purpose.

The field name cancelIndex is misleading since it's not an index but rather a counter. Consider renaming to clearRequestCount or similar to better reflect its purpose. Also add documentation explaining its role in preventing redundant clear operations.

-        private int cancelIndex = 0;
+        /// <summary>
+        /// Counter to track clear result requests and prevent redundant clear operations.
+        /// </summary>
+        private int clearRequestCount = 0;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2026bb7 and 905a97d.

📒 Files selected for processing (1)
  • Flow.Launcher/ViewModel/MainViewModel.cs (2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Check Spelling
Flow.Launcher/ViewModel/MainViewModel.cs

[warning] 1858-1858: Spell check warning: VSTHRD is not a recognized word. (unrecognized-spelling)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: build

@Jack251970 Jack251970 added the Dev branch only An issue or fix for the Dev branch build label May 24, 2025
Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Copy link

gitstream-cm bot commented May 26, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970, jjw24 have most 👩‍💻 activity in the files.
Jack251970 has most 🧠 knowledge in the files.

See details

Flow.Launcher/ViewModel/MainViewModel.cs

Activity based on git-commit:

Jack251970 jjw24
MAY 529 additions & 316 deletions 39 additions & 27 deletions
APR 35 additions & 28 deletions
MAR 695 additions & 628 deletions
FEB 63 additions & 21 deletions
JAN 17 additions & 21 deletions
DEC 59 additions & 63 deletions

Knowledge based on git-blame:
Jack251970: 40%

Flow.Launcher/ViewModel/ResultsViewModel.cs

Activity based on git-commit:

Jack251970 jjw24
MAY 17 additions & 7 deletions 8 additions & 3 deletions
APR 4 additions & 5 deletions
MAR 8 additions & 6 deletions
FEB
JAN
DEC

Knowledge based on git-blame:
Jack251970: 7%

To learn more about /:\ gitStream - Visit our Docs

Copy link
Contributor

@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)
Flow.Launcher/ViewModel/ResultsViewModel.cs (1)

192-202: Refactor the conditional logic for better clarity.

The logic correctly implements the intended behavior to clear results even when cancelled, but the nested structure could be simplified for better readability.

Consider this cleaner approach:

-            if (token.IsCancellationRequested)
-            {
-                if (shouldClearExistingResults)
-                {
-                    newResults = new List<ResultViewModel>();
-                }
-                else
-                {
-                    return;
-                }
-            }
+            if (token.IsCancellationRequested && !shouldClearExistingResults)
+            {
+                return;
+            }
+            
+            if (token.IsCancellationRequested && shouldClearExistingResults)
+            {
+                newResults = new List<ResultViewModel>();
+            }

This makes the two distinct behaviors more explicit and easier to understand.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 905a97d and d5d660e.

📒 Files selected for processing (2)
  • Flow.Launcher/ViewModel/MainViewModel.cs (5 hunks)
  • Flow.Launcher/ViewModel/ResultsViewModel.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/ViewModel/MainViewModel.cs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (2)
Flow.Launcher/ViewModel/ResultsViewModel.cs (2)

188-188: LGTM! Well-designed parameter addition.

The optional shouldClearExistingResults parameter with a default value of false maintains backward compatibility while clearly indicating its purpose. The naming convention is appropriate.


188-202:

✅ Verification successful

Verify the fix addresses the original issue completely.

This implementation looks correct for addressing issue #3567 where results weren't clearing when input was cleared. The approach of passing an empty list when shouldClearExistingResults is true should trigger the clearing behavior through the existing UpdateResults pipeline.

To ensure this fix works as intended, please verify:


🏁 Script executed:

#!/bin/bash
# Description: Check how shouldClearExistingResults is used in MainViewModel
# Expected: Find usage in MainViewModel.cs that sets this parameter to true when clearing input

echo "Searching for shouldClearExistingResults usage in MainViewModel..."
rg -A 5 -B 5 "shouldClearExistingResults.*true" 

echo "Searching for AddResults calls in MainViewModel..."
rg -A 3 -B 2 "AddResults.*shouldClearExistingResults"

Length of output: 1530


🏁 Script executed:

#!/bin/bash
echo "Fetching context around AddResults call in MainViewModel:"
rg -A5 -B5 "Results\.AddResults" Flow.Launcher/ViewModel/MainViewModel.cs

echo
echo "Looking for declaration or assignment of shouldClearExistingResults in the surrounding scope:"
rg -A3 -B3 "shouldClearExistingResults" Flow.Launcher/ViewModel/MainViewModel.cs

Length of output: 3501


🏁 Script executed:

#!/bin/bash
echo "Searching for ShouldClearExistingResultsForQuery implementation..."
rg -n "ShouldClearExistingResultsForQuery" -A20 -B5 .

echo
echo "Showing just the signature and return logic:"
rg -n "ShouldClearExistingResultsForQuery" -A5 -B0 .

Length of output: 9756


✅ Fix Verified: Clearing Behavior Works as Intended

I’ve confirmed that:

  • ShouldClearExistingResultsForQuery correctly returns true when the input is cleared (or when switching home/keyword queries).
  • MainViewModel passes that flag into Results.AddResults(..., shouldClearExistingResults: true) for both plugin and history result updates.
  • ResultsViewModel.AddResults replaces newResults with an empty list when shouldClearExistingResults is true (and the token is canceled), effectively clearing the UI.

No unintended side effects were found—this fully addresses issue #3567 without breaking existing behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 min review Dev branch only An issue or fix for the Dev branch build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant