EnableHttp2PublicAPI (#45294)

* allow using http2

* update pipeline

* fix tests

* allow enable http2

* resolve comments

* fix tests

* update changelog

* add enableHttp2PublicAPI

* update changelog

* Update sdk/cosmos/azure-cosmos/CHANGELOG.md

Co-authored-by: Fabian Meiswinkel <[email protected]>

* resolve comments

* fix tests

* add javadocs

* make toDiagnosticsString() package private

* remove annotation

* Http2ConnectionConfig.toDiagnosticsString() needs to be public for ConnectionPolicy.toString()

* fix diagnostics tests

* Fixing Beta-Version

* Update Http2ConnectionConfig.java

* Update Http2ConnectionConfig.java

* Fixing more flaky tests

* Fixing build break

* Update ClientMetricsTest.java

* Update ClientMetricsTest.java

---------

Co-authored-by: annie-mac <[email protected]>
Co-authored-by: Annie Liang <[email protected]>
Co-authored-by: Neha Rao <[email protected]>
Co-authored-by: nehrao1 <[email protected]>

Author: 4 people

sdk/cosmos/azure-cosmos-benchmark/src/test/java/com/azure/cosmos/benchmark/FlakyTestRetryAnalyzer.java

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package com.azure.cosmos.benchmark;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testng.IRetryAnalyzer;
+import org.testng.ITestResult;
+
+public class FlakyTestRetryAnalyzer implements IRetryAnalyzer {
+    protected static Logger logger = LoggerFactory.getLogger(FlakyTestRetryAnalyzer.class.getSimpleName());
+    private int counter = 0;
+    protected int retryLimit = 2;
+
+    @Override
+    public boolean retry(ITestResult iTestResult) {
+        if (iTestResult.isSuccess()) {
+            return false;
+        }
+
+        if (counter < retryLimit) {
+            counter++;
+            logger.info(
+                "Retrying test {} - retry number {} out of at most {}. Exception seen in previous attempt: {}",
+                iTestResult.getTestName(),
+                counter,
+                retryLimit,
+                iTestResult.getThrowable());
+
+            return true;
+        }
+
+        return false;
+    }
+}

sdk/cosmos/azure-cosmos-benchmark/src/test/java/com/azure/cosmos/benchmark/ReadMyWritesConsistencyTest.java

@@ -94,7 +94,7 @@ public Object[][] collectionLinkTypeArgProvider() {
         };
     }
 
