[Transform] add method to collect deprecations from a transform confi…

…guration (#77565) (#77752) add checkForDeprecations to TransformConfig and implement deprecation checks
elastic · Sep 15, 2021 · a246cc9 · a246cc9
1 parent cfa1a34
commit a246cc9
Show file tree

Hide file tree

Showing 36 changed files with 415 additions and 59 deletions.
diff --git a/...h/xpack/deprecation/DeprecationIssue.java → ...ck/core/deprecation/DeprecationIssue.java b/...h/xpack/deprecation/DeprecationIssue.java → ...ck/core/deprecation/DeprecationIssue.java
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-package org.elasticsearch.xpack.deprecation;
+package org.elasticsearch.xpack.core.deprecation;
 
 import org.elasticsearch.Version;
 import org.elasticsearch.core.Nullable;

diff --git a/...oggingDeprecationAccumulationHandler.java → ...oggingDeprecationAccumulationHandler.java b/...oggingDeprecationAccumulationHandler.java → ...oggingDeprecationAccumulationHandler.java
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-package org.elasticsearch.xpack.core.ml.utils;
+package org.elasticsearch.xpack.core.deprecation;
 
 import org.elasticsearch.common.logging.LoggerMessageFormat;
 import org.elasticsearch.common.xcontent.DeprecationHandler;

diff --git a/...n/core/src/main/java/org/elasticsearch/xpack/core/ml/utils/XContentObjectTransformer.java b/...n/core/src/main/java/org/elasticsearch/xpack/core/ml/utils/XContentObjectTransformer.java
@@ -19,6 +19,7 @@
 import org.elasticsearch.index.query.AbstractQueryBuilder;
 import org.elasticsearch.index.query.QueryBuilder;
 import org.elasticsearch.search.aggregations.AggregatorFactories;
+import org.elasticsearch.xpack.core.deprecation.LoggingDeprecationAccumulationHandler;
 
 import java.io.IOException;
 import java.util.ArrayList;

diff --git a/...ugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java b/...ugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+package org.elasticsearch.xpack.core.transform;
+
+public class TransformDeprecations {
+    public static final String BREAKING_CHANGES_BASE_URL =
+        "https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-8.0.html";
+
+    public static final String QUERY_BREAKING_CHANGES_URL = BREAKING_CHANGES_BASE_URL + "#breaking_80_search_changes";
+
+    public static final String AGGS_BREAKING_CHANGES_URL = BREAKING_CHANGES_BASE_URL + "#breaking_80_aggregations_changes";
+
+    private TransformDeprecations() {}
+}
diff --git a/...ugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/DestConfig.java b/...ugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/DestConfig.java
@@ -9,18 +9,21 @@
 
 import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionRequestValidationException;
-import org.elasticsearch.common.xcontent.ParseField;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
+import org.elasticsearch.common.xcontent.ParseField;
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
 import org.elasticsearch.xpack.core.transform.utils.ExceptionsHelper;
 
 import java.io.IOException;
 import java.util.Objects;
+import java.util.function.Consumer;
 
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
@@ -75,6 +78,9 @@ public ActionRequestValidationException validate(ActionRequestValidationExceptio
         return validationException;
     }
 
+    public void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation) {
+    }
+
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         out.writeString(index);

diff --git a/...gin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/QueryConfig.java b/...gin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/QueryConfig.java
@@ -15,6 +15,7 @@
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.io.stream.Writeable;
+import org.elasticsearch.common.xcontent.DeprecationHandler;
 import org.elasticsearch.common.xcontent.LoggingDeprecationHandler;
 import org.elasticsearch.common.xcontent.NamedXContentRegistry;
 import org.elasticsearch.common.xcontent.ToXContentObject;
@@ -25,12 +26,17 @@
 import org.elasticsearch.index.query.AbstractQueryBuilder;
 import org.elasticsearch.index.query.MatchAllQueryBuilder;
 import org.elasticsearch.index.query.QueryBuilder;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue.Level;
