Add API specific endpoints for routing rules

Author: koszti

docs/gateway-api.md

@@ -124,20 +124,25 @@ curl -X POST http://localhost:8080/gateway/backend/activate/trino-2
 
 ## Update routing rules
 
-This endpoint is part of the `/webapp` endpoint family and requires the
-`ADMIN` role.
-
 The API can be used to programmatically update the routing rules. Rule are
 updated based on the rule name. Storage of the rules must use a writeable file
-and the configuration 'rulesType: FILE'.
+and the configuration `rulesType: FILE`.
 
 For this feature to work with multiple replicas of the Trino Gateway, you must
 provide a shared storage that supports file locking for the routing rules file.
 If multiple replicas are used with local storage, then rules get out of
 sync when updated.
 
+Get all routing rules:
+
+```shell
+curl -X GET http://localhost:8080/gateway/routing-rules/all
+```
+
+Update a routing rule:
+
 ```shell
-curl -X POST http://localhost:8080/webapp/updateRoutingRules \
+curl -X POST http://localhost:8080/gateway/routing-rules/modify/update \
  -H 'Content-Type: application/json' \
  -d '{  "name": "trino-rule",
         "description": "updated rule description",

gateway-ha/src/main/java/io/trino/gateway/ha/resource/GatewayResource.java

@@ -15,8 +15,10 @@
 
 import com.google.inject.Inject;
 import io.airlift.log.Logger;
+import io.trino.gateway.ha.domain.RoutingRule;
 import io.trino.gateway.ha.router.GatewayBackendManager;
 import jakarta.annotation.security.RolesAllowed;
+import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
@@ -27,6 +29,8 @@
 import jakarta.ws.rs.core.Request;
 import jakarta.ws.rs.core.Response;
 
+import java.io.IOException;
+
 import static java.util.Objects.requireNonNull;
 
 @RolesAllowed("API")
@@ -37,11 +41,13 @@ public class GatewayResource
     private static final Logger log = Logger.get(GatewayResource.class);
 
     private final GatewayBackendManager gatewayBackendManager;
+    private final RoutingRulesResourceHandler routingRulesResourceHandler;
 
     @Inject
-    public GatewayResource(GatewayBackendManager gatewayBackendManager)
+    public GatewayResource(GatewayBackendManager gatewayBackendManager, RoutingRulesResourceHandler routingRulesResourceHandler)
     {
         this.gatewayBackendManager = requireNonNull(gatewayBackendManager, "gatewayBackendManager is null");
+        this.routingRulesResourceHandler = requireNonNull(routingRulesResourceHandler, "routingRulesResourceHandler is null");
     }
 
     @GET
@@ -92,6 +98,23 @@ public Response activateBackend(@PathParam("name") String name)
         return Response.ok().build();
     }
 
+    @GET
+    @Path("/routing-rules/all")
+    public Response getRoutingRules()
+            throws IOException
+    {
+        return routingRulesResourceHandler.getRoutingRules();
+    }
+
+    @POST
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Path("/routing-rules/modify/update")
+    public Response updateRoutingRules(RoutingRule routingRule)
+            throws IOException
+    {
+        return routingRulesResourceHandler.updateRoutingRules(routingRule);
+    }
+
     private Response throwError(Exception e)
     {
         return Response.status(Response.Status.NOT_FOUND)

gateway-ha/src/main/java/io/trino/gateway/ha/resource/GatewayWebAppResource.java

@@ -19,8 +19,6 @@
 import io.trino.gateway.ha.clustermonitor.TrinoStatus;
 import io.trino.gateway.ha.config.HaGatewayConfiguration;
 import io.trino.gateway.ha.config.ProxyBackendConfiguration;
-import io.trino.gateway.ha.config.RoutingRulesConfiguration;
-import io.trino.gateway.ha.config.RulesType;
 import io.trino.gateway.ha.config.UIConfiguration;
 import io.trino.gateway.ha.domain.Result;
 import io.trino.gateway.ha.domain.RoutingRule;
@@ -40,7 +38,6 @@
 import io.trino.gateway.ha.router.HaGatewayManager;
 import io.trino.gateway.ha.router.QueryHistoryManager;
 import io.trino.gateway.ha.router.ResourceGroupsManager;
-import io.trino.gateway.ha.router.RoutingRulesManager;
 import jakarta.annotation.security.RolesAllowed;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.GET;
@@ -76,30 +73,25 @@ public class GatewayWebAppResource
     private final QueryHistoryManager queryHistoryManager;
     private final BackendStateManager backendStateManager;
     private final ResourceGroupsManager resourceGroupsManager;
-    private final boolean isRulesEngineEnabled;
-    private final RulesType ruleType;
     // TODO Avoid putting mutable objects in fields
     private final UIConfiguration uiConfiguration;
-    private final RoutingRulesManager routingRulesManager;
+    private final RoutingRulesResourceHandler routingRulesResourceHandler;
 
     @Inject
     public GatewayWebAppResource(
             GatewayBackendManager gatewayBackendManager,
             QueryHistoryManager queryHistoryManager,
             BackendStateManager backendStateManager,
             ResourceGroupsManager resourceGroupsManager,
-            RoutingRulesManager routingRulesManager,
+            RoutingRulesResourceHandler routingRulesResourceHandler,
             HaGatewayConfiguration configuration)
     {
         this.gatewayBackendManager = requireNonNull(gatewayBackendManager, "gatewayBackendManager is null");
         this.queryHistoryManager = requireNonNull(queryHistoryManager, "queryHistoryManager is null");
         this.backendStateManager = requireNonNull(backendStateManager, "backendStateManager is null");
         this.resourceGroupsManager = requireNonNull(resourceGroupsManager, "resourceGroupsManager is null");
         this.uiConfiguration = configuration.getUiConfiguration();
-        this.routingRulesManager = requireNonNull(routingRulesManager, "routingRulesManager is null");
-        RoutingRulesConfiguration routingRules = configuration.getRoutingRules();
-        isRulesEngineEnabled = routingRules.isRulesEngineEnabled();
-        ruleType = routingRules.getRulesType();
+        this.routingRulesResourceHandler = requireNonNull(routingRulesResourceHandler, "routingRulesResourceHandler is null");
     }
 
     @POST
@@ -461,12 +453,7 @@ public Response readExactMatchSourceSelector()
     public Response getRoutingRules()
             throws IOException
     {
-        if (isRulesEngineEnabled && ruleType == RulesType.EXTERNAL) {
-            return Response.status(Response.Status.NO_CONTENT)
-                    .entity(Result.fail("Routing rules are managed by an external service")).build();
-        }
-        List<RoutingRule> routingRulesList = routingRulesManager.getRoutingRules();
-        return Response.ok(Result.ok(routingRulesList)).build();
+        return routingRulesResourceHandler.getRoutingRules();
     }
 
     @POST
@@ -477,8 +464,7 @@ public Response getRoutingRules()
     public Response updateRoutingRules(RoutingRule routingRule)
             throws IOException
     {
-        List<RoutingRule> routingRulesList = routingRulesManager.updateRoutingRule(routingRule);
-        return Response.ok(Result.ok(routingRulesList)).build();
+        return routingRulesResourceHandler.updateRoutingRules(routingRule);
     }
 
     @GET

gateway-ha/src/main/java/io/trino/gateway/ha/resource/RoutingRulesResourceHandler.java

@@ -0,0 +1,62 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.trino.gateway.ha.resource;
+
+import com.google.inject.Inject;
+import io.trino.gateway.ha.config.HaGatewayConfiguration;
+import io.trino.gateway.ha.config.RoutingRulesConfiguration;
+import io.trino.gateway.ha.config.RulesType;
+import io.trino.gateway.ha.domain.Result;
+import io.trino.gateway.ha.domain.RoutingRule;
+import io.trino.gateway.ha.router.RoutingRulesManager;
+import jakarta.ws.rs.core.Response;
+
+import java.io.IOException;
+import java.util.List;
+
+import static java.util.Objects.requireNonNull;
+
+public class RoutingRulesResourceHandler
+{
+    private final RoutingRulesManager routingRulesManager;
+    private final boolean isRulesEngineEnabled;
+    private final RulesType rulesType;
+
+    @Inject
+    public RoutingRulesResourceHandler(RoutingRulesManager routingRulesManager, HaGatewayConfiguration configuration)
+    {
+        this.routingRulesManager = requireNonNull(routingRulesManager, "routingRulesManager is null");
+        RoutingRulesConfiguration routingRulesConfiguration = requireNonNull(configuration, "configuration is null").getRoutingRules();
+        this.isRulesEngineEnabled = routingRulesConfiguration.isRulesEngineEnabled();
+        this.rulesType = routingRulesConfiguration.getRulesType();
+    }
+
+    public Response getRoutingRules()
+            throws IOException
+    {
+        if (isRulesEngineEnabled && rulesType == RulesType.EXTERNAL) {
+            return Response.status(Response.Status.NO_CONTENT)
+                    .entity(Result.fail("Routing rules are managed by an external service")).build();
+        }
+        List<RoutingRule> routingRulesList = routingRulesManager.getRoutingRules();
+        return Response.ok(Result.ok(routingRulesList)).build();
+    }
+
+    public Response updateRoutingRules(RoutingRule routingRule)
+            throws IOException
+    {
+        List<RoutingRule> routingRulesList = routingRulesManager.updateRoutingRule(routingRule);
+        return Response.ok(Result.ok(routingRulesList)).build();
+    }
+}

gateway-ha/src/test/java/io/trino/gateway/ha/router/TestRoutingAPI.java

@@ -77,7 +77,7 @@ void testGetRoutingRulesAPI()
     {
         Request request =
                 new Request.Builder()
-                        .url("http://localhost:" + routerPort + "/webapp/getRoutingRules")
+                        .url("http://localhost:" + routerPort + "/gateway/routing-rules/all")
                         .get()
                         .build();
         Response response = httpClient.newCall(request).execute();
@@ -105,7 +105,7 @@ void testUpdateRoutingRulesAPI()
         RoutingRule updatedRoutingRules = new RoutingRule("airflow", "if query from airflow, route to adhoc group", 0, List.of("result.put(\"routingGroup\", \"adhoc\")"), "request.getHeader(\"X-Trino-Source\") == \"JDBC\"");
         RequestBody requestBody = RequestBody.create(OBJECT_MAPPER.writeValueAsString(updatedRoutingRules), MediaType.parse("application/json; charset=utf-8"));
         Request request = new Request.Builder()
-                        .url("http://localhost:" + routerPort + "/webapp/updateRoutingRules")
+                        .url("http://localhost:" + routerPort + "/gateway/routing-rules/modify/update")
                         .addHeader("Content-Type", "application/json")
                         .post(requestBody)
                         .build();
@@ -116,7 +116,7 @@ void testUpdateRoutingRulesAPI()
         //Fetch the routing rules to see if the update was successful
         Request request2 =
                 new Request.Builder()
-                        .url("http://localhost:" + routerPort + "/webapp/getRoutingRules")
+                        .url("http://localhost:" + routerPort + "/gateway/routing-rules/all")
                         .get()
                         .build();
         Response response2 = httpClient.newCall(request2).execute();
@@ -139,13 +139,26 @@ void testUpdateRoutingRulesAPI()
         RoutingRule revertRoutingRules = new RoutingRule("airflow", "if query from airflow, route to etl group", 0, List.of("result.put(\"routingGroup\", \"etl\")"), "request.getHeader(\"X-Trino-Source\") == \"airflow\"");
         RequestBody requestBody3 = RequestBody.create(OBJECT_MAPPER.writeValueAsString(revertRoutingRules), MediaType.parse("application/json; charset=utf-8"));
         Request request3 = new Request.Builder()
-                .url("http://localhost:" + routerPort + "/webapp/updateRoutingRules")
+                .url("http://localhost:" + routerPort + "/gateway/routing-rules/modify/update")
                 .addHeader("Content-Type", "application/json")
                 .post(requestBody3)
                 .build();
         httpClient.newCall(request3).execute();
     }
 
+    @Test
+    void testWebappRoutingRulesCompatibilityAPI()
+            throws Exception
+    {
+        Request request =
+                new Request.Builder()
+                        .url("http://localhost:" + routerPort + "/webapp/getRoutingRules")
+                        .get()
+                        .build();
+        Response response = httpClient.newCall(request).execute();
+        assertThat(response.code()).isEqualTo(200);
+    }
+
     @Test
     void testUIConfigurationAPI()
             throws Exception