-    @Test(dataProvider = "collectionLinkTypeArgProvider", groups = "e2e")
+    @Test(dataProvider = "collectionLinkTypeArgProvider", groups = "e2e", retryAnalyzer = FlakyTestRetryAnalyzer.class)
     public void readMyWrites(boolean useNameLink) throws Exception {
 
         int concurrency = 5;

sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/ClientMetricsTest.java

@@ -139,6 +139,7 @@ public void createItem() throws Exception {
 
         for (boolean disableLatencyMeter: disableLatencyMeterTestCases) {
 
+            logger.info("Disable latency meter: {}", disableLatencyMeter);
             try (TestState state = new TestState(getClientBuilder(), CosmosMetricCategory.DEFAULT)) {
                 if (disableLatencyMeter) {
                     state.inputMetricsOptions
@@ -1507,14 +1508,27 @@ public TestState(CosmosClientBuilder clientBuilder,
             assertThat(writeRegions).isNotNull().isNotEmpty();
             this.preferredRegion = writeRegions.iterator().next();
 
-            CosmosAsyncDatabase db = getSharedCosmosDatabase(this.client.asyncClient());
-            CosmosAsyncContainer asyncContainer = createCollection(
-                db,
-                getCollectionDefinitionWithRangeRangeIndex(),
-                new CosmosContainerRequestOptions(),
-                10100);
-            this.databaseId = db.getId();
-            this.containerId = asyncContainer.getId();
+            CosmosClient mgmtClient = clientBuilder
+                .clientTelemetryConfig(
+                    new CosmosClientTelemetryConfig().metricsOptions(new CosmosMicrometerMetricsOptions().setEnabled(false))
+                )
+                .buildClient();
+            try {
+                CosmosAsyncDatabase db = getSharedCosmosDatabase(mgmtClient.asyncClient());
+                CosmosAsyncContainer asyncContainer = createCollection(
+                    db,
+                    getCollectionDefinitionWithRangeRangeIndex(),
+                    new CosmosContainerRequestOptions(),
+                    10100);
+
+                this.databaseId = db.getId();
+                this.containerId = asyncContainer.getId();
+                mgmtClient.close();
+            } catch (Exception error) {
+                logger.error(error.getMessage(), error);
+                throw error;
+            }
+
             this.clientCorrelationTag = client.asyncClient().getClientCorrelationTag();
             this.container = client.getDatabase(databaseId).getContainer(containerId);
         }
@@ -1541,7 +1555,11 @@ public void close() throws Exception {
                 }
             }
 
-            CosmosClient mgmtClient = clientBuilder.buildClient();
+            CosmosClient mgmtClient = clientBuilder
+                .clientTelemetryConfig(
+                    new CosmosClientTelemetryConfig().metricsOptions(new CosmosMicrometerMetricsOptions().setEnabled(false))
+                )
+                .buildClient();
             try {
                 mgmtClient.getDatabase(this.databaseId).getContainer(this.containerId).delete();
                 mgmtClient.close();

sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/ProactiveConnectionManagementTest.java

@@ -135,7 +135,7 @@ public void openConnectionsAndInitCachesWithInvalidCosmosClientConfig(List<Strin
         }
     }
 
-    @Test(groups = {"multi-master"}, dataProvider = "proactiveContainerInitConfigs")
+    @Test(groups = {"multi-master"}, dataProvider = "proactiveContainerInitConfigs", retryAnalyzer = FlakyTestRetryAnalyzer.class)
     public void openConnectionsAndInitCachesWithContainer(ProactiveConnectionManagementTestConfig proactiveConnectionManagementTestConfig) {
         CosmosAsyncClient asyncClient = null;
 

sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/ClientConfigDiagnosticsTest.java

@@ -202,7 +202,9 @@ public void rntbd() throws Exception {
         assertThat(objectNode.get("numberOfClients").asInt()).isEqualTo(2);
         assertThat(objectNode.get("consistencyCfg").asText()).isEqualTo("(consistency: null, readConsistencyStrategy: null,  mm: false, prgns: [null])");
         assertThat(objectNode.get("connCfg").get("rntbd").asText()).isEqualTo("(cto:PT5S, nrto:PT5S, icto:PT0S, ieto:PT1H, mcpe:130, mrpc:30, cer:true)");
-        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:1000, nrto:PT1M, icto:PT1M, cto:PT45S, p:false)");
+
+        String http2Enabled = Configs.isHttp2Enabled() ? "true" : "false";
+        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:1000, nrto:PT1M, icto:PT1M, cto:PT45S, p:false, http2:(enabled:"+ http2Enabled + ", maxc:1000, minc:1, maxs:30))");
         assertThat(objectNode.get("connCfg").get("other").asText()).isEqualTo("(ed: false, cs: false, rv: true)");
     }
 
@@ -237,7 +239,9 @@ public void gw() throws Exception {
         assertThat(objectNode.get("numberOfClients").asInt()).isEqualTo(2);
         assertThat(objectNode.get("consistencyCfg").asText()).isEqualTo("(consistency: null, readConsistencyStrategy: null,  mm: false, prgns: [null])");
         assertThat(objectNode.get("connCfg").get("rntbd").asText()).isEqualTo("null");
-        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:500, nrto:PT18S, icto:PT17S, cto:PT45S, p:false)");
+
+        String http2Enabled = Configs.isHttp2Enabled() ? "true" : "false";
+        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:500, nrto:PT18S, icto:PT17S, cto:PT45S, p:false, http2:(enabled:" + http2Enabled + ", maxc:1000, minc:1, maxs:30))");
         assertThat(objectNode.get("connCfg").get("other").asText()).isEqualTo("(ed: false, cs: false, rv: true)");
     }
 
@@ -309,7 +313,9 @@ public void full(
         assertThat(objectNode.get("numberOfClients").asInt()).isEqualTo(2);
         assertThat(objectNode.get("consistencyCfg").asText()).isEqualTo("(consistency: null, readConsistencyStrategy: null,  mm: false, prgns: [westus1,westus2])");
         assertThat(objectNode.get("connCfg").get("rntbd").asText()).isEqualTo("null");
-        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:500, nrto:PT18S, icto:PT17S, cto:PT45S, p:false)");
+
+        String http2Enabled = Configs.isHttp2Enabled() ? "true" : "false";
+        assertThat(objectNode.get("connCfg").get("gw").asText()).isEqualTo("(cps:500, nrto:PT18S, icto:PT17S, cto:PT45S, p:false, http2:(enabled:" + http2Enabled + ", maxc:1000, minc:1, maxs:30))");
         assertThat(objectNode.get("connCfg").get("other").asText()).isEqualTo("(ed: true, cs: true, rv: false)");
         assertThat(objectNode.get("excrgns").asText()).isEqualTo("[westus2]");
 

sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/RxDocumentClientImplTest.java

@@ -10,6 +10,7 @@
 import com.azure.cosmos.CosmosDiagnostics;
 import com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig;
 import com.azure.cosmos.CosmosItemSerializer;
+import com.azure.cosmos.Http2ConnectionConfig;
 import com.azure.cosmos.SessionRetryOptions;
 import com.azure.cosmos.implementation.apachecommons.lang.tuple.ImmutablePair;
 import com.azure.cosmos.implementation.caches.RxClientCollectionCache;
@@ -179,6 +180,7 @@ public void readMany() {
         Mockito.when(this.connectionPolicyMock.getMaxConnectionPoolSize()).thenReturn(dummyInt);
         Mockito.when(this.connectionPolicyMock.getProxy()).thenReturn(dummyProxyOptions);
         Mockito.when(this.connectionPolicyMock.getHttpNetworkRequestTimeout()).thenReturn(dummyDuration);
+        Mockito.when(this.connectionPolicyMock.getHttp2ConnectionConfig()).thenReturn(new Http2ConnectionConfig());
 
         httpClientMock
             .when(() -> HttpClient.createFixed(Mockito.any(HttpClientConfig.class)))

sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/TestSuiteBase.java

@@ -4,7 +4,6 @@
 
 import com.azure.core.credential.AzureKeyCredential;
 import com.azure.cosmos.BridgeInternal;
-import com.azure.cosmos.ConnectionMode;
 import com.azure.cosmos.ConsistencyLevel;
 import com.azure.cosmos.CosmosAsyncClient;
 import com.azure.cosmos.CosmosAsyncClientTest;
@@ -14,15 +13,14 @@
 import com.azure.cosmos.CosmosBridgeInternal;
 import com.azure.cosmos.CosmosClient;
 import com.azure.cosmos.CosmosClientBuilder;
-import com.azure.cosmos.CosmosContainer;
 import com.azure.cosmos.CosmosDatabase;
 import com.azure.cosmos.CosmosDatabaseForTest;
 import com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder;
 import com.azure.cosmos.CosmosException;
 import com.azure.cosmos.CosmosResponseValidator;
 import com.azure.cosmos.DirectConnectionConfig;
 import com.azure.cosmos.GatewayConnectionConfig;
-import com.azure.cosmos.ReadConsistencyStrategy;
+import com.azure.cosmos.Http2ConnectionConfig;
 import com.azure.cosmos.TestNGLogListener;
 import com.azure.cosmos.ThrottlingRetryOptions;
 import com.azure.cosmos.implementation.Configs;
@@ -1474,6 +1472,15 @@ static protected CosmosClientBuilder createGatewayRxDocumentClient(
         boolean retryOnThrottledRequests) {
 
         GatewayConnectionConfig gatewayConnectionConfig = new GatewayConnectionConfig();
+        if (Configs.isHttp2Enabled()) {
+            Http2ConnectionConfig http2ConnectionConfig = new Http2ConnectionConfig()
+                .setEnabled(true)
+                .setMaxConnectionPoolSize(10)
+                .setMinConnectionPoolSize(1)
+                .setMaxConcurrentStreams(30);
+            gatewayConnectionConfig.setHttp2ConnectionConfig(http2ConnectionConfig);
+        }
+
         CosmosClientBuilder builder = new CosmosClientBuilder().endpoint(endpoint)
             .credential(credential)
             .gatewayMode(gatewayConnectionConfig)

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -3,6 +3,7 @@
 ### 4.69.0 (2025-05-13)
 
 #### Features Added
+* Added Beta public API to enable http2. - See [PR 43123](https://github.com/Azure/azure-sdk-for-java/pull/43123)
 * Added API to allow customers to wrap/extend `CosmosAsyncContainer` - [PR 43724](https://github.com/Azure/azure-sdk-for-java/pull/43724) and [PR 45087](https://github.com/Azure/azure-sdk-for-java/pull/45087) 
 * Added Per-Partition Automatic Failover which enables failover for writes at per-partition level for Single-Write Multi-Region accounts. - [PR 44099](https://github.com/Azure/azure-sdk-for-java/pull/44099)
 * Added Beta public API to allow defining the consistency behavior for read / query / change feed operations independent of the chosen account-level consistency level. **NOTE: This API is still in preview mode and can only be used when using DIRECT connection mode.** - See [PR 45161](https://github.com/Azure/azure-sdk-for-java/pull/45161)

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BridgeInternal.java

@@ -623,5 +623,6 @@ public static void  initializeAllAccessors() {
         SessionRetryOptions.initialize();
         CosmosItemSerializer.initialize();
         ReadConsistencyStrategy.initialize();
+        Http2ConnectionConfig.initialize();
     }
 }

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/GatewayConnectionConfig.java

@@ -5,6 +5,7 @@
 
 import com.azure.core.http.ProxyOptions;
 import com.azure.cosmos.implementation.Configs;
+import com.azure.cosmos.util.Beta;
 
 import java.time.Duration;
 
@@ -24,6 +25,7 @@ public final class GatewayConnectionConfig {
     private int maxConnectionPoolSize;
     private Duration idleConnectionTimeout;
     private ProxyOptions proxy;
+    private Http2ConnectionConfig http2ConnectionConfig;
 
     /**
      * Constructor.
@@ -32,6 +34,7 @@ public GatewayConnectionConfig() {
         this.idleConnectionTimeout = DEFAULT_IDLE_CONNECTION_TIMEOUT;
         this.maxConnectionPoolSize = Configs.getDefaultHttpPoolSize();
         this.networkRequestTimeout = DEFAULT_NETWORK_REQUEST_TIMEOUT;
+        this.http2ConnectionConfig = new Http2ConnectionConfig();
     }
 
     /**
@@ -136,6 +139,27 @@ public GatewayConnectionConfig setProxy(ProxyOptions proxy) {
         return this;
     }
 
+    /***
+     * Get the http2 connection config.
+     * @return the {@link Http2ConnectionConfig}.
+     */
+    @Beta(value = Beta.SinceVersion.V4_69_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public Http2ConnectionConfig getHttp2ConnectionConfig() {
+        return http2ConnectionConfig;
+    }
+
+    /***
+     * Set the http2 connection config.
+     * @param http2ConnectionConfig the {@link Http2ConnectionConfig}.
+     */
+    @Beta(value = Beta.SinceVersion.V4_69_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public GatewayConnectionConfig setHttp2ConnectionConfig(Http2ConnectionConfig http2ConnectionConfig) {
+        checkNotNull(http2ConnectionConfig, "Argument 'http2ConnectionConfig' can not be null");
+
+        this.http2ConnectionConfig = http2ConnectionConfig;
+        return this;
+    }
+
     @Override
     public String toString() {
         String proxyType = proxy != null ? proxy.getType().toString() : null;
@@ -147,6 +171,7 @@ public String toString() {
             ", networkRequestTimeout=" + networkRequestTimeout +
             ", proxyType=" + proxyType +
             ", inetSocketProxyAddress=" + proxyAddress +
+            ", http2ConnectionConfig=" + http2ConnectionConfig.toDiagnosticsString() +
             '}';
     }
 }