perf(encoding): speed up EncodeVarint with io.ByteWriter+hand rolled varintEncode

[odeke-em]

This change speeds up EncodeVarint by testing if the input writer implements io.ByteWriter and if so, goes to use our hand-rolled varint encoder, instead of using the awkward standard libary encoding/binary.PutVarint that requires a byteslice, which we also retrofitted using a bytearray pool.
While here, added parity tests to ensure that we get the exact same results as with the Go standard library's encoding/binary package with caution from https://cyber.orijtech.com/advisory/varint-decode-limitless and also added benchmarks whose results reflect the change in just the benchmark initially

$ benchstat before.txt after.txt
name            old time/op    new time/op    delta
EncodeVarint-8     360ns ± 3%     245ns ± 3%  -31.80%  (p=0.000 n=10+10)

name            old alloc/op   new alloc/op   delta
EncodeVarint-8     0.00B          0.00B          ~     (all equal)

name            old allocs/op  new allocs/op  delta
EncodeVarint-8      0.00           0.00          ~     (all equal)

Fixes #891

[coderabbitai]

Walkthrough

The overall change focuses on optimizing the encoding of variable integers by introducing a more efficient handling mechanism when writing to io.Writer interfaces in Go. It specifically improves the EncodeVarint function to check for io.ByteWriter implementation, minimizing overhead in scenarios where direct byte writing is possible. Additionally, it addresses performance concerns in encoding processes, particularly in contexts like IAVL node byte writing, by streamlining the varint encoding to reduce unnecessary memory operations.

Changes

Files	Change Summary
internal/encoding/bench_test.go	Introduces benchmarking for varint encoding using binary encoding.
internal/encoding/encoding.go	Optimizes EncodeVarint to check for io.ByteWriter and uses fVarintEncode for efficient varint encoding. Keeps EncodeVarintSize unchanged.

Assessment against linked issues

Objective	Addressed	Explanation
Change IAVL node.writeBytes to take in bytes.Buffer (#891)	❌	The changes focus on optimizing varint encoding but do not directly modify IAVL node.writeBytes to use bytes.Buffer. The objective of removing buffer pools overhead in node.WriteBytes by directly using bytes.Buffer.WriteByte is not addressed in the provided changes.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[odeke-em]

Kindly cc-ing @ValarDragon

[ValarDragon]

Ah amazing, nice job!

[tac0turtle]

@Mergifyio backport release/v1.x

[mergify]

backport release/v1.x

❌ No backport have been created

• Backport to branch release/v1.x failed

GitHub error: Branch not found

[tac0turtle]

@Mergifyio backport release/v1.1.x

[tac0turtle]

@Mergifyio backport release/v1.x.x

[mergify]

backport release/v1.1.x

✅ Backports have been created

• #918 perf(encoding): speed up EncodeVarint with io.ByteWriter+hand rolled varintEncode (backport #917) has been created for branch release/v1.1.x

[mergify]

backport release/v1.x.x

✅ Backports have been created

• #919 perf(encoding): speed up EncodeVarint with io.ByteWriter+hand rolled varintEncode (backport #917) has been created for branch release/v1.x.x

[odeke-em]

Thanks for the reviews Dev & Marko!