Merge branch 'main' into issue/67

Author: tsegismont

.github/workflows/ci-5.x.yml

@@ -18,7 +18,7 @@ jobs:
           - os: windows-latest
             jdk: 11
           - os: ubuntu-latest
-            jdk: 17
+            jdk: 21
     uses: ./.github/workflows/ci.yml
     with:
       branch: ${{ github.event.pull_request.head.sha || github.ref_name }}

pom.xml

@@ -20,7 +20,7 @@
   <parent>
     <groupId>io.vertx</groupId>
     <artifactId>vertx5-parent</artifactId>
-    <version>4</version>
+    <version>9</version>
   </parent>
 
   <artifactId>vertx-http-proxy</artifactId>
@@ -36,7 +36,6 @@
 
   <properties>
     <fatjar.dir>${project.build.directory}</fatjar.dir>
-    <jar.manifest>${project.basedir}/src/main/resources/META-INF/MANIFEST.MF</jar.manifest>
   </properties>
 
   <dependencyManagement>
@@ -134,4 +133,4 @@
       </plugin>
     </plugins>
   </build>
-</project>
+</project>

src/main/asciidoc/index.adoc

@@ -120,8 +120,6 @@ Likewise with the proxy response
 {@link examples.HttpProxyExamples#outboundInterceptor}
 ----
 
-Interceptors will not apply to WebSocket handshake packets by default. While in some use cases (e.g. changing the WebSocket request path), you can overwrite {@link io.vertx.httpproxy.ProxyInterceptor#allowApplyToWebSocket} method to allow interceptors apply to WebSocket.
-
 ==== Body filtering
 
 You can filter body by simply replacing the original {@link io.vertx.httpproxy.Body} with a new one
@@ -143,27 +141,41 @@ You can change the control, e.g you can send a response immediately to the user-
 {@link examples.HttpProxyExamples#immediateResponse}
 ----
 
-==== Header interceptor
+==== Head interceptor
+
+You can use the {@link io.vertx.httpproxy.interceptors.HeadInterceptor} to change HTTP request/response heads:
+
+- request path
+- query params
+- request and response headers
+
+A {@link io.vertx.httpproxy.interceptors.HeadInterceptor} is created and configured with a {@link io.vertx.httpproxy.interceptors.HeadInterceptorBuilder}.
 
-You can apply header interceptors to change headers from the request and response with common operations:
+The builder methods can be invoked several times.
+Operations on the path will be invoked in the order of configuration.
+That goes for operations on query parameters, request headers and response headers.
+
+===== Headers interception
+
+You can apply the interceptor to change headers from the request and response with common operations:
 
 [source,java]
 ----
 {@link examples.HttpProxyExamples#headerInterceptorFilter}
 ----
 
-Check out the {@link io.vertx.httpproxy.interceptors.HeadersInterceptor} class for details about the available methods.
+Check out {@link io.vertx.httpproxy.interceptors.HeadInterceptorBuilder} for details about the available methods.
 
-==== Query interceptor
+===== Query params interception
 
-You can use query interceptors to update or remove the query parameters:
+You can apply the interceptor to update or remove query parameters:
 
 [source,java]
 ----
 {@link examples.HttpProxyExamples#queryInterceptorAdd}
 ----
 
-You can also refer to {@link io.vertx.httpproxy.interceptors.QueryInterceptor} for more information.
+You can also refer to {@link io.vertx.httpproxy.interceptors.HeadInterceptorBuilder} for more information.
 
 ==== Body interceptor
 
@@ -176,9 +188,11 @@ You can use body interceptor to create body transformations for common data type
 
 Please check the {@link io.vertx.httpproxy.interceptors.BodyTransformer} for other supported transformations.
 
-==== WebSocket interceptor
+==== Interception and WebSocket upgrades
+
+By default, interceptors are not invoked during WebSocket upgrades.
 
-You can use WebSocket interceptor to wrap an interceptor to let it allow WebSocket handling:
+To make an interceptor available during the WebSocket handshake, use {@link io.vertx.httpproxy.HttpProxy#addInterceptor(io.vertx.httpproxy.ProxyInterceptor, boolean)}:
 
 [source,java]
 ----

src/main/generated/io/vertx/httpproxy/ProxyOptionsConverter.java

@@ -4,17 +4,13 @@
 import io.vertx.core.json.JsonArray;
 import java.time.Instant;
 import java.time.format.DateTimeFormatter;
-import java.util.Base64;
 
 /**
  * Converter and mapper for {@link io.vertx.httpproxy.ProxyOptions}.
  * NOTE: This class has been automatically generated from the {@link io.vertx.httpproxy.ProxyOptions} original class using Vert.x codegen.
  */
 public class ProxyOptionsConverter {
 
-  private static final Base64.Decoder BASE64_DECODER = Base64.getUrlDecoder();
-  private static final Base64.Encoder BASE64_ENCODER = Base64.getUrlEncoder().withoutPadding();
-
    static void fromJson(Iterable<java.util.Map.Entry<String, Object>> json, ProxyOptions obj) {
     for (java.util.Map.Entry<String, Object> member : json) {
       switch (member.getKey()) {

src/main/generated/io/vertx/httpproxy/cache/CacheOptionsConverter.java

@@ -4,17 +4,13 @@
 import io.vertx.core.json.JsonArray;
 import java.time.Instant;
 import java.time.format.DateTimeFormatter;
-import java.util.Base64;
 
 /**
  * Converter and mapper for {@link io.vertx.httpproxy.cache.CacheOptions}.
  * NOTE: This class has been automatically generated from the {@link io.vertx.httpproxy.cache.CacheOptions} original class using Vert.x codegen.
  */
 public class CacheOptionsConverter {
 
-  private static final Base64.Decoder BASE64_DECODER = Base64.getUrlDecoder();
-  private static final Base64.Encoder BASE64_ENCODER = Base64.getUrlEncoder().withoutPadding();
-
    static void fromJson(Iterable<java.util.Map.Entry<String, Object>> json, CacheOptions obj) {
     for (java.util.Map.Entry<String, Object> member : json) {
       switch (member.getKey()) {

src/main/java/examples/HttpProxyExamples.java

@@ -13,7 +13,9 @@
 import io.vertx.core.net.SocketAddress;
 import io.vertx.httpproxy.*;
 import io.vertx.httpproxy.cache.CacheOptions;
-import io.vertx.httpproxy.interceptors.*;
+import io.vertx.httpproxy.interceptors.BodyInterceptor;
+import io.vertx.httpproxy.interceptors.BodyTransformer;
+import io.vertx.httpproxy.interceptors.HeadInterceptor;
 
 import java.util.Set;
 
@@ -109,12 +111,12 @@ public Future<Void> handleProxyResponse(ProxyContext context) {
   public void headerInterceptorFilter(HttpProxy proxy, Set<CharSequence> shouldRemove) {
     // remove a set of headers
     proxy.addInterceptor(
-      HeadersInterceptor.filterResponseHeaders(shouldRemove));
+      HeadInterceptor.builder().filteringResponseHeaders(shouldRemove).build());
   }
 
   public void queryInterceptorAdd(HttpProxy proxy, String key, String value) {
     proxy.addInterceptor(
-      QueryInterceptor.setQueryParam(key, value));
+      HeadInterceptor.builder().settingQueryParam(key, value).build());
   }
 
   public void bodyInterceptorJson(HttpProxy proxy) {
@@ -127,9 +129,10 @@ public void bodyInterceptorJson(HttpProxy proxy) {
   }
 
   public void webSocketInterceptorPath(HttpProxy proxy) {
-    proxy.addInterceptor(
-      WebSocketInterceptor.allow(PathInterceptor.addPrefix("/api"))
-    );
+    HeadInterceptor interceptor = HeadInterceptor.builder()
+      .addingPathPrefix("/api")
+      .build();
+    proxy.addInterceptor(interceptor, true);
   }
 
   public void immediateResponse(HttpProxy proxy) {

src/main/java/io/vertx/httpproxy/HttpProxy.java

@@ -102,12 +102,29 @@ default HttpProxy originSelector(Function<HttpServerRequest, Future<SocketAddres
 
   /**
    * Add an interceptor to the interceptor chain.
+   * <p>
+   * Interceptors are invoked in order of configuration.
+   * When added with this method, it is considered the interceptor doesn't support WebSocket upgrades.
    *
-   * @param interceptor
+   * @param interceptor the {@link ProxyInterceptor} to add
    * @return a reference to this, so the API can be used fluently
    */
   @Fluent
-  HttpProxy addInterceptor(ProxyInterceptor interceptor);
+  default HttpProxy addInterceptor(ProxyInterceptor interceptor) {
+    return addInterceptor(interceptor, false);
+  }
+
+  /**
+   * Add an interceptor to the interceptor chain.
+   * <p>
+   * Interceptors are invoked in order of configuration.
+   *
+   * @param interceptor the {@link ProxyInterceptor} to add
+   * @param supportsWebSocketUpgrade whether the interceptor supports WebSocket upgrades
+   * @return a reference to this, so the API can be used fluently
+   */
+  @Fluent
+  HttpProxy addInterceptor(ProxyInterceptor interceptor, boolean supportsWebSocketUpgrade);
 
   /**
    * Handle the <i><b>outbound</b></i> {@code HttpServerRequest}.

src/main/java/io/vertx/httpproxy/ProxyInterceptor.java

@@ -28,14 +28,4 @@ default Future<ProxyResponse> handleProxyRequest(ProxyContext context) {
   default Future<Void> handleProxyResponse(ProxyContext context) {
     return context.sendResponse();
   }
-
-  /**
-   * Used to set whether to apply the interceptor to the WebSocket
-   * handshake packet. The default value is false.
-   *
-   * @return the boolean value
-   */
-  default boolean allowApplyToWebSocket() {
-    return false;
-  }
 }

src/main/java/io/vertx/httpproxy/impl/ProxiedRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2020 Contributors to the Eclipse Foundation
+ * Copyright (c) 2011-2025 Contributors to the Eclipse Foundation
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -10,9 +10,14 @@
  */
 package io.vertx.httpproxy.impl;
 
-import io.vertx.core.*;
+import io.vertx.core.Future;
+import io.vertx.core.MultiMap;
 import io.vertx.core.buffer.Buffer;
-import io.vertx.core.http.*;
+import io.vertx.core.http.HttpClientRequest;
+import io.vertx.core.http.HttpHeaders;
+import io.vertx.core.http.HttpMethod;
+import io.vertx.core.http.HttpServerRequest;
+import io.vertx.core.http.HttpVersion;
 import io.vertx.core.internal.ContextInternal;
 import io.vertx.core.internal.http.HttpServerRequestInternal;
 import io.vertx.core.net.HostAndPort;
@@ -24,19 +29,27 @@
 import java.util.Map;
 import java.util.Objects;
 
+import static io.vertx.core.http.HttpHeaders.CONNECTION;
+import static io.vertx.core.http.HttpHeaders.CONTENT_LENGTH;
+import static io.vertx.core.http.HttpHeaders.KEEP_ALIVE;
+import static io.vertx.core.http.HttpHeaders.PROXY_AUTHENTICATE;
+import static io.vertx.core.http.HttpHeaders.PROXY_AUTHORIZATION;
+import static io.vertx.core.http.HttpHeaders.TRANSFER_ENCODING;
+import static io.vertx.core.http.HttpHeaders.UPGRADE;
+
 public class ProxiedRequest implements ProxyRequest {
 
   private static final CharSequence X_FORWARDED_HOST = HttpHeaders.createOptimized("x-forwarded-host");
 
   private static final MultiMap HOP_BY_HOP_HEADERS = MultiMap.caseInsensitiveMultiMap()
-    .add(HttpHeaders.CONNECTION, "whatever")
-    .add(HttpHeaders.KEEP_ALIVE, "whatever")
-    .add(HttpHeaders.PROXY_AUTHENTICATE, "whatever")
-    .add(HttpHeaders.PROXY_AUTHORIZATION, "whatever")
+    .add(CONNECTION, "whatever")
+    .add(KEEP_ALIVE, "whatever")
+    .add(PROXY_AUTHENTICATE, "whatever")
+    .add(PROXY_AUTHORIZATION, "whatever")
     .add("te", "whatever")
     .add("trailer", "whatever")
-    .add(HttpHeaders.TRANSFER_ENCODING, "whatever")
-    .add(HttpHeaders.UPGRADE, "whatever");
+    .add(TRANSFER_ENCODING, "whatever")
+    .add(UPGRADE, "whatever");
 
   final ContextInternal context;
   private HttpMethod method;
@@ -53,7 +66,7 @@ public ProxiedRequest(HttpServerRequest proxiedRequest) {
 
     // Determine content length
     long contentLength = -1L;
-    String contentLengthHeader = proxiedRequest.getHeader(HttpHeaders.CONTENT_LENGTH);
+    String contentLengthHeader = proxiedRequest.getHeader(CONTENT_LENGTH);
     if (contentLengthHeader != null) {
       try {
         contentLength = Long.parseLong(contentLengthHeader);
@@ -170,24 +183,31 @@ Future<ProxyResponse> sendRequest() {
       }
     }
 
-    long len = body.length();
-    if (len >= 0) {
-      request.putHeader(HttpHeaders.CONTENT_LENGTH, Long.toString(len));
+    if (body == null) {
+      if (proxiedRequest.headers().contains(CONTENT_LENGTH)) {
+        request.putHeader(CONTENT_LENGTH, "0");
+      }
+      request.end();
     } else {
-      Boolean isChunked = HttpUtils.isChunked(proxiedRequest.headers());
-      request.setChunked(len == -1 && Boolean.TRUE == isChunked);
-    }
-
-    Pipe<Buffer> pipe = body.stream().pipe();
-    pipe.endOnComplete(true);
-    pipe.endOnFailure(false);
-    pipe.to(request).onComplete(ar -> {
-      if (ar.failed()) {
-        request.reset();
+      long len = body.length();
+      if (len >= 0) {
+        request.putHeader(CONTENT_LENGTH, Long.toString(len));
+      } else {
+        Boolean isChunked = HttpUtils.isChunked(proxiedRequest.headers());
+        request.setChunked(len == -1 && Boolean.TRUE == isChunked);
       }
-    });
 
-    return request.response().<ProxyResponse>map(r -> {
+      Pipe<Buffer> pipe = body.stream().pipe();
+      pipe.endOnComplete(true);
+      pipe.endOnFailure(false);
+      pipe.to(request).onComplete(ar -> {
+        if (ar.failed()) {
+          request.reset();
+        }
+      });
+    }
+
+    return request.response().map(r -> {
       r.pause(); // Pause it
       return new ProxiedResponse(this, proxiedRequest.response(), r);
     });

src/main/java/io/vertx/httpproxy/impl/ProxiedResponse.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2020 Contributors to the Eclipse Foundation
+ * Copyright (c) 2011-2025 Contributors to the Eclipse Foundation
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -10,11 +10,8 @@
  */
 package io.vertx.httpproxy.impl;
 
-import io.vertx.core.AsyncResult;
 import io.vertx.core.Future;
-import io.vertx.core.Handler;
 import io.vertx.core.MultiMap;
-import io.vertx.core.Promise;
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.http.HttpClientResponse;
 import io.vertx.core.http.HttpHeaders;
@@ -31,6 +28,8 @@
 import java.util.Iterator;
 import java.util.List;
 
+import static io.vertx.core.http.HttpHeaders.CONTENT_LENGTH;
+
 class ProxiedResponse implements ProxyResponse {
 
   private final ProxiedRequest request;
@@ -214,8 +213,10 @@ public Future<Void> send() {
       }
     });
 
-    //
     if (body == null) {
+      if (response != null && response.headers().contains(CONTENT_LENGTH)) {
+        proxiedResponse.putHeader(CONTENT_LENGTH, "0");
+      }
       return proxiedResponse.end();
     } else {
       long len = body.length();