-
Notifications
You must be signed in to change notification settings - Fork 171
Add configurable Max query time range limit #9386
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
nishantmonu51
wants to merge
7
commits into
main
Choose a base branch
from
Nishant-Bangarwa/dashboard-max-time-range
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
803b1e4
Add configurable Max query time range limit
nishantmonu51 93406c5
Fix prettier
nishantmonu51 9e9ecf2
Handle review comments
nishantmonu51 2f7da00
Fix CI
nishantmonu51 8cbb9c6
add file
nishantmonu51 4ab2918
Fix lint
nishantmonu51 f960408
Handle review comments
nishantmonu51 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 51 additions & 10 deletions
61
runtime/metricsview/executor/executor_enforce_query_limits.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,71 @@ | ||
| package executor | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/rilldata/rill/runtime/metricsview" | ||
| "github.com/rilldata/rill/runtime/pkg/duration" | ||
| ) | ||
|
|
||
| // enforceQueryLimits checks that the query adheres to any limits specified in the QueryLimits. This should be called after time_range is resolved. | ||
| // enforceQueryLimits checks that the query adheres to any limits specified in the QueryLimits or on the metrics view spec. | ||
| // This should be called after time_range is resolved. | ||
| func (e *Executor) enforceQueryLimits(qry *metricsview.Query) error { | ||
| if qry.QueryLimits == nil { | ||
| return nil | ||
| if qry.QueryLimits != nil && qry.QueryLimits.RequireTimeRange && (qry.TimeRange == nil || qry.TimeRange.IsZero()) { | ||
| return fmt.Errorf("a valid time_range should be specified for the query") | ||
| } | ||
|
|
||
| if qry.QueryLimits.RequireTimeRange && (qry.TimeRange == nil || qry.TimeRange.IsZero()) { | ||
| return fmt.Errorf("a valid time_range should be specified for the query") | ||
| if qry.TimeRange == nil || qry.TimeRange.IsZero() { | ||
| return nil | ||
| } | ||
|
|
||
| // if require_time_range not set and time range is not specified, we skip the max time range check | ||
| if qry.QueryLimits.MaxTimeRangeDays <= 0 || qry.TimeRange == nil || qry.TimeRange.IsZero() { | ||
| maxRange, errMsg := e.maxTimeRange(qry) | ||
| if maxRange <= 0 { | ||
| return nil | ||
| } | ||
|
|
||
| days := qry.TimeRange.End.Sub(qry.TimeRange.Start).Hours() / 24 | ||
| if days > float64(qry.QueryLimits.MaxTimeRangeDays) { | ||
| return fmt.Errorf("time range for query cannot exceed %d days, this can be adjusted using rill.ai.max_time_range_days env var", qry.QueryLimits.MaxTimeRangeDays) | ||
| if err := checkTimeRangeWithinCap(qry.TimeRange, maxRange, errMsg); err != nil { | ||
| return err | ||
| } | ||
| if qry.ComparisonTimeRange != nil && !qry.ComparisonTimeRange.IsZero() { | ||
| if err := checkTimeRangeWithinCap(qry.ComparisonTimeRange, maxRange, errMsg); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // maxTimeRange returns the effective cap on the query's time range and a pre-formatted error message | ||
| // describing where the cap was configured. Returns 0 if no cap applies. | ||
| // | ||
| // An explicit caller-provided QueryLimits.MaxTimeRangeDays takes precedence over the metrics view's | ||
| // max_query_time_range spec property — this matters for the AI tool path which tightens the cap via | ||
| // the rill.ai.max_time_range_days env var. | ||
| func (e *Executor) maxTimeRange(qry *metricsview.Query) (time.Duration, string) { | ||
| if qry.QueryLimits != nil && qry.QueryLimits.MaxTimeRangeDays > 0 { | ||
| days := qry.QueryLimits.MaxTimeRangeDays | ||
| return time.Duration(days) * 24 * time.Hour, | ||
| fmt.Sprintf("time range for query cannot exceed %d days, configured via the rill.ai.max_time_range_days env var", days) | ||
| } | ||
| if e.metricsView != nil && e.metricsView.MaxQueryTimeRange != "" { | ||
| d, err := duration.ParseISO8601(e.metricsView.MaxQueryTimeRange) | ||
|
AdityaHegde marked this conversation as resolved.
Outdated
|
||
| if err != nil { | ||
| return 0, "" | ||
| } | ||
| native, ok := d.EstimateNative() | ||
| if !ok || native <= 0 { | ||
| return 0, "" | ||
| } | ||
| return native, | ||
| fmt.Sprintf("time range for query cannot exceed %s, configured via the metrics view's max_query_time_range property", e.metricsView.MaxQueryTimeRange) | ||
| } | ||
| return 0, "" | ||
| } | ||
|
|
||
| func checkTimeRangeWithinCap(tr *metricsview.TimeRange, maxRange time.Duration, errMsg string) error { | ||
| if tr.End.Sub(tr.Start) > maxRange { | ||
| return errors.New(errMsg) | ||
| } | ||
| return nil | ||
| } | ||
113 changes: 113 additions & 0 deletions
113
runtime/metricsview/executor/executor_enforce_query_limits_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package executor | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| runtimev1 "github.com/rilldata/rill/proto/gen/rill/runtime/v1" | ||
| "github.com/rilldata/rill/runtime/metricsview" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestEnforceQueryLimits(t *testing.T) { | ||
| tr := func(days int) *metricsview.TimeRange { | ||
| end := time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC) | ||
| return &metricsview.TimeRange{ | ||
| Start: end.AddDate(0, 0, -days), | ||
| End: end, | ||
| } | ||
| } | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| spec string | ||
| callerCap int64 | ||
| query *metricsview.Query | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "no spec, no caller cap — passes", | ||
| query: &metricsview.Query{TimeRange: tr(365)}, | ||
| }, | ||
| { | ||
| name: "spec cap with range under cap — passes", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{TimeRange: tr(7)}, | ||
| }, | ||
| { | ||
| name: "spec cap exceeded — fails", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{TimeRange: tr(60)}, | ||
| wantErr: "max_query_time_range", | ||
| }, | ||
| { | ||
| name: "caller cap tighter than spec — caller wins", | ||
| spec: "P90D", | ||
| callerCap: 30, | ||
| query: &metricsview.Query{TimeRange: tr(60)}, | ||
| wantErr: "rill.ai.max_time_range_days", | ||
| }, | ||
| { | ||
| name: "caller cap with range under cap — passes", | ||
| spec: "", | ||
| callerCap: 30, | ||
| query: &metricsview.Query{TimeRange: tr(7)}, | ||
| }, | ||
| { | ||
| name: "spec cap exceeded by comparison range — fails", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{TimeRange: tr(7), ComparisonTimeRange: tr(60)}, | ||
| wantErr: "max_query_time_range", | ||
| }, | ||
| { | ||
| name: "spec cap exceeded by primary, comparison fits — fails", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{TimeRange: tr(60), ComparisonTimeRange: tr(7)}, | ||
| wantErr: "max_query_time_range", | ||
| }, | ||
| { | ||
| name: "spec set but no time range on query — passes", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{}, | ||
| }, | ||
| { | ||
| name: "require_time_range without time range — fails", | ||
| query: &metricsview.Query{QueryLimits: &metricsview.QueryLimits{ | ||
| RequireTimeRange: true, | ||
| }}, | ||
| wantErr: "valid time_range", | ||
| }, | ||
| { | ||
| name: "calendar duration P1M ≈ 30 days — 31-day range exceeds", | ||
| spec: "P1M", | ||
| query: &metricsview.Query{TimeRange: tr(31)}, | ||
| wantErr: "max_query_time_range", | ||
| }, | ||
| { | ||
| name: "spec error message names the property", | ||
| spec: "P30D", | ||
| query: &metricsview.Query{TimeRange: tr(60)}, | ||
| wantErr: "configured via the metrics view's max_query_time_range property", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| e := &Executor{metricsView: &runtimev1.MetricsViewSpec{MaxQueryTimeRange: tt.spec}} | ||
| q := tt.query | ||
| if tt.callerCap > 0 { | ||
| if q.QueryLimits == nil { | ||
| q.QueryLimits = &metricsview.QueryLimits{} | ||
| } | ||
| q.QueryLimits.MaxTimeRangeDays = tt.callerCap | ||
| } | ||
| err := e.enforceQueryLimits(q) | ||
| if tt.wantErr == "" { | ||
| require.NoError(t, err) | ||
| return | ||
| } | ||
| require.Error(t, err) | ||
| require.Contains(t, err.Error(), tt.wantErr) | ||
| }) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.