Expand get-views to cover use cases for listing views

craigtaverner · craigtaverner · commit 73da7cda9232 · 2025-11-12T12:50:04.000+01:00
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_view.json b/rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_view.json
@@ -23,10 +23,16 @@
           ],
           "parts": {
             "name": {
-              "type": "string",
-              "description": "The name of the view to get"
+              "type": "list",
+              "description": "A comma-separated list of view names"
             }
           }
+        },
+        {
+          "path": "/_query/view",
+          "methods": [
+            "GET"
+          ]
         }
       ]
     }
diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/GetViewAction.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/GetViewAction.java
@@ -6,18 +6,24 @@
  */
 package org.elasticsearch.xpack.esql.view;
 
-import org.elasticsearch.action.ActionRequest;
-import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.action.ActionType;
 import org.elasticsearch.action.support.TransportAction;
+import org.elasticsearch.action.support.local.LocalClusterStateRequest;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.common.xcontent.ChunkedToXContentHelper;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.xcontent.ToXContentObject;
 import org.elasticsearch.xcontent.XContentBuilder;
 
 import java.io.IOException;
+import java.util.List;
+import java.util.Map;
 import java.util.Objects;
+import java.util.TreeMap;
+
+import static org.elasticsearch.xpack.esql.view.ViewMetadata.VIEWS;
 
 public class GetViewAction extends ActionType<GetViewAction.Response> {
 
@@ -28,56 +34,48 @@ private GetViewAction() {
         super(NAME);
     }
 
-    public static class Request extends ActionRequest {
-        private String name;
+    public static class Request extends LocalClusterStateRequest {
+        private List<String> names;
 
-        public Request(String name) {
-            this.name = Objects.requireNonNull(name, "name cannot be null");
+        public Request(TimeValue masterNodeTimeout, String... names) {
+            super(masterNodeTimeout);
+            this.names = List.of(names);
         }
 
         public Request(StreamInput in) throws IOException {
             super(in);
         }
 
-        @Override
-        public void writeTo(StreamOutput out) throws IOException {
-            super.writeTo(out);
-            out.writeString(name);
-        }
-
-        public String name() {
-            return name;
-        }
-
-        @Override
-        public ActionRequestValidationException validate() {
-            return null;
+        public List<String> names() {
+            return names;
         }
 
         @Override
         public boolean equals(Object o) {
             if (this == o) return true;
             if (o == null || getClass() != o.getClass()) return false;
             Request request = (Request) o;
-            return name.equals(request.name);
+            return Objects.equals(names, request.names);
         }
 
         @Override
         public int hashCode() {
-            return name.hashCode();
+            return Objects.hash(names);
         }
     }
 
     public static class Response extends ActionResponse implements ToXContentObject {
 
-        private final View view;
+        private final Map<String, View> views;
 
-        public Response(final View view) {
-            this.view = view;
+        public Response(Map<String, View> views) {
+            Objects.requireNonNull(views, "views cannot be null");
+            // use a treemap to guarantee ordering in the set, then transform it to the list of named policies
+            this.views = new TreeMap<>(views);
         }
 
-        public View getView() {
-            return view;
+        public Map<String, View> getViews() {
+            return views;
         }
 
         @Override
@@ -88,7 +86,10 @@ public void writeTo(StreamOutput out) throws IOException {
         @Override
         public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
             builder.startObject();
-            view.toXContent(builder, params);
+            var v = ChunkedToXContentHelper.xContentObjectFieldObjects(VIEWS.getPreferredName(), views);
+            while (v.hasNext()) {
+                v.next().toXContent(builder, params);
+            }
             builder.endObject();
             return builder;
         }
@@ -101,17 +102,17 @@ public boolean equals(Object o) {
             if (o == null || getClass() != o.getClass()) {
                 return false;
             }
-            return view.equals(((Response) o).view);
+            return views.equals(((Response) o).views);
         }
 
         @Override
         public int hashCode() {
-            return view.hashCode();
+            return views.hashCode();
         }
 
         @Override
         public String toString() {
-            return "GetViewAction.Response{view=" + view.toString() + '}';
+            return "GetViewAction.Response{" + views.toString() + '}';
         }
     }
 }
diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/RestGetViewAction.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/RestGetViewAction.java
@@ -8,10 +8,13 @@
 package org.elasticsearch.xpack.esql.view;
 
 import org.elasticsearch.client.internal.node.NodeClient;
+import org.elasticsearch.common.Strings;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
+import org.elasticsearch.rest.RestUtils;
 import org.elasticsearch.rest.Scope;
 import org.elasticsearch.rest.ServerlessScope;
+import org.elasticsearch.rest.action.RestCancellableNodeClient;
 import org.elasticsearch.rest.action.RestToXContentListener;
 
 import java.io.IOException;
@@ -23,7 +26,7 @@
 public class RestGetViewAction extends BaseRestHandler {
     @Override
     public List<Route> routes() {
-        return List.of(new Route(GET, "/_query/view/{name}"));
+        return List.of(new Route(GET, "/_query/view/{name}"), new Route(GET, "/_query/view"));
     }
 
     @Override
@@ -33,7 +36,14 @@ public String getName() {
 
     @Override
     protected RestChannelConsumer prepareRequest(final RestRequest request, final NodeClient client) throws IOException {
-        GetViewAction.Request req = new GetViewAction.Request(request.param("name"));
-        return channel -> client.execute(TransportGetViewAction.TYPE, req, new RestToXContentListener<>(channel));
+        GetViewAction.Request req = new GetViewAction.Request(
+            RestUtils.getMasterNodeTimeout(request),
+            Strings.splitStringByCommaToArray(request.param("name"))
+        );
+        return channel -> new RestCancellableNodeClient(client, request.getHttpChannel()).execute(
+            GetViewAction.INSTANCE,
+            req,
+            new RestToXContentListener<>(channel)
+        );
     }
 }
diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/TransportGetViewAction.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/view/TransportGetViewAction.java
@@ -16,6 +16,10 @@
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.TreeMap;
+
 public class TransportGetViewAction extends HandledTransportAction<GetViewAction.Request, GetViewAction.Response> {
     public static final ActionType<RemoteInfoResponse> TYPE = new ActionType<>(GetViewAction.NAME);
     private final ClusterViewService viewService;
@@ -28,11 +32,24 @@ public TransportGetViewAction(TransportService transportService, ActionFilters a
 
     @Override
     protected void doExecute(Task task, GetViewAction.Request request, ActionListener<GetViewAction.Response> listener) {
-        View view = viewService.get(request.name());
-        if (view == null) {
-            listener.onFailure(new IllegalArgumentException("View [" + request.name() + "] does not exist"));
+        TreeMap<String, View> views = new TreeMap<>();
+        List<String> missing = new ArrayList<>();
+        var names = request.names();
+        if (names.isEmpty()) {
+            names = new ArrayList<>(viewService.list());
+        }
+        for (String name : names) {
+            View view = viewService.get(name);
+            if (view == null) {
+                missing.add(name);
+            } else {
+                views.put(name, view);
+            }
+        }
+        if (missing.isEmpty() == false) {
+            listener.onFailure(new IllegalArgumentException("Views do not exist: " + String.join(", ", missing)));
         } else {
-            listener.onResponse(new GetViewAction.Response(view));
+            listener.onResponse(new GetViewAction.Response(views));
         }
     }
 }
diff --git a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/view/AbstractViewTestCase.java b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/view/AbstractViewTestCase.java
@@ -10,6 +10,7 @@
 import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
 import org.elasticsearch.cluster.project.ProjectResolver;
 import org.elasticsearch.cluster.service.ClusterService;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.features.FeatureService;
 import org.elasticsearch.indices.TestIndexNameExpressionResolver;
 import org.elasticsearch.plugins.Plugin;
@@ -18,6 +19,7 @@
 
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicReference;
 
@@ -37,30 +39,47 @@ protected ViewService viewService() {
         return new ClusterViewService(new EsqlFunctionRegistry(), clusterService, featureService, projectResolver, DEFAULT);
     }
 
-    protected AtomicReference<Exception> saveView(String name, View policy, ViewService viewService) throws InterruptedException {
-        IndexNameExpressionResolver resolver = TestIndexNameExpressionResolver.newInstance();
-        TestResponseCapture responseCapture = new TestResponseCapture();
-        viewService.put(name, policy, responseCapture);
-        responseCapture.latch.await();
-        return responseCapture.error;
-    }
+    protected class TestViewsApi {
+        protected ViewService viewService = viewService();
+
+        protected AtomicReference<Exception> save(String name, View policy) throws InterruptedException {
+            IndexNameExpressionResolver resolver = TestIndexNameExpressionResolver.newInstance();
+            TestResponseCapture<Void> responseCapture = new TestResponseCapture<>();
+            viewService.put(name, policy, responseCapture);
+            responseCapture.latch.await();
+            return responseCapture.error;
+        }
+
+        protected void delete(String name) throws Exception {
+            TestResponseCapture<Void> responseCapture = new TestResponseCapture<>();
+            viewService.delete(name, responseCapture);
+            responseCapture.latch.await();
+            if (responseCapture.error.get() != null) {
+                throw responseCapture.error.get();
+            }
+        }
 
-    protected void deleteView(String name, ViewService viewService) throws Exception {
-        TestResponseCapture responseCapture = new TestResponseCapture();
-        viewService.delete(name, responseCapture);
-        responseCapture.latch.await();
-        if (responseCapture.error.get() != null) {
-            throw responseCapture.error.get();
+        public Map<String, View> get(String... names) throws Exception {
+            TestResponseCapture<GetViewAction.Response> responseCapture = new TestResponseCapture<>();
+            TransportGetViewAction getViewAction = getInstanceFromNode(TransportGetViewAction.class);
+            GetViewAction.Request request = new GetViewAction.Request(TimeValue.THIRTY_SECONDS, names);
+            getViewAction.doExecute(null, request, responseCapture);
+            if (responseCapture.error.get() != null) {
+                throw responseCapture.error.get();
+            }
+            return responseCapture.response.getViews();
         }
     }
 
-    protected static class TestResponseCapture implements ActionListener<Void> {
+    protected static class TestResponseCapture<T> implements ActionListener<T> {
         CountDownLatch latch = new CountDownLatch(1);
         AtomicReference<Exception> error = new AtomicReference<>();
+        T response;
 
         @Override
-        public void onResponse(Void unused) {
+        public void onResponse(T response) {
             latch.countDown();
+            this.response = response;
         }
 
         @Override
diff --git a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/view/ViewCrudTests.java b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/view/ViewCrudTests.java

Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,16 @@`
`23`	`23`	`],`
`24`	`24`	`"parts": {`
`25`	`25`	`"name": {`
`26`		`- "type": "string",`
`27`		`- "description": "The name of the view to get"`
	`26`	`+ "type": "list",`
	`27`	`+ "description": "A comma-separated list of view names"`
`28`	`28`	`}`
`29`	`29`	`}`
	`30`	`+ },`
	`31`	`+ {`
	`32`	`+ "path": "/_query/view",`
	`33`	`+ "methods": [`
	`34`	`+ "GET"`
	`35`	`+ ]`
`30`	`36`	`}`
`31`	`37`	`]`
`32`	`38`	`}`