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

[API] Escape ActionKeywords duplicates #3151

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

NoPlagiarism
Copy link
Contributor

No description provided.

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.

Copy link

gitstream-cm bot commented Dec 28, 2024

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 Dec 28, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the AddActionKeyword method in the PluginManager class. The change focuses on preventing duplicate action keywords from being added to a plugin's ActionKeywords list. By implementing a simple check before adding a new keyword, the method now ensures that only unique action keywords are stored, maintaining the integrity of the plugin management system.

Changes

File Change Summary
Flow.Launcher.Core/Plugin/PluginManager.cs Modified AddActionKeyword method to prevent adding duplicate action keywords by checking for existing entries before insertion

Poem

🐰 A rabbit's code review delight,
No duplicates shall take flight!
Keywords unique, clean and neat,
Our plugin manager's now complete
With logic sharp and wisdom bright! 🔍


📜 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 fd3576d and 9b8ba7a.

📒 Files selected for processing (1)
  • Flow.Launcher.Core/Plugin/PluginManager.cs (1 hunks)
🔇 Additional comments (1)
Flow.Launcher.Core/Plugin/PluginManager.cs (1)

367-368: Consider thread-safety and null checks.

This check effectively guards against duplicates. However, if AddActionKeyword is invoked concurrently, there’s no synchronization mechanism preventing race conditions (e.g., two threads passing the if Contains(...) check at the same moment). Additionally, you may want to ensure newActionKeyword is not null or empty to avoid potential silent failures.

Do you need a sample code snippet demonstrating thread-safe dictionary and list operations, along with null checks?


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.

@taooceros
Copy link
Member

should we warn this with an error or something? I think technically plugin should call whether this actionkeyword is available before calling add (correct me if I am wrong as I add those thing way too long ago).

@taooceros
Copy link
Member

We don't really support duplicate keyword...I don't know whether we should though

@NoPlagiarism
Copy link
Contributor Author

warn this with an error

I guess it should be mentioned in logs 🤔

support duplicate keyword

This PR is not to add support, but to escape it in the first place. If there are 2 identical keywords, nothing bad happens

@taooceros
Copy link
Member

I was a little bit not sure whether we want to do this. For example a plugin add two action keywords for two different purposes. However because of this change, when user delete one then both will be deactivated, which might not be an ideal scenario.

Generally I think people solves this kind of thing with some reference counting, but I am not sure whether we want to do that.

@jjw24
Copy link
Member

jjw24 commented Dec 30, 2024

We don't really support duplicate keyword...I don't know whether we should though

Probably separate conversation to this change. But to answer your question, currently I think we should allow duplicates. The result might look messy but this means having duplicate actionkeywords is not a show stopper. Thinking in the long term when we have hundreds of plugins it's just not feasible for plugin devs to find a non-used action keyword easily.

Copy link

gitstream-cm bot commented Dec 30, 2024

🥷 Code experts: Yusyuriv, VictoriousRaptor

Yusyuriv, jjw24 have 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:

Yusyuriv jjw24
JAN
DEC
NOV
OCT
SEP
AUG 2 additions & 2 deletions 1 additions & 0 deletions

Knowledge based on git-blame:
VictoriousRaptor: 27%

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

@jjw24
Copy link
Member

jjw24 commented Dec 30, 2024

warn this with an error

I guess it should be mentioned in logs 🤔

support duplicate keyword

This PR is not to add support, but to escape it in the first place. If there are 2 identical keywords, nothing bad happens

What is the current behaviour? IIRC flow will error out and disable the plugins right?

With this change does it mean it will trigger both plugins' results after the action keyword is added?

@NoPlagiarism
Copy link
Contributor Author

NoPlagiarism commented Dec 30, 2024

Stop. Let me get this straight to skip any misunderstandings.

This PR is to escape per-plugin duplicates

This does not interferes with other plugins. It only looks up current plugin before adding new action keyword to it

P.S: I can rename PR & commit to be more specific if needed

@taooceros
Copy link
Member

Stop. Let me get this straight to skip any misunderstandings.

This PR is to escape per-plugin duplicates

This does not interferes with other plugins. It only looks up current plugin before adding new action keyword to it

P.S: I can rename PR & commit to be more specific if needed

No I understand the purpose of this pr. However, as I mentioned, it impose the risk that when a plugin add 2 duplicate action keyword, but when it delete one, then both will be deleted.

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