Skip to content

feat: add avg, max, min to allowed functions #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

catalyst17
Copy link
Contributor

@catalyst17 catalyst17 commented May 23, 2025

TL;DR

Added support for avg, max, and min functions to the allowed functions map.

What changed?

Added three new entries to the allowedFunctions map in internal/common/utils.go:

  • avg: for calculating averages
  • max: for finding maximum values
  • min: for finding minimum values

These functions join the existing allowed functions like sum, count, reinterpretasuint256, reverse, and unhex.

How to test?

  1. Use these newly added functions in queries or operations where allowed functions are checked
  2. Verify that operations using avg, max, and min now execute successfully
  3. Confirm that the functions perform their expected calculations correctly

Why make this change?

These statistical functions are commonly needed for data analysis and aggregation operations. Adding them to the allowed functions map enables users to perform more sophisticated data processing without requiring custom implementations.

Summary by CodeRabbit

  • New Features
    • Expanded support for additional functions ("countDistinct", "avg", "max", "min") in query validation.

Copy link

coderabbitai bot commented May 23, 2025

Walkthrough

The update expands the set of recognized allowed function names in the query validation logic by adding "countDistinct" along with "avg", "max", and "min" to the allowedFunctions map. No other logic or exported entities are changed.

Changes

File(s) Change Summary
internal/common/utils.go Added "countDistinct", "avg", "max", and "min" to the allowedFunctions map.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QueryValidator

    User->>QueryValidator: Submit query with function (e.g., "countDistinct", "avg", "max", "min")
    QueryValidator->>QueryValidator: Check if function is in allowedFunctions
    alt Function is allowed
        QueryValidator-->>User: Accept query
    else Function not allowed
        QueryValidator-->>User: Reject query
    end
Loading

📜 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 2cc8acf and bf71230.

📒 Files selected for processing (1)
  • internal/common/utils.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • internal/common/utils.go
✨ Finishing Touches
  • 📝 Generate Docstrings

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

Copy link
Contributor Author

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

@catalyst17 catalyst17 requested a review from a team May 23, 2025 18:08
@catalyst17 catalyst17 marked this pull request as ready for review May 23, 2025 18:08
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
internal/common/utils.go (1)

28-30: Correctly included “avg”, “max”, and “min” in allowedFunctions.

The new aggregation functions match the PR objectives and integrate cleanly with the existing validation logic.
Ensure that:

  1. Unit tests for ValidateQuery are updated to cover these three functions.
  2. Any documentation or code comments listing supported functions are updated accordingly.
  3. (Optional) For maintainability, consider alphabetically ordering or logically grouping entries in allowedFunctions.

Would you like me to generate the corresponding test cases and update documentation?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685b9d9 and 2cc8acf.

📒 Files selected for processing (1)
  • internal/common/utils.go (1 hunks)

@catalyst17 catalyst17 marked this pull request as draft May 23, 2025 18:58
@iuwqyir iuwqyir marked this pull request as ready for review May 23, 2025 19:23
@catalyst17 catalyst17 force-pushed the feat_add_avg_max_min_to_allowed_functions branch from 2cc8acf to bf71230 Compare May 23, 2025 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants