Skip to content

Conversation

Jack251970
Copy link
Member

Changes

  • Expose ISavable interface in derived class to make sure we are calling the new version of Save method. This can make sure we are calling the version of Save with error handling.
  • Use ISavable instead of object for code quality

Since all Save methods are called with error handling, we can resolve #3043, #3130.

@Jack251970 Jack251970 requested a review from Copilot June 6, 2025 10:45
@Jack251970 Jack251970 added this to the 1.20.1 milestone Jun 6, 2025
@Jack251970 Jack251970 added the bug Something isn't working label Jun 6, 2025
Copy link

gitstream-cm bot commented Jun 6, 2025

🥷 Code experts: no user but you matched threshold 10

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

See details

Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs

Activity based on git-commit:

Jack251970
JUN
MAY
APR 21 additions & 6 deletions
MAR 316 additions & 239 deletions
FEB 220 additions & 247 deletions
JAN

Knowledge based on git-blame:
Jack251970: 73%

Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs

Activity based on git-commit:

Jack251970
JUN
MAY
APR 44 additions & 14 deletions
MAR
FEB
JAN

Knowledge based on git-blame:
Jack251970: 72%

Flow.Launcher.Infrastructure/Storage/PluginBinaryStorage.cs

Activity based on git-commit:

Jack251970
JUN
MAY
APR 53 additions & 9 deletions
MAR
FEB
JAN

Knowledge based on git-blame:
Jack251970: 100%

Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs

Activity based on git-commit:

Jack251970
JUN
MAY
APR 39 additions & 9 deletions
MAR
FEB 15 additions & 13 deletions
JAN

Knowledge based on git-blame:
Jack251970: 64%

Flow.Launcher/PublicAPIInstance.cs

Activity based on git-commit:

Jack251970
JUN 19 additions & 5 deletions
MAY 124 additions & 131 deletions
APR 165 additions & 61 deletions
MAR 21 additions & 19 deletions
FEB 28 additions & 11 deletions
JAN 45 additions & 47 deletions

Knowledge based on git-blame:
Jack251970: 51%

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

Copy link

gitstream-cm bot commented Jun 6, 2025

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

This comment has been minimized.

@Jack251970 Jack251970 changed the title Derive class save Fix Derive Class Save Method Calling Issue Jun 6, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors plugin storage to use a unified ISavable interface, ensuring all Save calls use the error-handling version and improving type safety.

  • Expose ISavable on derived storage classes and JsonRPCPluginSettings
  • Switch PublicAPIInstance plugin storage dictionaries from object to ISavable and update save loops
  • Resolve issues #3043 and #3130 by guaranteeing the new Save method is invoked

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Flow.Launcher/PublicAPIInstance.cs Changed plugin storage dictionaries to ISavable and updated save loops
Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs Implemented ISavable on JSON storage
Flow.Launcher.Infrastructure/Storage/PluginBinaryStorage.cs Implemented ISavable on binary storage
Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs Implemented ISavable on launcher JSON storage
Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs Added ISavable to plugin settings class
Comments suppressed due to low confidence (2)

Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs:11

  • [nitpick] Public classes implementing ISavable should include XML documentation summarizing their behavior. Consider adding a <summary> comment for clarity.
public class PluginJsonStorage<T> : JsonStorage<T>, ISavable where T : new()

Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs:15

  • JsonRPCPluginSettings declares ISavable but does not implement the required Save method, causing a compile error. Add a Save implementation or remove the interface.
public class JsonRPCPluginSettings : ISavable

Copy link
Contributor

coderabbitai bot commented Jun 6, 2025

📝 Walkthrough

Walkthrough

The changes update several storage-related classes and a plugin settings class to explicitly implement the ISavable interface. Additionally, internal dictionaries in PublicAPIInstance are modified to store ISavable instances directly, removing the need for casting. No functional or control flow changes are introduced.

Changes

Files/Groups Change Summary
Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs JsonRPCPluginSettings now implements ISavable.
Flow.Launcher.Infrastructure/Storage/FlowLauncherJsonStorage.cs
Flow.Launcher.Infrastructure/Storage/PluginJsonStorage.cs
Flow.Launcher.Infrastructure/Storage/PluginBinaryStorage.cs
Storage classes now explicitly implement ISavable in their class signatures.
Flow.Launcher/PublicAPIInstance.cs Internal dictionaries now use ISavable as the value type, removing the need for casting.

Sequence Diagram(s)

sequenceDiagram
    participant PublicAPIInstance
    participant ISavable
    loop For each plugin storage
        PublicAPIInstance->>ISavable: Save()
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure plugin storage and settings classes correctly implement ISavable to avoid cast errors (#3043)
Update internal storage in PublicAPIInstance to store ISavable directly (#3043)

Suggested labels

Dev branch only

Suggested reviewers

  • jjw24
  • taooceros

Poem

A hop and a skip, a storage fix in place,
Now plugins save with elegant grace.
No more casting woes, just ISavable cheer,
The code is now tidy—bugs disappear!
With every Save() call, the rabbits rejoice,
For Flow hops smoothly, thanks to a wise choice! 🐇✨


📜 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 062cd2a and 754533f.

📒 Files selected for processing (1)
  • Flow.Launcher/PublicAPIInstance.cs (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/PublicAPIInstance.cs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Report (PR)
  • GitHub Check: gitStream.cm
  • GitHub Check: build
✨ 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.

@Jack251970 Jack251970 enabled auto-merge June 6, 2025 10:48
@jjw24
Copy link
Member

jjw24 commented Jun 8, 2025

Is there a way to test this?

@Jack251970
Copy link
Member Author

Is there a way to test this?

public class Base : ISave
{
    public void Save() { Console.WriteLine("a"); }
}

public class Derived : Base
{
    public new void Save() { Console.WriteLine("b"); } // Hides Base.Save
}

var obj = new Derived();
(obj as ISave)?.Save(); // a
public class Base : ISave
{
    public void Save() { Console.WriteLine("a"); }
}

public class Derived : Base, ISave
{
    public new void Save() { Console.WriteLine("b"); } // Hides Base.Save
}

var obj = new Derived();
(obj as ISave)?.Save(); // b --------------- this is the right thing

Copy link

github-actions bot commented Jun 8, 2025

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

@Jack251970 Jack251970 merged commit ba28621 into dev Jun 9, 2025
11 checks passed
@Jack251970 Jack251970 deleted the derive_class_save branch June 9, 2025 08:27
@jjw24 jjw24 removed the 1 min review label Jun 9, 2025
jjw24 pushed a commit that referenced this pull request Jun 11, 2025
Fix Derive Class Save Method Calling Issue
@Jack251970 Jack251970 linked an issue Jun 17, 2025 that may be closed by this pull request
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: Setting File Unable to delete the file being replaced BUG: Flow launcher got an error

2 participants