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

perf: use strings.Builder #1571

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

YESUNFEI
Copy link

@YESUNFEI YESUNFEI commented Dec 11, 2024

In the ConvertBigIntArrayToString function, the big.Int is first converted to a string and then concatenated with commas. This can be optimized using strings.Builder, which avoids creating new string objects on each concatenation. The performance advantage is particularly significant when dealing with larger arrays.

Purpose or design rationale of this PR

Describe your change. Make sure to answer these three questions: What does this PR do? Why does it do it? How does it do it?

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling with more descriptive messages for transaction data unpacking and calldata decoding.
  • Performance Improvements

    • Optimized string concatenation process for better memory allocation and performance.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request focus on modifications to the utils.go file in the bridge-history-api/internal/utils package. Key updates include the optimization of the ConvertBigIntArrayToString function by replacing a slice of strings with a strings.Builder for more efficient string concatenation. Additionally, the error handling in the GetBatchRangeFromCalldata function has been improved with more descriptive error messages, enhancing clarity during failures. Overall, the control flow remains unchanged, with no new functions added or removed.

Changes

File Path Change Summary
bridge-history-api/internal/utils/utils.go - Optimized ConvertBigIntArrayToString function using strings.Builder for better performance.
- Enhanced error handling in GetBatchRangeFromCalldata with more descriptive error messages.

Poem

In the code where rabbits hop,
Strings now build and never stop.
Errors clearer, paths defined,
A smoother run for all aligned.
With each change, we celebrate,
Efficiency is truly great! 🐇✨


📜 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 c82031c and 7469608.

📒 Files selected for processing (1)
  • bridge-history-api/internal/utils/utils.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • bridge-history-api/internal/utils/utils.go

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. (Experiment)
  • @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

@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: 0

🧹 Outside diff range and nitpick comments (1)
bridge-history-api/internal/utils/utils.go (1)

175-182: Consider preallocating builder capacity for large arrays

While the current implementation is good, for very large arrays, you could further optimize by preallocating the builder's capacity.

Here's a suggested enhancement:

 func ConvertBigIntArrayToString(array []*big.Int) string {
 	var sb strings.Builder
+	// Preallocate capacity (assuming ~20 chars per number plus separator)
+	sb.Grow(len(array) * 22)
 	for i, num := range array {
 		if i > 0 {
 			sb.WriteString(", ")
 		}
 		sb.WriteString(num.String())
 	}
 	return sb.String()
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06beb5d and 97688ef.

📒 Files selected for processing (1)
  • bridge-history-api/internal/utils/utils.go (1 hunks)
🔇 Additional comments (1)
bridge-history-api/internal/utils/utils.go (1)

175-182: LGTM! Efficient use of strings.Builder

The optimization from string concatenation to strings.Builder is a good improvement that reduces memory allocations and improves performance.

Copy link

@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: 0

🧹 Outside diff range and nitpick comments (1)
bridge-history-api/internal/utils/utils.go (1)

175-184: LGTM! Efficient implementation using strings.Builder

The optimization using strings.Builder with preallocated capacity is a good performance improvement over string concatenation. The implementation correctly handles all edge cases and uses the appropriate methods.

Consider making the capacity calculation more precise:

-        sb.Grow(len(array) * 22)
+        // Preallocate capacity: 20 chars per number + 2 chars for ", " separator
+        sb.Grow(len(array) * 20 + (len(array) - 1) * 2)

This adjustment:

  • Allocates exactly 20 chars per number
  • Accounts for separators only between numbers (len-1 times)
  • Provides a more accurate capacity estimation
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 97688ef and c82031c.

📒 Files selected for processing (1)
  • bridge-history-api/internal/utils/utils.go (1 hunks)

@@ -172,13 +172,16 @@ func GetBlocksInRange(ctx context.Context, cli *ethclient.Client, start, end uin

// ConvertBigIntArrayToString convert the big int array to string
func ConvertBigIntArrayToString(array []*big.Int) string {
Copy link
Member

Choose a reason for hiding this comment

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

can you add unit test for your changes?

Copy link
Author

Choose a reason for hiding this comment

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

I only modified the internal structure of the function and ran the TestConvertBigIntArrayToString test. The result passed successfully.

@YESUNFEI YESUNFEI changed the title fix: use strings.Builder perf: use strings.Builder Dec 12, 2024
In the ConvertBigIntArrayToString function, the big.Int is first converted to a string and then concatenated with commas. This can be optimized using strings.Builder, which avoids creating new string objects on each concatenation. The performance advantage is particularly significant when dealing with larger arrays.
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.

2 participants