refactor: small clenaups in helper funcs by cristaloleg · Pull Request #289 · celestiaorg/nmt

cristaloleg · 2025-02-26T10:12:08Z

Micro PR that I did before and forget to push. Use min and max builtin funcs instead of own implementations.

Summary by CodeRabbit

These updates focus on internal code quality improvements that enhance maintainability and clarity without changing user-visible functionality:

Refactor
- Streamlined internal logic by removing redundant comparison functions and adopting more concise coding patterns.
Tests
- Updated test routines to reflect improved naming conventions and ensure consistency.
Chores
- Simplified numerical operations and removed unnecessary type conversions for more robust code maintenance.

coderabbitai · 2025-02-26T10:12:16Z

Walkthrough

This pull request streamlines the code by removing and renaming redundant helper functions for comparing byte slices. In particular, the max and min functions have been removed from hasher.go and replaced by updated implementations elsewhere, while corresponding test functions in hasher_test.go and proof_test.go now use maxNs/minNs and min, respectively. Additionally, tuple assignments have replaced temporary variables for swapping in tests, and an unnecessary type cast in subdivide has been removed. All changes maintain the existing core functionalities.

Changes

File(s)	Summary
`hasher.go`, `proof.go`	Removed unused helper functions (`max`, `min`, `minInt`) and replaced `minInt` usage with an updated `min` function without affecting core logic.
`hasher_test.go`, `proof_test.go`	Updated tests by renaming functions (`max`/`min` → `maxNs`/`min`) and refactoring swap implementations to use tuple assignment for conciseness.
`nmt_test.go`, `subrootpaths.go`	Simplified code: replaced a temporary variable with a tuple assignment in swap functions and removed an unnecessary type cast in the `subdivide` function.

Possibly related PRs

fix: reduce calls to MinNamespace & MaxNamespace #285: Optimizes min and max functions in the nmt module for handling byte slice comparisons, aligning with the refactoring of similar functions in this PR.

Suggested labels

enhancement

Suggested reviewers

rootulp

Poem

I'm but a rabbit, swift and keen,
Hoping over code so clean.
Functions gone, renamed with flair,
Swaps and casts light as air.
I nibble on these changes with delight,
Leaping forward in code, day and night!
🥕🐇

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

📜 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 a336f12 and 3b6dbf5.

📒 Files selected for processing (6)

hasher.go (0 hunks)
hasher_test.go (3 hunks)
nmt_test.go (1 hunks)
proof.go (1 hunks)
proof_test.go (2 hunks)
subrootpaths.go (1 hunks)

💤 Files with no reviewable changes (1)

hasher.go

✅ Files skipped from review due to trivial changes (3)

subrootpaths.go
nmt_test.go
proof_test.go

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

GitHub Check: markdown-lint
GitHub Check: Analyze (go)

🔇 Additional comments (4)

proof.go (1)

635-635: Good refactoring to use built-in min function

The change replaces the custom minInt function with the built-in min function, which simplifies the code and leverages the Go standard library.

hasher_test.go (3)

752-752: Renamed max to maxNs for better clarity

The function call has been renamed to better reflect that it's specifically for namespace byte comparison.

787-787: Renamed min to minNs for better clarity

The function call has been renamed to better reflect that it's specifically for namespace byte comparison.

930-942: Added specialized namespace comparison functions

These new functions replace the generic ones that were likely in hasher.go. The implementation properly captures the namespace-specific comparison logic using bytes.Compare.

The function names now clearly indicate their purpose is for namespace comparison.

✨ Finishing Touches

📝 Generate Docstrings

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.
@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.

cristaloleg · 2025-02-26T10:12:29Z

subrootpaths.go

 func subdivide(idxStart uint, width uint) []int {
 	var path []int
-	pathlen := int(bits.Len(width) - 1)
+	pathlen := bits.Len(width) - 1


Already an int.

rootulp

LGTM. Thanks!

chore: small clenaups in helper funcs

3b6dbf5

cristaloleg commented Feb 26, 2025

View reviewed changes

rootulp assigned cristaloleg Feb 26, 2025

rootulp changed the title ~~chore: small clenaups in helper funcs~~ refactor: small clenaups in helper funcs Feb 26, 2025

rootulp approved these changes Feb 26, 2025

View reviewed changes

cristaloleg enabled auto-merge (squash) February 26, 2025 14:43

vgonkivs approved these changes Feb 26, 2025

View reviewed changes

cristaloleg merged commit ca7cd2f into main Feb 26, 2025
8 checks passed

cristaloleg deleted the chore/cleanups branch February 26, 2025 15:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: small clenaups in helper funcs#289

refactor: small clenaups in helper funcs#289
cristaloleg merged 1 commit intomainfrom
chore/cleanups

cristaloleg commented Feb 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 26, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

cristaloleg Feb 26, 2025

Uh oh!

rootulp left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

cristaloleg commented Feb 26, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

cristaloleg Feb 26, 2025

Choose a reason for hiding this comment

Uh oh!

rootulp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cristaloleg commented Feb 26, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)