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

PoParser PERF #15943

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

PoParser PERF #15943

wants to merge 4 commits into from

Conversation

hishamco
Copy link
Member

@hishamco hishamco commented May 2, 2024

Related to Seb comments in ##15886

Summary by CodeRabbit

  • New Features
    • Improved text processing for localization features.
  • Refactor
    • Enhanced parsing capabilities in localization tools for better performance and reliability.

@hishamco hishamco requested a review from sebastienros May 2, 2024 05:23
Copy link
Contributor

coderabbitai bot commented May 2, 2024

Walkthrough

The recent update in the OrchardCore.Localization.Core project involves enhancing performance and optimizing memory usage. The inclusion of the ZString package and modifications in the PoParser class, such as replacing StringBuilder with Utf16ValueStringBuilder and using a FrozenDictionary, are aimed at improving string manipulation and parsing efficiency within the localization functionalities.

Changes

File Path Change Summary
.../Localization.Core.csproj Added ZString package reference.
.../PortableObject/PoParser.cs Replaced System.Text with Cysharp.Text, updated _escapeTranslations to FrozenDictionary, and optimized string handling in Unescape method.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@hishamco
Copy link
Member Author

hishamco commented May 2, 2024

Benchmarks

Before:

Method Mean Error StdDev Gen0 Allocated
ParseSmallPO 5.018 ns 0.1204 ns 0.1433 ns 0.0057 72 B
ParseLongPO 4.711 ns 0.1089 ns 0.1018 ns 0.0057 72 B

After:

Method Mean Error StdDev Gen0 Allocated
ParseSmallPO 4.817 ns 0.1188 ns 0.1167 ns 0.0057 72 B
ParseLongPO 4.639 ns 0.0736 ns 0.0689 ns 0.0057 72 B

The allocation is quite similar but there's some improvement after this PR

@hishamco
Copy link
Member Author

hishamco commented May 2, 2024

Something strange here, 3 unit tests broken, I will check again

@@ -55,31 +61,32 @@ public IEnumerable<CultureDictionaryRecord> Parse(TextReader reader)

private static string Unescape(string str)
{
StringBuilder sb = null;
var builder = default(Utf16ValueStringBuilder);
Copy link
Member

Choose a reason for hiding this comment

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

I would just check for \ in the input string. (IndexOf is fast, it's vectorized). If not return the string. Otherwise create the ZString, check the other usages in Orchard, it needs to be disposed.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure why we need to check? BTW the disposing in my mind after the tests pass

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.

None yet

2 participants