Report parser name and location in XContent deprecation warnings #53752
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
romseygeek
added
>enhancement
:Core/Infra/Core
|
Pinging @elastic/es-core-infra (:Core/Infra/Core) |
|
I also changed the 'this field has been removed entirely' message to read more easily. |
pugnascotia
reviewed
Mar 19, 2020
Comment on lines
55
to
60
| if (parserName != null) { | ||
| deprecationLogger.deprecated("[{}][{}] Deprecated field [{}] used, expected [{}] instead", | ||
| parserName, location.get(), usedName, modernName); | ||
| } else { | ||
| deprecationLogger.deprecated("Deprecated field [{}] used, expected [{}] instead", usedName, modernName); | ||
| } |
There was a problem hiding this comment.
The only suggestion I'd make is about whether it's possible to consolidate the log messages. For example:
Suggested change
| if (parserName != null) { | |
| deprecationLogger.deprecated("[{}][{}] Deprecated field [{}] used, expected [{}] instead", | |
| parserName, location.get(), usedName, modernName); | |
| } else { | |
| deprecationLogger.deprecated("Deprecated field [{}] used, expected [{}] instead", usedName, modernName); | |
| } | |
| String prefix = parserName == null ? "" : | |
| "[" + parserName + "][" + location.get() + "] "; | |
| deprecationLogger.deprecated("{}Deprecated field [{}] used, expected [{}] instead", prefix, usedName, modernName); |
pugnascotia
approved these changes
Mar 19, 2020
pugnascotia
reviewed
Mar 19, 2020
| deprecationLogger.deprecated("[{}][{}] Deprecated field [{}] used, this field is unused and will be removed entirely", | ||
| parserName, location.get(), usedName); | ||
| String prefix = parserName == null ? "" : "[" + parserName + "][" + location.get() + "] "; | ||
| if (true) { |
There was a problem hiding this comment.
This doesn't look right 🤔
There was a problem hiding this comment.
Sorry, out-of-date diff 😅
pugnascotia
approved these changes
Mar 19, 2020
|
Thanks for the review @pugnascotia ! |
yyff
pushed a commit
to yyff/elasticsearch
that referenced
this pull request
Apr 17, 2020
…stic#53752) It's simple to deprecate a field used in an ObjectParser just by adding deprecation markers to the relevant ParseField objects. However, the warnings themselves don't currently have any context; they simply say that a deprecated field has been used, but not where in the input it appears. This commit adds the parent object parser name and XContentLocation to these deprecation messages.
yyff
pushed a commit
to yyff/elasticsearch
that referenced
this pull request
Apr 17, 2020
…ngs (elastic#53752)" This reverts commit 7636930. There is some randomization in the YAML test suite which means we can't check for exact xcontentlocation in the deprecation warning headers.
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.
It's simple to deprecate a field used in an
ObjectParserjust by adding deprecationmarkers to the relevant
ParseFieldobjects. The warnings themselves don't currentlyhave any context - they simply say that a deprecated field has been used, but not
where in the input xcontent it appears. This commit adds the parent object parser
name and
XContentLocationto these deprecation messages.