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

Use System.Text.Json to replace Newtonsoft.Json for better performance #3174

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

Jack251970
Copy link
Contributor

Use System.Text.Json to replace Newtonsoft.Json for better performance & Improve code quality

This comment has been minimized.

Copy link

gitstream-cm bot commented Jan 9, 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 Jan 9, 2025

📝 Walkthrough

Walkthrough

The pull request introduces changes to the Utilities.cs file in the Flow Launcher Plugin Manager, specifically updating the JSON serialization approach. The modification replaces the Newtonsoft.Json library with System.Text.Json for deserializing plugin information from a ZIP file. This change represents a migration from one JSON processing library to another while preserving the existing functionality of the plugin information retrieval method.

Changes

File Change Summary
Plugins/Flow.Launcher.Plugin.PluginsManager/Utilities.cs - Replaced Newtonsoft.Json with System.Text.Json
- Updated JSON deserialization method from JsonConvert.DeserializeObject to JsonSerializer.Deserialize
- Simplified resource management by using a using declaration for the stream

Poem

🐰 A rabbit's JSON tale unfolds,
Libraries change, but code still holds.
Newtonsoft bows, System steps in light,
Serialization dances with delight.
Flow Launcher plugins, smooth and neat! 🔧


📜 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 ad02700 and 95b4c4c.

📒 Files selected for processing (1)
  • Plugins/Flow.Launcher.Plugin.PluginsManager/Utilities.cs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Plugins/Flow.Launcher.Plugin.PluginsManager/Utilities.cs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • 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: 1

🧹 Nitpick comments (1)
Plugins/Flow.Launcher.Plugin.PluginsManager/Utilities.cs (1)

74-77: Consider async/await for better performance

For better scalability and performance, consider making the method async:

-internal static UserPlugin GetPluginInfoFromZip(string filePath)
+internal static async Task<UserPlugin> GetPluginInfoFromZipAsync(string filePath)
{
    var plugin = null as UserPlugin;

-    using (ZipArchive archive = System.IO.Compression.ZipFile.OpenRead(filePath))
+    using (ZipArchive archive = await Task.Run(() => System.IO.Compression.ZipFile.OpenRead(filePath)))
    {
        var pluginJsonPath = archive.Entries.FirstOrDefault(x => x.Name == "plugin.json").ToString();
        ZipArchiveEntry pluginJsonEntry = archive.GetEntry(pluginJsonPath);

        if (pluginJsonEntry != null)
        {
-            using StreamReader reader = new StreamReader(pluginJsonEntry.Open());
-            string pluginJsonContent = reader.ReadToEnd();
-            plugin = JsonSerializer.Deserialize<UserPlugin>(pluginJsonContent);
+            using var stream = pluginJsonEntry.Open();
+            plugin = await JsonSerializer.DeserializeAsync<UserPlugin>(stream, options);
             plugin.IcoPath = "Images\\zipfolder.png";
        }
    }

    return plugin;
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7cccbb0 and ad02700.

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

6-6: LGTM!

Appropriate addition of the System.Text.Json namespace.


74-77: 🛠️ Refactor suggestion

Configure JsonSerializer options for compatibility with Newtonsoft.Json

While the migration to System.Text.Json is good for performance, it handles certain scenarios differently from Newtonsoft.Json. To ensure compatibility, consider adding serialization options.

-    plugin = JsonSerializer.Deserialize<UserPlugin>(pluginJsonContent);
+    var options = new JsonSerializerOptions
+    {
+        PropertyNameCaseInsensitive = true,
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+        AllowTrailingCommas = true
+    };
+    plugin = JsonSerializer.Deserialize<UserPlugin>(pluginJsonContent, options);

Let's verify if there are any specific JSON property naming conventions in existing plugin.json files:

Plugins/Flow.Launcher.Plugin.PluginsManager/Utilities.cs Outdated Show resolved Hide resolved
}
using StreamReader reader = new StreamReader(pluginJsonEntry.Open());
string pluginJsonContent = reader.ReadToEnd();
plugin = JsonSerializer.Deserialize<UserPlugin>(pluginJsonContent);
Copy link
Member

Choose a reason for hiding this comment

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

I remember there's an overload for stream directly so we don't need to read it as string before deserializing it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, please check.

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 Jack251970 requested a review from taooceros January 10, 2025 05:35
@taooceros taooceros merged commit 5f4d24a into Flow-Launcher:dev Jan 10, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants