Migrate scripted metric aggregation scripts to ScriptContext design #30111
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.painless; | ||
|
|
||
| import org.elasticsearch.painless.spi.Whitelist; | ||
| import org.elasticsearch.script.ScriptedMetricAggContexts; | ||
| import org.elasticsearch.script.ScriptContext; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class ScriptedMetricAggContextsTests extends ScriptTestCase { | ||
| @Override | ||
| protected Map<ScriptContext<?>, List<Whitelist>> scriptContexts() { | ||
| Map<ScriptContext<?>, List<Whitelist>> contexts = new HashMap<>(); | ||
| contexts.put(ScriptedMetricAggContexts.InitScript.CONTEXT, Whitelist.BASE_WHITELISTS); | ||
| contexts.put(ScriptedMetricAggContexts.MapScript.CONTEXT, Whitelist.BASE_WHITELISTS); | ||
| contexts.put(ScriptedMetricAggContexts.CombineScript.CONTEXT, Whitelist.BASE_WHITELISTS); | ||
| contexts.put(ScriptedMetricAggContexts.ReduceScript.CONTEXT, Whitelist.BASE_WHITELISTS); | ||
| return contexts; | ||
| } | ||
|
|
||
| public void testInitBasic() { | ||
| ScriptedMetricAggContexts.InitScript.Factory factory = scriptEngine.compile("test", | ||
| "agg.testField = params.initialVal", ScriptedMetricAggContexts.InitScript.CONTEXT, Collections.emptyMap()); | ||
|
|
||
| Map<String, Object> params = new HashMap<>(); | ||
| Map<String, Object> agg = new HashMap<>(); | ||
|
|
||
| params.put("initialVal", 10); | ||
|
|
||
| ScriptedMetricAggContexts.InitScript script = factory.newInstance(params, agg); | ||
| script.execute(); | ||
|
|
||
| assert(agg.containsKey("testField")); | ||
| assertEquals(10, agg.get("testField")); | ||
| } | ||
|
|
||
| public void testMapBasic() { | ||
| ScriptedMetricAggContexts.MapScript.Factory factory = scriptEngine.compile("test", | ||
| "agg.testField = 2*_score", ScriptedMetricAggContexts.MapScript.CONTEXT, Collections.emptyMap()); | ||
|
|
||
| Map<String, Object> params = new HashMap<>(); | ||
| Map<String, Object> agg = new HashMap<>(); | ||
| double _score = 0.5; | ||
|
|
||
| ScriptedMetricAggContexts.MapScript.LeafFactory leafFactory = factory.newFactory(params, agg, null); | ||
| ScriptedMetricAggContexts.MapScript script = leafFactory.newInstance(null); | ||
|
|
||
| script.execute(_score); | ||
|
|
||
| assert(agg.containsKey("testField")); | ||
| assertEquals(1.0, agg.get("testField")); | ||
| } | ||
|
|
||
| public void testCombineBasic() { | ||
| ScriptedMetricAggContexts.CombineScript.Factory factory = scriptEngine.compile("test", | ||
| "agg.testField = params.initialVal; return agg.testField + params.inc", ScriptedMetricAggContexts.CombineScript.CONTEXT, | ||
| Collections.emptyMap()); | ||
|
|
||
| Map<String, Object> params = new HashMap<>(); | ||
| Map<String, Object> agg = new HashMap<>(); | ||
|
|
||
| params.put("initialVal", 10); | ||
| params.put("inc", 2); | ||
|
|
||
| ScriptedMetricAggContexts.CombineScript script = factory.newInstance(params, agg); | ||
| Object res = script.execute(); | ||
|
|
||
| assert(agg.containsKey("testField")); | ||
| assertEquals(10, agg.get("testField")); | ||
| assertEquals(12, res); | ||
| } | ||
|
|
||
| public void testReduceBasic() { | ||
| ScriptedMetricAggContexts.ReduceScript.Factory factory = scriptEngine.compile("test", | ||
| "aggs[0].testField + aggs[1].testField", ScriptedMetricAggContexts.ReduceScript.CONTEXT, Collections.emptyMap()); | ||
|
|
||
| Map<String, Object> params = new HashMap<>(); | ||
| List<Object> aggs = new ArrayList<>(); | ||
|
|
||
| Map<String, Object> agg1 = new HashMap<>(), agg2 = new HashMap<>(); | ||
| agg1.put("testField", 1); | ||
| agg2.put("testField", 2); | ||
|
|
||
| aggs.add(agg1); | ||
| aggs.add(agg2); | ||
|
|
||
| ScriptedMetricAggContexts.ReduceScript script = factory.newInstance(params, aggs); | ||
| Object res = script.execute(); | ||
| assertEquals(3, res); | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.script; | ||
|
|
||
| import org.apache.lucene.index.LeafReaderContext; | ||
| import org.elasticsearch.index.fielddata.ScriptDocValues; | ||
| import org.elasticsearch.search.lookup.LeafSearchLookup; | ||
| import org.elasticsearch.search.lookup.SearchLookup; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class ScriptedMetricAggContexts { | ||
| private abstract static class ParamsAndAggBase { | ||
|
||
| private final Map<String, Object> params; | ||
| private final Object agg; | ||
|
|
||
| ParamsAndAggBase(Map<String, Object> params, Object agg) { | ||
| this.params = params; | ||
| this.agg = agg; | ||
| } | ||
|
|
||
| public Map<String, Object> getParams() { | ||
| return params; | ||
| } | ||
|
|
||
| public Object getAgg() { | ||
| return agg; | ||
| } | ||
| } | ||
|
|
||
| public abstract static class InitScript extends ParamsAndAggBase { | ||
| public InitScript(Map<String, Object> params, Object agg) { | ||
| super(params, agg); | ||
| } | ||
|
|
||
| public abstract void execute(); | ||
|
|
||
| public interface Factory { | ||
| InitScript newInstance(Map<String, Object> params, Object agg); | ||
| } | ||
|
|
||
| public static String[] PARAMETERS = {}; | ||
| public static ScriptContext<Factory> CONTEXT = new ScriptContext<>("aggs_init", Factory.class); | ||
| } | ||
|
|
||
| public abstract static class MapScript extends ParamsAndAggBase { | ||
| private final LeafSearchLookup leafLookup; | ||
|
|
||
| public MapScript(Map<String, Object> params, Object agg, SearchLookup lookup, LeafReaderContext leafContext) { | ||
| super(params, agg); | ||
|
|
||
| this.leafLookup = leafContext == null ? null : lookup.getLeafSearchLookup(leafContext); | ||
| } | ||
|
|
||
| // Return the doc as a map (instead of LeafDocLookup) in order to abide by type whitelisting rules for | ||
| // Painless scripts. | ||
| public Map<String, ScriptDocValues<?>> getDoc() { | ||
| return leafLookup == null ? null : leafLookup.doc(); | ||
| } | ||
|
|
||
| public void setDocument(int docId) { | ||
| if (leafLookup != null) { | ||
| leafLookup.setDocument(docId); | ||
| } | ||
| } | ||
|
|
||
| public abstract void execute(double _score); | ||
|
|
||
| public interface LeafFactory { | ||
| MapScript newInstance(LeafReaderContext ctx); | ||
| } | ||
|
|
||
| public interface Factory { | ||
| LeafFactory newFactory(Map<String, Object> params, Object agg, SearchLookup lookup); | ||
| } | ||
|
|
||
| public static String[] PARAMETERS = new String[] {"_score"}; | ||
| public static ScriptContext<Factory> CONTEXT = new ScriptContext<>("aggs_map", Factory.class); | ||
| } | ||
|
|
||
| public abstract static class CombineScript extends ParamsAndAggBase { | ||
| public CombineScript(Map<String, Object> params, Object agg) { | ||
| super(params, agg); | ||
| } | ||
|
|
||
| public abstract Object execute(); | ||
|
|
||
| public interface Factory { | ||
| CombineScript newInstance(Map<String, Object> params, Object agg); | ||
| } | ||
|
|
||
| public static String[] PARAMETERS = {}; | ||
| public static ScriptContext<Factory> CONTEXT = new ScriptContext<>("aggs_combine", Factory.class); | ||
| } | ||
|
|
||
| public abstract static class ReduceScript { | ||
| private final Map<String, Object> params; | ||
| private final List<Object> aggs; | ||
|
|
||
| public ReduceScript(Map<String, Object> params, List<Object> aggs) { | ||
| this.params = params; | ||
| this.aggs = aggs; | ||
| } | ||
|
|
||
| public Map<String, Object> getParams() { | ||
| return params; | ||
| } | ||
|
|
||
| public List<Object> getAggs() { | ||
| return aggs; | ||
| } | ||
|
|
||
| public abstract Object execute(); | ||
|
|
||
| public interface Factory { | ||
| ReduceScript newInstance(Map<String, Object> params, List<Object> aggs); | ||
| } | ||
|
|
||
| public static String[] PARAMETERS = {}; | ||
| public static ScriptContext<Factory> CONTEXT = new ScriptContext<>("aggs_reduce", Factory.class); | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would name this MetricAggScripts so that the inner classes read more naturally, eg
MetricAggScripts.Init.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's what I had originally, actually. I abandoned e.g.
Initin favor ofInitScriptbecause naming one of the classesMapends up requiring fully qualifying java.util.Map in a bunch of spots which is pretty annoying (although really isn't a dealbreaker since it could be limited to this file). And past that, @colings86 suggestion that "metric agg" as a term is more general than this feature made sense to me. Admittedly the current situation makes the outer class kind of unnecessary since references to the scripts end up using long names anyway. This could be replaced with a package (or not even) and names likeScriptedMetricAggInitScriptor justMetricAggInitScriptwhich may be more palatable since it avoids a more general name without "script" in it.TBH I might lean toward the latter; using a class as a small namespace in this context is a little clunky anyway IMO (even if it's the best Java can do). I defer to what you two think makes the most sense in context. I will await comment from @rjernst and @colings86 to settle this one.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rjernst I'm inclined to leave this as-is because personally I think the MapScript name qualification is more annoying than the ScriptedMetricAggContexts.*Script naming, and on further reflection I do think having them all in one file is better than splitting them apart. Let me know if you are firm in a different opinion on this though.