fix: expose credential provider to customer properly (#362)

kneekey23 · web-flow · commit 8a3742f7f7cc · 2021-08-24T10:46:32.000-07:00
diff --git a/AWSClientRuntime/Sources/AWSClientConfiguration.swift b/AWSClientRuntime/Sources/AWSClientConfiguration.swift
@@ -6,7 +6,7 @@
 import ClientRuntime
 
 public protocol AWSRuntimeConfiguration {
-    var credentialsProvider: AWSCredentialsProvider { get set }
+    var credentialsProvider: CredentialsProvider { get set }
     var region: String? { get set }
     var signingRegion: String? {get set}
     var endpointResolver: EndpointResolver {get set}
diff --git a/AWSClientRuntime/Sources/Auth/AWSCredentialsProvider.swift b/AWSClientRuntime/Sources/Auth/AWSCredentialsProvider.swift
@@ -5,7 +5,7 @@
 import AwsCommonRuntimeKit
 import ClientRuntime
 
-public class AWSCredentialsProvider {
+public class AWSCredentialsProvider: CredentialsProvider {
     let crtCredentialsProvider: CRTAWSCredentialsProvider
     
     init(awsCredentialsProvider: CRTAWSCredentialsProvider) {
@@ -47,6 +47,12 @@ public class AWSCredentialsProvider {
         return AWSCredentialsProvider(awsCredentialsProvider: credsProvider)
     }
     
+    public static func fromCustom(_ credentialsProvider: CredentialsProvider) throws -> AWSCredentialsProvider {
+        let crtCredentialsProviderWrapper = CredentialsProviderCRTAdapter(credentialsProvider: credentialsProvider)
+        let credsProvider = try CRTAWSCredentialsProvider(fromProvider: crtCredentialsProviderWrapper)
+        return AWSCredentialsProvider(awsCredentialsProvider: credsProvider)
+    }
+    
     public func getCredentials() throws -> AWSCredentials {
         let credentials = crtCredentialsProvider.getCredentials()
         let result = try credentials.get()
diff --git a/AWSClientRuntime/Sources/Auth/CredentialsProvider.swift b/AWSClientRuntime/Sources/Auth/CredentialsProvider.swift
@@ -0,0 +1,11 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+        
+public protocol CredentialsProvider {
+    /// Resolves `AWSCredentials` through custom means
+    func getCredentials() throws -> AWSCredentials
+}
diff --git a/AWSClientRuntime/Sources/Auth/CredentialsProviderCRTAdapter.swift b/AWSClientRuntime/Sources/Auth/CredentialsProviderCRTAdapter.swift
@@ -0,0 +1,34 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import AwsCommonRuntimeKit
+import ClientRuntime
+        
+struct CredentialsProviderCRTAdapter: CRTCredentialsProvider {
+    var allocator: Allocator
+    let credentialsProvider: CredentialsProvider
+    let logger: SwiftLogger
+    init(credentialsProvider: CredentialsProvider) {
+        self.credentialsProvider = credentialsProvider
+        self.logger = SwiftLogger(label: "CustomCredentialProvider")
+        self.allocator = defaultAllocator
+    }
+    
+    func getCredentials(credentialCallbackData: CRTCredentialsProviderCallbackData) {
+        do {
+            let credentials = try credentialsProvider.getCredentials()
+            let emptyError = AWSError(errorCode: 0)
+            let crtCredentials = credentials.toCRTType()
+            credentialCallbackData.onCredentialsResolved?(crtCredentials, CRTError.crtError(emptyError))
+        } catch let err {
+            logger.error("An error occurred with retrieving credentials from your custom credentials provider. Error: \(err)")
+            
+            credentialCallbackData.onCredentialsResolved?(nil, CRTError.crtError(AWSError(errorCode: -1)))
+        }
+        
+    }
+}
diff --git a/AWSClientRuntime/Sources/HttpContextBuilder+Extension.swift b/AWSClientRuntime/Sources/HttpContextBuilder+Extension.swift
@@ -39,8 +39,8 @@ extension HttpContextBuilder {
     }
 
     @discardableResult
-    public func withCredentialsProvider(value: AWSCredentialsProvider) -> HttpContextBuilder {
-        self.attributes.set(key: AttributeKey<AWSCredentialsProvider>(name: "AWSCredentialsProvider"), value: value)
+    public func withCredentialsProvider(value: CredentialsProvider) -> HttpContextBuilder {
+        self.attributes.set(key: AttributeKey<CredentialsProvider>(name: "CredentialsProvider"), value: value)
         return self
     }
     
diff --git a/AWSClientRuntime/Tests/Auth/AWSCredentialProviderTests.swift b/AWSClientRuntime/Tests/Auth/AWSCredentialProviderTests.swift
@@ -0,0 +1,27 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+        
+import ClientRuntime
+import SmithyTestUtil
+import XCTest
+@testable import AWSClientRuntime
+
+class AWSCredentialProviderTests: XCTestCase {
+    
+    func testYouCanUseCustomCredentialsProvider() throws {
+        let awsCredsProvider = try AWSCredentialsProvider.fromCustom(MyCustomCredentialsProvider())
+        let credentials = try awsCredsProvider.getCredentials()
+        XCTAssertEqual(credentials.accessKey, "MYACCESSKEY")
+        XCTAssertEqual(credentials.secret, "sekrit")
+    }
+}
+
+struct MyCustomCredentialsProvider: CredentialsProvider {
+    func getCredentials() throws -> AWSCredentials {
+        return AWSCredentials(accessKey: "MYACCESSKEY", secret: "sekrit", expirationTimeout: 30)
+    }
+}
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSClientRuntimeTypes.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSClientRuntimeTypes.kt
@@ -39,7 +39,8 @@ object AWSClientRuntimeTypes {
         val RetrierMiddleware = runtimeSymbol("RetrierMiddleware")
         val EndpointResolverMiddleware = runtimeSymbol("EndpointResolverMiddleware")
         val EndpointResolver = runtimeSymbol("EndpointResolver")
-        val CredentialsProvider = runtimeSymbol("AWSCredentialsProvider")
+        val CredentialsProvider = runtimeSymbol("CredentialsProvider")
+        val AWSCredentialsProvider = runtimeSymbol("AWSCredentialsProvider")
         val AWSClientConfiguration = runtimeSymbol("AWSClientConfiguration")
         val AWSEndpoint = runtimeSymbol("AWSEndpoint")
         val Partition = runtimeSymbol("Partition")
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSServiceConfig.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSServiceConfig.kt
@@ -37,9 +37,9 @@ class AWSServiceConfig(writer: SwiftWriter, serviceName: String) : ServiceConfig
         writer.write("self.signingRegion = signingRegion ?? defaultRegion")
         writer.write("self.endpointResolver = endpointResolver ?? DefaultEndpointResolver()")
         writer.openBlock("if let credProvider = credentialsProvider {", "} else {") {
-            writer.write("self.credentialsProvider = credProvider")
+            writer.write("self.credentialsProvider = try \$N.fromCustom(credProvider)", AWSClientRuntimeTypes.Core.AWSCredentialsProvider)
         }
-        writer.indent().write("self.credentialsProvider = try \$N.fromChain()", AWSClientRuntimeTypes.Core.CredentialsProvider)
+        writer.indent().write("self.credentialsProvider = try \$N.fromChain()", AWSClientRuntimeTypes.Core.AWSCredentialsProvider)
         writer.dedent().write("}")
         val runtimeTimeConfigFields = sdkRuntimeConfigProperties()
         runtimeTimeConfigFields.forEach {
diff --git a/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/RestJsonProtocolGeneratorTests.kt b/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/RestJsonProtocolGeneratorTests.kt
@@ -116,14 +116,14 @@ class RestJsonProtocolGeneratorTests {
                     public var logger: ClientRuntime.LogAgent
                     public var retrier: ClientRuntime.Retrier
             
-                    public var credentialsProvider: AWSClientRuntime.AWSCredentialsProvider
+                    public var credentialsProvider: AWSClientRuntime.CredentialsProvider
                     public var endpointResolver: AWSClientRuntime.EndpointResolver
                     public var region: Swift.String?
                     public var regionResolver: AWSClientRuntime.RegionResolver
                     public var signingRegion: Swift.String?
             
                     public init(
-                        credentialsProvider: AWSClientRuntime.AWSCredentialsProvider? = nil,
+                        credentialsProvider: AWSClientRuntime.CredentialsProvider? = nil,
                         endpointResolver: AWSClientRuntime.EndpointResolver? = nil,
                         region: Swift.String? = nil,
                         regionResolver: AWSClientRuntime.RegionResolver? = nil,
@@ -136,7 +136,7 @@ class RestJsonProtocolGeneratorTests {
                         self.signingRegion = signingRegion ?? defaultRegion
                         self.endpointResolver = endpointResolver ?? DefaultEndpointResolver()
                         if let credProvider = credentialsProvider {
-                            self.credentialsProvider = credProvider
+                            self.credentialsProvider = try AWSClientRuntime.AWSCredentialsProvider.fromCustom(credProvider)
                         } else {
                             self.credentialsProvider = try AWSClientRuntime.AWSCredentialsProvider.fromChain()
                         }
@@ -151,7 +151,7 @@ class RestJsonProtocolGeneratorTests {
                     }
             
                     public convenience init(
-                        credentialsProvider: AWSClientRuntime.AWSCredentialsProvider? = nil,
+                        credentialsProvider: AWSClientRuntime.CredentialsProvider? = nil,
                         endpointResolver: AWSClientRuntime.EndpointResolver? = nil,
                         region: Swift.String? = nil,
                         regionResolver: AWSClientRuntime.RegionResolver? = nil,

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,8 @@ extension HttpContextBuilder {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@discardableResult`
`42`		`- public func withCredentialsProvider(value: AWSCredentialsProvider) -> HttpContextBuilder {`
`43`		`- self.attributes.set(key: AttributeKey<AWSCredentialsProvider>(name: "AWSCredentialsProvider"), value: value)`
	`42`	`+ public func withCredentialsProvider(value: CredentialsProvider) -> HttpContextBuilder {`
	`43`	`+ self.attributes.set(key: AttributeKey<CredentialsProvider>(name: "CredentialsProvider"), value: value)`
`44`	`44`	`return self`
`45`	`45`	`}`
`46`	`46`