Deprecate all variants of a ParseField with no replacement #53722
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
romseygeek
added
>enhancement
:Core/Infra/Core
|
Pinging @elastic/es-core-infra (:Core/Infra/Core) |
|
Lots of tests were using anonymous DeprecationHandlers that did nothing. Rather than extend all of these with an extra method, I thought it was worth adding a static do-nothing instance on |
nik9000
reviewed
Mar 18, 2020
| @@ -108,15 +118,17 @@ public boolean match(String fieldName, DeprecationHandler deprecationHandler) { | |||
| Objects.requireNonNull(fieldName, "fieldName cannot be null"); | |||
| // if this parse field has not been completely deprecated then try to | |||
| // match the preferred name | |||
| if (allReplacedWith == null && fieldName.equals(name)) { | |||
| if (fullyDeprecated == false && allReplacedWith == null && fieldName.equals(name)) { | |||
There was a problem hiding this comment.
Would it be simpler to add something like:
if (fullyDeprecated) {
deprecationHandler.usedDeprecatedField(fieldName);
return true;
}
above this if statement?
There was a problem hiding this comment.
We still need to check that one of the possible names matches so it's not quite as simple as that, unfortunately
| /** | ||
| * Ignores all deprecations | ||
| */ | ||
| DeprecationHandler IGNORE_DEPRECATIONS = new DeprecationHandler() { |
nik9000
approved these changes
Mar 18, 2020
| @@ -108,15 +118,17 @@ public boolean match(String fieldName, DeprecationHandler deprecationHandler) { | |||
| Objects.requireNonNull(fieldName, "fieldName cannot be null"); | |||
| // if this parse field has not been completely deprecated then try to | |||
| // match the preferred name | |||
| if (allReplacedWith == null && fieldName.equals(name)) { | |||
| if (fullyDeprecated == false && allReplacedWith == null && fieldName.equals(name)) { | |||
romseygeek
added a commit
that referenced
this pull request
Mar 18, 2020
…placement (#53722) Sometimes we want to deprecate and remove a ParseField entirely, without replacement; for example, the various places where we specify a _type field in 7x. Currently we can tell users only that a particular field name should not be used, and that another name should be used in its place. This commit adds the ability to say that a field should not be used at all.
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.
Sometimes we want to deprecate and remove a ParseField entirely, without replacement;
for example, the various places where we specify a
_typefield in 7x. Currently we cantell users only that a particular field name should not be used, and that another name should
be used in its place. This commit adds the ability to say that a field should not be used at
all.