RestHandlers declare handled routes (#52123)

This commit changes how RestHandlers are registered with the RestController so that a RestHandler no longer needs to register itself with the RestController. Instead the RestHandler interface has new methods which when called provide information about the routes (method and path combinations) that are handled by the handler including any deprecated and/or replaced combinations. This change also makes the publication of RestHandlers safe since they no longer publish a reference to themselves within their constructors. Closes #51622 Co-authored-by: Jason Tedor <jason@tedor.me> Backport of #51950
elastic · Feb 10, 2020 · 3edadfe · 3edadfe
1 parent 8c0b49c
commit 3edadfe
Show file tree

Hide file tree

Showing 396 changed files with 4,251 additions and 2,313 deletions.
diff --git a/...ent-benchmark-noop-api-plugin/src/main/java/org/elasticsearch/plugin/noop/NoopPlugin.java b/...ent-benchmark-noop-api-plugin/src/main/java/org/elasticsearch/plugin/noop/NoopPlugin.java
@@ -55,7 +55,7 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
             IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver,
             Supplier<DiscoveryNodes> nodesInCluster) {
         return Arrays.asList(
-                new RestNoopBulkAction(restController),
-                new RestNoopSearchAction(restController));
+                new RestNoopBulkAction(),
+                new RestNoopSearchAction());
     }
 }
diff --git a/...pi-plugin/src/main/java/org/elasticsearch/plugin/noop/action/bulk/RestNoopBulkAction.java b/...pi-plugin/src/main/java/org/elasticsearch/plugin/noop/action/bulk/RestNoopBulkAction.java
@@ -32,26 +32,30 @@
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.BytesRestResponse;
 import org.elasticsearch.rest.RestChannel;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.RestResponse;
 import org.elasticsearch.rest.action.RestBuilderListener;
 
 import java.io.IOException;