+import org.elasticsearch.xpack.core.deprecation.LoggingDeprecationAccumulationHandler;
+import org.elasticsearch.xpack.core.transform.TransformDeprecations;
 import org.elasticsearch.xpack.core.transform.TransformMessages;
 
 import java.io.IOException;
 import java.util.Collections;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.Consumer;
 
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 
@@ -83,10 +89,8 @@ public static QueryConfig fromXContent(final XContentParser parser, boolean leni
         Map<String, Object> source = parser.mapOrdered();
         QueryBuilder query = null;
 
-        try (XContentBuilder xContentBuilder = XContentFactory.jsonBuilder().map(source);
-                XContentParser sourceParser = XContentType.JSON.xContent().createParser(registry, LoggingDeprecationHandler.INSTANCE,
-                        BytesReference.bytes(xContentBuilder).streamInput())) {
-            query = AbstractQueryBuilder.parseInnerQueryBuilder(sourceParser);
+        try {
+            query = queryFromXContent(source, registry, LoggingDeprecationHandler.INSTANCE);
         } catch (Exception e) {
             if (lenient) {
                 logger.warn(TransformMessages.LOG_TRANSFORM_CONFIGURATION_BAD_QUERY, e);
@@ -98,6 +102,20 @@ public static QueryConfig fromXContent(final XContentParser parser, boolean leni
         return new QueryConfig(source, query);
     }
 
+    private static QueryBuilder queryFromXContent(
+        Map<String, Object> source,
+        NamedXContentRegistry namedXContentRegistry,
+        DeprecationHandler deprecationHandler
+    ) throws IOException {
+        QueryBuilder query = null;
+        XContentBuilder xContentBuilder = XContentFactory.jsonBuilder().map(source);
+        XContentParser sourceParser = XContentType.JSON.xContent()
+            .createParser(namedXContentRegistry, deprecationHandler, BytesReference.bytes(xContentBuilder).streamInput());
+        query = AbstractQueryBuilder.parseInnerQueryBuilder(sourceParser);
+
+        return query;
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(source, query);
@@ -124,4 +142,37 @@ public ActionRequestValidationException validate(ActionRequestValidationExceptio
         }
         return validationException;
     }
+
+    public void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation) {
+        LoggingDeprecationAccumulationHandler deprecationLogger = new LoggingDeprecationAccumulationHandler();
+
+        try {
+            queryFromXContent(source, namedXContentRegistry, deprecationLogger);
+        } catch (IOException e) {
+            onDeprecation.accept(
+                new DeprecationIssue(
+                    Level.CRITICAL,
+                    "Transform [" + id + "]: " + TransformMessages.LOG_TRANSFORM_CONFIGURATION_BAD_QUERY,
+                    TransformDeprecations.QUERY_BREAKING_CHANGES_URL,
+                    e.getMessage(),
+                    false,
+                    null
+                )
+            );
+        }
+
+        deprecationLogger.getDeprecations().forEach(deprecationMessage -> {
+            onDeprecation.accept(
+                new DeprecationIssue(
+                    Level.CRITICAL,
+                    "Transform [" + id + "] uses deprecated query options",
+                    TransformDeprecations.QUERY_BREAKING_CHANGES_URL,
+                    deprecationMessage,
+                    false,
+                    null
+                )
+            );
+        });
+
+    }
 }
diff --git a/...rc/main/java/org/elasticsearch/xpack/core/transform/transforms/RetentionPolicyConfig.java b/...rc/main/java/org/elasticsearch/xpack/core/transform/transforms/RetentionPolicyConfig.java
@@ -9,8 +9,14 @@
 
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.common.io.stream.NamedWriteable;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
 import org.elasticsearch.common.xcontent.ToXContentObject;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
+
+import java.util.function.Consumer;
 
 public interface RetentionPolicyConfig extends ToXContentObject, NamedWriteable {
     ActionRequestValidationException validate(ActionRequestValidationException validationException);
+
+    void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation);
 }
diff --git a/.../core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/SettingsConfig.java b/.../core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/SettingsConfig.java
@@ -14,15 +14,18 @@
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
 import org.elasticsearch.common.xcontent.ObjectParser.ValueType;
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.search.aggregations.MultiBucketConsumerService;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
 import org.elasticsearch.xpack.core.transform.TransformField;
 
 import java.io.IOException;
 import java.util.Objects;
+import java.util.function.Consumer;
 
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg;
@@ -139,6 +142,9 @@ public ActionRequestValidationException validate(ActionRequestValidationExceptio
         return validationException;
     }
 
+    public void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation) {
+    }
+
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         out.writeOptionalInt(maxPageSearchSize);

diff --git a/...in/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/SourceConfig.java b/...in/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/SourceConfig.java
@@ -9,17 +9,19 @@
 
 import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionRequestValidationException;
-import org.elasticsearch.common.xcontent.ParseField;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
+import org.elasticsearch.common.xcontent.ParseField;
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.license.RemoteClusterLicenseChecker;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
 import org.elasticsearch.xpack.core.transform.TransformField;
 import org.elasticsearch.xpack.core.transform.utils.ExceptionsHelper;
 
@@ -29,6 +31,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.Consumer;
 
 import static java.util.stream.Collectors.toMap;
 import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
@@ -129,6 +132,10 @@ public ActionRequestValidationException validate(ActionRequestValidationExceptio
         return queryConfig.validate(validationException);
     }
 
+    public void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation) {
+        queryConfig.checkForDeprecations(id, namedXContentRegistry, onDeprecation);
+    }
+
     public boolean requiresRemoteCluster() {
         return Arrays.stream(index).anyMatch(RemoteClusterLicenseChecker::isRemoteIndex);
     }

diff --git a/...ain/java/org/elasticsearch/xpack/core/transform/transforms/TimeRetentionPolicyConfig.java b/...ain/java/org/elasticsearch/xpack/core/transform/transforms/TimeRetentionPolicyConfig.java
@@ -11,16 +11,19 @@
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
 import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.core.TimeValue;
+import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
 import org.elasticsearch.xpack.core.transform.TransformField;
 import org.elasticsearch.xpack.core.transform.utils.ExceptionsHelper;
 
 import java.io.IOException;
 import java.util.Objects;
+import java.util.function.Consumer;
 
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
@@ -90,6 +93,10 @@ public ActionRequestValidationException validate(ActionRequestValidationExceptio
         return validationException;
     }
 
+    @Override
+    public void checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation) {
+    }
+
     @Override
     public void writeTo(final StreamOutput out) throws IOException {
         out.writeString(field);