[Alerting]: get type-checking, tests, and ui working for index threshold #59064
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
pmuellr
added
Feature:Alerting
release_note:skip
|
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
This is a follow-on to elastic#57030 , "[alerting] initial index threshold alertType and supporting APIs", to get it working with the existing alerting UI. The parameter shape was different between the two, so the alertType was changed to fix the existing UI shapes expected.
pmuellr
force-pushed
the
alerting-ui/new-index-threshold
branch
from
d99291d to
c5a0e4c
Compare
YulNaumenko
approved these changes
Mar 2, 2020
gmmorris
approved these changes
Mar 2, 2020
Comment on lines
+40
to
+47
| if (betweenComparators.has(thresholdComparator) && threshold.length === 1) { | ||
| return i18n.translate('xpack.alertingBuiltins.indexThreshold.invalidThreshold2ErrorMessage', { | ||
| defaultMessage: | ||
| '[threshold]: must have two elements for the "{thresholdComparator}" comparator', | ||
| values: { | ||
| thresholdComparator, | ||
| }, | ||
| }); |
Comment on lines
-42
to
-50
| if (aggType === 'count' && aggField) { | ||
| return i18n.translate('xpack.alertingBuiltins.indexThreshold.aggTypeNotEmptyErrorMessage', { | ||
| defaultMessage: '[aggField]: must not have a value when [aggType] is "{aggType}"', | ||
| values: { | ||
| aggType, | ||
| }, | ||
| }); | ||
| } | ||
|
|
There was a problem hiding this comment.
I might be missing something - why do we no longer need this check? 🤔
There was a problem hiding this comment.
The UI sends parameters it doesn't need to be sending. We could tighten this up later, but if you're using count, you don't need an aggField, we used to error if you did, now it's silently ignored. shrug
Comment on lines
96
to
102
| if (groupBy === 'all' || groupBy === 'top') return; | ||
| return i18n.translate('xpack.alertingBuiltins.indexThreshold.invalidGroupByErrorMessage', { | ||
| defaultMessage: 'invalid groupBy: "{groupBy}"', | ||
| values: { | ||
| groupBy, | ||
| }, | ||
| }); |
There was a problem hiding this comment.
nit.
I find early returns like this are easy to miss and misread.
Would it be possible to flip it so that the invalid group is only returned when groupBy !== 'all' && groupBy !== 'top' and then the function's implicit void return would mean it's valid?
Just feels cleaner to me.
There was a problem hiding this comment.
Or better yet, use the type? Something like this should work:
schema.oneOf([
schema.literal('all'),
schema.literal('top'),
])
There was a problem hiding this comment.
I did use schema.oneOf([schema.literal('foo'), ...]) at one point for things like this. But I changed back to strings with a custom validation, because the schema way produced an error message with submessages for each valid literal (eg, "it wasn't a foo; and it wasn't a bar; and it wasn't a ...", but even longer). Heh. I'll open an issue on kbn-schema for that, I think there's probably a way to fix that ...
There was a problem hiding this comment.
I opted to make the early return more obvious; put it in a block, with an empty line behind it.I like early returns, but you're right, sometimes they aren't obvious ...
|
@elasticmachine merge upstream |
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "before each" hook for "should return 404 when overwriting, without references"Standard OutStack TraceKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "after each" hook for "should return 404 when overwriting, without references"Standard OutStack TraceKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "before each" hook for "should return 404 when overwriting, without references"Standard OutStack TraceTo update your PR or re-run it, just comment with: |
pmuellr
added a commit
to pmuellr/kibana
that referenced
this pull request
Mar 3, 2020
…old (elastic#59064) This is a follow-on to elastic#57030 , "[alerting] initial index threshold alertType and supporting APIs", to get it working with the existing alerting UI. The parameter shape was different between the two, so the alertType was changed to fix the existing UI shapes expected.
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 is a follow-on to #57030 , "[alerting] initial index threshold alertType and supporting APIs", to get it working with the existing alerting UI. The parameter shape was different between the two, so the alertType was changed to fix the existing UI shapes expected.
Summary
Summarize your PR. If it involves visual changes include a screenshot or gif.
Checklist
Delete any items that are not applicable to this PR.