+import java.util.List;
 
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
 import static org.elasticsearch.rest.RestRequest.Method.PUT;
 import static org.elasticsearch.rest.RestStatus.OK;
 
 public class RestNoopBulkAction extends BaseRestHandler {
 
-    public RestNoopBulkAction(RestController controller) {
-        controller.registerHandler(POST, "/_noop_bulk", this);
-        controller.registerHandler(PUT, "/_noop_bulk", this);
-        controller.registerHandler(POST, "/{index}/_noop_bulk", this);
-        controller.registerHandler(PUT, "/{index}/_noop_bulk", this);
-        controller.registerHandler(POST, "/{index}/{type}/_noop_bulk", this);
-        controller.registerHandler(PUT, "/{index}/{type}/_noop_bulk", this);
+    @Override
+    public List<Route> routes() {
+        return unmodifiableList(asList(
+            new Route(POST, "/_noop_bulk"),
+            new Route(PUT, "/_noop_bulk"),
+            new Route(POST, "/{index}/_noop_bulk"),
+            new Route(PUT, "/{index}/_noop_bulk"),
+            new Route(POST, "/{index}/{type}/_noop_bulk"),
+            new Route(PUT, "/{index}/{type}/_noop_bulk")));
     }
 
     @Override

diff --git a/...lugin/src/main/java/org/elasticsearch/plugin/noop/action/search/RestNoopSearchAction.java b/...lugin/src/main/java/org/elasticsearch/plugin/noop/action/search/RestNoopSearchAction.java
@@ -21,22 +21,27 @@
 import org.elasticsearch.action.search.SearchRequest;
 import org.elasticsearch.client.node.NodeClient;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestStatusToXContentListener;
 
+import java.util.List;
+
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
 
 public class RestNoopSearchAction extends BaseRestHandler {
 
-    public RestNoopSearchAction(RestController controller) {
-        controller.registerHandler(GET, "/_noop_search", this);
-        controller.registerHandler(POST, "/_noop_search", this);
-        controller.registerHandler(GET, "/{index}/_noop_search", this);
-        controller.registerHandler(POST, "/{index}/_noop_search", this);
-        controller.registerHandler(GET, "/{index}/{type}/_noop_search", this);
-        controller.registerHandler(POST, "/{index}/{type}/_noop_search", this);
+    @Override
+    public List<Route> routes() {
+        return unmodifiableList(asList(
+            new Route(GET, "/_noop_search"),
+            new Route(POST, "/_noop_search"),
+            new Route(GET, "/{index}/_noop_search"),
+            new Route(POST, "/{index}/_noop_search"),
+            new Route(GET, "/{index}/{type}/_noop_search"),
+            new Route(POST, "/{index}/{type}/_noop_search")));
     }
 
     @Override

diff --git a/...s/ingest-common/src/main/java/org/elasticsearch/ingest/common/GrokProcessorGetAction.java b/...s/ingest-common/src/main/java/org/elasticsearch/ingest/common/GrokProcessorGetAction.java
@@ -32,15 +32,16 @@
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
 
 import java.io.IOException;
+import java.util.List;
 import java.util.Map;
 
+import static java.util.Collections.singletonList;
 import static org.elasticsearch.ingest.common.IngestCommonPlugin.GROK_PATTERNS;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 
@@ -116,8 +117,10 @@ protected void doExecute(Task task, Request request, ActionListener<Response> li
     }
 
     public static class RestAction extends BaseRestHandler {
-        RestAction(RestController controller) {
-            controller.registerHandler(GET, "/_ingest/processor/grok", this);
+
+        @Override
+        public List<Route> routes() {
+            return singletonList(new Route(GET, "/_ingest/processor/grok"));
         }
 
         @Override

diff --git a/modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/IngestCommonPlugin.java b/modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/IngestCommonPlugin.java
@@ -102,7 +102,7 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
                                              IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter,
                                              IndexNameExpressionResolver indexNameExpressionResolver,
                                              Supplier<DiscoveryNodes> nodesInCluster) {
-        return Arrays.asList(new GrokProcessorGetAction.RestAction(restController));
+        return Collections.singletonList(new GrokProcessorGetAction.RestAction());
     }
 
     @Override

diff --git a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MustachePlugin.java b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MustachePlugin.java
@@ -59,8 +59,8 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
             IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver,
             Supplier<DiscoveryNodes> nodesInCluster) {
         return Arrays.asList(
-                new RestSearchTemplateAction(restController),
-                new RestMultiSearchTemplateAction(settings, restController),
-                new RestRenderSearchTemplateAction(restController));
+                new RestSearchTemplateAction(),
+                new RestMultiSearchTemplateAction(settings),
+                new RestRenderSearchTemplateAction());
     }
 }
diff --git a/...stache/src/main/java/org/elasticsearch/script/mustache/RestMultiSearchTemplateAction.java b/...stache/src/main/java/org/elasticsearch/script/mustache/RestMultiSearchTemplateAction.java
@@ -24,18 +24,19 @@
 import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.rest.action.search.RestMultiSearchAction;
 import org.elasticsearch.rest.action.search.RestSearchAction;
 
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
 
@@ -49,25 +50,28 @@ public class RestMultiSearchTemplateAction extends BaseRestHandler {
 
     static {
         final Set<String> responseParams = new HashSet<>(
-            Arrays.asList(RestSearchAction.TYPED_KEYS_PARAM, RestSearchAction.TOTAL_HITS_AS_INT_PARAM)
+            asList(RestSearchAction.TYPED_KEYS_PARAM, RestSearchAction.TOTAL_HITS_AS_INT_PARAM)
         );
         RESPONSE_PARAMS = Collections.unmodifiableSet(responseParams);
     }
 
 
     private final boolean allowExplicitIndex;
 
-    public RestMultiSearchTemplateAction(Settings settings, RestController controller) {
+    public RestMultiSearchTemplateAction(Settings settings) {
         this.allowExplicitIndex = MULTI_ALLOW_EXPLICIT_INDEX.get(settings);
+    }
 
-        controller.registerHandler(GET, "/_msearch/template", this);
-        controller.registerHandler(POST, "/_msearch/template", this);
-        controller.registerHandler(GET, "/{index}/_msearch/template", this);
-        controller.registerHandler(POST, "/{index}/_msearch/template", this);
-
-        // Deprecated typed endpoints.
-        controller.registerHandler(GET, "/{index}/{type}/_msearch/template", this);
-        controller.registerHandler(POST, "/{index}/{type}/_msearch/template", this);
+    @Override
+    public List<Route> routes() {
+        return unmodifiableList(asList(
+            new Route(GET, "/_msearch/template"),
+            new Route(POST, "/_msearch/template"),
+            new Route(GET, "/{index}/_msearch/template"),
+            new Route(POST, "/{index}/_msearch/template"),
+            // Deprecated typed endpoints.
+            new Route(GET, "/{index}/{type}/_msearch/template"),
+            new Route(POST, "/{index}/{type}/_msearch/template")));
     }
 
     @Override

diff --git a/...tache/src/main/java/org/elasticsearch/script/mustache/RestRenderSearchTemplateAction.java b/...tache/src/main/java/org/elasticsearch/script/mustache/RestRenderSearchTemplateAction.java
@@ -22,23 +22,27 @@
 import org.elasticsearch.client.node.NodeClient;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.script.ScriptType;
 
 import java.io.IOException;
+import java.util.List;
 
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
 
 public class RestRenderSearchTemplateAction extends BaseRestHandler {
 
-    public RestRenderSearchTemplateAction(RestController controller) {
-        controller.registerHandler(GET, "/_render/template", this);
-        controller.registerHandler(POST, "/_render/template", this);
-        controller.registerHandler(GET, "/_render/template/{id}", this);
-        controller.registerHandler(POST, "/_render/template/{id}", this);
+    @Override
+    public List<Route> routes() {
+        return unmodifiableList(asList(
+            new Route(GET, "/_render/template"),
+            new Route(POST, "/_render/template"),
+            new Route(GET, "/_render/template/{id}"),
+            new Route(POST, "/_render/template/{id}")));
     }
 
     @Override

diff --git a/...ng-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java b/...ng-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java
@@ -23,7 +23,6 @@
 import org.elasticsearch.client.node.NodeClient;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestStatusToXContentListener;
 import org.elasticsearch.rest.action.search.RestSearchAction;
@@ -32,8 +31,11 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
 
@@ -46,15 +48,16 @@ public class RestSearchTemplateAction extends BaseRestHandler {
         RESPONSE_PARAMS = Collections.unmodifiableSet(responseParams);
     }
 
-    public RestSearchTemplateAction(RestController controller) {
-        controller.registerHandler(GET, "/_search/template", this);
-        controller.registerHandler(POST, "/_search/template", this);
-        controller.registerHandler(GET, "/{index}/_search/template", this);
-        controller.registerHandler(POST, "/{index}/_search/template", this);
-
-        // Deprecated typed endpoints.
-        controller.registerHandler(GET, "/{index}/{type}/_search/template", this);
-        controller.registerHandler(POST, "/{index}/{type}/_search/template", this);
+    @Override
+    public List<Route> routes() {
+        return unmodifiableList(asList(
+            new Route(GET, "/_search/template"),
+            new Route(POST, "/_search/template"),
+            new Route(GET, "/{index}/_search/template"),
+            new Route(POST, "/{index}/_search/template"),
+            // Deprecated typed endpoints.
+            new Route(GET, "/{index}/{type}/_search/template"),
+            new Route(POST, "/{index}/{type}/_search/template")));
     }
 
     @Override

diff --git a/...e/src/test/java/org/elasticsearch/script/mustache/RestMultiSearchTemplateActionTests.java b/...e/src/test/java/org/elasticsearch/script/mustache/RestMultiSearchTemplateActionTests.java
@@ -32,7 +32,7 @@ public class RestMultiSearchTemplateActionTests extends RestActionTestCase {
 
     @Before
     public void setUpAction() {
-        new RestMultiSearchTemplateAction(Settings.EMPTY, controller());
+        controller().registerHandler(new RestMultiSearchTemplateAction(Settings.EMPTY));
     }
 
     public void testTypeInPath() {

diff --git a/...stache/src/test/java/org/elasticsearch/script/mustache/RestSearchTemplateActionTests.java b/...stache/src/test/java/org/elasticsearch/script/mustache/RestSearchTemplateActionTests.java
@@ -31,7 +31,7 @@ public class RestSearchTemplateActionTests extends RestActionTestCase {
 
     @Before
     public void setUpAction() {
-        new RestSearchTemplateAction(controller());
+        controller().registerHandler(new RestSearchTemplateAction());
     }
 
     public void testTypeInPath() {

diff --git a/modules/lang-painless/src/main/java/org/elasticsearch/painless/PainlessPlugin.java b/modules/lang-painless/src/main/java/org/elasticsearch/painless/PainlessPlugin.java
@@ -142,8 +142,8 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
                                              IndexNameExpressionResolver indexNameExpressionResolver,
                                              Supplier<DiscoveryNodes> nodesInCluster) {
         List<RestHandler> handlers = new ArrayList<>();
-        handlers.add(new PainlessExecuteAction.RestAction(restController));
-        handlers.add(new PainlessContextAction.RestAction(restController));
+        handlers.add(new PainlessExecuteAction.RestAction());
+        handlers.add(new PainlessContextAction.RestAction());
         return handlers;
     }
 }
diff --git a/.../lang-painless/src/main/java/org/elasticsearch/painless/action/PainlessContextAction.java b/.../lang-painless/src/main/java/org/elasticsearch/painless/action/PainlessContextAction.java
@@ -37,7 +37,6 @@
 import org.elasticsearch.painless.PainlessScriptEngine;
 import org.elasticsearch.painless.lookup.PainlessLookup;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.script.ScriptContext;
@@ -52,6 +51,7 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
+import static java.util.Collections.singletonList;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 
 /**
@@ -194,8 +194,9 @@ protected void doExecute(Task task, Request request, ActionListener<Response> li
 
     public static class RestAction extends BaseRestHandler {
 
-        public RestAction(RestController controller) {
-            controller.registerHandler(GET, "/_scripts/painless/_context", this);
+        @Override
+        public List<Route> routes() {
+            return singletonList(new Route(GET, "/_scripts/painless/_context"));
         }
 
         @Override

diff --git a/.../lang-painless/src/main/java/org/elasticsearch/painless/action/PainlessExecuteAction.java b/.../lang-painless/src/main/java/org/elasticsearch/painless/action/PainlessExecuteAction.java
@@ -69,7 +69,6 @@
 import org.elasticsearch.index.shard.ShardId;
 import org.elasticsearch.indices.IndicesService;
 import org.elasticsearch.rest.BaseRestHandler;
-import org.elasticsearch.rest.RestController;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.script.FilterScript;
@@ -84,9 +83,12 @@
 import java.io.IOException;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 import static org.elasticsearch.rest.RestRequest.Method.POST;
@@ -584,9 +586,11 @@ private static Response prepareRamIndex(Request request,
 
     public static class RestAction extends BaseRestHandler {
 
-        public RestAction(RestController controller) {
-            controller.registerHandler(GET, "/_scripts/painless/_execute", this);
-            controller.registerHandler(POST, "/_scripts/painless/_execute", this);
+        @Override
+        public List<Route> routes() {
+            return unmodifiableList(asList(
+                new Route(GET, "/_scripts/painless/_execute"),
+                new Route(POST, "/_scripts/painless/_execute")));
         }
 
         @Override

diff --git a/modules/rank-eval/src/main/java/org/elasticsearch/index/rankeval/RankEvalPlugin.java b/modules/rank-eval/src/main/java/org/elasticsearch/index/rankeval/RankEvalPlugin.java
@@ -36,6 +36,7 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.function.Supplier;
 
@@ -50,7 +51,7 @@ public class RankEvalPlugin extends Plugin implements ActionPlugin {
     public List<RestHandler> getRestHandlers(Settings settings, RestController restController, ClusterSettings clusterSettings,
             IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver,
             Supplier<DiscoveryNodes> nodesInCluster) {
-        return Arrays.asList(new RestRankEvalAction(restController));
+        return Collections.singletonList(new RestRankEvalAction());
     }
 
     @Override