Remove HTTP options ALPN version field.

Motivation:

HTTP options classes define a List<HttpVersion> as ALPN versions to use.

Since the encapsulation of SSL options in SSLOptions, the HTTP options ALPN field mirrors the state of the underlying nested SSL options field.

Updating HTTP ALPN fields is not correlated to the nested ALPN generic field and thus the TCP client/server code needs to calculate it to reflect it.

Changes:

Remove the HTTP options ALPN version field and make the getter/setter delegate to the SSL options generic ALPN field.

Author: vietj

vertx-core/src/main/java/io/vertx/core/eventbus/EventBusOptions.java

@@ -31,8 +31,6 @@
 @JsonGen(publicConverter = false)
 public class EventBusOptions extends TCPSSLOptions {
 
-
-
   /**
    * The default cluster host = null which means use the same as the cluster manager, if possible.
    */

vertx-core/src/main/java/io/vertx/core/http/HttpClientOptions.java

@@ -13,8 +13,10 @@
 
 import io.netty.handler.logging.ByteBufFormat;
 import io.vertx.codegen.annotations.DataObject;
+import io.vertx.codegen.annotations.GenIgnore;
 import io.vertx.codegen.json.annotations.JsonGen;
 import io.vertx.core.buffer.Buffer;
+import io.vertx.core.http.impl.HttpUtils;
 import io.vertx.core.impl.Arguments;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.net.*;
@@ -181,7 +183,6 @@ public class HttpClientOptions extends ClientOptionsBase {
   private int maxInitialLineLength;
   private int maxHeaderSize;
   private Http2Settings initialSettings;
-  private List<HttpVersion> alpnVersions;
   private boolean http2ClearTextUpgrade;
   private boolean http2ClearTextUpgradeWithPreflightRequest;
   private int maxRedirects;
@@ -236,7 +237,6 @@ public HttpClientOptions(HttpClientOptions other) {
     this.maxInitialLineLength = other.getMaxInitialLineLength();
     this.maxHeaderSize = other.getMaxHeaderSize();
     this.initialSettings = other.initialSettings != null ? new Http2Settings(other.initialSettings) : null;
-    this.alpnVersions = other.alpnVersions != null ? new ArrayList<>(other.alpnVersions) : null;
     this.http2ClearTextUpgrade = other.http2ClearTextUpgrade;
     this.http2ClearTextUpgradeWithPreflightRequest = other.http2ClearTextUpgradeWithPreflightRequest;
     this.maxRedirects = other.maxRedirects;
@@ -288,7 +288,6 @@ private void init() {
     maxInitialLineLength = DEFAULT_MAX_INITIAL_LINE_LENGTH;
     maxHeaderSize = DEFAULT_MAX_HEADER_SIZE;
     initialSettings = new Http2Settings();
-    alpnVersions = new ArrayList<>(DEFAULT_ALPN_VERSIONS);
     http2ClearTextUpgrade = DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE;
     http2ClearTextUpgradeWithPreflightRequest = DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE_WITH_PREFLIGHT_REQUEST;
     maxRedirects = DEFAULT_MAX_REDIRECTS;
@@ -299,6 +298,11 @@ private void init() {
     name = DEFAULT_NAME;
   }
 
+  @Override
+  protected ClientSSLOptions createSSLOptions() {
+    return super.createSSLOptions().setApplicationLayerProtocols(HttpUtils.fromHttpAlpnVersions(DEFAULT_ALPN_VERSIONS));
+  }
+
   @Override
   public HttpClientOptions setSendBufferSize(int sendBufferSize) {
     super.setSendBufferSize(sendBufferSize);
@@ -857,12 +861,13 @@ public HttpClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
    * the list is empty, the client provides a best effort list according to {@link #setProtocolVersion}
    */
   public List<HttpVersion> getAlpnVersions() {
-    return alpnVersions;
+    List<String> applicationLayerProtocols = getOrCreateSSLOptions().getApplicationLayerProtocols();
+    return applicationLayerProtocols != null ? HttpUtils.toHttpAlpnVersions(applicationLayerProtocols ) : null;
   }
 
   /**
    * Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
-   * When the list is empty, the client provides a best effort list according to {@link #setProtocolVersion}:
+   * When the list is empty, the client makes a best effort list according to {@link #setProtocolVersion}:
    *
    * <ul>
    *   <li>{@link HttpVersion#HTTP_2}: [ "h2", "http/1.1" ]</li>
@@ -873,7 +878,12 @@ public List<HttpVersion> getAlpnVersions() {
    * @return a reference to this, so the API can be used fluently
    */
   public HttpClientOptions setAlpnVersions(List<HttpVersion> alpnVersions) {
-    this.alpnVersions = alpnVersions;
+    ClientSSLOptions sslOptions = getOrCreateSSLOptions();
+    if (alpnVersions != null) {
+      sslOptions.setApplicationLayerProtocols(HttpUtils.fromHttpAlpnVersions(alpnVersions));
+    } else {
+      sslOptions.setApplicationLayerProtocols(null);
+    }
     return this;
   }
 

vertx-core/src/main/java/io/vertx/core/http/HttpServerOptions.java

@@ -19,13 +19,10 @@
 import io.vertx.codegen.json.annotations.JsonGen;
 import io.vertx.core.Handler;
 import io.vertx.core.buffer.Buffer;
+import io.vertx.core.http.impl.HttpUtils;
 import io.vertx.core.impl.Arguments;
 import io.vertx.core.json.JsonObject;
-import io.vertx.core.net.KeyCertOptions;
-import io.vertx.core.net.NetServerOptions;
-import io.vertx.core.net.SSLEngineOptions;
-import io.vertx.core.net.TrafficShapingOptions;
-import io.vertx.core.net.TrustOptions;
+import io.vertx.core.net.*;
 import io.vertx.core.tracing.TracingPolicy;
 
 import java.util.ArrayList;
@@ -35,6 +32,7 @@
 import java.util.Objects;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 
 /**
  * Represents options used by an {@link io.vertx.core.http.HttpServer} instance
@@ -226,7 +224,6 @@ public class HttpServerOptions extends NetServerOptions {
   private int maxFormFields;
   private int maxFormBufferedBytes;
   private Http2Settings initialSettings;
-  private List<HttpVersion> alpnVersions;
   private boolean http2ClearTextEnabled;
   private int http2ConnectionWindowSize;
   private boolean decompressionSupported;
@@ -277,7 +274,6 @@ public HttpServerOptions(HttpServerOptions other) {
     this.maxFormFields = other.getMaxFormFields();
     this.maxFormBufferedBytes = other.getMaxFormBufferedBytes();
     this.initialSettings = other.initialSettings != null ? new Http2Settings(other.initialSettings) : null;
-    this.alpnVersions = other.alpnVersions != null ? new ArrayList<>(other.alpnVersions) : null;
     this.http2ClearTextEnabled = other.http2ClearTextEnabled;
     this.http2ConnectionWindowSize = other.http2ConnectionWindowSize;
     this.decompressionSupported = other.isDecompressionSupported();
@@ -336,7 +332,6 @@ private void init() {
     maxFormFields = DEFAULT_MAX_FORM_FIELDS;
     maxFormBufferedBytes = DEFAULT_MAX_FORM_BUFFERED_SIZE;
     initialSettings = new Http2Settings().setMaxConcurrentStreams(DEFAULT_INITIAL_SETTINGS_MAX_CONCURRENT_STREAMS);
-    alpnVersions = new ArrayList<>(DEFAULT_ALPN_VERSIONS);
     http2ClearTextEnabled = DEFAULT_HTTP2_CLEAR_TEXT_ENABLED;
     http2ConnectionWindowSize = DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE;
     decompressionSupported = DEFAULT_DECOMPRESSION_SUPPORTED;
@@ -365,6 +360,11 @@ public HttpServerOptions copy() {
     return new HttpServerOptions(this);
   }
 
+  @Override
+  protected ServerSSLOptions createSSLOptions() {
+    return super.createSSLOptions().setApplicationLayerProtocols(HttpUtils.fromHttpAlpnVersions(DEFAULT_ALPN_VERSIONS));
+  }
+
   @Override
   public HttpServerOptions setSendBufferSize(int sendBufferSize) {
     super.setSendBufferSize(sendBufferSize);
@@ -896,20 +896,26 @@ public HttpServerOptions setInitialSettings(Http2Settings settings) {
   }
 
   /**
-   * @return the list of protocol versions to provide during the Application-Layer Protocol Negotiatiation
+   * @return the list of protocol versions to provide during the Application-Layer Protocol Negotiation
    */
   public List<HttpVersion> getAlpnVersions() {
-    return alpnVersions;
+    List<String> applicationLayerProtocols = getOrCreateSSLOptions().getApplicationLayerProtocols();
+    return applicationLayerProtocols != null ? HttpUtils.toHttpAlpnVersions(applicationLayerProtocols ) : null;
   }
 
   /**
-   * Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.
+   * Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
    *
    * @param alpnVersions the versions
    * @return a reference to this, so the API can be used fluently
    */
   public HttpServerOptions setAlpnVersions(List<HttpVersion> alpnVersions) {
-    this.alpnVersions = alpnVersions;
+    ServerSSLOptions sslOptions = getOrCreateSSLOptions();
+    if (alpnVersions != null) {
+      sslOptions.setApplicationLayerProtocols(HttpUtils.fromHttpAlpnVersions(alpnVersions));
+    } else {
+      sslOptions.setApplicationLayerProtocols(null);
+    }
     return this;
   }
 

vertx-core/src/main/java/io/vertx/core/http/HttpVersion.java

@@ -34,4 +34,18 @@ public enum HttpVersion {
   public String alpnName() {
     return alpnName;
   }
+
+  public static HttpVersion fromAlpnName(String alpnName) {
+    switch (alpnName) {
+      case "http/1.0":
+        return HTTP_1_0;
+      case "http/1.1":
+        return HTTP_1_1;
+      case "h2":
+        return HTTP_2;
+      default:
+        return null;
+    }
+  }
+
 }

vertx-core/src/main/java/io/vertx/core/http/impl/HttpClientBase.java

@@ -26,7 +26,6 @@
 import java.util.*;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Predicate;
-import java.util.stream.Collectors;
 
 /**
  * @author <a href="http://tfox.org">Tim Fox</a>
@@ -36,7 +35,6 @@ public class HttpClientBase implements MetricsProvider, Closeable {
   protected final VertxInternal vertx;
   public final HttpClientOptions options;
   protected final NetClientInternal netClient;
-  protected final List<String> alpnVersions;
   protected final HttpClientMetrics metrics;
   protected final CloseSequence closeSequence;
   private volatile ClientSSLOptions defaultSslOptions;
@@ -48,23 +46,18 @@ public HttpClientBase(VertxInternal vertx, HttpClientOptions options) {
     if (!options.isKeepAlive() && options.isPipelining()) {
       throw new IllegalStateException("Cannot have pipelining with no keep alive");
     }
+    options = new HttpClientOptions(options);
     List<HttpVersion> alpnVersions = options.getAlpnVersions();
     if (alpnVersions == null || alpnVersions.isEmpty()) {
-      switch (options.getProtocolVersion()) {
-        case HTTP_2:
-          alpnVersions = Arrays.asList(HttpVersion.HTTP_2, HttpVersion.HTTP_1_1);
-          break;
-        default:
-          alpnVersions = Collections.singletonList(options.getProtocolVersion());
-          break;
+      if (options.getProtocolVersion() == HttpVersion.HTTP_2) {
+        options.setAlpnVersions(List.of(HttpVersion.HTTP_2, HttpVersion.HTTP_1_1));
+      } else {
+        options.setAlpnVersions(List.of(options.getProtocolVersion()));
       }
-    } else {
-      alpnVersions = new ArrayList<>(alpnVersions);
     }
-    this.alpnVersions = alpnVersions.stream().map(HttpVersion::alpnName).collect(Collectors.toUnmodifiableList());
     this.vertx = vertx;
     this.metrics = vertx.metrics() != null ? vertx.metrics().createHttpClientMetrics(options) : null;
-    this.options = new HttpClientOptions(options);
+    this.options = options;
     this.closeSequence = new CloseSequence(p -> doClose(p), p1 -> doShutdown(p1));
     this.proxyFilter = options.getNonProxyHosts() != null ? ProxyFilter.nonProxyHosts(options.getNonProxyHosts()) : ProxyFilter.DEFAULT_PROXY_FILTER;
     this.netClient = new NetClientBuilder(vertx, new NetClientOptions(options).setProxyOptions(null)).metrics(metrics).build();
@@ -80,9 +73,6 @@ private void configureSSLOptions(ClientSSLOptions sslOptions) {
     if (sslOptions.getHostnameVerificationAlgorithm() == null) {
       sslOptions.setHostnameVerificationAlgorithm(options.isVerifyHost() ? "HTTPS" : "");
     }
-    if (sslOptions.getApplicationLayerProtocols() == null) {
-      sslOptions.setApplicationLayerProtocols(alpnVersions);
-    }
   }
 
   public NetClientInternal netClient() {

vertx-core/src/main/java/io/vertx/core/http/impl/HttpServerImpl.java

@@ -26,10 +26,8 @@
 import io.vertx.core.spi.metrics.Metrics;
 import io.vertx.core.spi.metrics.MetricsProvider;
 
-import java.util.List;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
 /**
  * @author <a href="http://tfox.org">Tim Fox</a>
@@ -70,7 +68,6 @@ public Future<Boolean> updateSSLOptions(ServerSSLOptions options, boolean force)
       throw new IllegalStateException("Not listening");
     }
     options = options.copy();
-    configureApplicationLayerProtocols(options);
     return s.updateSSLOptions(options, force);
   }
 
@@ -180,9 +177,6 @@ public synchronized Future<HttpServer> listen(SocketAddress address) {
     }
     HttpServerOptions options = this.options;
     HttpServerOptions tcpOptions = new HttpServerOptions(options);
-    if (tcpOptions.getSslOptions() != null) {
-      configureApplicationLayerProtocols(tcpOptions.getSslOptions());
-    }
     ContextInternal context = vertx.getOrCreateContext();
     ContextInternal listenContext;
     // Not sure of this
@@ -271,18 +265,6 @@ public Future<Void> shutdown(long timeout, TimeUnit unit) {
     }
   }
 
-  /**
-   * Configure the {@code options} to match the server configured HTTP versions.
-   */
-  private void configureApplicationLayerProtocols(ServerSSLOptions options) {
-    List<String> applicationProtocols = this.options
-      .getAlpnVersions()
-      .stream()
-      .map(HttpVersion::alpnName)
-      .collect(Collectors.toList());
-    options.setApplicationLayerProtocols(applicationProtocols);
-  }
-
   private boolean isListening() {
     return tcpServer != null;
   }

vertx-core/src/main/java/io/vertx/core/http/impl/HttpUtils.java

@@ -51,6 +51,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
 
 import static io.netty.handler.codec.http.HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED;
 import static io.netty.handler.codec.http.HttpHeaderValues.MULTIPART_FORM_DATA;
@@ -996,4 +997,18 @@ public static String positiveLongToString(long value) {
     }
     return str;
   }
+
+  public static List<String> fromHttpAlpnVersions(List<io.vertx.core.http.HttpVersion> alpnVersions) {
+    return alpnVersions
+      .stream()
+      .map(io.vertx.core.http.HttpVersion::alpnName)
+      .collect(Collectors.toList());
+  }
+
+  public static List<io.vertx.core.http.HttpVersion> toHttpAlpnVersions(List<String> alpnVersions) {
+    return alpnVersions
+      .stream()
+      .map(io.vertx.core.http.HttpVersion::fromAlpnName)
+      .collect(Collectors.toList());
+  }
 }

vertx-core/src/main/java/io/vertx/core/net/ClientOptionsBase.java

@@ -109,6 +109,11 @@ protected ClientSSLOptions getOrCreateSSLOptions() {
     return (ClientSSLOptions) super.getOrCreateSSLOptions();
   }
 
+  @Override
+  protected ClientSSLOptions createSSLOptions() {
+    return new ClientSSLOptions();
+  }
+
   /**
    *
    * @return true if all server certificates should be trusted

vertx-core/src/main/java/io/vertx/core/net/NetServerOptions.java

@@ -146,6 +146,11 @@ protected ServerSSLOptions getOrCreateSSLOptions() {
     return (ServerSSLOptions) super.getOrCreateSSLOptions();
   }
 
+  @Override
+  protected ServerSSLOptions createSSLOptions() {
+    return new ServerSSLOptions();
+  }
+
   @Override
   public NetServerOptions setSendBufferSize(int sendBufferSize) {
     super.setSendBufferSize(sendBufferSize);

vertx-core/src/main/java/io/vertx/core/net/TCPSSLOptions.java

@@ -227,7 +227,7 @@ private void init() {
 
   protected SSLOptions getOrCreateSSLOptions() {
     if (sslOptions == null) {
-      sslOptions = this instanceof ClientOptionsBase ? new ClientSSLOptions() : new ServerSSLOptions();
+      sslOptions = createSSLOptions();
       // Necessary hacks because we return lazy created collections so we need to care about that
       if (enabledCipherSuites != null) {
         sslOptions.enabledCipherSuites = enabledCipherSuites;
@@ -248,6 +248,10 @@ protected SSLOptions getOrCreateSSLOptions() {
     return sslOptions;
   }
 
+  protected SSLOptions createSSLOptions() {
+    return new SSLOptions();
+  }
+
   @GenIgnore
   public TcpOptions getTransportOptions() {
     return transportOptions;