Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EQL: Adds "fields" request field to the eql request (#68962) #69447

Merged
merged 6 commits into from
Feb 24, 2021
Merged

EQL: Adds "fields" request field to the eql request (#68962) #69447

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52ba256
EQL: Adds "fields" request field to the eql request (#68962)
astefan Feb 23, 2021
008551b
Adapt to 7.x and fix the bwc serialization tests
astefan Feb 23, 2021
4086ab1
Merge branch '7.x' of https://github.com/elastic/elasticsearch into 6…
astefan Feb 24, 2021
3d22dd9
More fixes
astefan Feb 24, 2021
60fd6fe
Address reviews
astefan Feb 24, 2021
222c064
Merge branch '7.x' into 68962_7x_backport
elasticmachine Feb 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions x-pack/plugin/eql/src/main/java/org/elasticsearch/xpack/eql/action/EqlSearchRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public EqlSearchRequest(StreamInput in) throws IOException {
if (in.getVersion().before(Version.V_7_10_0)) {
in.readBoolean();
}
if (in.getVersion().onOrAfter(Version.V_7_12_0)) {
if (in.getVersion().onOrAfter(Version.V_7_13_0)) {
if (in.readBoolean()) {
fetchFields = in.readList(FieldAndFormat::new);
}
Expand Down Expand Up @@ -362,7 +362,7 @@ public void writeTo(StreamOutput out) throws IOException {
if (out.getVersion().before(Version.V_7_10_0)) {
out.writeBoolean(true);
}
if (out.getVersion().onOrAfter(Version.V_7_12_0)) {
if (out.getVersion().onOrAfter(Version.V_7_13_0)) {
out.writeBoolean(fetchFields != null);
if (fetchFields != null) {
out.writeList(fetchFields);
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugin/eql/src/main/java/org/elasticsearch/xpack/eql/action/EqlSearchResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ public Event(StreamInput in) throws IOException {
index = in.readString();
id = in.readString();
source = in.readBytesReference();
if (in.getVersion().onOrAfter(Version.V_7_12_0) && in.readBoolean()) {
if (in.getVersion().onOrAfter(Version.V_7_13_0) && in.readBoolean()) {
fetchFields = in.readMap(StreamInput::readString, DocumentField::new);
} else {
fetchFields = null;
Expand All @@ -254,7 +254,7 @@ public void writeTo(StreamOutput out) throws IOException {
out.writeString(index);
out.writeString(id);
out.writeBytesReference(source);
if (out.getVersion().onOrAfter(Version.V_7_12_0)) {
if (out.getVersion().onOrAfter(Version.V_7_13_0)) {
out.writeBoolean(fetchFields != null);
if (fetchFields != null) {
out.writeMap(fetchFields, StreamOutput::writeString, (stream, documentField) -> documentField.writeTo(stream));
Expand Down
4 changes: 3 additions & 1 deletion ...lugin/eql/src/test/java/org/elasticsearch/xpack/eql/AbstractBWCSerializationTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ private static List<Version> getAllBWCVersions(Version version) {

private static final List<Version> DEFAULT_BWC_VERSIONS = getAllBWCVersions(Version.CURRENT);

protected abstract T mutateInstanceForVersion(T instance, Version version);

public final void testBwcSerialization() throws IOException {
for (int runs = 0; runs < NUMBER_OF_TEST_RUNS; runs++) {
T testInstance = createTestInstance();
Expand All @@ -42,7 +44,7 @@ public final void testBwcSerialization() throws IOException {

protected final void assertBwcSerialization(T testInstance, Version version) throws IOException {
T deserializedInstance = copyInstance(testInstance, version);
assertOnBWCObject(testInstance, deserializedInstance, version);
assertOnBWCObject(mutateInstanceForVersion(testInstance, version), deserializedInstance, version);
}

protected void assertOnBWCObject(T testInstance, T bwcDeserializedObject, Version version) {
Expand Down
4 changes: 3 additions & 1 deletion ...gin/eql/src/test/java/org/elasticsearch/xpack/eql/AbstractBWCWireSerializingTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ private static List<Version> getAllBWCVersions(Version version) {

private static final List<Version> DEFAULT_BWC_VERSIONS = getAllBWCVersions(Version.CURRENT);

protected abstract T mutateInstanceForVersion(T instance, Version version);

public final void testBwcSerialization() throws IOException {
for (int runs = 0; runs < NUMBER_OF_TEST_RUNS; runs++) {
T testInstance = createTestInstance();
Expand All @@ -41,7 +43,7 @@ public final void testBwcSerialization() throws IOException {

protected final void assertBwcSerialization(T testInstance, Version version) throws IOException {
T deserializedInstance = copyInstance(testInstance, version);
assertOnBWCObject(testInstance, deserializedInstance, version);
assertOnBWCObject(mutateInstanceForVersion(testInstance, version), deserializedInstance, version);
}

protected void assertOnBWCObject(T testInstance, T bwcDeserializedObject, Version version) {
Expand Down
21 changes: 21 additions & 0 deletions ...ck/plugin/eql/src/test/java/org/elasticsearch/xpack/eql/action/EqlSearchRequestTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*/
package org.elasticsearch.xpack.eql.action;

import org.elasticsearch.Version;
import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.settings.Settings;
Expand Down Expand Up @@ -101,4 +102,24 @@ protected Writeable.Reader<EqlSearchRequest> instanceReader() {
protected EqlSearchRequest doParseInstance(XContentParser parser) {
return EqlSearchRequest.fromXContent(parser).indices(new String[]{defaultTestIndex});
}

@Override
protected EqlSearchRequest mutateInstanceForVersion(EqlSearchRequest instance, Version version) {
EqlSearchRequest mutatedInstance = new EqlSearchRequest();
mutatedInstance.indices(instance.indices());
mutatedInstance.indicesOptions(instance.indicesOptions());
mutatedInstance.filter(instance.filter());
mutatedInstance.timestampField(instance.timestampField());
mutatedInstance.tiebreakerField(instance.tiebreakerField());
mutatedInstance.eventCategoryField(instance.eventCategoryField());
mutatedInstance.size(instance.size());
mutatedInstance.fetchSize(instance.fetchSize());
mutatedInstance.query(instance.query());
mutatedInstance.waitForCompletionTimeout(instance.waitForCompletionTimeout());
mutatedInstance.keepAlive(instance.keepAlive());
mutatedInstance.keepOnCompletion(instance.keepOnCompletion());
mutatedInstance.fetchFields(version.onOrAfter(Version.V_7_13_0) ? instance.fetchFields() : null);

return mutatedInstance;
}
}
43 changes: 37 additions & 6 deletions ...k/plugin/eql/src/test/java/org/elasticsearch/xpack/eql/action/EqlSearchResponseTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package org.elasticsearch.xpack.eql.action;

import org.apache.lucene.search.TotalHits;
import org.elasticsearch.Version;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.collect.Tuple;
import org.elasticsearch.common.document.DocumentField;
Expand All @@ -20,6 +21,7 @@
import org.elasticsearch.test.RandomObjects;
import org.elasticsearch.xpack.eql.AbstractBWCWireSerializingTestCase;
import org.elasticsearch.xpack.eql.action.EqlSearchResponse.Event;
import org.elasticsearch.xpack.eql.action.EqlSearchResponse.Sequence;

import java.io.IOException;
import java.util.ArrayList;
Expand All @@ -36,7 +38,7 @@
public class EqlSearchResponseTests extends AbstractBWCWireSerializingTestCase<EqlSearchResponse> {

public void testFromXContent() throws IOException {
XContentType xContentType = randomFrom(XContentType.values()).canonical();
XContentType xContentType = randomFrom(XContentType.values());
EqlSearchResponse response = randomEqlSearchResponse(xContentType);
boolean humanReadable = randomBoolean();
BytesReference originalBytes = toShuffledXContent(response, xContentType, ToXContent.EMPTY_PARAMS, humanReadable);
Expand Down Expand Up @@ -128,10 +130,8 @@ private static Tuple<DocumentField, DocumentField> randomDocumentField(XContentT
DocumentField listField = new DocumentField(randomAlphaOfLength(5), listValues);
return Tuple.tuple(listField, listField);
case 2:
List<Object> objectValues = randomList(1, 5, () ->
Map.of(randomAlphaOfLength(5), randomInt(),
randomAlphaOfLength(5), randomBoolean(),
randomAlphaOfLength(5), randomAlphaOfLength(10)));
List<Object> objectValues = randomList(1, 5,
randomFrom(Arrays.asList(() -> randomAlphaOfLength(10), ESTestCase::randomInt, ESTestCase::randomBoolean)));
DocumentField objectField = new DocumentField(randomAlphaOfLength(5), objectValues);
return Tuple.tuple(objectField, objectField);
default:
Expand Down Expand Up @@ -217,5 +217,36 @@ public static EqlSearchResponse createRandomInstance(TotalHits totalHits, XConte
return null;
}
}


@Override
protected EqlSearchResponse mutateInstanceForVersion(EqlSearchResponse instance, Version version) {
List<Event> mutatedEvents = mutateEvents(instance.hits().events(), version);

List<Sequence> sequences = instance.hits().sequences();
List<Sequence> mutatedSequences = null;
if (sequences != null) {
mutatedSequences = new ArrayList<>(sequences.size());
for(Sequence s : sequences) {
mutatedSequences.add(new Sequence(s.joinKeys(), mutateEvents(s.events(), version)));
}
}

return new EqlSearchResponse(new EqlSearchResponse.Hits(mutatedEvents, mutatedSequences, instance.hits().totalHits()),
instance.took(), instance.isTimeout(), instance.id(), instance.isRunning(), instance.isPartial());
}

private List<Event> mutateEvents(List<Event> original, Version version) {
if (original == null || original.isEmpty()) {
return original;
}
List<Event> mutatedEvents = new ArrayList<>(original.size());
for(Event e : original) {
if (version.onOrAfter(Version.V_7_13_0)) {
mutatedEvents.add(new Event(e.index(), e.id(), e.source(), e.fetchFields()));
} else {
mutatedEvents.add(new Event(e.index(), e.id(), e.source(), null));
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: optionally, you could add one line (or two) only, if you condition just last parameter's value by the version (like done in the Request test).

}
return mutatedEvents;
}
}