honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Watcher: HttpResponse serialization may not contain dots in field names 

The HTTP response toXContent() method contains the http response headers, which
are used as field names in Elasticsearch in the watch history.
These can contain dots, like `es.index` being returned when Elasticsearch
encounters an exception - which results in an index error.

This patch changes the dots to an underscore when calling toXContent()

Closes elastic/elasticsearch#1803

Original commit: elastic/x-pack-elasticsearch@e4070f8b70
This commit is contained in:
Alexander Reelsen 2016-04-13 08:59:27 +02:00
parent 847287278b
commit 6d0a2f642a
2 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
elasticsearch/x-pack/watcher/src/main/java/org/elasticsearch/watcher/support/http/HttpResponse.java
View File

@ -149,7 +149,9 @@ public class HttpResponse implements ToXContent {
if (!headers.isEmpty()) {
builder.startObject(Field.HEADERS.getPreferredName());
for (Map.Entry<String, String[]> header : headers.entrySet()) {
builder.array(header.getKey(), header.getValue());
// in order to prevent dots in field names, that might occur in headers, we simply de_dot those header names
// when writing toXContent
builder.array(header.getKey().replaceAll("\\.", "_"), header.getValue());
}
builder.endObject();
}

36
elasticsearch/x-pack/watcher/src/test/java/org/elasticsearch/watcher/support/http/HttpResponseTests.java
View File

@ -5,11 +5,15 @@
*/
package org.elasticsearch.watcher.support.http;
import com.google.common.collect.Lists;
import org.elasticsearch.common.bytes.BytesArray;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.test.ESTestCase;
import org.hamcrest.Matchers;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
@ -21,13 +25,18 @@ import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder;
import static org.elasticsearch.watcher.test.WatcherTestUtils.xContentParser;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.Matchers.arrayContaining;
import static org.hamcrest.Matchers.hasEntry;
import static org.hamcrest.Matchers.hasKey;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.notNullValue;
import static org.hamcrest.Matchers.not;
/**
*
*/
public class HttpResponseTests extends ESTestCase {
public void testParseSelfGenerated() throws Exception {
int status = randomIntBetween(200, 600);
Map<String, String[]> headers = emptyMap();
@ -91,4 +100,31 @@ public class HttpResponseTests extends ESTestCase {
assertThat(response.header("key")[0], is("value"));
assertThat(response.contentType(), is("text/html"));
}
public void testThatHeaderNamesDoNotContainDotsOnSerialization() throws Exception {
Map<String, String[]> headers = new HashMap<>();
headers.put("es.index", new String[] { "value" });
headers.put("es.index.2", new String[] { "value" });
HttpResponse response = new HttpResponse(200, headers);
assertThat(response.header("es.index")[0], is("value"));
assertThat(response.header("es.index.2")[0], is("value"));
XContentBuilder builder = jsonBuilder();
response.toXContent(builder, ToXContent.EMPTY_PARAMS);
XContentParser parser = XContentFactory.xContent(builder.string()).createParser(builder.string());
Map<String, Object> responseMap = parser.map();
parser.close();
assertThat(responseMap, hasKey("headers"));
assertThat(responseMap.get("headers"), instanceOf(Map.class));
Map<String, Object> responseHeaders = (Map<String, Object>) responseMap.get("headers");
assertThat(responseHeaders, not(hasKey("es.index")));
assertThat(responseHeaders, hasEntry("es_index", Lists.newArrayList("value")));
assertThat(responseHeaders, not(hasKey("es.index.2")));
assertThat(responseHeaders, hasEntry("es_index_2", Lists.newArrayList("value")));
}
}