Assert that REST params are consumed iff supported #113933
Merged
Conversation
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
DaveCTurner
added
>test
DaveCTurner
force-pushed
the
2024/10/02/ensure-consumed-params-supported
branch
from
f9844df to
2902035
Compare
DaveCTurner
changed the title
REST APIs which declare their supported parameters must consume exactly those parameters: consuming an unsupported parameter means that requests including that parameter will be rejected, whereas failing to consume a supported parameter means that this parameter has no effect and should be removed. This commit adds an assertion to verify that we are consuming the correct parameters. Closes elastic#113854
DaveCTurner
force-pushed
the
2024/10/02/ensure-consumed-params-supported
branch
from
6c6e45e to
e33234e
Compare
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
rjernst
reviewed
Oct 2, 2024
| private boolean assertConsumesSupportedParams(@Nullable Set<String> supported, RestRequest request) { | ||
| if (supported != null) { | ||
| final var supportedAndCommon = new TreeSet<>(supported); | ||
| supportedAndCommon.addAll(List.of("error_trace", "filter_path", "format", "pretty", "human")); |
There was a problem hiding this comment.
Do we have these common params defined anywhere so this isn't an arbitrary list?
There was a problem hiding this comment.
Eh not all of them. There's org.elasticsearch.rest.BaseRestHandler#ALWAYS_SUPPORTED but that doesn't include error_trace. I pushed a commit that uses ALWAYS_SUPPORTED. Not a huge deal here in any case, if we get this wrong then this assertion will trip.
💔 Backport failed
You can use sqren/backport to manually backport by running |
DaveCTurner
added a commit
to DaveCTurner/elasticsearch
that referenced
this pull request
Oct 3, 2024
REST APIs which declare their supported parameters must consume exactly those parameters: consuming an unsupported parameter means that requests including that parameter will be rejected, whereas failing to consume a supported parameter means that this parameter has no effect and should be removed. This commit adds an assertion to verify that we are consuming the correct parameters. Closes elastic#113854 Backport of elastic#113933 to `8.x`
gmarouli
pushed a commit
to gmarouli/elasticsearch
that referenced
this pull request
Oct 3, 2024
REST APIs which declare their supported parameters must consume exactly those parameters: consuming an unsupported parameter means that requests including that parameter will be rejected, whereas failing to consume a supported parameter means that this parameter has no effect and should be removed. This commit adds an assertion to verify that we are consuming the correct parameters. Closes elastic#113854
DaveCTurner
added a commit
that referenced
this pull request
Oct 3, 2024
|
Bah this had a bug, I reverted it and will open a fresh PR. |
matthewabbott
pushed a commit
to matthewabbott/elasticsearch
that referenced
this pull request
Oct 4, 2024
REST APIs which declare their supported parameters must consume exactly those parameters: consuming an unsupported parameter means that requests including that parameter will be rejected, whereas failing to consume a supported parameter means that this parameter has no effect and should be removed. This commit adds an assertion to verify that we are consuming the correct parameters. Closes elastic#113854
matthewabbott
pushed a commit
to matthewabbott/elasticsearch
that referenced
this pull request
Oct 4, 2024
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.
REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.
This commit adds an assertion to verify that we are consuming the
correct parameters.
Closes #113854