Skip to content

Make scripted search templates work with new mediaType from XContentType.JSON #67677

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 9 commits into from
Jan 21, 2021
Merged

Make scripted search templates work with new mediaType from XContentType.JSON #67677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4b5bfce
init and debug script check
pgomulka Jan 19, 2021
67970bf
script tests
pgomulka Jan 19, 2021
e96daa8
script modifying options to XContentType.JSON.mediaType when present
pgomulka Jan 19, 2021
232b5b4
formatting
pgomulka Jan 19, 2021
4b9c3aa
make options unmodificable before trying to copy
pgomulka Jan 19, 2021
fffb022
javadoc
pgomulka Jan 19, 2021
60e9df3
remove Script class changes
pgomulka Jan 20, 2021
e897dc3
mime to media type rename
pgomulka Jan 21, 2021
65a55b0
Merge remote-tracking branch 'upstream/master' into scripting/content…
pgomulka Jan 21, 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
34 changes: 17 additions & 17 deletions .../lang-mustache/src/main/java/org/elasticsearch/script/mustache/CustomMustacheFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import com.github.mustachejava.codes.DefaultMustache;
import com.github.mustachejava.codes.IterableCode;
import com.github.mustachejava.codes.WriteCode;
import org.apache.lucene.search.highlight.DefaultEncoder;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentType;
Expand All @@ -51,30 +50,31 @@
import java.util.regex.Pattern;

public class CustomMustacheFactory extends DefaultMustacheFactory {
static final String V7_JSON_MEDIA_TYPE_WITH_CHARSET = "application/json; charset=UTF-8";
static final String JSON_MEDIA_TYPE_WITH_CHARSET = "application/json;charset=utf-8";
static final String JSON_MEDIA_TYPE = "application/json";
static final String PLAIN_TEXT_MEDIA_TYPE = "text/plain";
static final String X_WWW_FORM_URLENCODED_MEDIA_TYPE = "application/x-www-form-urlencoded";

static final String JSON_MIME_TYPE_WITH_CHARSET = "application/json;charset=utf-8";
static final String JSON_MIME_TYPE = "application/json";
static final String PLAIN_TEXT_MIME_TYPE = "text/plain";
static final String X_WWW_FORM_URLENCODED_MIME_TYPE = "application/x-www-form-urlencoded";

private static final String DEFAULT_MIME_TYPE = JSON_MIME_TYPE;
private static final String DEFAULT_MEDIA_TYPE = JSON_MEDIA_TYPE;

private static final Map<String, Supplier<Encoder>> ENCODERS = Map.of(
JSON_MIME_TYPE_WITH_CHARSET, JsonEscapeEncoder::new,
JSON_MIME_TYPE, JsonEscapeEncoder::new,
PLAIN_TEXT_MIME_TYPE, DefaultEncoder::new,
X_WWW_FORM_URLENCODED_MIME_TYPE, UrlEncoder::new);
V7_JSON_MEDIA_TYPE_WITH_CHARSET, JsonEscapeEncoder::new,
JSON_MEDIA_TYPE_WITH_CHARSET, JsonEscapeEncoder::new,
JSON_MEDIA_TYPE, JsonEscapeEncoder::new,
PLAIN_TEXT_MEDIA_TYPE, DefaultEncoder::new,
X_WWW_FORM_URLENCODED_MEDIA_TYPE, UrlEncoder::new);

private final Encoder encoder;

public CustomMustacheFactory(String mimeType) {
public CustomMustacheFactory(String mediaType) {
super();
setObjectHandler(new CustomReflectionObjectHandler());
this.encoder = createEncoder(mimeType);
this.encoder = createEncoder(mediaType);
}

public CustomMustacheFactory() {
this(DEFAULT_MIME_TYPE);
this(DEFAULT_MEDIA_TYPE);
}

@Override
Expand All @@ -86,10 +86,10 @@ public void encode(String value, Writer writer) {
}
}

