[V4] Add the ConnectTimeout property for .NET 8 target (#3819)

normj · web-flow · commit 16ce1712712f · 2025-05-16T11:03:11.000-07:00
diff --git a/extensions/src/AWSSDK.Extensions.NETCore.Setup/AWSSDK.Extensions.NETCore.Setup.nuspec b/extensions/src/AWSSDK.Extensions.NETCore.Setup/AWSSDK.Extensions.NETCore.Setup.nuspec
@@ -3,7 +3,7 @@
   <metadata> 
     <id>AWSSDK.Extensions.NETCore.Setup</id>
     <title>AWSSDK - Extensions for NETCore Setup</title>
-    <version>4.0.0.0</version>
+    <version>4.0.1.0</version>
     <authors>Amazon Web Services</authors>
     <description>Extensions for the AWS SDK for .NET to integrate with .NET Core configuration and dependency injection frameworks.</description>
     <language>en-US</language>
diff --git a/extensions/src/AWSSDK.Extensions.NETCore.Setup/ClientFactory.cs b/extensions/src/AWSSDK.Extensions.NETCore.Setup/ClientFactory.cs
@@ -339,6 +339,12 @@ private ClientConfig CreateConfig(AWSOptions options)
             {
                 config.Timeout = defaultConfig.Timeout.Value;
             }
+#if NET8_0_OR_GREATER
+            if (defaultConfig.ConnectTimeout.HasValue)
+            {
+                config.ConnectTimeout = defaultConfig.ConnectTimeout.Value;
+            }
+#endif
             if (defaultConfig.UseAlternateUserAgentHeader.HasValue)
             {
                 config.UseAlternateUserAgentHeader = defaultConfig.UseAlternateUserAgentHeader.Value;
diff --git a/extensions/src/AWSSDK.Extensions.NETCore.Setup/ConfigurationExtensions.cs b/extensions/src/AWSSDK.Extensions.NETCore.Setup/ConfigurationExtensions.cs
@@ -313,6 +313,17 @@ public static AWSOptions GetAWSOptions(this IConfiguration config, string config
 
                     options.DefaultClientConfig.Timeout = TimeSpan.FromMilliseconds(timeout);
                 }
+#if NET8_0_OR_GREATER
+                else if (string.Equals(element.Key, nameof(DefaultClientConfig.ConnectTimeout), StringComparison.OrdinalIgnoreCase))
+                {
+                    if (!int.TryParse(element.Value, out var connectTimeout))
+                    {
+                        throw new ArgumentException($"Invalid integer value for {nameof(DefaultClientConfig.ConnectTimeout)}.");
+                    }
+
+                    options.DefaultClientConfig.ConnectTimeout = TimeSpan.FromMilliseconds(connectTimeout);
+                }
+#endif
                 else if (string.Equals(element.Key, nameof(DefaultClientConfig.UseAlternateUserAgentHeader), StringComparison.OrdinalIgnoreCase))
                 {
                     if (!bool.TryParse(element.Value, out var useAlternateUserAgentHeader))
diff --git a/extensions/src/AWSSDK.Extensions.NETCore.Setup/DefaultClientConfig.cs b/extensions/src/AWSSDK.Extensions.NETCore.Setup/DefaultClientConfig.cs
@@ -214,6 +214,15 @@ public class DefaultClientConfig
         /// </summary>
         public TimeSpan? Timeout { get; set; }
 
+#if NET8_0_OR_GREATER
+        /// <summary>
+        /// Gets and sets the connection timeout that will be set on the HttpClient used by the service client to make requests.
+        /// The connection timeout is used control the wait time for the connection to be established to the service. The default
+        /// connection timeout for the HttpClient infinite waiting period.
+        /// </summary>
+        public TimeSpan? ConnectTimeout { get; set; }
+#endif
+
         /// <summary>
         /// When set to true, the service client will use the x-amz-user-agent
         /// header instead of the User-Agent header to report version and
diff --git a/extensions/test/NETCore.SetupTests/ConfigurationTests.cs b/extensions/test/NETCore.SetupTests/ConfigurationTests.cs
@@ -127,6 +127,11 @@ public void GetClientConfigSettingsTest()
             var clientConfig = client.Config as AmazonS3Config;
             Assert.NotNull(clientConfig);
             Assert.True(clientConfig.ForcePathStyle);
+
+#if NET8_0_OR_GREATER
+            Assert.Equal(TimeSpan.FromMilliseconds(500), options.DefaultClientConfig.ConnectTimeout);
+            Assert.Equal(TimeSpan.FromMilliseconds(500), clientConfig.ConnectTimeout);
+#endif
         }
 
         [Fact]
diff --git a/extensions/test/NETCore.SetupTests/TestFiles/GetClientConfigSettingsTest.json b/extensions/test/NETCore.SetupTests/TestFiles/GetClientConfigSettingsTest.json
@@ -3,10 +3,11 @@
     "UseHttp": true,
     "MaxErrorRetry": 6,
     "Timeout": 1000,
+    "ConnectTimeout": 500,
     "AuthenticationRegion": "us-east-1",
     "Region": "us-west-2",
     "DefaultsMode": "Standard",
-    "ForcePathStyle":  true,
+    "ForcePathStyle": true,
     "RetryMode": "Standard"
   }
 }
