[Backport 2.x] Added validation for the new clusters field. (#633) #636
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
* Added validation for the clusters field. Refactored ClusterMetricsInput validiation to throw 4xx-level CommonUtilsExceptions instead of 5xx-level IllegalArgumentException. Signed-off-by: AWSHurneyt <[email protected]> * Moved some regex from alerting plugin to common utils. Signed-off-by: AWSHurneyt <[email protected]> * Moved cluster-based regex to separate file. Signed-off-by: AWSHurneyt <[email protected]> * Fixed ktlint error. Signed-off-by: AWSHurneyt <[email protected]> * Fixed regex. Moved cluster-related regexes. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]>
engechas
previously approved these changes
Apr 12, 2024
eirsep
previously approved these changes
Apr 12, 2024
eirsep
reviewed
Apr 12, 2024
| clusterMetricType = findApiType(constructedUri.path) | ||
| this.parseEmptyFields() | ||
| } catch (exception: Exception) { | ||
| throw CommonUtilsException.wrap(exception) |
There was a problem hiding this comment.
why are we creating a common utils exception?
The plugin using common utils can handle the exception and wrap it as necessary?
There was a problem hiding this comment.
Removed CommonUtilsException in PR #639. Will cherry-pick that commit once that PR is merged.
eirsep
reviewed
Apr 12, 2024
|
|
||
| private val log = LogManager.getLogger(CommonUtilsException::class.java) | ||
|
|
||
| class CommonUtilsException(message: String, val status: RestStatus, ex: Exception) : OpenSearchException(message, ex) { |
There was a problem hiding this comment.
what benefit are we getting from removing the delegation of execption handling to the plugin? there is no business logic in common utils
why should we have to throw a common utils exception?
There was a problem hiding this comment.
Removed CommonUtilsException in PR #639. Will cherry-pick that commit once that PR is merged.
eirsep
reviewed
Apr 12, 2024
| * question marks, double quotes, less than or greater than signs, pipes, colons, or periods. | ||
| * The length of the index must be between 1 and 255 characters | ||
| */ | ||
| val VALID_INDEX_NAME_REGEX = Regex("""^(?![_\-\+])(?!.*\.\.)[^\s,\\\/\*\?"<>|#:\.]{1,255}$""") |
There was a problem hiding this comment.
why aren't we using opensearch core's index name validation?
There was a problem hiding this comment.
This was just moved to common utils from alerting; it wasn't implemented as part of these changes. Core didn't have a regex for index names. This comment explains where the validation came from https://github.com/opensearch-project/alerting/pull/992/files#r1259175796
eirsep
reviewed
Apr 12, 2024
| * The sequences of characters can include lowercase letters, uppercase letters, digits, underscores, or hyphens | ||
| * The total length of the string can range from 1 to 255 characters | ||
| */ | ||
| val CLUSTER_NAME_REGEX = Regex("^(?=.{1,255}$)[a-z0-9]([a-zA-Z0-9_-]*:?[a-zA-Z0-9_-]*)$") |
There was a problem hiding this comment.
why are we not re-using cross cluster validation from core?
There was a problem hiding this comment.
Discussed this in this comment
#633 (comment)
5 tasks
…should be caught in the plugins themselves. Signed-off-by: AWSHurneyt <[email protected]>
jowg-amazon
approved these changes
Apr 13, 2024
eirsep
approved these changes
Apr 13, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 13, 2024
) * Added validation for the new clusters field. (#633) * Added validation for the clusters field. Refactored ClusterMetricsInput validiation to throw 4xx-level CommonUtilsExceptions instead of 5xx-level IllegalArgumentException. Signed-off-by: AWSHurneyt <[email protected]> * Moved some regex from alerting plugin to common utils. Signed-off-by: AWSHurneyt <[email protected]> * Moved cluster-based regex to separate file. Signed-off-by: AWSHurneyt <[email protected]> * Fixed ktlint error. Signed-off-by: AWSHurneyt <[email protected]> * Fixed regex. Moved cluster-related regexes. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]> * Removed CommonUtilsException. Team decided IllegalArgumentExceptions should be caught in the plugins themselves. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]> (cherry picked from commit 4e81d64) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 13, 2024
) * Added validation for the new clusters field. (#633) * Added validation for the clusters field. Refactored ClusterMetricsInput validiation to throw 4xx-level CommonUtilsExceptions instead of 5xx-level IllegalArgumentException. Signed-off-by: AWSHurneyt <[email protected]> * Moved some regex from alerting plugin to common utils. Signed-off-by: AWSHurneyt <[email protected]> * Moved cluster-based regex to separate file. Signed-off-by: AWSHurneyt <[email protected]> * Fixed ktlint error. Signed-off-by: AWSHurneyt <[email protected]> * Fixed regex. Moved cluster-related regexes. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]> * Removed CommonUtilsException. Team decided IllegalArgumentExceptions should be caught in the plugins themselves. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]> (cherry picked from commit 4e81d64) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AWSHurneyt
pushed a commit
that referenced
this pull request
Apr 13, 2024
) (#641) * Added validation for the new clusters field. (#633) * Added validation for the clusters field. Refactored ClusterMetricsInput validiation to throw 4xx-level CommonUtilsExceptions instead of 5xx-level IllegalArgumentException. * Moved some regex from alerting plugin to common utils. * Moved cluster-based regex to separate file. * Fixed ktlint error. * Fixed regex. Moved cluster-related regexes. --------- * Removed CommonUtilsException. Team decided IllegalArgumentExceptions should be caught in the plugins themselves. --------- (cherry picked from commit 4e81d64) Signed-off-by: AWSHurneyt <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.
Description
Manual cherry-pick of PR #633
Issues Resolved
[List any issues this PR will resolve]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.