refactor: Remove AWSSignerType attribute from service configs

dscpinheiro · dscpinheiro · commit 2f7a286f46d4 · 2025-04-03T09:31:08.000-04:00
diff --git a/generator/.DevConfigs/3388e8f1-17fe-40f7-bcf3-bb43641e5f7a.json b/generator/.DevConfigs/3388e8f1-17fe-40f7-bcf3-bb43641e5f7a.json
@@ -0,0 +1,10 @@
+{
+    "core": {
+        "updateMinimum": true,
+        "type": "Patch",
+        "changeLogMessages": [
+            "Remove redundant `AWSSignerType` attribute from service configuration classes.",
+            "Fix `EndpointDiscoveryHandler` not to fail when a request contains bearer token credentials."
+        ]
+    }
+}
diff --git a/generator/ServiceClientGeneratorLib/Generators/Endpoints/EndpointResolver.partial.cs b/generator/ServiceClientGeneratorLib/Generators/Endpoints/EndpointResolver.partial.cs
@@ -25,7 +25,7 @@ private string GetValueSource(Parameter parameter)
                 case "AWS::S3::DisableMultiRegionAccessPoints": return "config.DisableMultiregionAccessPoints";
                 case "AWS::S3::UseGlobalEndpoint": return "config.USEast1RegionalEndpointValue == S3UsEast1RegionalEndpointValue.Legacy";
                 case "AWS::STS::UseGlobalEndpoint": return "false";
-                case "AWS::Auth::AccountId": return "(requestContext.Identity as AWSCredentials)?.GetCredentials()?.AccountId";
+                case "AWS::Auth::AccountId": return "requestContext.Identity is AWSCredentials credentials ? credentials.GetCredentials().AccountId : null";
                 case "AWS::Auth::AccountIdEndpointMode": return "config.AccountIdEndpointMode.ToString().ToLower()";
                 default: throw new Exception("Unknown builtIn");
             }
diff --git a/generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceConfig.cs b/generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceConfig.cs
diff --git a/generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceConfig.tt b/generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceConfig.tt
@@ -20,7 +20,6 @@ namespace <#=this.Config.Namespace#>
     /// <summary>
     /// Configuration for accessing Amazon <#=this.Config.ClassName#> service
     /// </summary>
-    [AWSSignerType("<#=Config.ServiceModel.SignatureVersion#>")]
     public partial class Amazon<#=this.Config.ClassName#>Config : ClientConfig
     {
         private static readonly string UserAgentString =
diff --git a/sdk/src/Core/Amazon.Runtime/Credentials/Internal/AuthSchemeOption.cs b/sdk/src/Core/Amazon.Runtime/Credentials/Internal/AuthSchemeOption.cs
@@ -54,7 +54,7 @@ public class AuthSchemeOption : IAuthSchemeOption
         };
 
         /// <summary>