diff --git a/generator/.DevConfigs/A78BAE5D-9864-4E0F-853F-BBA0ACD3F60D.json b/generator/.DevConfigs/A78BAE5D-9864-4E0F-853F-BBA0ACD3F60D.json
@@ -0,0 +1,13 @@
+{
+    "core": {
+        "updateMinimum": true,
+        "type": "Patch",
+        "changeLogMessages": [
+            "Add the ConnectTimeout property on the service client config for the .NET 8 target of the SDK."
+        ],
+		"backwardIncompatibilitiesToIgnore": [
+			"Amazon.Runtime.ClientConfig/MethodAdded",
+			"Amazon.Runtime.IClientConfig/MethodAbstractMethodAdded"
+		]
+    }
+}
diff --git a/sdk/src/Core/Amazon.Runtime/ClientConfig.cs b/sdk/src/Core/Amazon.Runtime/ClientConfig.cs
@@ -742,7 +742,31 @@ public TimeSpan? Timeout
             }
         }
 
-#if AWS_ASYNC_API
+#if NET8_0_OR_GREATER
+        TimeSpan? _connectTimeout;
+
+        /// <summary>
+        /// Gets and sets the connection timeout that will be set on the HttpClient used by the service client to make requests.
+        /// The connection timeout is used control the wait time for the connection to be established to the service. The default
+        /// connection timeout for the HttpClient is infinite waiting period.
+        /// </summary>
+        public TimeSpan? ConnectTimeout
+        {
+            get
+            {
+                if (!this._connectTimeout.HasValue)
+                    return null;
+
+                return this._connectTimeout.Value;
+            }
+            set
+            {
+                ValidateTimeout(value);
+                this._connectTimeout = value;
+            }
+        }
+#endif
+
         /// <summary>
         /// Generates a <see cref="CancellationToken"/> based on the value
         /// for <see cref="DefaultConfiguration.TimeToFirstByteTimeout"/>.
@@ -758,7 +782,6 @@ internal CancellationToken BuildDefaultCancellationToken()
                 ? new CancellationTokenSource(cancelTimeout.Value).Token
                 : default(CancellationToken);
         }
-#endif
 
         /// <summary>
         /// Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint
diff --git a/sdk/src/Core/Amazon.Runtime/IClientConfig.cs b/sdk/src/Core/Amazon.Runtime/IClientConfig.cs
@@ -260,6 +260,13 @@ public partial interface IClientConfig
         /// </remarks>
         TimeSpan? Timeout { get; }
 
