feat: get proved path query benchmarks

[pauldelucia]

Issue being fixed or feature implemented

Benchmarks for get_proved_path_query

What was done?

Add benchmark file

How Has This Been Tested?

N/A

Breaking Changes

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have made corresponding changes to the documentation

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

Summary by CodeRabbit

• New Features

  • Introduced a new benchmark suite for proof generation, allowing performance measurement of single-item and full-leaf proofs at various tree depths.

• Refactor

  • Updated the insertion benchmark to use a direct version reference and a new random key generation method.

• Chores

  • Removed the license header from the insertion benchmark file.
  • Added configuration for the new proof generation benchmark.

[coderabbitai]

Walkthrough

A new benchmark suite for proof generation in GroveDB has been introduced, with corresponding configuration added to Cargo.toml. The insertion benchmark file was updated to use a different random number generator and versioning method, and its license header was removed. No changes to public APIs or control flow were made outside of the new benchmarks.

Changes

File(s)	Change Summary
grovedb/Cargo.toml	Added a new benchmark configuration for "proof_generation_benchmark" under the [[bench]] section with harness = false.
grovedb/benches/insertion_benchmark.rs	Removed MIT license header, replaced grove_version with direct GroveVersion default calls, and updated random key generation.
grovedb/benches/proof_generation_benchmark.rs	Introduced a new benchmark suite for proof generation using Criterion, with helpers for database setup and multiple benchmark cases.

Sequence Diagram(s)

sequenceDiagram
    participant Criterion
    participant Benchmark
    participant GroveDb

    Criterion->>Benchmark: Run single_item_proof or full_leaf_proof
    Benchmark->>GroveDb: setup_db (create nested subtrees, insert items)
    Benchmark->>GroveDb: Generate proof (single key or range query)
    GroveDb-->>Benchmark: Return proof
    Benchmark-->>Criterion: Report benchmark result

Loading

Suggested reviewers

• fominok

Poem

In the burrow where the code does grow,
New benchmarks sprout and numbers flow.
Proofs are timed, and leaves are deep,
While rabbits dream of data they keep.
With every hop, the tests expand—
GroveDB’s speed, now finely planned!
🐇✨

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 221ca6e and 04bd88d.

📒 Files selected for processing (3)

• grovedb/Cargo.toml (1 hunks)
• grovedb/benches/insertion_benchmark.rs (13 hunks)
• grovedb/benches/proof_generation_benchmark.rs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

grovedb/benches/proof_generation_benchmark.rs (3)

grovedb/src/operations/get/query.rs (1)

• query (241-281)

grovedb/src/lib.rs (1)

• open (272-275)

grovedb/src/element/constructor.rs (2)

• empty_tree (17-19)
• new_item (77-79)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Compilation errors
• GitHub Check: Linting
• GitHub Check: Tests
• GitHub Check: Code Coverage

🔇 Additional comments (8)

grovedb/Cargo.toml (1)

52-54: LGTM! Benchmark configuration added for proof generation.

The new benchmark configuration is correctly set up with harness = false to match the existing pattern.

grovedb/benches/insertion_benchmark.rs (2)

32-32: LGTM! Consistent versioning approach applied.

All instances of version handling have been standardized to use direct calls to GroveVersion::default(), which improves consistency.

Also applies to: 47-47, 69-69, 85-85, 111-111, 137-137, 179-179, 202-202, 221-221

---

36-36: Updated random number generation with preferred method.

The random key generation has been consistently updated to use rand::rng().random() instead of thread_rng().gen(), providing better uniformity across the benchmarks.

Also applies to: 73-73, 100-100, 125-125, 154-154, 168-168, 195-195, 209-209

grovedb/benches/proof_generation_benchmark.rs (5)

1-17: Good benchmarking setup with appropriate imports.

The imports are well-organized and properly wrapped with feature flags, consistent with the existing benchmarking code.

---

21-55: Well-structured benchmark for single-item proofs.

The benchmark properly tests proof generation at various tree depths (0, 5, 10), creating a fresh database for each sample to ensure accurate measurements.

---

57-88: Comprehensive benchmark for full-leaf proofs.

The benchmark effectively tests the generation of proofs for range queries spanning the entire key space of a subtree with approximately 10,000 items. The range query from "\x00" to "\xFF" ensures complete coverage.

---

90-136: Well-implemented setup helper function.

The setup_db function efficiently creates the test environment with the following advantages:

• Uses a deterministic RNG with a fixed seed (42) for reproducible results
• Creates the requested depth of nested subtrees
• Populates with exactly N_KEYS items
• Returns all necessary data for the benchmark functions

---

138-141: Correctly configured criterion benchmark group.

The benchmark group is properly set up with both benchmark functions and conditionally compiled under the "minimal" feature.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.