-        /// Default auth scheme options for services / operations that that only support SigV4A.
+        /// Default auth scheme options for services / operations that that only support bearer authentication.
         /// </summary>
         public static readonly List<IAuthSchemeOption> DEFAULT_BEARER = new()
         {
diff --git a/sdk/src/Core/Amazon.Runtime/Internal/AWSSignerTypeAttribute.cs b/sdk/src/Core/Amazon.Runtime/Internal/AWSSignerTypeAttribute.cs
@@ -2,6 +2,7 @@
 
 namespace Amazon.Runtime.Internal
 {
+    [Obsolete("This attribute should not be used as the SDK resolves which signer to use at the request level")]
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public sealed class AWSSignerTypeAttribute : Attribute
     {
diff --git a/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/CSMHandler/CSMCallAttemptHandler.cs b/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/CSMHandler/CSMCallAttemptHandler.cs
@@ -105,7 +105,10 @@ protected static void CSMCallAttemptMetricsCapture(IRequestContext requestContex
             requestContext.CSMCallAttempt.Api = CSMUtilities.
                 GetApiNameFromRequest(requestContext.Request.RequestName, requestContext.ServiceMetaData.OperationNameMapping, requestContext.CSMCallAttempt.Service);
 
-            requestContext.CSMCallAttempt.AccessKey = (requestContext.Identity as AWSCredentials)?.GetCredentials()?.AccessKey;
+            if (requestContext.Identity is AWSCredentials credentials)
+            {
+                requestContext.CSMCallAttempt.AccessKey = credentials.GetCredentials().AccessKey;
+            }
 
             requestContext.CSMCallAttempt.AttemptLatency = (long)requestContext
                 .Metrics.StopEvent(Metric.CSMAttemptLatency)
diff --git a/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/EndpointDiscoveryHandler.cs b/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/EndpointDiscoveryHandler.cs
@@ -38,7 +38,12 @@ public override void InvokeSync(IExecutionContext executionContext)
         {
             var requestContext = executionContext.RequestContext;
             var regionalEndpoint = requestContext.Request.Endpoint;
-            var immutableCredentials = (requestContext.Identity as AWSCredentials)?.GetCredentials();
+            
+            ImmutableCredentials immutableCredentials = null;
+            if (requestContext.Identity is AWSCredentials credentials)
+            {
+                immutableCredentials = credentials.GetCredentials();
+            }
 
             PreInvoke(executionContext, immutableCredentials);
 
@@ -71,7 +76,12 @@ public override async System.Threading.Tasks.Task<T> InvokeAsync<T>(IExecutionCo
         {
             var requestContext = executionContext.RequestContext;
             var regionalEndpoint = requestContext.Request.Endpoint;
-            var immutableCredentials = await ((requestContext.Identity as AWSCredentials)?.GetCredentialsAsync()).ConfigureAwait(false);
+
+            ImmutableCredentials immutableCredentials = null;
+            if (requestContext.Identity is AWSCredentials credentials)
+            {
+                immutableCredentials = await credentials.GetCredentialsAsync().ConfigureAwait(false);
+            }
 
             PreInvoke(executionContext, immutableCredentials);
 
diff --git a/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/Signer.cs b/sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/Signer.cs
@@ -106,12 +106,14 @@ public static void SignRequest(IRequestContext requestContext)
             using (MetricsUtilities.MeasureDuration(requestContext, TelemetryConstants.AuthSigningDurationMetricName))
             {
                 ImmutableCredentials immutableCredentials = null;
-
-                using (TracingUtilities.CreateSpan(requestContext, TelemetryConstants.CredentialsRetrievalSpanName))
-                using (MetricsUtilities.MeasureDuration(requestContext, TelemetryConstants.ResolveIdentityDurationMetricName))
-                using (requestContext.Metrics.StartEvent(Metric.CredentialsRequestTime))
+                if (requestContext.Identity is AWSCredentials awsCredentials)
                 {
-                    immutableCredentials = (requestContext.Identity as AWSCredentials)?.GetCredentials();
+                    using (TracingUtilities.CreateSpan(requestContext, TelemetryConstants.CredentialsRetrievalSpanName))
+                    using (MetricsUtilities.MeasureDuration(requestContext, TelemetryConstants.ResolveIdentityDurationMetricName))
+                    using (requestContext.Metrics.StartEvent(Metric.CredentialsRequestTime))
+                    {
+                        immutableCredentials = awsCredentials.GetCredentials();
+                    }
                 }
 
                 if (immutableCredentials?.UseToken == true && 
@@ -168,10 +170,8 @@ private static async Task SignRequestAsync(IRequestContext requestContext)
             using (requestContext.Metrics.StartEvent(Metric.RequestSigningTime))
             using (MetricsUtilities.MeasureDuration(requestContext, TelemetryConstants.AuthSigningDurationMetricName))
             {
-                var awsCredentials = requestContext.Identity as AWSCredentials;
                 ImmutableCredentials immutableCredentials = null;
-
-                if (awsCredentials != null)
+                if (requestContext.Identity is AWSCredentials awsCredentials)
                 {
                     using (TracingUtilities.CreateSpan(requestContext, TelemetryConstants.CredentialsRetrievalSpanName))
                     using (MetricsUtilities.MeasureDuration(requestContext, TelemetryConstants.ResolveIdentityDurationMetricName))
diff --git a/sdk/test/UnitTests/Custom/Runtime/EndpointDiscoveryTests.cs b/sdk/test/UnitTests/Custom/Runtime/EndpointDiscoveryTests.cs
@@ -64,7 +64,7 @@ public void RequiredNoIdentifiers(string endpoint, string expectedEndpoint)
             var config = SetupConfig();
             var client = new EndpointDiscoveryTestClient(config, baseUrl: endpoint);
             var executionContext = CreateExecutionContext(client, config, true, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             Assert.AreEqual(expectedEndpoint,
@@ -84,7 +84,7 @@ public void RequiredNoIdentifiersCached()
             var config = SetupConfig();
             var client = new EndpointDiscoveryTestClient(config);
             var executionContext = CreateExecutionContext(client, config, true, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             Assert.AreEqual("https://test123.amazonaws.com/shared/",
@@ -115,7 +115,7 @@ public void RequiredNoIdentifiersEvictCache()
             var config = SetupConfig();
             var client = new EndpointDiscoveryTestClient(config);
             var executionContext = CreateExecutionContext(client, config, true, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             Assert.AreEqual("https://test123.amazonaws.com/shared/",
@@ -156,7 +156,7 @@ public void RequiredWithIdentifiers()
             SortedDictionary<string, string> identifiers = new SortedDictionary<string, string>();
             identifiers.Add(IDENTIFIER_NAME, "test");
             var executionContext = CreateExecutionContext(client, config, true, identifiers);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             Assert.AreEqual("https://test123.amazonaws.com/shared/CreateTable",
@@ -178,7 +178,7 @@ public void RequiredWithIdentifiersCached()
             SortedDictionary<string, string> identifiers = new SortedDictionary<string, string>();
             identifiers.Add(IDENTIFIER_NAME, "test");
             var executionContext = CreateExecutionContext(client, config, true, identifiers);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             Assert.AreEqual("https://test123.amazonaws.com/shared/CreateTable",
@@ -208,7 +208,7 @@ public void RequiredNoIdentifiersFailedDiscovery()
             SortedDictionary<string, string> identifiers = new SortedDictionary<string, string>();
             identifiers.Add(IDENTIFIER_NAME, "test");
             var executionContext = CreateExecutionContext(client, config, true, identifiers);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             Utils.AssertExceptionExpected(
                 () => { EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials); },
@@ -227,7 +227,7 @@ public void NotRequiredNoIdentifiersFailedDiscoveryWait()
             var config = SetupConfig(true);
             var client = new EndpointDiscoveryTestClient(config, true);
             var executionContext = CreateExecutionContext(client, config, false, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             var endpoints = client.WaitForCachedValue(CACHEKEY);
@@ -247,7 +247,7 @@ public void NotRequiredEnabledNoIdentifiersWait()
             var config = SetupConfig(true);
             var client = new EndpointDiscoveryTestClient(config);
             var executionContext = CreateExecutionContext(client, config, false, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             var endpoints = client.WaitForCachedValue(CACHEKEY);
@@ -268,7 +268,7 @@ public void NotRequiredEnabledHasIdentifiersWait()
             SortedDictionary<string, string> identifiers = new SortedDictionary<string, string>();
             identifiers.Add(IDENTIFIER_NAME, "test");
             var executionContext = CreateExecutionContext(client, config, false, identifiers);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
             var endpoints = client.WaitForCachedValue(CACHEKEY_IDENTIFIERS);
@@ -287,7 +287,7 @@ public void NotRequiredNoIdentifiersFailedDiscoveryNoWait()
             var config = SetupConfig(true);
             var client = new EndpointDiscoveryTestClient(config, true);
             var executionContext = CreateExecutionContext(client, config, false, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
 
@@ -303,7 +303,7 @@ public void NotRequiredEnabledNoIdentifiersNoWait()
             var config = SetupConfig(true);
             var client = new EndpointDiscoveryTestClient(config);
             var executionContext = CreateExecutionContext(client, config, false, null);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
 
@@ -321,7 +321,7 @@ public void NotRequiredEnabledHasIdentifiersNoWait()
             SortedDictionary<string, string> identifiers = new SortedDictionary<string, string>();
             identifiers.Add(IDENTIFIER_NAME, "test");
             var executionContext = CreateExecutionContext(client, config, false, identifiers);
-            var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+            var immutableCredentials = GetCredentialsFromContext(executionContext);
 
             EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
 
@@ -343,7 +343,7 @@ public void CacheEvictionTestUsingEndpointDiscoveryCallStack()
                 var config = SetupConfig();
                 var client = new EndpointDiscoveryTestClient(config);
                 var executionContext = CreateExecutionContext(client, config, true, null);
-                var immutableCredentials = (executionContext.RequestContext.Identity as AWSCredentials)?.GetCredentials();
+                var immutableCredentials = GetCredentialsFromContext(executionContext);
                 EndpointDiscoveryHandler.DiscoverEndpoints(executionContext.RequestContext, false, immutableCredentials);
 
                 Assert.AreEqual(1, client.CacheCount);
@@ -430,6 +430,16 @@ private bool HasEndpointAddress(IEnumerable<DiscoveryEndpointBase> endpoints, st
             return endpoints.Any(endpoint =>
                 string.Equals(endpoint?.Address, address, StringComparison.OrdinalIgnoreCase));
         }
+
+        private ImmutableCredentials GetCredentialsFromContext(ExecutionContext executionContext)
+        {
+            if (executionContext.RequestContext.Identity is AWSCredentials credentials)
+            {
+                return credentials.GetCredentials();
+            }
+
+            return null;
+        }
     }
 
     public class EndpointDiscoveryTestClient : AmazonDynamoDBClient

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ private string GetValueSource(Parameter parameter)`
`25`	`25`	`case "AWS::S3::DisableMultiRegionAccessPoints": return "config.DisableMultiregionAccessPoints";`
`26`	`26`	`case "AWS::S3::UseGlobalEndpoint": return "config.USEast1RegionalEndpointValue == S3UsEast1RegionalEndpointValue.Legacy";`
`27`	`27`	`case "AWS::STS::UseGlobalEndpoint": return "false";`
`28`		`- case "AWS::Auth::AccountId": return "(requestContext.Identity as AWSCredentials)?.GetCredentials()?.AccountId";`
	`28`	`+ case "AWS::Auth::AccountId": return "requestContext.Identity is AWSCredentials credentials ? credentials.GetCredentials().AccountId : null";`
`29`	`29`	`case "AWS::Auth::AccountIdEndpointMode": return "config.AccountIdEndpointMode.ToString().ToLower()";`
`30`	`30`	`default: throw new Exception("Unknown builtIn");`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ namespace <#=this.Config.Namespace#>`
`20`	`20`	`/// <summary>`
`21`	`21`	`/// Configuration for accessing Amazon <#=this.Config.ClassName#> service`
`22`	`22`	`/// </summary>`
`23`		`- [AWSSignerType("<#=Config.ServiceModel.SignatureVersion#>")]`
`24`	`23`	`public partial class Amazon<#=this.Config.ClassName#>Config : ClientConfig`
`25`	`24`	`{`
`26`	`25`	`private static readonly string UserAgentString =`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public class AuthSchemeOption : IAuthSchemeOption`
`54`	`54`	`};`
`55`	`55`
`56`	`56`	`/// <summary>`
`57`		`- /// Default auth scheme options for services / operations that that only support SigV4A.`
	`57`	`+ /// Default auth scheme options for services / operations that that only support bearer authentication.`
`58`	`58`	`/// </summary>`
`59`	`59`	`public static readonly List<IAuthSchemeOption> DEFAULT_BEARER = new()`
`60`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Amazon.Runtime.Internal`
`4`	`4`	`{`
	`5`	`+ [Obsolete("This attribute should not be used as the SDK resolves which signer to use at the request level")]`
`5`	`6`	`[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]`
`6`	`7`	`public sealed class AWSSignerTypeAttribute : Attribute`
`7`	`8`	`{`