Add types deprecation to script contexts (#37554)

jdconrad · web-flow · commit de55b4dfd1fe · 2019-01-18T09:13:49.000-08:00
This adds deprecation to _type in the script contexts for ingest and update. 
This adds a DeprecationMap that wraps the ctx Map containing _type for these 
specific contexts.
diff --git a/modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/ScriptProcessor.java b/modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/ScriptProcessor.java
@@ -30,13 +30,16 @@
 import org.elasticsearch.ingest.AbstractProcessor;
 import org.elasticsearch.ingest.IngestDocument;
 import org.elasticsearch.ingest.Processor;
+import org.elasticsearch.script.DeprecationMap;
 import org.elasticsearch.script.IngestScript;
 import org.elasticsearch.script.Script;
 import org.elasticsearch.script.ScriptException;
 import org.elasticsearch.script.ScriptService;
 
 import java.io.InputStream;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 
 import static org.elasticsearch.ingest.ConfigurationUtils.newConfigurationException;
@@ -46,6 +49,16 @@
  */
 public final class ScriptProcessor extends AbstractProcessor {
 
+    private static final Map<String, String> DEPRECATIONS;
+    static {
+        Map<String, String> deprecations = new HashMap<>();
+        deprecations.put(
+                "_type",
+                "[types removal] Looking up doc types [_type] in scripts is deprecated."
+        );
+        DEPRECATIONS = Collections.unmodifiableMap(deprecations);
+    }
+
     public static final String TYPE = "script";
 
     private final Script script;
@@ -72,7 +85,8 @@ public final class ScriptProcessor extends AbstractProcessor {
     @Override
     public IngestDocument execute(IngestDocument document) {
         IngestScript.Factory factory = scriptService.compile(script, IngestScript.CONTEXT);
-        factory.newInstance(script.getParams()).execute(document.getSourceAndMetadata());
+        factory.newInstance(script.getParams()).execute(
+                new DeprecationMap(document.getSourceAndMetadata(), DEPRECATIONS, "script_processor"));
         CollectionUtils.ensureNoSelfReferences(document.getSourceAndMetadata(), "ingest script");
         return document;
     }
diff --git a/modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/ScriptProcessorTests.java b/modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/ScriptProcessorTests.java
@@ -74,4 +74,28 @@ Script.DEFAULT_SCRIPT_LANG, new MockScriptEngine(
         assertThat(ingestDocument.getSourceAndMetadata(), hasKey("bytes_total"));
         assertThat(ingestDocument.getSourceAndMetadata().get("bytes_total"), is(randomBytesTotal));
     }
+
+    public void testTypeDeprecation() throws Exception {
+        String scriptName = "script";
+        ScriptService scriptService = new ScriptService(Settings.builder().build(),
+                Collections.singletonMap(
+                        Script.DEFAULT_SCRIPT_LANG, new MockScriptEngine(
+                                Script.DEFAULT_SCRIPT_LANG,
+                                Collections.singletonMap(
+                                        scriptName, ctx -> {
+                                            ctx.get("_type");
+                                            return null;
+                                        }
+                                ),
+                                Collections.emptyMap()
+                        )
+                ),
+                new HashMap<>(ScriptModule.CORE_CONTEXTS)
+        );
+        Script script = new Script(ScriptType.INLINE, Script.DEFAULT_SCRIPT_LANG, scriptName, Collections.emptyMap());
+        IngestDocument ingestDocument = RandomDocumentPicks.randomIngestDocument(random(), Collections.emptyMap());
+        ScriptProcessor processor = new ScriptProcessor(randomAlphaOfLength(10), script, scriptService);
+        processor.execute(ingestDocument);
+        assertWarnings("[types removal] Looking up doc types [_type] in scripts is deprecated.");
+    }
 }
diff --git a/modules/reindex/src/test/java/org/elasticsearch/index/reindex/AbstractAsyncBulkByScrollActionScriptTestCase.java b/modules/reindex/src/test/java/org/elasticsearch/index/reindex/AbstractAsyncBulkByScrollActionScriptTestCase.java
@@ -58,7 +58,7 @@ protected <T extends ActionRequest> T applyScript(Consumer<Map<String, Object>>
         UpdateScript.Factory factory = (params, ctx) -> new UpdateScript(Collections.emptyMap(), ctx) {
             @Override
             public void execute() {
-                scriptBody.accept(ctx);
+                scriptBody.accept(getCtx());
             }
         };;
         when(scriptService.compile(any(), eq(UpdateScript.CONTEXT))).thenReturn(factory);
@@ -67,6 +67,11 @@ public void execute() {
         return (result != null) ? (T) result.self() : null;
     }
 
+    public void testTypeDeprecation() {
+        applyScript((Map<String, Object> ctx) -> ctx.get("_type"));
+        assertWarnings("[types removal] Looking up doc types [_type] in scripts is deprecated.");
+    }
+
     public void testScriptAddingJunkToCtxIsError() {
         try {
             applyScript((Map<String, Object> ctx) -> ctx.put("junk", "junk"));
diff --git a/server/src/main/java/org/elasticsearch/ingest/ConditionalProcessor.java b/server/src/main/java/org/elasticsearch/ingest/ConditionalProcessor.java
@@ -23,6 +23,7 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.ListIterator;
@@ -31,12 +32,24 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.LongSupplier;
 import java.util.stream.Collectors;
+
+import org.elasticsearch.script.DeprecationMap;
 import org.elasticsearch.script.IngestConditionalScript;
 import org.elasticsearch.script.Script;
 import org.elasticsearch.script.ScriptService;
 
 public class ConditionalProcessor extends AbstractProcessor {
 
+    private static final Map<String, String> DEPRECATIONS;
+    static {
+        Map<String, String> deprecations = new HashMap<>();
+        deprecations.put(
+                "_type",
+                "[types removal] Looking up doc types [_type] in scripts is deprecated."
+        );
+        DEPRECATIONS = Collections.unmodifiableMap(deprecations);
+    }
+
     static final String TYPE = "conditional";
 
     private final Script condition;
@@ -81,7 +94,8 @@ public IngestDocument execute(IngestDocument ingestDocument) throws Exception {
     boolean evaluate(IngestDocument ingestDocument) {
         IngestConditionalScript script =
             scriptService.compile(condition, IngestConditionalScript.CONTEXT).newInstance(condition.getParams());
-        return script.execute(new UnmodifiableIngestData(ingestDocument.getSourceAndMetadata()));
+        return script.execute(new UnmodifiableIngestData(
+                new DeprecationMap(ingestDocument.getSourceAndMetadata(), DEPRECATIONS, "conditional-processor")));
     }
 
     Processor getProcessor() {
diff --git a/server/src/main/java/org/elasticsearch/script/AbstractSortScript.java b/server/src/main/java/org/elasticsearch/script/AbstractSortScript.java
@@ -66,7 +66,7 @@ abstract class AbstractSortScript implements ScorerAware {
         this.leafLookup = lookup.getLeafSearchLookup(leafContext);
         Map<String, Object> parameters = new HashMap<>(params);
         parameters.putAll(leafLookup.asMap());
-        this.params = new DeprecationMap(parameters, DEPRECATIONS);
+        this.params = new DeprecationMap(parameters, DEPRECATIONS, "sort-script");
     }
 
     protected AbstractSortScript() {
diff --git a/server/src/main/java/org/elasticsearch/script/AggregationScript.java b/server/src/main/java/org/elasticsearch/script/AggregationScript.java
@@ -71,7 +71,7 @@ public abstract class AggregationScript implements ScorerAware {
     private Object value;
 
     public AggregationScript(Map<String, Object> params, SearchLookup lookup, LeafReaderContext leafContext) {
-        this.params = new DeprecationMap(new HashMap<>(params), DEPRECATIONS);
+        this.params = new DeprecationMap(new HashMap<>(params), DEPRECATIONS, "aggregation-script");
         this.leafLookup = lookup.getLeafSearchLookup(leafContext);
         this.params.putAll(leafLookup.asMap());
     }
diff --git a/server/src/main/java/org/elasticsearch/script/DeprecationMap.java b/server/src/main/java/org/elasticsearch/script/DeprecationMap.java
@@ -35,9 +35,12 @@ public final class DeprecationMap implements Map<String, Object> {
 
     private final Map<String, String> deprecations;
 
-    public DeprecationMap(Map<String, Object> delegate, Map<String, String> deprecations) {
+    private final String logKeyPrefix;
+
+    public DeprecationMap(Map<String, Object> delegate, Map<String, String> deprecations, String logKeyPrefix) {
         this.delegate = delegate;
         this.deprecations = deprecations;
+        this.logKeyPrefix = logKeyPrefix;
     }
 
     @Override
@@ -64,7 +67,7 @@ public boolean containsValue(final Object value) {
     public Object get(final Object key) {
         String deprecationMessage = deprecations.get(key);
         if (deprecationMessage != null) {
-            deprecationLogger.deprecated(deprecationMessage);
+            deprecationLogger.deprecatedAndMaybeLog(logKeyPrefix + "_" + key, deprecationMessage);
         }
         return delegate.get(key);
     }
diff --git a/server/src/main/java/org/elasticsearch/script/FieldScript.java b/server/src/main/java/org/elasticsearch/script/FieldScript.java
@@ -63,7 +63,7 @@ public FieldScript(Map<String, Object> params, SearchLookup lookup, LeafReaderCo
         this.leafLookup = lookup.getLeafSearchLookup(leafContext);
         params = new HashMap<>(params);
         params.putAll(leafLookup.asMap());
-        this.params = new DeprecationMap(params, DEPRECATIONS);
+        this.params = new DeprecationMap(params, DEPRECATIONS, "field-script");
     }
 
     // for expression engine
diff --git a/server/src/main/java/org/elasticsearch/script/ScoreScript.java b/server/src/main/java/org/elasticsearch/script/ScoreScript.java
@@ -73,7 +73,7 @@ public ScoreScript(Map<String, Object> params, SearchLookup lookup, LeafReaderCo
             this.leafLookup = lookup.getLeafSearchLookup(leafContext);
             params = new HashMap<>(params);
             params.putAll(leafLookup.asMap());
-            this.params = new DeprecationMap(params, DEPRECATIONS);
+            this.params = new DeprecationMap(params, DEPRECATIONS, "score-script");
         }
     }
 
diff --git a/server/src/main/java/org/elasticsearch/script/ScriptedMetricAggContexts.java b/server/src/main/java/org/elasticsearch/script/ScriptedMetricAggContexts.java
@@ -95,7 +95,7 @@ public MapScript(Map<String, Object> params, Map<String, Object> state, SearchLo
             if (leafLookup != null) {
                 params = new HashMap<>(params); // copy params so we aren't modifying input
                 params.putAll(leafLookup.asMap()); // add lookup vars
-                params = new DeprecationMap(params, DEPRECATIONS); // wrap with deprecations
+                params = new DeprecationMap(params, DEPRECATIONS, "map-script"); // wrap with deprecations
             }
             this.params = params;
         }
diff --git a/server/src/main/java/org/elasticsearch/script/TermsSetQueryScript.java b/server/src/main/java/org/elasticsearch/script/TermsSetQueryScript.java
@@ -64,7 +64,7 @@ public TermsSetQueryScript(Map<String, Object> params, SearchLookup lookup, Leaf
         Map<String, Object> parameters = new HashMap<>(params);
         this.leafLookup = lookup.getLeafSearchLookup(leafContext);
         parameters.putAll(leafLookup.asMap());
-        this.params = new DeprecationMap(parameters, DEPRECATIONS);
+        this.params = new DeprecationMap(parameters, DEPRECATIONS, "term-set-query-script");
     }
 
     protected TermsSetQueryScript() {
diff --git a/server/src/main/java/org/elasticsearch/script/UpdateScript.java b/server/src/main/java/org/elasticsearch/script/UpdateScript.java
@@ -20,13 +20,25 @@
 
 package org.elasticsearch.script;
 
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
  * An update script.
  */
 public abstract class UpdateScript {
 
+    private static final Map<String, String> DEPRECATIONS;
+    static {
+        Map<String, String> deprecations = new HashMap<>();
+        deprecations.put(
+                "_type",
+                "[types removal] Looking up doc types [_type] in scripts is deprecated."
+        );
+        DEPRECATIONS = Collections.unmodifiableMap(deprecations);
+    }
+
     public static final String[] PARAMETERS = { };
 
     /** The context used to compile {@link UpdateScript} factories. */
@@ -40,7 +52,7 @@ public abstract class UpdateScript {
 
     public UpdateScript(Map<String, Object> params, Map<String, Object> ctx) {
         this.params = params;
-        this.ctx = ctx;
+        this.ctx = new DeprecationMap(ctx, DEPRECATIONS, "update-script");
     }
 
     /** Return the parameters for this script. */
diff --git a/server/src/main/java/org/elasticsearch/search/lookup/LeafDocLookup.java b/server/src/main/java/org/elasticsearch/search/lookup/LeafDocLookup.java
@@ -44,7 +44,7 @@ public class LeafDocLookup implements Map<String, ScriptDocValues<?>> {
             = new DeprecationLogger(LogManager.getLogger(LeafDocLookup.class));
     static final String TYPES_DEPRECATION_KEY = "type-field-doc-lookup";
     static final String TYPES_DEPRECATION_MESSAGE =
-            "[types removal] Looking up doc types in scripts is deprecated.";
+            "[types removal] Looking up doc types [_type] in scripts is deprecated.";
 
     private final Map<String, ScriptDocValues<?>> localCacheFieldData = new HashMap<>(4);
 
diff --git a/server/src/test/java/org/elasticsearch/ingest/ConditionalProcessorTests.java b/server/src/test/java/org/elasticsearch/ingest/ConditionalProcessorTests.java
@@ -133,6 +133,54 @@ public void testActsOnImmutableData() throws Exception {
         assertMutatingCtxThrows(ctx -> ((List<Object>)ctx.get("listField")).remove("bar"));
     }
 
+    public void testTypeDeprecation() throws Exception {
+        String scriptName = "conditionalScript";
+        ScriptService scriptService = new ScriptService(Settings.builder().build(),
+                Collections.singletonMap(
+                        Script.DEFAULT_SCRIPT_LANG,
+                        new MockScriptEngine(
+                                Script.DEFAULT_SCRIPT_LANG,
+                                Collections.singletonMap(
+                                        scriptName, ctx -> {
+                                                ctx.get("_type");
+                                                return true;
+                                        }
+                                ),
+                                Collections.emptyMap()
+                        )
+                ),
+                new HashMap<>(ScriptModule.CORE_CONTEXTS)
+        );
+
+        LongSupplier relativeTimeProvider = mock(LongSupplier.class);
+        when(relativeTimeProvider.getAsLong()).thenReturn(0L, TimeUnit.MILLISECONDS.toNanos(1), 0L, TimeUnit.MILLISECONDS.toNanos(2));
+        ConditionalProcessor processor = new ConditionalProcessor(
+                randomAlphaOfLength(10),
+                new Script(
+                        ScriptType.INLINE, Script.DEFAULT_SCRIPT_LANG,
+                        scriptName, Collections.emptyMap()), scriptService,
+                new Processor() {
+                    @Override
+                    public IngestDocument execute(final IngestDocument ingestDocument){
+                        return ingestDocument;
+                    }
+
+                    @Override
+                    public String getType() {
+                        return null;
+                    }
+
+                    @Override
+                    public String getTag() {
+                        return null;
+                    }
+                }, relativeTimeProvider);
+
+        IngestDocument ingestDocument = RandomDocumentPicks.randomIngestDocument(random(), Collections.emptyMap());
+        processor.execute(ingestDocument);
+        assertWarnings("[types removal] Looking up doc types [_type] in scripts is deprecated.");
+    }
+
     private static void assertMutatingCtxThrows(Consumer<Map<String, Object>> mutation) throws Exception {
         String scriptName = "conditionalScript";
         CompletableFuture<Exception> expectedException = new CompletableFuture<>();

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ abstract class AbstractSortScript implements ScorerAware {`
`66`	`66`	`this.leafLookup = lookup.getLeafSearchLookup(leafContext);`
`67`	`67`	`Map<String, Object> parameters = new HashMap<>(params);`
`68`	`68`	`parameters.putAll(leafLookup.asMap());`
`69`		`- this.params = new DeprecationMap(parameters, DEPRECATIONS);`
	`69`	`+ this.params = new DeprecationMap(parameters, DEPRECATIONS, "sort-script");`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`protected AbstractSortScript() {`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public abstract class AggregationScript implements ScorerAware {`
`71`	`71`	`private Object value;`
`72`	`72`
`73`	`73`	`public AggregationScript(Map<String, Object> params, SearchLookup lookup, LeafReaderContext leafContext) {`
`74`		`- this.params = new DeprecationMap(new HashMap<>(params), DEPRECATIONS);`
	`74`	`+ this.params = new DeprecationMap(new HashMap<>(params), DEPRECATIONS, "aggregation-script");`
`75`	`75`	`this.leafLookup = lookup.getLeafSearchLookup(leafContext);`
`76`	`76`	`this.params.putAll(leafLookup.asMap());`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,12 @@ public final class DeprecationMap implements Map<String, Object> {`
`35`	`35`
`36`	`36`	`private final Map<String, String> deprecations;`
`37`	`37`
`38`		`- public DeprecationMap(Map<String, Object> delegate, Map<String, String> deprecations) {`
	`38`	`+ private final String logKeyPrefix;`
	`39`	`+`
	`40`	`+ public DeprecationMap(Map<String, Object> delegate, Map<String, String> deprecations, String logKeyPrefix) {`
`39`	`41`	`this.delegate = delegate;`
`40`	`42`	`this.deprecations = deprecations;`
	`43`	`+ this.logKeyPrefix = logKeyPrefix;`
`41`	`44`	`}`
`42`	`45`
`43`	`46`	`@Override`
`@@ -64,7 +67,7 @@ public boolean containsValue(final Object value) {`
`64`	`67`	`public Object get(final Object key) {`
`65`	`68`	`String deprecationMessage = deprecations.get(key);`
`66`	`69`	`if (deprecationMessage != null) {`
`67`		`- deprecationLogger.deprecated(deprecationMessage);`
	`70`	`+ deprecationLogger.deprecatedAndMaybeLog(logKeyPrefix + "_" + key, deprecationMessage);`
`68`	`71`	`}`
`69`	`72`	`return delegate.get(key);`
`70`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public FieldScript(Map<String, Object> params, SearchLookup lookup, LeafReaderCo`
`63`	`63`	`this.leafLookup = lookup.getLeafSearchLookup(leafContext);`
`64`	`64`	`params = new HashMap<>(params);`
`65`	`65`	`params.putAll(leafLookup.asMap());`
`66`		`- this.params = new DeprecationMap(params, DEPRECATIONS);`
	`66`	`+ this.params = new DeprecationMap(params, DEPRECATIONS, "field-script");`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`// for expression engine`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public ScoreScript(Map<String, Object> params, SearchLookup lookup, LeafReaderCo`
`73`	`73`	`this.leafLookup = lookup.getLeafSearchLookup(leafContext);`
`74`	`74`	`params = new HashMap<>(params);`
`75`	`75`	`params.putAll(leafLookup.asMap());`
`76`		`- this.params = new DeprecationMap(params, DEPRECATIONS);`
	`76`	`+ this.params = new DeprecationMap(params, DEPRECATIONS, "score-script");`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public MapScript(Map<String, Object> params, Map<String, Object> state, SearchLo`
`95`	`95`	`if (leafLookup != null) {`
`96`	`96`	`params = new HashMap<>(params); // copy params so we aren't modifying input`
`97`	`97`	`params.putAll(leafLookup.asMap()); // add lookup vars`
`98`		`- params = new DeprecationMap(params, DEPRECATIONS); // wrap with deprecations`
	`98`	`+ params = new DeprecationMap(params, DEPRECATIONS, "map-script"); // wrap with deprecations`
`99`	`99`	`}`
`100`	`100`	`this.params = params;`
`101`	`101`	`}`