static Encoder createEncoder(String mimeType) {
final Supplier<Encoder> supplier = ENCODERS.get(mimeType);
static Encoder createEncoder(String mediaType) {
final Supplier<Encoder> supplier = ENCODERS.get(mediaType);
if (supplier == null) {
throw new IllegalArgumentException("No encoder found for MIME type [" + mimeType + "]");
throw new IllegalArgumentException("No encoder found for media type [" + mediaType + "]");
}
return supplier.get();
}
Expand Down
26 changes: 13 additions & 13 deletions ...-mustache/src/test/java/org/elasticsearch/script/mustache/CustomMustacheFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@

import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonMap;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.JSON_MIME_TYPE;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.PLAIN_TEXT_MIME_TYPE;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.X_WWW_FORM_URLENCODED_MIME_TYPE;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.JSON_MEDIA_TYPE;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.PLAIN_TEXT_MEDIA_TYPE;
import static org.elasticsearch.script.mustache.CustomMustacheFactory.X_WWW_FORM_URLENCODED_MEDIA_TYPE;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;

Expand All @@ -40,33 +40,33 @@ public void testCreateEncoder() {
{
final IllegalArgumentException e =
expectThrows(IllegalArgumentException.class, () -> CustomMustacheFactory.createEncoder("non-existent"));
assertThat(e.getMessage(), equalTo("No encoder found for MIME type [non-existent]"));
assertThat(e.getMessage(), equalTo("No encoder found for media type [non-existent]"));
}

{
final IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> CustomMustacheFactory.createEncoder(""));
assertThat(e.getMessage(), equalTo("No encoder found for MIME type []"));
assertThat(e.getMessage(), equalTo("No encoder found for media type []"));
}

{
final IllegalArgumentException e =
expectThrows(IllegalArgumentException.class, () -> CustomMustacheFactory.createEncoder("test"));
assertThat(e.getMessage(), equalTo("No encoder found for MIME type [test]"));
assertThat(e.getMessage(), equalTo("No encoder found for media type [test]"));
}

assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.JSON_MIME_TYPE_WITH_CHARSET),
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.JSON_MEDIA_TYPE_WITH_CHARSET),
instanceOf(CustomMustacheFactory.JsonEscapeEncoder.class));
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.JSON_MIME_TYPE),
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.JSON_MEDIA_TYPE),
instanceOf(CustomMustacheFactory.JsonEscapeEncoder.class));
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.PLAIN_TEXT_MIME_TYPE),
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.PLAIN_TEXT_MEDIA_TYPE),
instanceOf(CustomMustacheFactory.DefaultEncoder.class));
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.X_WWW_FORM_URLENCODED_MIME_TYPE),
assertThat(CustomMustacheFactory.createEncoder(CustomMustacheFactory.X_WWW_FORM_URLENCODED_MEDIA_TYPE),
instanceOf(CustomMustacheFactory.UrlEncoder.class));
}

public void testJsonEscapeEncoder() {
final ScriptEngine engine = new MustacheScriptEngine();
final Map<String, String> params = randomBoolean() ? singletonMap(Script.CONTENT_TYPE_OPTION, JSON_MIME_TYPE) : emptyMap();
final Map<String, String> params = randomBoolean() ? singletonMap(Script.CONTENT_TYPE_OPTION, JSON_MEDIA_TYPE) : emptyMap();

TemplateScript.Factory compiled = engine.compile(null, "{\"field\": \"{{value}}\"}", TemplateScript.CONTEXT, params);

Expand All @@ -76,7 +76,7 @@ public void testJsonEscapeEncoder() {

public void testDefaultEncoder() {
final ScriptEngine engine = new MustacheScriptEngine();
final Map<String, String> params = singletonMap(Script.CONTENT_TYPE_OPTION, PLAIN_TEXT_MIME_TYPE);
final Map<String, String> params = singletonMap(Script.CONTENT_TYPE_OPTION, PLAIN_TEXT_MEDIA_TYPE);

TemplateScript.Factory compiled = engine.compile(null, "{\"field\": \"{{value}}\"}", TemplateScript.CONTEXT, params);

Expand All @@ -86,7 +86,7 @@ public void testDefaultEncoder() {

public void testUrlEncoder() {
final ScriptEngine engine = new MustacheScriptEngine();
final Map<String, String> params = singletonMap(Script.CONTENT_TYPE_OPTION, X_WWW_FORM_URLENCODED_MIME_TYPE);
final Map<String, String> params = singletonMap(Script.CONTENT_TYPE_OPTION, X_WWW_FORM_URLENCODED_MEDIA_TYPE);

TemplateScript.Factory compiled = engine.compile(null, "{\"field\": \"{{value}}\"}", TemplateScript.CONTEXT, params);

Expand Down
3 changes: 0 additions & 3 deletions qa/rolling-upgrade/src/test/resources/rest-api-spec/test/mixed_cluster/10_basic.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
"Verify that we can still find things with the template":
- skip:
version: "all"
reason: "Awaits fix: https://github.com/elastic/elasticsearch/issues/66986"

- do:
search_template:
Expand Down
3 changes: 0 additions & 3 deletions qa/rolling-upgrade/src/test/resources/rest-api-spec/test/upgraded_cluster/10_basic.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
"Verify that we can still find things with the template":
- skip:
version: "all"
reason: "Awaits fix: https://github.com/elastic/elasticsearch/issues/66986"

- do:
search_template:
Expand Down