BE-664 | Add denoms filter for /pools endpoint

[deividaspetraitis]

Introduces a denoms filter for /pools endpoint allowing to filter pools by given list of denoms

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced filtering capability for pool requests based on multiple denominations.
  • Added a new function for configuring pool options with a denom filter.

• Enhancements

  • Updated request structures to support new filtering parameters and enforce limits on denomination counts.

• Bug Fixes

  • Improved handling of query parameters to maintain backward compatibility with deprecated options.

These changes enhance the usability of pool requests, allowing for more precise data retrieval based on user-defined criteria.

[sonarqubecloud]

Quality Gate failed

Failed conditions
31.6% Coverage on New Code (required ≥ 50%)
18.2% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

[deividaspetraitis]

sonarcloud is complaining regarding generated file: pkg/api/v1beta1/pools/pools.pb.go

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="The linter 'exportloopref' is deprecated (since v1.60.2) due to: Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar."

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on enhancing the handling of protocol buffers and filtering capabilities for pool requests. Key modifications include the addition of a new Makefile for protocol buffer management, the introduction of a WithDenom function in the domain/pools.go, and updates to the GetPoolsRequestFilter in http.go and pools.proto to support filtering by denominations. The GetPools method in pools_usecase.go is also enhanced to incorporate this new filtering logic.

Changes

File	Change Summary
Makefile	- Added inclusion of proto.mk file. - Removed obsolete target -proto-gen:.
domain/pools.go	- Added new function WithDenom(denom []string) PoolsOption.
pkg/api/v1beta1/pools/http.go	- Added constant maxDenoms. - Added query parameter queryFilterDenom. - Updated UnmarshalHTTPRequest to handle the new parameter.
pools/usecase/pools_usecase.go	- Enhanced GetPools method with new filtering capability for pool denoms.
proto/sqs/pools/v1beta1/pools.proto	- Added new field repeated string denom = 7; in GetPoolsRequestFilter. - Moved search field to position 8.

Possibly related PRs

• BE-636 | Add pagination + sorting + query filtering support for /pools endpoint #553: Enhances the /pools endpoint with pagination, sorting, and query filtering, directly related to the changes in the main PR.
• BE-636-api | .proto and related generated files for pools endpoint #575: Introduces Protocol Buffers definitions for the /pools endpoint, aligning with changes in the main PR regarding protocol buffer management.
• BE-636-backwards-compatibility | Backwards compatibility support #582: Adds backwards compatibility support for the /pools endpoint, relevant to the changes ensuring existing functionalities remain intact.
• BE-636-get-incentive | Pool Incentive helper method #576: Introduces a helper method for pool incentives, which is part of the broader functionality being enhanced in the /pools endpoint, connecting it to the changes in the main PR regarding protocol buffer handling.
• BE-636 | Fix search bug #584: Fixes a search bug related to the /pools endpoint, connected to the changes in the main PR.

Suggested reviewers

• cryptomatictrader
• PaddyMc
• p0mvn

🐰 In the meadow, changes bloom,
New filters sprout, dispelling gloom.
With denoms now, we seek and find,
A world of pools, all intertwined.
Protocols dance, in files they play,
Hopping forward, we build today! 🌼

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 60ba6b3 and 0f6d1d2.

⛔ Files ignored due to path filters (3)

• pkg/api/v1beta1/pools/http_test.go is excluded by !**/*_test.go
• pkg/api/v1beta1/pools/pools.pb.go is excluded by !**/*.pb.go
• pools/usecase/pools_usecase_test.go is excluded by !**/*_test.go

📒 Files selected for processing (5)

• Makefile (1 hunks)
• domain/pools.go (1 hunks)
• pkg/api/v1beta1/pools/http.go (5 hunks)
• pools/usecase/pools_usecase.go (1 hunks)
• proto/sqs/pools/v1beta1/pools.proto (1 hunks)

---

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:

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

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.