+#if NET8_0_OR_GREATER
+        /// <summary>
+        /// Gets the connection timeout that will be set on the HttpClient used by the service client to make requests.
+        /// The connection timeout is used control the wait time for the connection to be established to the service.
+        /// </summary>
+        TimeSpan? ConnectTimeout { get; }
+#endif
         /// <summary>
         /// Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint
         /// for the configured region.
diff --git a/sdk/src/Core/Amazon.Runtime/Pipeline/HttpHandler/_netstandard/HttpRequestMessageFactory.cs b/sdk/src/Core/Amazon.Runtime/Pipeline/HttpHandler/_netstandard/HttpRequestMessageFactory.cs
@@ -255,6 +255,11 @@ private static HttpClient CreateManagedHttpClient(IClientConfig clientConfig)
                 // is going to be required.
                 EnableMultipleHttp2Connections = true
             };
+
+            if (clientConfig.ConnectTimeout.HasValue)
+            {
+                httpMessageHandler.ConnectTimeout = clientConfig.ConnectTimeout.Value;
+            }
 #else
             var httpMessageHandler = new HttpClientHandler();
 #endif
diff --git a/sdk/src/Core/Amazon.Runtime/_netstandard/ClientConfig.cs b/sdk/src/Core/Amazon.Runtime/_netstandard/ClientConfig.cs
@@ -168,6 +168,11 @@ internal static string CreateConfigUniqueString(IClientConfig clientConfig)
             if (clientConfig.MaxConnectionsPerServer.HasValue)
                 uniqueString = string.Concat(uniqueString, "MaxConnectionsPerServer:", clientConfig.MaxConnectionsPerServer.Value.ToString());
 
+#if NET8_0_OR_GREATER
+            if (clientConfig.ConnectTimeout.HasValue)
+                uniqueString = string.Concat(uniqueString, "ConnectTimeout:", clientConfig.ConnectTimeout.Value.ToString());
+#endif
+
             return uniqueString;
         }
 
diff --git a/sdk/test/NetStandard/UnitTests/ClientConfigTests.cs b/sdk/test/NetStandard/UnitTests/ClientConfigTests.cs
@@ -37,6 +37,9 @@ public class ClientConfigTests
             "DisableLogging",
             "ProxyCredentials",
             "Timeout",
+#if NET8_0_OR_GREATER
+            "ConnectTimeout",
+#endif
             "UseDualstackEndpoint",
             "UseFIPSEndpoint",
             "ProxyHost",

Original file line number	Diff line number	Diff line change
`@@ -339,6 +339,12 @@ private ClientConfig CreateConfig(AWSOptions options)`
`339`	`339`	`{`
`340`	`340`	`config.Timeout = defaultConfig.Timeout.Value;`
`341`	`341`	`}`
	`342`	`+#if NET8_0_OR_GREATER`
	`343`	`+ if (defaultConfig.ConnectTimeout.HasValue)`
	`344`	`+ {`
	`345`	`+ config.ConnectTimeout = defaultConfig.ConnectTimeout.Value;`
	`346`	`+ }`
	`347`	`+#endif`
`342`	`348`	`if (defaultConfig.UseAlternateUserAgentHeader.HasValue)`
`343`	`349`	`{`
`344`	`350`	`config.UseAlternateUserAgentHeader = defaultConfig.UseAlternateUserAgentHeader.Value;`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,11 @@`
`3`	`3`	`"UseHttp": true,`
`4`	`4`	`"MaxErrorRetry": 6,`
`5`	`5`	`"Timeout": 1000,`
	`6`	`+ "ConnectTimeout": 500,`
`6`	`7`	`"AuthenticationRegion": "us-east-1",`
`7`	`8`	`"Region": "us-west-2",`
`8`	`9`	`"DefaultsMode": "Standard",`
`9`		`- "ForcePathStyle": true,`
	`10`	`+ "ForcePathStyle": true,`
`10`	`11`	`"RetryMode": "Standard"`
`11`	`12`	`}`
`12`	`13`	`}`