Return the _source of inner hit nested as is without wrapping it into its full path context #26982
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
colings86
reviewed
Oct 17, 2017
| return; | ||
| } | ||
|
|
||
| if (source.internalSourceRef() == null) { | ||
| if (rootHit && source.internalSourceRef() == null) { |
There was a problem hiding this comment.
Do we need to check source.internalSourceRef() == null before returning to ensure that for non-root hits its actually been set by the end of this method?
There was a problem hiding this comment.
Yes, I think so. In case of regular hits the source has already been set in the FetchPhase and I guess this check exists to ensure that the binary representation of the _source has really been set.
| builder.value(value); | ||
| hitContext.hit().sourceRef(builder.bytes()); | ||
| if (rootHit) { | ||
| final int initialCapacity = Math.min(1024, source.internalSourceRef().length()); |
There was a problem hiding this comment.
source.internalSourceRef() could be null here now?
There was a problem hiding this comment.
It is null in the case rootHit is false, which can't be the case here.
tlrx
reviewed
Oct 18, 2017
| @@ -35,29 +42,50 @@ public void hitExecute(SearchContext context, HitContext hitContext) { | |||
| if (context.sourceRequested() == false) { | |||
| return; | |||
| } | |||
| boolean rootHit = hitContext.hit().getNestedIdentity() == null; | |||
There was a problem hiding this comment.
I'd call this nestedHit and make it final
| hitContext.hit().sourceRef(builder.bytes()); | ||
| if (rootHit) { | ||
| final int initialCapacity = Math.min(1024, source.internalSourceRef().length()); | ||
| BytesStreamOutput streamOutput = new BytesStreamOutput(initialCapacity); |
There was a problem hiding this comment.
It looks to me like it duplicates the logic of creating a XContentBuilder in a given type and then write the filtered source as map. Could it be something like this?
...
Object value = source.filter(fetchSourceContext);
try {
if (nestedHit) {
value = getNestedSource((Map<String, Object>) value, hitContext);
}
final int initialCapacity = Math.min(1024, source.internalSourceRef().length()); // deal with null here
try (BytesStreamOutput streamOutput = new BytesStreamOutput(initialCapacity)) {
XContentBuilder builder = new XContentBuilder(source.sourceContentType().xContent(), streamOutput);
builder.value(value);
hitContext.hit().sourceRef(builder.bytes());
}
...
jpountz
approved these changes
Oct 18, 2017
… its full path context Due to a change happened via elastic#26102 to make the nested source consistent with or without source filtering, the _source of a nested inner hit was always wrapped in the parent path. This turned out to be not ideal for users relying on the nested source, as it would require additional parsing on the client side. This change fixes this, the _source of nested inner hits is now no longer wrapped by parent json objects, irregardless of whether the _source is included as is or source filtering is used. Internally source filtering and highlighting relies on the fact that the _source of nested inner hits are accessible by its full field path, so in order to now break this, the conversion of the _source into its binary form is performed in FetchSourceSubPhase, after any potential source filtering is performed to make sure the structure of _source of the nested inner hit is consistent irregardless if source filtering is performed. PR for elastic#26944 Closes elastic#26944
martijnvg
force-pushed
the
nested_inner_hit_source
branch
from
ec316e9
to
87c9b79
Compare
clintongormley
added
:Search/Search
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.
Due to a change happened via #26102 to make the nested source consistent
with or without source filtering, the _source of a nested inner hit was
always wrapped in the parent path. This turned out to be not ideal for
users relying on the nested source, as it would require additional parsing
on the client side. This change fixes this, the _source of nested inner hits
is now no longer wrapped by parent json objects, irregardless of whether
the _source is included as is or source filtering is used.
Internally source filtering and highlighting relies on the fact that the
_source of nested inner hits are accessible by its full field path, so
in order to now break this, the conversion of the _source into its binary
form is performed in FetchSourceSubPhase, after any potential source filtering
is performed to make sure the structure of _source of the nested inner hit
is consistent irregardless if source filtering is performed.
PR for #26944