Skip to content

Conversation

Jack251970
Copy link
Member

@Jack251970 Jack251970 commented Feb 20, 2025

Use null as default value for record key

  • Because old data does not have this key, we should use null as the default value for consistency.

Deep clone result list before updating results

  • Because FL will change the score property of the results during results update, so before we update the results, we need to deep clone the result list, so that plugin can cache them for performance improvement (like Flow.Launcher.Plugin.Program).

This can fix issue in #3203. Tested.

This comment has been minimized.

Copy link

gitstream-cm bot commented Feb 20, 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 Feb 20, 2025

📝 Walkthrough

Walkthrough

This pull request updates several components for improved type safety and result handling. In the PluginManager class, the parameter for UpdatePluginMetadata is now an IReadOnlyList<Result> instead of a List<Result>. The Result class has its RecordKey default changed from an empty string to null. Additionally, a new method DeepCloneResults is introduced in the MainViewModel class, which ensures a deep copy of results is processed, preventing unintended modifications.

Changes

File(s) Change Summary
Flow.Launcher.Core/Plugin/PluginManager.cs
Flow.Launcher.Plugin/Result.cs
Updated public API signatures: In PluginManager, changed method parameter from List<Result> to IReadOnlyList<Result>; in Result, changed default for RecordKey from an empty string to null.
Flow.Launcher/ViewModel/MainViewModel.cs Added the DeepCloneResults method to create a deep copy of result objects and updated QueryTask to use this method, ensuring immutability during updates.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • jjw24
  • taooceros

Poem

I'm a happy rabbit hopping through the code,
Seeing changes bloom, lightening my load.
Deep copies keep the carrots crisp and new,
Nulls and IReadOnly lists, a clearer view.
Hoppity, happity—coding in a lovely mode!
🥕🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd73e4b and b469228.

📒 Files selected for processing (1)
  • Flow.Launcher/ViewModel/MainViewModel.cs (4 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 (1)
  • GitHub Check: gitStream.cm

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
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 (2)
Flow.Launcher/ViewModel/MainViewModel.cs (2)

417-431: Consider adding a null check
If results might be null in some future usage, consider early returning an empty list instead of throwing a NullReferenceException.


1497-1499: Use the actual MaxScore constant
Here, a literal 100000 is assigned, but the comment references Result.MaxScore, which is int.MaxValue. To avoid confusion and align with the constant, consider:

- result.Score = 100000; //Result.MaxScore;
+ result.Score = Result.MaxScore;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a54eed and 9850e9d.

📒 Files selected for processing (3)
  • Flow.Launcher.Core/Plugin/PluginManager.cs (1 hunks)
  • Flow.Launcher.Plugin/Result.cs (1 hunks)
  • Flow.Launcher/ViewModel/MainViewModel.cs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (4)
Flow.Launcher/ViewModel/MainViewModel.cs (2)

234-235: Deep cloning is a clean approach here
These lines ensure each plugin's changes won't inadvertently mutate the Flow Launcher's results. Looks good.


1199-1208: Graceful handling of null results
Falling back to _emptyResult is a robust choice, preventing null reference errors.

Flow.Launcher.Plugin/Result.cs (1)

269-271: Null default for RecordKey
Changing from empty string to null aligns the code with older data.

Flow.Launcher.Core/Plugin/PluginManager.cs (1)

284-284: Upgrade to IReadOnlyList<Result>
Switching from List<Result> to a read-only list improves immutability and clarity.

@Jack251970 Jack251970 enabled auto-merge February 20, 2025 10:26

This comment has been minimized.

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/MainViewModel.cs (1)

417-431: Optimize the deep clone implementation.

The implementation can be improved in the following ways:

  1. Remove unnecessary .ToList() call as the input is already IReadOnlyList.
  2. Add null check for the input parameter.

Apply this diff to optimize the implementation:

 private static IReadOnlyList<Result> DeepCloneResults(IReadOnlyList<Result> results, CancellationToken token = default)
 {
+    if (results == null)
+        return _emptyResult;
+
     var resultsCopy = new List<Result>();
-    foreach (var result in results.ToList())
+    foreach (var result in results)
     {
         if (token.IsCancellationRequested)
         {
             break;
         }

         var resultCopy = result.Clone();
         resultsCopy.Add(resultCopy);
     }
     return resultsCopy;
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9850e9d and dd73e4b.

📒 Files selected for processing (1)
  • Flow.Launcher/ViewModel/MainViewModel.cs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (3)
Flow.Launcher/ViewModel/MainViewModel.cs (3)

234-236: LGTM! Good use of deep cloning to prevent side effects.

The implementation correctly clones the results before updating plugin metadata, preventing potential issues where plugins might modify the list or items during view model updates.


1199-1208: LGTM! Proper handling of null results and deep cloning.

The implementation correctly:

  1. Handles null results by returning an empty list.
  2. Deep clones results to prevent Flow Launcher from modifying properties like score.

1499-1505: LGTM! Proper score calculation with priority and selected count.

The implementation correctly:

  1. Handles top most records by setting max score.
  2. Calculates priority score based on metadata priority.
  3. Adds selected count if enabled.

@Jack251970 Jack251970 requested a review from jjw24 February 22, 2025 08:00
Copy link

@check-spelling-bot Report

🔴 Please review

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

❌ Errors Count
❌ forbidden-pattern 22
⚠️ ignored-expect-variant 1
⚠️ non-alpha-in-dictionary 19

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.

@Jack251970
Copy link
Member Author

@jjw24 I have done my work, please check.

@Jack251970 Jack251970 merged commit 9665619 into Flow-Launcher:dev Feb 22, 2025
7 checks passed
@jjw24 jjw24 added Dev branch only An issue or fix for the Dev branch build and removed bug Something isn't working 1 min review labels Feb 22, 2025
@jjw24 jjw24 added this to the 1.20.0 milestone Feb 22, 2025
Copy link

gitstream-cm bot commented Feb 22, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970 has most 👩‍💻 activity in the files.
VictoriousRaptor has most 🧠 knowledge in the files.

See details

Flow.Launcher.Core/Plugin/PluginManager.cs

Activity based on git-commit:

Jack251970
FEB 1 additions & 1 deletions
JAN
DEC
NOV 1 additions & 1 deletions
OCT
SEP

Knowledge based on git-blame:
VictoriousRaptor: 27%

Flow.Launcher.Plugin/Result.cs

Activity based on git-commit:

Jack251970
FEB 2 additions & 1 deletions
JAN 17 additions & 0 deletions
DEC 10 additions & 0 deletions
NOV
OCT
SEP

Knowledge based on git-blame:
VictoriousRaptor: 12%

Flow.Launcher/ViewModel/MainViewModel.cs

Activity based on git-commit:

Jack251970
FEB 54 additions & 10 deletions
JAN 14 additions & 19 deletions
DEC 59 additions & 63 deletions
NOV 39 additions & 15 deletions
OCT
SEP

Knowledge based on git-blame:
VictoriousRaptor: 10%

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

2 participants