Check validity of consolidation function in sortBy #102
Conversation
This file contains 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 comment has been minimized.
This comment has been minimized.
|
can you add a regression test for this case? |
carrieedwards
force-pushed
the
cedwards/fix-consolidation-summarizer
branch
from
b6ab967
to
2315796
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
npazosmendez
reviewed
Sep 8, 2022
| @@ -112,6 +112,9 @@ func (f *smartSummarize) Do(ctx context.Context, e parser.Expr, from, until int6 | |||
| } | |||
|
|
|||
| if t >= bucketEnd { | |||
| if err := consolidations.CheckValidConsolidationFunc(summarizeFunction); err != nil { | |||
There was a problem hiding this comment.
I think it's better if we do this only once, and just after the summarizeFunction is obtained, in line 53
| @@ -124,6 +127,9 @@ func (f *smartSummarize) Do(ctx context.Context, e parser.Expr, from, until int6 | |||
|
|
|||
| // last partial bucket | |||
| if bucketItems > 0 { | |||
| if err := consolidations.CheckValidConsolidationFunc(summarizeFunction); err != nil { | |||
| @@ -59,6 +59,9 @@ func (f *legendValue) Do(ctx context.Context, e parser.Expr, from, until int64, | |||
| nameBuf.Grow(len(r.Name) + len(methods)*5) | |||
| nameBuf.WriteString(r.Name) | |||
| for _, method := range methods { | |||
| if err := consolidations.CheckValidConsolidationFunc(method); err != nil { | |||
There was a problem hiding this comment.
nit: we could move this check to line 51 so it's done at the beginning and some of the allocations are avoided
expr/functions/summarize/function.go
Outdated
| @@ -157,6 +160,9 @@ func (f *summarize) Do(ctx context.Context, e parser.Expr, from, until int64, va | |||
|
|
|||
| // last partial bucket | |||
| if bucketItems > 0 { | |||
| if err := consolidations.CheckValidConsolidationFunc(summarizeFunction); err != nil { | |||
There was a problem hiding this comment.
Same as for the smartSummarize, we can move these checks just after the summarizeFunction is obtained from the arguments
This comment has been minimized.
This comment has been minimized.
carrieedwards
force-pushed
the
cedwards/fix-consolidation-summarizer
branch
from
b89ca07
to
a4053e5
Compare
This comment has been minimized.
This comment has been minimized.
npazosmendez
reviewed
Sep 8, 2022
Comment on lines
52
to
54
| if err != nil { | ||
| return ErrInvalidConsolidationFunc.WithMessage("invalid consolidation " + functionName) | ||
| } |
There was a problem hiding this comment.
This can be deleted.
Also nitnit: the else branch is not necessary
carrieedwards
force-pushed
the
cedwards/fix-consolidation-summarizer
branch
2 times, most recently
from
5db03b4
to
6e4ee3b
Compare
This comment has been minimized.
This comment has been minimized.
npazosmendez
approved these changes
Sep 8, 2022
| return nil | ||
| } | ||
|
|
||
| return ErrInvalidConsolidationFunc.WithMessage("invalid consolidation " + functionName) |
There was a problem hiding this comment.
Sorry, I meant the whole return statement isn't needed, since it would just return at line 55
carrieedwards
force-pushed
the
cedwards/fix-consolidation-summarizer
branch
from
6e4ee3b
to
d34d68e
Compare
|
Go coverage report: Click to expand.
Go lint report: No issues found. 😎 |
npazosmendez
approved these changes
Sep 8, 2022
carrieedwards
added a commit
that referenced
this pull request
Sep 14, 2022
…izer (#102) * Check validity of consolidation function in sortBy * Add test for checking validity of consolidation functions * Update validity checker function and add tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes a bug found in the sortBy() function, in which the specified consolidation function was not checked to verify that it was a valid function. This would cause a panic to occur, because in consolidations.SummarizeValues, the default case in the switch statement involves a string split which assumes that the consolidation function is 'p50'-'p999'. If the specified consolidation function was not 'p50'-'p999', then the panic would occur on the string split.