berachain / beacon-kit

A modular framework for building EVM consensus clients ⛵️✨
https://berachain.com
Other
82 stars 45 forks source link

perf(bytes): reduces the number of iterations and improves performance. #1633

Closed hoank101 closed 1 week ago

hoank101 commented 1 week ago

Before

pkg: github.com/berachain/beacon-kit/mod/primitives/pkg/hex
BenchmarkDecodeFixedText/Size100-11              4122153               289.8 ns/op
BenchmarkDecodeFixedText/Size1000-11              434762              2772 ns/op
BenchmarkDecodeFixedText/Size10000-11              43886             28172 ns/op

After

pkg: github.com/berachain/beacon-kit/mod/primitives/pkg/hex
BenchmarkDecodeFixedText/Size100-11              5818707               184.6 ns/op
BenchmarkDecodeFixedText/Size1000-11              677403              1756 ns/op
BenchmarkDecodeFixedText/Size10000-11              68588             17629 ns/op

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits Files that changed from the base of the PR and between 24fda66578d4b6feb64f0a26cbd0b3763c18b31a and 2b0534c777a8e01a8159b4877d4e83398f2e8fb8.
Files selected for processing (3) * mod/primitives/pkg/hex/bytes.go (1 hunks) * mod/primitives/pkg/hex/bytes_test.go (2 hunks) * mod/primitives/pkg/hex/const.go (1 hunks)
 ____________________________________________________________________________________________________________________________________________________
< Critically analyze what you read and hear. Don't be swayed by vendors, media hype, or dogma. Analyze information in terms of you and your project. >
 ----------------------------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Walkthrough

The recent changes optimize the DecodeFixedText function in the Go package for better performance by merging syntax verification and decoding into a single pass. Additionally, a new benchmark function, BenchmarkDecodeFixedText, has been introduced to evaluate decoding performance for various input sizes.

Changes

Files Change Summary
mod/primitives/pkg/hex/bytes.go Combined syntax verification and decoding in DecodeFixedText for efficiency and cleaner logic flow.
mod/primitives/pkg/hex/bytes_test.go Introduced BenchmarkDecodeFixedText to measure performance of DecodeFixedText with different inputs.

Poem

In bytes and nibbles, we do dance,
With code refined in one swift chance.
Across the fields of hex we stride,
Efficiency, our trusted guide.
Let's measure now, with tests so bright,
As coderabbits leap in the night.
🐰卩↋≏≌∱⹁𓃰✨


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.