Skip to content

Add support for rest_total_hits_as_int in watcher #36035

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

Merged
merged 3 commits into from
Nov 30, 2018
Merged

Add support for rest_total_hits_as_int in watcher #36035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50734da
Add support for rest_total_hits_as_int in watcher
jimczi Nov 29, 2018
5b2076b
Merge branch 'master' into watcher_rest_total_hits_as_int
jimczi Nov 29, 2018
4d469e8
address review
jimczi Nov 30, 2018
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
12 changes: 10 additions & 2 deletions ...her/src/main/java/org/elasticsearch/xpack/watcher/input/search/ExecutableSearchInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.elasticsearch.xpack.watcher.support.search.WatcherSearchTemplateRequest;
import org.elasticsearch.xpack.watcher.support.search.WatcherSearchTemplateService;

import java.util.Collections;
import java.util.Map;

import static org.elasticsearch.xpack.watcher.input.search.SearchInput.TYPE;
Expand All @@ -37,11 +38,12 @@
* An input that executes search and returns the search response as the initial payload
*/
public class ExecutableSearchInput extends ExecutableInput<SearchInput, SearchInput.Result> {

public static final SearchType DEFAULT_SEARCH_TYPE = SearchType.QUERY_THEN_FETCH;

private static final Logger logger = LogManager.getLogger(ExecutableSearchInput.class);

private static final Params EMPTY_PARAMS = new MapParams(Collections.emptyMap());

private final Client client;
private final WatcherSearchTemplateService searchTemplateService;
private final TimeValue timeout;
Expand Down Expand Up @@ -86,7 +88,13 @@ SearchInput.Result doExecute(WatchExecutionContext ctx, WatcherSearchTemplateReq

final Payload payload;
if (input.getExtractKeys() != null) {
BytesReference bytes = XContentHelper.toXContent(response, XContentType.JSON, false);
Params params;
if (request.isRestTotalHitsAsint()) {
params = new MapParams(Collections.singletonMap("rest_total_hits_a_int", "true"));
} else {
params = EMPTY_PARAMS;
}
BytesReference bytes = XContentHelper.toXContent(response, XContentType.JSON, params, false);
// EMPTY is safe here because we never use namedObject
try (XContentParser parser = XContentHelper
.createParser(NamedXContentRegistry.EMPTY, LoggingDeprecationHandler.INSTANCE, bytes)) {
Expand Down
41 changes: 36 additions & 5 deletions ...ain/java/org/elasticsearch/xpack/watcher/support/search/WatcherSearchTemplateRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public class WatcherSearchTemplateRequest implements ToXContentObject {
private final SearchType searchType;
private final IndicesOptions indicesOptions;
private final Script template;

private final BytesReference searchSource;
private boolean restTotalHitsAsInt;

public WatcherSearchTemplateRequest(String[] indices, String[] types, SearchType searchType, IndicesOptions indicesOptions,
BytesReference searchSource) {
Expand Down Expand Up @@ -72,6 +72,7 @@ public WatcherSearchTemplateRequest(WatcherSearchTemplateRequest original, Bytes
this.indicesOptions = original.indicesOptions;
this.searchSource = source;
this.template = original.template;
this.restTotalHitsAsInt = original.restTotalHitsAsInt;
}

private WatcherSearchTemplateRequest(String[] indices, String[] types, SearchType searchType, IndicesOptions indicesOptions,
Expand Down Expand Up @@ -105,6 +106,19 @@ public IndicesOptions getIndicesOptions() {
return indicesOptions;
}

public boolean isRestTotalHitsAsint() {
return restTotalHitsAsInt;
}

/**
* Indicates whether the total hits in the response should be
* serialized as number (<code>true</code>) or as an object (<code>false</code>).
* Defaults to false.
*/
public void setRestTotalHitsAsInt(boolean value) {
this.restTotalHitsAsInt = restTotalHitsAsInt;
}

public BytesReference getSearchSource() {
return searchSource;
}
Expand All @@ -129,6 +143,9 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
if (types != null) {
builder.array(TYPES_FIELD.getPreferredName(), types);
}
if (restTotalHitsAsInt) {
builder.field(REST_TOTAL_HITS_AS_INT_FIELD.getPreferredName(), restTotalHitsAsInt);
}
if (searchSource != null && searchSource.length() > 0) {
try (InputStream stream = searchSource.streamInput()) {
builder.rawField(BODY_FIELD.getPreferredName(), stream);
Expand Down Expand Up @@ -167,6 +184,7 @@ public static WatcherSearchTemplateRequest fromXContent(XContentParser parser, S
IndicesOptions indicesOptions = DEFAULT_INDICES_OPTIONS;
BytesReference searchSource = null;
Script template = null;
boolean totalHitsAsInt = false;

XContentParser.Token token;
String currentFieldName = null;
Expand Down Expand Up @@ -263,10 +281,19 @@ public static WatcherSearchTemplateRequest fromXContent(XContentParser parser, S
types.addAll(Arrays.asList(Strings.delimitedListToStringArray(typesStr, ",", " \t")));
} else if (SEARCH_TYPE_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
searchType = SearchType.fromString(parser.text().toLowerCase(Locale.ROOT));
} else if (REST_TOTAL_HITS_AS_INT_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
totalHitsAsInt = parser.booleanValue();
} else {
throw new ElasticsearchParseException("could not read search request. unexpected string field [" +
currentFieldName + "]");
}
} else if (token == XContentParser.Token.VALUE_BOOLEAN) {
if (REST_TOTAL_HITS_AS_INT_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
totalHitsAsInt = parser.booleanValue();
} else {
throw new ElasticsearchParseException("could not read search request. unexpected boolean field [" +
currentFieldName + "]");
}
} else {
throw new ElasticsearchParseException("could not read search request. unexpected token [" + token + "]");
}
Expand All @@ -276,8 +303,10 @@ public static WatcherSearchTemplateRequest fromXContent(XContentParser parser, S
searchSource = BytesArray.EMPTY;
}

return new WatcherSearchTemplateRequest(indices.toArray(new String[0]), types.toArray(new String[0]), searchType,
indicesOptions, searchSource, template);
WatcherSearchTemplateRequest request = new WatcherSearchTemplateRequest(indices.toArray(new String[0]),
types.toArray(new String[0]), searchType, indicesOptions, searchSource, template);
request.setRestTotalHitsAsInt(totalHitsAsInt);
return request;
}

@Override
Expand All @@ -291,13 +320,14 @@ public boolean equals(Object o) {
Objects.equals(searchType, other.searchType) &&
Objects.equals(indicesOptions, other.indicesOptions) &&
Objects.equals(searchSource, other.searchSource) &&
Objects.equals(template, other.template);
Objects.equals(template, other.template) &&
Objects.equals(restTotalHitsAsInt, other.restTotalHitsAsInt);

}

@Override
public int hashCode() {
return Objects.hash(indices, types, searchType, indicesOptions, searchSource, template);
return Objects.hash(indices, types, searchType, indicesOptions, searchSource, template, restTotalHitsAsInt);
}

private static final ParseField INDICES_FIELD = new ParseField("indices");
Expand All @@ -309,6 +339,7 @@ public int hashCode() {
private static final ParseField IGNORE_UNAVAILABLE_FIELD = new ParseField("ignore_unavailable");
private static final ParseField ALLOW_NO_INDICES_FIELD = new ParseField("allow_no_indices");
private static final ParseField TEMPLATE_FIELD = new ParseField("template");
private static final ParseField REST_TOTAL_HITS_AS_INT_FIELD = new ParseField("rest_total_hits_as_int");

public static final IndicesOptions DEFAULT_INDICES_OPTIONS = IndicesOptions.lenientExpandOpen();
}
126 changes: 126 additions & 0 deletions .../qa/smoke-test-watcher/src/test/resources/rest-api-spec/test/mustache/30_search_input.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,129 @@ setup:
- match: { "watch_record.result.input.search.request.body.query.bool.must.0.term.value": "val_2" }
- match: { "watch_record.result.input.search.request.template.id": "search-template" }
- match: { "watch_record.result.input.search.request.template.params.num": 2 }

---
"Test search input mustache integration (using request body and rest_total_hits_as_int)":
- skip:
version: " - 6.99.99"
reason: "rest_total_hits_as_int support was added in 7.0"
- do:
xpack.watcher.execute_watch:
body: >
{
"trigger_data" : {
"scheduled_time" : "2015-01-04T00:00:00"
},
"watch" : {
"trigger" : { "schedule" : { "interval" : "10s" } },
"actions" : {
"dummy" : {
"logging" : {
"text" : "executed!"
}
}
},
"input" : {
"search" : {
"request" : {
"indices" : "idx",
"rest_total_hits_as_int": true,
"body" : {
"query" : {
"bool" : {
"filter" : [
{
"range" : {
"date" : {
"lte" : "{{ctx.trigger.scheduled_time}}",
"gte" : "{{ctx.trigger.scheduled_time}}||-3d"
}
}
}
]
}
}
}
}
}
}
}
}
- match: { "watch_record.result.input.type": "search" }
- match: { "watch_record.result.input.status": "success" }
- match: { "watch_record.result.input.payload.hits.total": 4 }
# makes sure that the mustache template snippets have been resolved correctly:
- match: { "watch_record.result.input.search.request.body.query.bool.filter.0.range.date.gte": "2015-01-04T00:00:00.000Z||-3d" }
- match: { "watch_record.result.input.search.request.body.query.bool.filter.0.range.date.lte": "2015-01-04T00:00:00.000Z" }

---
"Test search input mustache integration (using request template and rest_total_hits_as_int)":
- skip:
version: " - 6.99.99"
reason: "rest_total_hits_as_int support was added in 7.0"

- do:
put_script:
id: "search-template"
body: {
"script": {
"lang": "mustache",
"source": {
"query" : {
"bool" : {
"must" : [
{
"term" : {
"value" : "val_{{num}}"
}
}
]
}
}
}
}
}
- match: { acknowledged: true }

- do:
xpack.watcher.execute_watch:
body: >
{
"trigger_data" : {
"scheduled_time" : "2015-01-04T00:00:00"
},
"watch" : {
"trigger" : { "schedule" : { "interval" : "10s" } },
"actions" : {
"dummy" : {
"logging" : {
"text" : "executed!"
}
}
},
"input" : {
"search" : {
"request" : {
"rest_total_hits_as_int": true,
"indices" : "idx",
"template" : {
"id": "search-template",
"params": {
"num": 2
}
}
}
}
}
}
}
- match: { "watch_record.result.input.type": "search" }
- match: { "watch_record.result.input.status": "success" }
- match: { "watch_record.result.input.payload.hits.total": 1 }
- match: { "watch_record.result.input.payload.hits.hits.0._id": "2" }
# makes sure that the mustache template snippets have been resolved correctly:
- match: { "watch_record.result.input.search.request.body.query.bool.must.0.term.value": "val_2" }
- match: { "watch_record.result.input.search.request.template.id": "search-template" }
- match: { "watch_record.result.input.search.request.template.params.num": 2 }


Loading