Additional work on path normalization

quarkusio · Aug 19, 2021 · 90aa803 · 90aa803
1 parent 5062b6c
commit 90aa803
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 25 deletions.
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/util/UriNormalizationUtil.java b/core/deployment/src/main/java/io/quarkus/deployment/util/UriNormalizationUtil.java
@@ -91,14 +91,18 @@ public static URI toURI(String path, boolean trailingSlash) {
      * </ul>
      *
      * @param base URI to resolve relative paths. Use {@link #toURI(String, boolean)} to construct this parameter.
-     * 
+     *
      * @param segment Relative or absolute path
      * @param trailingSlash true if resulting URI must end with a '/'
      * @throws IllegalArgumentException if the path contains invalid characters or path segments.
      */
     public static URI normalizeWithBase(URI base, String segment, boolean trailingSlash) {
         if (segment == null || segment.trim().isEmpty()) {
-            return base;
+            if ("/".equals(base.getPath())) {
+                return base;
+            }
+            // otherwise, make sure trailingSlash is honored
+            return toURI(base.getPath(), trailingSlash);
         }
         URI segmentUri = toURI(segment, trailingSlash);
         URI resolvedUri = base.resolve(segmentUri);

diff --git a/...c/main/java/io/quarkus/resteasy/server/common/deployment/ResteasyDeploymentBuildItem.java b/...c/main/java/io/quarkus/resteasy/server/common/deployment/ResteasyDeploymentBuildItem.java
@@ -5,12 +5,12 @@
 import io.quarkus.builder.item.SimpleBuildItem;
 
 public final class ResteasyDeploymentBuildItem extends SimpleBuildItem {
-    private ResteasyDeployment deployment;
     private String rootPath;
+    private ResteasyDeployment deployment;
 
     public ResteasyDeploymentBuildItem(String rootPath, ResteasyDeployment deployment) {
+        this.rootPath = rootPath.startsWith("/") ? rootPath : "/" + rootPath;
         this.deployment = deployment;
-        this.rootPath = rootPath;
     }
 
     public ResteasyDeployment getDeployment() {

diff --git a/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerConfigBuildItem.java b/...main/java/io/quarkus/resteasy/server/common/deployment/ResteasyServerConfigBuildItem.java
@@ -21,7 +21,7 @@ public final class ResteasyServerConfigBuildItem extends SimpleBuildItem {
      */
     public ResteasyServerConfigBuildItem(String rootPath, String path, Map<String, String> initParameters) {
         this.rootPath = rootPath;
-        this.path = path;
+        this.path = path.startsWith("/") ? path : "/" + path;
         this.initParameters = initParameters;
     }
 

diff --git a/...asy/deployment/src/main/java/io/quarkus/resteasy/deployment/ResteasyServletProcessor.java b/...asy/deployment/src/main/java/io/quarkus/resteasy/deployment/ResteasyServletProcessor.java
@@ -53,9 +53,8 @@ public void jaxrsConfig(
             BuildProducer<io.quarkus.resteasy.server.common.spi.ResteasyJaxrsConfigBuildItem> resteasyJaxrsConfig,
             HttpRootPathBuildItem httpRootPathBuildItem) {
         if (resteasyServerConfig.isPresent()) {
-            String rp = resteasyServerConfig.get().getRootPath();
-            String rootPath = httpRootPathBuildItem.resolvePath(rp.startsWith("/") ? rp.substring(1) : rp);
-            String defaultPath = httpRootPathBuildItem.resolvePath(resteasyServerConfig.get().getPath());
+            String rootPath = httpRootPathBuildItem.relativePath(resteasyServerConfig.get().getRootPath());
+            String defaultPath = resteasyServerConfig.get().getPath();
 
             deprecatedResteasyJaxrsConfig.produce(new ResteasyJaxrsConfigBuildItem(defaultPath));
             resteasyJaxrsConfig

diff --git a/...sions/undertow/deployment/src/main/java/io/quarkus/undertow/deployment/ServletConfig.java b/...sions/undertow/deployment/src/main/java/io/quarkus/undertow/deployment/ServletConfig.java
@@ -1,10 +1,17 @@
 package io.quarkus.undertow.deployment;
 
+import static io.quarkus.runtime.configuration.ConverterSupport.DEFAULT_QUARKUS_CONVERTER_PRIORITY;
+
 import java.util.Optional;
 
+import javax.annotation.Priority;
+
+import org.eclipse.microprofile.config.spi.Converter;
+
 import io.quarkus.runtime.annotations.ConfigItem;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
+import io.quarkus.runtime.annotations.ConvertWith;
 
 @ConfigRoot(phase = ConfigPhase.BUILD_TIME)
 public class ServletConfig {
@@ -17,6 +24,7 @@ public class ServletConfig {
      * is /bar and the http root is /foo then the actual Servlet path will be /foo/bar.
      */
     @ConfigItem
+    @ConvertWith(ContextPathConverter.class)
     Optional<String> contextPath;
 
     /**
@@ -25,4 +33,33 @@ public class ServletConfig {
     @ConfigItem(defaultValue = "UTF-8")
     public String defaultCharset;
 
+    /**
+     * This converter adds a / at the beginning of the context path but does not add one at the end, given we want to support
+     * it.
+     * <p>
+     * See ContextPathTestCase for an example.
+     */
+    @Priority(DEFAULT_QUARKUS_CONVERTER_PRIORITY)
+    public static class ContextPathConverter implements Converter<String> {
+
+        private static final String SLASH = "/";
+
+        @Override
+        public String convert(String value) throws IllegalArgumentException, NullPointerException {
+            if (value == null) {
+                return SLASH;
+            }
+
+            value = value.trim();
+            if (SLASH.equals(value)) {
+                return value;
+            }
+            if (!value.startsWith(SLASH)) {
+                value = SLASH + value;
+            }
+
+            return value;
+        }
+    }
+
 }
diff --git a/...s/undertow/deployment/src/main/java/io/quarkus/undertow/deployment/UndertowBuildStep.java b/...s/undertow/deployment/src/main/java/io/quarkus/undertow/deployment/UndertowBuildStep.java
@@ -116,6 +116,7 @@
 import io.quarkus.undertow.runtime.UndertowDeploymentRecorder;
 import io.quarkus.undertow.runtime.UndertowHandlersConfServletExtension;
 import io.quarkus.vertx.http.deployment.DefaultRouteBuildItem;
+import io.quarkus.vertx.http.deployment.HttpRootPathBuildItem;
 import io.quarkus.vertx.http.deployment.RouteBuildItem;
 import io.quarkus.vertx.http.runtime.HttpBuildTimeConfig;
 import io.quarkus.vertx.http.runtime.HttpConfiguration;
@@ -319,11 +320,7 @@ public ServletContextPathBuildItem contextPath(
             WebMetadataBuildItem webMetadataBuildItem) {
         String contextPath;
         if (servletConfig.contextPath.isPresent()) {
-            if (!servletConfig.contextPath.get().startsWith("/")) {
-                contextPath = "/" + servletConfig.contextPath;
-            } else {
-                contextPath = servletConfig.contextPath.get();
-            }
+            contextPath = servletConfig.contextPath.get();
         } else if (webMetadataBuildItem.getWebMetaData().getDefaultContextPath() != null) {
             contextPath = webMetadataBuildItem.getWebMetaData().getDefaultContextPath();
         } else {
@@ -351,6 +348,7 @@ public ServletDeploymentManagerBuildItem build(List<ServletBuildItem> servlets,
             ShutdownContextBuildItem shutdownContext,
             KnownPathsBuildItem knownPaths,
             HttpBuildTimeConfig httpBuildTimeConfig,
+            HttpRootPathBuildItem httpRootPath,
             ServletConfig servletConfig) throws Exception {
 
         ObjectSubstitutionBuildItem.Holder holder = new ObjectSubstitutionBuildItem.Holder(ServletSecurityInfo.class,
@@ -365,7 +363,7 @@ public ServletDeploymentManagerBuildItem build(List<ServletBuildItem> servlets,
         String contextPath = servletContextPathBuildItem.getServletContextPath();
         RuntimeValue<DeploymentInfo> deployment = recorder.createDeployment("test", knownPaths.knownFiles,
                 knownPaths.knownDirectories,
-                launchMode.getLaunchMode(), shutdownContext, contextPath, httpBuildTimeConfig.rootPath,
+                launchMode.getLaunchMode(), shutdownContext, httpRootPath.relativePath(contextPath),
                 servletConfig.defaultCharset, webMetaData.getRequestCharacterEncoding(),
                 webMetaData.getResponseCharacterEncoding(), httpBuildTimeConfig.auth.proactive,
                 webMetaData.getWelcomeFileList() != null ? webMetaData.getWelcomeFileList().getWelcomeFiles() : null);

diff --git a/...ndertow/runtime/src/main/java/io/quarkus/undertow/runtime/UndertowDeploymentRecorder.java b/...ndertow/runtime/src/main/java/io/quarkus/undertow/runtime/UndertowDeploymentRecorder.java
@@ -156,26 +156,17 @@ public static void setHotDeploymentResources(List<Path> resources) {
     }
 
     public RuntimeValue<DeploymentInfo> createDeployment(String name, Set<String> knownFile, Set<String> knownDirectories,
-            LaunchMode launchMode, ShutdownContext context, String contextPath, String httpRootPath, String defaultCharset,
+            LaunchMode launchMode, ShutdownContext context, String mountPoint, String defaultCharset,
             String requestCharacterEncoding, String responseCharacterEncoding, boolean proactiveAuth,
             List<String> welcomeFiles) {
-        String realMountPoint;
-        if (contextPath.equals("/")) {
-            realMountPoint = httpRootPath;
-        } else if (httpRootPath.equals("/")) {
-            realMountPoint = contextPath;
-        } else {
-            realMountPoint = httpRootPath + contextPath;
-        }
-
         DeploymentInfo d = new DeploymentInfo();
         d.setDefaultRequestEncoding(requestCharacterEncoding);
         d.setDefaultResponseEncoding(responseCharacterEncoding);
         d.setDefaultEncoding(defaultCharset);
         d.setSessionIdGenerator(new QuarkusSessionIdGenerator());
         d.setClassLoader(getClass().getClassLoader());
         d.setDeploymentName(name);
-        d.setContextPath(realMountPoint);
+        d.setContextPath(mountPoint);
         d.setEagerFilterInit(true);
         ClassLoader cl = Thread.currentThread().getContextClassLoader();
         if (cl == null) {