Fix API instance create twice issue & Make PluginManager.API private

[Jack251970]

From #3296

We should not initialize API in static constructor or it will create another API instance.

[github-actions]

@check-spelling-bot Report

🔴 Please review

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

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

See ❌ Event descriptions for more information.

Forbidden patterns 🙅 (1)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

s.b. workaround(s)

\bwork[- ]arounds?\b

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.

[gitstream-cm]

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request refactors the API initialization mechanism and updates API references. The PluginManager class now lazily initializes its API instance to ensure a single instance is used. Furthermore, calls across various application components previously invoking PluginManager.API have been updated to use App.API. These changes adjust the underlying API gateway distribution without altering overall functionality.

Changes

File(s)	Change Summary
Flow.Launcher.Core/Plugin/PluginManager.cs	Refactored the API initialization by replacing a direct public static property with a private static field and lazy-loaded property to prevent multiple instances.
Flow.Launcher/MainWindow.xaml.cs, Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs, Flow.Launcher/SettingPages/Views/SettingsPanePluginStore.xaml.cs, Flow.Launcher/ViewModel/MainViewModel.cs, Flow.Launcher/ViewModel/PluginViewModel.cs	Updated API calls by replacing references from PluginManager.API to App.API for operations such as saving settings, opening directories, opening URLs, and updating queries.

Sequence Diagram(s)

Loading

sequenceDiagram
    participant Caller as Calling Code
    participant PM as PluginManager
    participant Ioc as Ioc.Default

    Caller->>PM: Access API property
    PM->>PM: Check if 'api' is null
    alt api is null
        PM->>Ioc: GetRequiredService<IPublicAPI>()
        Ioc-->>PM: Return IPublicAPI instance
        PM-->>Caller: Return initialized API
    else
        PM-->>Caller: Return cached API
    end

Loading

sequenceDiagram
    participant UI as Application Component
    participant App as App.API
    participant Service as IPublicAPI

    UI->>App: Invoke API method (e.g. OpenUrl, SaveAppAllSettings)
    App->>Service: Perform API operation
    Service-->>App: Return operation result
    App-->>UI: Return response

Possibly related PRs

• Support deleting plugin settings when uninstalling plugins #3219: Alters the UninstallPlugin method in the PluginManager class, enhancing plugin settings management during uninstallation and showing strong code-level connection.

Suggested labels

enhancement

Suggested reviewers

• jjw24
• taooceros

Poem

I'm a rabbit with hops so spry,
Fixing lazy loads as time flies by.
From PluginManager to App the calls now flow,
Ensuring one API instance to know.
In a code-filled garden, may our refactor glow!
🥕🐇

---

📜 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 65f85cf and c06042f.

📒 Files selected for processing (6)

• Flow.Launcher.Core/Plugin/PluginManager.cs (1 hunks)
• Flow.Launcher/MainWindow.xaml.cs (1 hunks)
• Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (1 hunks)
• Flow.Launcher/SettingPages/Views/SettingsPanePluginStore.xaml.cs (1 hunks)
• Flow.Launcher/ViewModel/MainViewModel.cs (1 hunks)
• Flow.Launcher/ViewModel/PluginViewModel.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: gitStream.cm
• GitHub Check: gitStream.cm
• GitHub Check: gitStream.cm

🔇 Additional comments (9)

Flow.Launcher/SettingPages/Views/SettingsPanePluginStore.xaml.cs (1)

51-51: API reference updated correctly

The change from PluginManager.API.OpenUrl to App.API.OpenUrl aligns with the PR objective of making PluginManager.API private and centralizing API access through the App class.

Flow.Launcher/MainWindow.xaml.cs (1)

441-441: API reference updated correctly

The change from PluginManager.API.SaveAppAllSettings to App.API.SaveAppAllSettings maintains the same functionality while helping to prevent the API instance from being created twice by centralizing API access through the App class.

Flow.Launcher/ViewModel/MainViewModel.cs (1)

445-445: API reference updated correctly

The change from PluginManager.API.OpenUrl to App.API.OpenUrl maintains the same functionality while consolidating API access through the App class, which helps address the issue of API instance being created twice.

Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (2)

79-79: API reference updated correctly

The change from PluginManager.API.OpenDirectory to App.API.OpenDirectory is consistent with the other changes in this PR, centralizing API access through the App class.

---

87-87: API reference updated correctly

The change from PluginManager.API.OpenDirectory to App.API.OpenDirectory is consistent with the goal of making PluginManager.API private and preventing the API instance from being created twice.

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

32-34: Well implemented lazy initialization pattern!

This change properly addresses the issue of API instances being created twice by:

1. Adding a private static field api that holds the instance
2. Implementing lazy initialization in the property getter using the null-coalescing assignment operator
3. Making the API property private to enforce proper encapsulation

This approach ensures the API is instantiated only once when first accessed.

Flow.Launcher/ViewModel/PluginViewModel.cs (3)

137-137: Correctly updated API reference.

The change from PluginManager.API to App.API is consistent with the refactoring to centralize API access through the App class.

---

143-143: Correctly updated API reference.

The change from PluginManager.API to App.API is consistent with the refactoring to centralize API access through the App class.

---

149-150: Correctly updated API references.

Both API calls have been properly updated from PluginManager.API to App.API, maintaining functionality while improving architectural consistency.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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]

@taooceros I have targeted the source of this issue and now it works fine for me.

[taooceros]

looks cool! wonderful

i will review it once i get to computer

[taooceros]

Ideally we should also make PluginManager as a Singleton, but let's keep it like this for now as that might take quite a few work.