validate group and sort by

[iuwqyir]

TL;DR

Added field validation for GroupBy and SortBy parameters in API requests to prevent invalid queries.

What changed?

• Created a new field validation system that validates GroupBy and SortBy fields against allowed columns for each entity type
• Added EntityColumns map that defines valid columns for blocks, transactions, logs, transfers, balances, and traces
• Implemented ValidateGroupByAndSortBy function to check if fields are valid entity columns or aggregate function aliases
• Added support for extracting and validating aggregate function aliases (e.g., "COUNT(*) AS count")
• Integrated validation into all handler functions (blocks, transactions, logs, transfers, token balances)
• Added comprehensive test suite for the validation functionality

How to test?

1. Test valid requests with proper GroupBy and SortBy fields:

   GET /api/v1/blocks?group_by=block_number&sort_by=block_timestamp
   

2. Test invalid requests with improper fields to verify error handling:

   GET /api/v1/blocks?group_by=invalid_field
   

   Should return a 400 Bad Request with a descriptive error message

3. Test requests with aggregate functions and aliases:

   GET /api/v1/transactions?group_by=from_address&aggregates=SUM(value) AS total_value&sort_by=total_value
   

Why make this change?

This validation prevents users from submitting queries with invalid fields, which could lead to SQL errors or unexpected behavior. By validating input parameters early in the request lifecycle, we can provide clear error messages to API consumers and prevent potential security issues from malformed queries. The validation also supports aggregate function aliases, making the API more flexible for analytical queries.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 07-30-validate_group_and_sort_by

---

🪧 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 generate unit tests to generate unit tests 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.

[iuwqyir]

• validate group and sort by #254 👈 (View in Graphite)
• improve start block determination for poller #253
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.