Create NamedRoute to map extension routes to a shortened name

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add events correlation engine plugin ([#6854](https://github.com/opensearch-project/OpenSearch/issues/6854))
 - Add connectToNodeAsExtension in TransportService ([#6866](https://github.com/opensearch-project/OpenSearch/pull/6866))
 - Adds ExtensionsManager.lookupExtensionSettingsById ([#7466](https://github.com/opensearch-project/OpenSearch/pull/7466))
+- Create ProtectedRoute to map extension routes to a shortened name ([#6870](https://github.com/opensearch-project/OpenSearch/pull/6870))
 
 ### Dependencies
 - Bump `log4j-core` from 2.18.0 to 2.19.0
@@ -129,4 +130,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Security
 
 [Unreleased 3.0]: https://github.com/opensearch-project/OpenSearch/compare/2.x...HEAD
-[Unreleased 2.x]: https://github.com/opensearch-project/OpenSearch/compare/2.7...2.x
+[Unreleased 2.x]: https://github.com/opensearch-project/OpenSearch/compare/2.7...2.x

server/src/main/java/org/opensearch/extensions/ExtensionsManager.java

@@ -108,7 +108,6 @@ public static enum OpenSearchRequestType {
 
     private final Path extensionsPath;
     private ExtensionTransportActionsHandler extensionTransportActionsHandler;
-
     private Map<String, Extension> extensionSettingsMap;
     private Map<String, DiscoveryExtensionNode> initializedExtensions;
     private Map<String, DiscoveryExtensionNode> extensionIdMap;

server/src/main/java/org/opensearch/extensions/rest/RestActionsRequestHandler.java

@@ -12,6 +12,7 @@
 import org.opensearch.extensions.DiscoveryExtensionNode;
 import org.opensearch.rest.RestController;
 import org.opensearch.rest.RestHandler;
+import org.opensearch.rest.extensions.RestSendToExtensionAction;
 import org.opensearch.transport.TransportResponse;
 import org.opensearch.transport.TransportService;
 

server/src/main/java/org/opensearch/extensions/rest/RouteHandler.java

@@ -0,0 +1,69 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.extensions.rest;
+
+import java.util.function.Function;
+
+import org.opensearch.rest.RestHandler.Route;
+import org.opensearch.rest.RestRequest;
+import org.opensearch.rest.RestRequest.Method;
+
+/**
+ * A subclass of {@link Route} that includes a handler method for that route.
+ */
+public class RouteHandler extends Route {
+
+    private final String name;
+
+    private final Function<RestRequest, ExtensionRestResponse> responseHandler;
+
+    /**
+     * Handle the method and path with the specified handler.
+     *
+     * @param method The {@link Method} to handle.
+     * @param path The path to handle.
+     * @param handler The method which handles the method and path.
+     */
+    public RouteHandler(Method method, String path, Function<RestRequest, ExtensionRestResponse> handler) {
+        super(method, path);
+        this.responseHandler = handler;
+        this.name = null;
+    }
+
+    /**
+     * Handle the method and path with the specified handler.
+     *
+     * @param name The name of the handler.
+     * @param method The {@link Method} to handle.
+     * @param path The path to handle.
+     * @param handler The method which handles the method and path.
+     */
+    public RouteHandler(String name, Method method, String path, Function<RestRequest, ExtensionRestResponse> handler) {
+        super(method, path);
+        this.responseHandler = handler;
+        this.name = name;
+    }
+
+    /**
+     * Executes the handler for this route.
+     *
+     * @param request The request to handle
+     * @return the {@link ExtensionRestResponse} result from the handler for this route.
+     */
+    public ExtensionRestResponse handleRequest(RestRequest request) {
+        return responseHandler.apply(request);
+    }
+
+    /**
+     * The name of the RouteHandler. Must be unique across route handlers.
+     */
+    public String name() {
+        return this.name;
+    }
+}

server/src/main/java/org/opensearch/rest/ProtectedRoute.java

@@ -0,0 +1,31 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.rest;
+
+/**
+ * A named Route
+ *
+ * @opensearch.api
+ */
+public class ProtectedRoute extends RestHandler.Route {
+
+    private final String name;
+
+    public ProtectedRoute(RestRequest.Method method, String path, String name) {
+        super(method, path);
+        this.name = name;
+    }
+
+    /**
+     * The name of the Route. Must be unique across Route.
+     */
+    public String name() {
+        return this.name;
+    }
+}

server/src/main/java/org/opensearch/extensions/rest/RestSendToExtensionAction.java → server/src/main/java/org/opensearch/rest/extensions/RestSendToExtensionAction.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.extensions.rest;
+package org.opensearch.rest.extensions;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -16,8 +16,12 @@
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.extensions.DiscoveryExtensionNode;
 import org.opensearch.extensions.ExtensionsManager;
+import org.opensearch.extensions.rest.ExtensionRestRequest;
+import org.opensearch.extensions.rest.RegisterRestActionsRequest;
+import org.opensearch.extensions.rest.RestExecuteOnExtensionResponse;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.BytesRestResponse;
+import org.opensearch.rest.ProtectedRoute;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.RestRequest.Method;
 import org.opensearch.rest.RestStatus;
@@ -33,6 +37,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.concurrent.CompletableFuture;
@@ -86,15 +91,26 @@ public RestSendToExtensionAction(
 
         List<Route> restActionsAsRoutes = new ArrayList<>();
         for (String restAction : restActionsRequest.getRestActions()) {
-            int delim = restAction.indexOf(' ');
+            Optional<String> name = Optional.empty();
+            String[] parts = restAction.split(" ");
+            if (parts.length < 2) {
+                throw new IllegalArgumentException("REST action must contain at least a REST method and route");
+            }
             try {
-                method = RestRequest.Method.valueOf(restAction.substring(0, delim));
-                path = pathPrefix + restAction.substring(delim).trim();
+                method = RestRequest.Method.valueOf(parts[0].trim());
+                path = pathPrefix + parts[1].trim();
+                if (parts.length > 2) {
+                    name = Optional.of(parts[2].trim());
+                }
             } catch (IndexOutOfBoundsException | IllegalArgumentException e) {
                 throw new IllegalArgumentException(restAction + " does not begin with a valid REST method");
             }
             logger.info("Registering: " + method + " " + path);
-            restActionsAsRoutes.add(new Route(method, path));
+            if (name.isPresent()) {
+                restActionsAsRoutes.add(new ProtectedRoute(method, path, name.get()));
+            } else {
+                restActionsAsRoutes.add(new Route(method, path));
+            }
         }
         this.routes = unmodifiableList(restActionsAsRoutes);
 

server/src/main/java/org/opensearch/rest/extensions/package-info.java

@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** REST classes for the extensions package. OpenSearch extensions provide extensibility to OpenSearch.*/
+package org.opensearch.rest.extensions;

server/src/test/java/org/opensearch/extensions/rest/RestSendToExtensionActionTests.java

@@ -33,8 +33,10 @@
 import org.opensearch.common.util.PageCacheRecycler;
 import org.opensearch.extensions.DiscoveryExtensionNode;
 import org.opensearch.indices.breaker.NoneCircuitBreakerService;
+import org.opensearch.rest.ProtectedRoute;
 import org.opensearch.rest.RestHandler.Route;
 import org.opensearch.rest.RestRequest.Method;
+import org.opensearch.rest.extensions.RestSendToExtensionAction;
 import org.opensearch.test.OpenSearchTestCase;
 import org.opensearch.test.transport.MockTransportService;
 import org.opensearch.threadpool.TestThreadPool;
@@ -127,6 +129,40 @@ public void testRestSendToExtensionAction() throws Exception {
         assertTrue(expectedMethods.containsAll(methods));
     }
 
+    public void testRestSendToExtensionActionWithProtectedRoute() throws Exception {
+        RegisterRestActionsRequest registerRestActionRequest = new RegisterRestActionsRequest(
+            "uniqueid1",
+            List.of("GET /foo foo", "PUT /bar bar", "POST /baz baz"),
+            List.of("GET /deprecated/foo foo_deprecated", "It's deprecated!")
+        );
+        RestSendToExtensionAction restSendToExtensionAction = new RestSendToExtensionAction(
+            registerRestActionRequest,
+            discoveryExtensionNode,
+            transportService
+        );
+
+        assertEquals("send_to_extension_action", restSendToExtensionAction.getName());
+        List<ProtectedRoute> expected = new ArrayList<>();
+        String uriPrefix = "/_extensions/_uniqueid1";
+        expected.add(new ProtectedRoute(Method.GET, uriPrefix + "/foo", "foo"));
+        expected.add(new ProtectedRoute(Method.PUT, uriPrefix + "/bar", "bar"));
+        expected.add(new ProtectedRoute(Method.POST, uriPrefix + "/baz", "baz"));
+
+        List<Route> routes = restSendToExtensionAction.routes();
+        assertEquals(expected.size(), routes.size());
+        List<String> expectedPaths = expected.stream().map(Route::getPath).collect(Collectors.toList());
+        List<String> paths = routes.stream().map(Route::getPath).collect(Collectors.toList());
+        List<Method> expectedMethods = expected.stream().map(Route::getMethod).collect(Collectors.toList());
+        List<Method> methods = routes.stream().map(Route::getMethod).collect(Collectors.toList());
+        List<String> expectedNames = expected.stream().map(ProtectedRoute::name).collect(Collectors.toList());
+        List<String> names = routes.stream().map(r -> ((ProtectedRoute) r).name()).collect(Collectors.toList());
+        assertTrue(paths.containsAll(expectedPaths));
+        assertTrue(expectedPaths.containsAll(paths));
+        assertTrue(methods.containsAll(expectedMethods));
+        assertTrue(expectedMethods.containsAll(methods));
+        assertTrue(expectedNames.containsAll(names));
+    }
+
     public void testRestSendToExtensionActionFilterHeaders() throws Exception {
         RegisterRestActionsRequest registerRestActionRequest = new RegisterRestActionsRequest(
             "uniqueid1",

server/src/test/java/org/opensearch/extensions/rest/RouteHandlerTests.java

@@ -0,0 +1,36 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.extensions.rest;
+
+import org.opensearch.rest.RestRequest;
+import org.opensearch.rest.RestStatus;
+import org.opensearch.test.OpenSearchTestCase;
+
+public class RouteHandlerTests extends OpenSearchTestCase {
+    public void testUnnamedRouteHandler() {
+        RouteHandler rh = new RouteHandler(
+            RestRequest.Method.GET,
+            "/foo/bar",
+            req -> new ExtensionRestResponse(req, RestStatus.OK, "content")
+        );
+
+        assertEquals(null, rh.name());
+    }
+
+    public void testNamedRouteHandler() {
+        RouteHandler rh = new RouteHandler(
+            "foo",
+            RestRequest.Method.GET,
+            "/foo/bar",
+            req -> new ExtensionRestResponse(req, RestStatus.OK, "content")
+        );
+
+        assertEquals("foo", rh.name());
+    }
+}