Add HTTP/2 PING for broken connection detection.

sdk/cosmos/azure-cosmos-tests/pom.xml

@@ -857,6 +857,67 @@ Licensed under the MIT License.
         </plugins>
       </build>
     </profile>
+    <profile>
+      <id>manual-http-network-fault</id>
+      <properties>
+        <test.groups>manual-http-network-fault</test.groups>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <version>3.5.3</version> <!-- {x-version-update;org.apache.maven.plugins:maven-failsafe-plugin;external_dependency} -->
+            <configuration>
+              <suiteXmlFiles>
+                <suiteXmlFile>src/test/resources/manual-http-network-fault-testng.xml</suiteXmlFile>
+              </suiteXmlFiles>
+              <systemPropertyVariables>
+                <COSMOS.CLIENT_LEAK_DETECTION_ENABLED>true</COSMOS.CLIENT_LEAK_DETECTION_ENABLED>
+                <COSMOS.THINCLIENT_ENABLED>true</COSMOS.THINCLIENT_ENABLED>
+                <COSMOS.HTTP2_ENABLED>true</COSMOS.HTTP2_ENABLED>
+                <COSMOS.HTTP2_PING_HEALTH_ENABLED>true</COSMOS.HTTP2_PING_HEALTH_ENABLED>
+                <COSMOS.HTTP2_PING_INTERVAL_IN_SECONDS>1</COSMOS.HTTP2_PING_INTERVAL_IN_SECONDS>
+                <COSMOS.HTTP2_PING_TIMEOUT_IN_SECONDS>2</COSMOS.HTTP2_PING_TIMEOUT_IN_SECONDS>
+              </systemPropertyVariables>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <!-- Compute / Gateway V2 variant of manual-http-network-fault. Same suite XML and test
+           group as the thin-client variant; the only difference is COSMOS.THINCLIENT_ENABLED=false
+           so HTTP/2 tests (e.g. Http2PingKeepaliveTest) exercise the regional gateway on :443
+           instead of the thin-client proxy on :10250. Requires an account whose regional
+           gateway negotiates h2 via ALPN. -->
+      <id>manual-http-network-fault-compute</id>
+      <properties>
+        <test.groups>manual-http-network-fault</test.groups>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <version>3.5.3</version> <!-- {x-version-update;org.apache.maven.plugins:maven-failsafe-plugin;external_dependency} -->
+            <configuration>
+              <suiteXmlFiles>
+                <suiteXmlFile>src/test/resources/manual-http-network-fault-testng.xml</suiteXmlFile>
+              </suiteXmlFiles>
+              <systemPropertyVariables>
+                <COSMOS.CLIENT_LEAK_DETECTION_ENABLED>true</COSMOS.CLIENT_LEAK_DETECTION_ENABLED>
+                <COSMOS.THINCLIENT_ENABLED>false</COSMOS.THINCLIENT_ENABLED>
+                <COSMOS.HTTP2_ENABLED>true</COSMOS.HTTP2_ENABLED>
+                <COSMOS.HTTP2_PING_HEALTH_ENABLED>true</COSMOS.HTTP2_PING_HEALTH_ENABLED>
+                <COSMOS.HTTP2_PING_INTERVAL_IN_SECONDS>1</COSMOS.HTTP2_PING_INTERVAL_IN_SECONDS>
+                <COSMOS.HTTP2_PING_TIMEOUT_IN_SECONDS>2</COSMOS.HTTP2_PING_TIMEOUT_IN_SECONDS>
+              </systemPropertyVariables>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
     <profile>
       <!-- thin client integration tests, requires thin client endpoint and key -->
       <id>fi-thinclient-multi-region</id>

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

@@ -21,6 +21,7 @@
 import com.azure.cosmos.implementation.RxStoreModel;
 import com.azure.cosmos.implementation.TestConfigurations;
 import com.azure.cosmos.implementation.UserAgentContainer;
+import com.azure.cosmos.implementation.UserAgentFeatureFlags;
 import com.azure.cosmos.implementation.Utils;
 import com.azure.cosmos.implementation.clienttelemetry.ClientTelemetry;
 import com.azure.cosmos.implementation.directconnectivity.GatewayAddressCache;
@@ -1978,8 +1979,17 @@ private void validateChannelAcquisitionContext(CosmosDiagnostics diagnostics, bo
     }
 
     private String generateHttp2OptedInUserAgentIfRequired(String userAgent) {
+        // Mirrors RxDocumentClientImpl.addUserAgentSuffix + UserAgentContainer.setFeatureEnabledFlagsAsSuffix:
+        // when HTTP/2 is enabled, the Http2 bit is set; when PING keepalive is also effectively enabled
+        // (kill-switch on AND positive interval), the Http2PingHealth bit is OR'd in.
+        // Tests here do not override Http2ConnectionConfig.setEnabled(...) so the per-client override branch
+        // in addUserAgentSuffix is a no-op for this helper.
         if (Configs.isHttp2Enabled()) {
-            userAgent = userAgent + "|F10";
+            int featureValue = UserAgentFeatureFlags.Http2.getValue();
+            if (Configs.isHttp2PingHealthEnabled() && Configs.getHttp2PingIntervalInSeconds() > 0) {
+                featureValue |= UserAgentFeatureFlags.Http2PingHealth.getValue();
+            }
+            userAgent = userAgent + "|F" + Integer.toHexString(featureValue).toUpperCase(Locale.ROOT);
         }
 
         return userAgent;

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

@@ -7,6 +7,7 @@
 package com.azure.cosmos;
 
 import com.azure.cosmos.implementation.Configs;
+import com.azure.cosmos.implementation.UserAgentFeatureFlags;
 import com.azure.cosmos.models.CosmosContainerResponse;
 import com.azure.cosmos.rx.TestSuiteBase;
 import org.testng.ITestContext;
@@ -15,6 +16,8 @@
 import org.testng.annotations.Factory;
 import org.testng.annotations.Test;
 
+import java.util.Locale;
+
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class UserAgentSuffixTest extends TestSuiteBase {
@@ -115,8 +118,15 @@ public void userAgentSuffixWithWhitespaceAndAsciiSpecialChars() {
 
     private void validateUserAgentSuffix(String actualUserAgent, String expectedUserAgentSuffix) {
 
+        // Mirrors RxDocumentClientImpl.addUserAgentSuffix + UserAgentContainer.setFeatureEnabledFlagsAsSuffix:
+        // when HTTP/2 is enabled, the Http2 bit is set; when PING keepalive is also effectively enabled
+        // (kill-switch on AND positive interval), the Http2PingHealth bit is OR'd in.
         if (Configs.isHttp2Enabled()) {
-            expectedUserAgentSuffix = expectedUserAgentSuffix + "|F10";
+            int featureValue = UserAgentFeatureFlags.Http2.getValue();
+            if (Configs.isHttp2PingHealthEnabled() && Configs.getHttp2PingIntervalInSeconds() > 0) {
+                featureValue |= UserAgentFeatureFlags.Http2PingHealth.getValue();
+            }
+            expectedUserAgentSuffix = expectedUserAgentSuffix + "|F" + Integer.toHexString(featureValue).toUpperCase(Locale.ROOT);
         }
 
         assertThat(actualUserAgent).endsWith(expectedUserAgentSuffix);