Support overlapping paths on resource classes

Postremus · Postremus · commit 5d81443a77c7 · 2025-04-20T20:43:15.000+02:00
diff --git a/extensions/resteasy-reactive/rest/deployment/src/test/java/io/quarkus/resteasy/reactive/server/test/resource/basic/OverlappingResourceClassPathTest.java b/extensions/resteasy-reactive/rest/deployment/src/test/java/io/quarkus/resteasy/reactive/server/test/resource/basic/OverlappingResourceClassPathTest.java
@@ -0,0 +1,79 @@
+package io.quarkus.resteasy.reactive.server.test.resource.basic;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.equalTo;
+
+import java.util.function.Supplier;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+
+import org.jboss.resteasy.reactive.RestPath;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.resteasy.reactive.server.test.simple.PortProviderUtil;
+import io.quarkus.test.QuarkusUnitTest;
+
+class OverlappingResourceClassPathTest {
+    @RegisterExtension
+    static QuarkusUnitTest testExtension = new QuarkusUnitTest()
+            .setArchiveProducer(new Supplier<>() {
+                @Override
+                public JavaArchive get() {
+                    JavaArchive war = ShrinkWrap.create(JavaArchive.class);
+                    war.addClasses(PortProviderUtil.class);
+                    war.addClasses(UsersResource.class);
+                    war.addClasses(UserResource.class);
+                    war.addClasses(GreetingResource.class);
+                    return war;
+                }
+            });
+
+    @Test
+    void basicTest() {
+        given()
+                .get("/users/userId")
+                .then()
+                .statusCode(200)
+                .body(equalTo("userId"));
+
+        given()
+                .get("/users/userId/by-id")
+                .then()
+                .statusCode(200)
+                .body(equalTo("getByIdInUserResource-userId"));
+    }
+
+    @Path("/users")
+    public static class UsersResource {
+
+        @GET
+        @Path("{id}")
+        public String getByIdInUsersResource(@RestPath String id) {
+            return id;
+        }
+    }
+
+    @Path("/users/{id}")
+    public static class UserResource {
+
+        @GET
+        @Path("by-id")
+        public String getByIdInUserResource(@RestPath String id) {
+            return "getByIdInUserResource-" + id;
+        }
+    }
+
+    @Path("/i-do-not-match")
+    public static class GreetingResource {
+
+        @GET
+        @Path("greet")
+        public String greet() {
+            return "Hello";
+        }
+    }
+}
diff --git a/extensions/resteasy-reactive/rest/runtime/src/test/java/io/quarkus/resteasy/reactive/runtime/mapping/RequestMapperTestCase.java b/extensions/resteasy-reactive/rest/runtime/src/test/java/io/quarkus/resteasy/reactive/runtime/mapping/RequestMapperTestCase.java
@@ -10,9 +10,9 @@
 public class RequestMapperTestCase {
 
     @Test
-    public void testPathMapper() {
+    public void testMap() {
 
-        RequestMapper<String> mapper = mapper("/id", "/id/{param}", "/bar/{p1}/{p2}", "/bar/{p1}");
+        RequestMapper<String> mapper = mapper(false, "/id", "/id/{param}", "/bar/{p1}/{p2}", "/bar/{p1}");
         mapper.dump();
 
         RequestMapper.RequestMatch<String> result = mapper.map("/bar/34/44");
@@ -31,13 +31,30 @@ public void testPathMapper() {
         result = mapper.map("/bar/34");
         Assertions.assertEquals("/bar/{p1}", result.value);
         Assertions.assertEquals("34", result.pathParamValues[0]);
+    }
+
+    @Test
+    public void testAllMatches() {
+        RequestMapper<String> mapper = mapper(true, "/greetings", "/greetings/{id}", "/greetings/unrelated");
+        mapper.dump();
 
+        var result = mapper.allMatches("/not-existing");
+        Assertions.assertFalse(result.hasNext());
+
+        result = mapper.allMatches("/greetings/greeting-id");
+        Assertions.assertTrue(result.hasNext());
+        var next = result.next();
+        Assertions.assertEquals("", next.remaining);
+        Assertions.assertTrue(result.hasNext());
+        next = result.next();
+        Assertions.assertEquals("/greeting-id", next.remaining);
+        Assertions.assertFalse(result.hasNext());
     }
 
-    RequestMapper<String> mapper(String... vals) {
+    RequestMapper<String> mapper(boolean prefixTemplates, String... vals) {
         ArrayList<RequestMapper.RequestPath<String>> list = new ArrayList<>();
         for (String i : vals) {
-            list.add(new RequestMapper.RequestPath<>(false, new URITemplate(i, false), i));
+            list.add(new RequestMapper.RequestPath<>(prefixTemplates, new URITemplate(i, false), i));
         }
         return new RequestMapper<>(list);
     }
diff --git a/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/core/ResteasyReactiveRequestContext.java b/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/core/ResteasyReactiveRequestContext.java
@@ -12,6 +12,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Deque;
+import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -51,6 +52,7 @@
 import org.jboss.resteasy.reactive.server.SimpleResourceInfo;
 import org.jboss.resteasy.reactive.server.core.multipart.FormData;
 import org.jboss.resteasy.reactive.server.core.serialization.EntityWriter;
+import org.jboss.resteasy.reactive.server.handlers.RestInitialHandler;
 import org.jboss.resteasy.reactive.server.injection.ResteasyReactiveInjectionContext;
 import org.jboss.resteasy.reactive.server.jaxrs.AsyncResponseImpl;
 import org.jboss.resteasy.reactive.server.jaxrs.ContainerRequestContextImpl;
@@ -62,6 +64,7 @@
 import org.jboss.resteasy.reactive.server.jaxrs.SseEventSinkImpl;
 import org.jboss.resteasy.reactive.server.jaxrs.SseImpl;
 import org.jboss.resteasy.reactive.server.jaxrs.UriInfoImpl;
+import org.jboss.resteasy.reactive.server.mapping.RequestMapper;
 import org.jboss.resteasy.reactive.server.mapping.RuntimeResource;
 import org.jboss.resteasy.reactive.server.mapping.URITemplate;
 import org.jboss.resteasy.reactive.server.multipart.FormValue;
@@ -156,6 +159,8 @@ public abstract class ResteasyReactiveRequestContext
     private FormData formData;
     private boolean producesChecked;
 
+    private Iterator<RequestMapper.RequestMatch<RestInitialHandler.InitialMatch>> initialMatches;
+
     public ResteasyReactiveRequestContext(Deployment deployment,
             ThreadSetupAction requestContext, ServerRestHandler[] handlerChain, ServerRestHandler[] abortHandlerChain) {
         super(handlerChain, abortHandlerChain, requestContext);
@@ -203,6 +208,30 @@ public void restart(RuntimeResource target, boolean setLocatorTarget) {
         this.target = target;
     }
 
+    /**
+     * Restarts handler chain processing if another initial match exists. Initial matches are determined in RestInitialHandler.
+     *
+     * @return true if a restart occurred
+     */
+    public boolean restartWithNextInitialMatch() {
+        if (initialMatches == null || !initialMatches.hasNext()) {
+            return false;
+        }
+        RequestMapper.RequestMatch<RestInitialHandler.InitialMatch> initialMatch = initialMatches
+                .next();
+        restart(initialMatch.value.handlers);
+        setMaxPathParams(initialMatch.value.maxPathParams);
+        setRemaining(initialMatch.remaining);
+        for (int i = 0; i < initialMatch.pathParamValues.length; ++i) {
+            String pathParamValue = initialMatch.pathParamValues[i];
+            if (pathParamValue == null) {
+                break;
+            }
+            setPathParamValue(i, initialMatch.pathParamValues[i]);
+        }
+        return true;
+    }
+
     /**
      * Meant to be used when an error occurred early in processing chain
      */
@@ -1254,6 +1283,14 @@ private String getResourceLocatorPathParam(String name, PreviousResource previou
 
     public abstract boolean resumeExternalProcessing();
 
+    public Iterator<RequestMapper.RequestMatch<RestInitialHandler.InitialMatch>> getInitialMatches() {
+        return initialMatches;
+    }
+
+    public void setInitialMatches(Iterator<RequestMapper.RequestMatch<RestInitialHandler.InitialMatch>> initialMatches) {
+        this.initialMatches = initialMatches;
+    }
+
     static class PreviousResource {
 
         private static final String PROPERTY_KEY = AbstractResteasyReactiveContext.CUSTOM_RR_PROPERTIES_PREFIX
diff --git a/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/handlers/ClassRoutingHandler.java b/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/handlers/ClassRoutingHandler.java
@@ -66,6 +66,9 @@ public void handle(ResteasyReactiveRequestContext requestContext) throws Excepti
                 mapper = mappers.get(null);
             }
             if (mapper == null) {
+                if (requestContext.restartWithNextInitialMatch()) {
+                    return;
+                }
                 // The idea here is to check if any of the mappers of the class could map the request - if the HTTP Method were correct
                 String remaining = getRemaining(requestContext);
                 for (RequestMapper<RuntimeResource> existingMapper : mappers.values()) {
@@ -89,6 +92,9 @@ public void handle(ResteasyReactiveRequestContext requestContext) throws Excepti
             }
 
             if (target == null) {
+                if (requestContext.restartWithNextInitialMatch()) {
+                    return;
+                }
                 // The idea here is to check if any of the mappers of the class could map the request - if the HTTP Method were correct
                 for (Map.Entry<String, RequestMapper<RuntimeResource>> entry : mappers.entrySet()) {
                     if (entry.getKey() == null) {
diff --git a/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/handlers/RestInitialHandler.java b/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/handlers/RestInitialHandler.java
@@ -1,5 +1,6 @@
 package org.jboss.resteasy.reactive.server.handlers;
 
+import java.util.Iterator;
 import java.util.List;
 
 import jakarta.ws.rs.NotFoundException;
@@ -58,8 +59,8 @@ public void beginProcessing(Object externalHttpContext, Throwable throwable) {
 
     @Override
     public void handle(ResteasyReactiveRequestContext requestContext) throws Exception {
-        RequestMapper.RequestMatch<InitialMatch> target = mappers.map(requestContext.getPathWithoutPrefix());
-        if (target == null) {
+        Iterator<RequestMapper.RequestMatch<InitialMatch>> targets = mappers.allMatches(requestContext.getPathWithoutPrefix());
+        if (!targets.hasNext()) {
             ProvidersImpl providers = requestContext.getProviders();
             ExceptionMapper<NotFoundException> exceptionMapper = providers.getExceptionMapper(NotFoundException.class);
 
@@ -73,16 +74,8 @@ public void handle(ResteasyReactiveRequestContext requestContext) throws Excepti
                 return;
             }
         }
-        requestContext.restart(target.value.handlers);
-        requestContext.setMaxPathParams(target.value.maxPathParams);
-        requestContext.setRemaining(target.remaining);
-        for (int i = 0; i < target.pathParamValues.length; ++i) {
-            String pathParamValue = target.pathParamValues[i];
-            if (pathParamValue == null) {
-                break;
-            }
-            requestContext.setPathParamValue(i, target.pathParamValues[i]);
-        }
+        requestContext.setInitialMatches(targets);
+        requestContext.restartWithNextInitialMatch();
     }
 
     public static class InitialMatch {
diff --git a/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/mapping/RequestMapper.java b/independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/mapping/RequestMapper.java
