feat: RetryErrorInfoProvider is configurable per-protocol (#565)

smithy-lang · Jun 20, 2023 · 6eb145f · 6eb145f
1 parent 7aafee3
commit 6eb145f
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 7 deletions.
diff --git a/Sources/ClientRuntime/Config/DefaultSDKRuntimeConfiguration.swift b/Sources/ClientRuntime/Config/DefaultSDKRuntimeConfiguration.swift
@@ -9,9 +9,6 @@
 public struct DefaultSDKRuntimeConfiguration<DefaultSDKRuntimeRetryStrategy: RetryStrategy,
     DefaultSDKRuntimeRetryErrorInfoProvider: RetryErrorInfoProvider> {
 
-    public typealias DefaultSDKRuntimeRetryStrategy = DefaultRetryStrategy
-    public typealias DefaultSDKRuntimeRetryErrorInfoProvider = DefaultRetryErrorInfoProvider
-
     /// The name of this Smithy service.
     public var serviceName: String
 

diff --git a/Sources/ClientRuntime/Retries/DefaultRetryErrorInfoProvider.swift b/Sources/ClientRuntime/Retries/DefaultRetryErrorInfoProvider.swift
@@ -16,6 +16,9 @@ public enum DefaultRetryErrorInfoProvider: RetryErrorInfoProvider {
         .gatewayTimeout,       // 504
     ]
 
+    /// Returns information used to determine how & if to retry an error.
+    /// - Parameter error: The error to be triaged for retry info
+    /// - Returns: `RetryErrorInfo` for the passed error, or `nil` if the error should not be retried.
     public static func errorInfo(for error: Error) -> RetryErrorInfo? {
         var hint: TimeInterval?
         if let retryAfterString = (error as? HTTPError)?.httpResponse.headers.value(for: "x-retry-after") {

diff --git a/Sources/ClientRuntime/Retries/RetryErrorInfo.swift b/Sources/ClientRuntime/Retries/RetryErrorInfo.swift
@@ -17,5 +17,11 @@ public struct RetryErrorInfo: Equatable {
     public let retryAfterHint: TimeInterval?
 
     /// Whether this error is a network timeout error.
-    var isTimeout: Bool
+    public var isTimeout: Bool
+
+    public init(errorType: RetryErrorType, retryAfterHint: TimeInterval?, isTimeout: Bool) {
+        self.errorType = errorType
+        self.retryAfterHint = retryAfterHint
+        self.isTimeout = isTimeout
+    }
 }
diff --git a/...n/kotlin/software/amazon/smithy/swift/codegen/integration/HttpBindingProtocolGenerator.kt b/...n/kotlin/software/amazon/smithy/swift/codegen/integration/HttpBindingProtocolGenerator.kt
@@ -415,7 +415,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
 
             operationMiddleware.appendMiddleware(operation, DeserializeMiddleware(ctx.model, ctx.symbolProvider))
             operationMiddleware.appendMiddleware(operation, LoggingMiddleware(ctx.model, ctx.symbolProvider))
-            operationMiddleware.appendMiddleware(operation, RetryMiddleware(ctx.model, ctx.symbolProvider))
+            operationMiddleware.appendMiddleware(operation, RetryMiddleware(ctx.model, ctx.symbolProvider, retryErrorInfoProviderSymbol))
 
             addProtocolSpecificMiddleware(ctx, operation)
 

diff --git a/...gen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/ProtocolGenerator.kt b/...gen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/ProtocolGenerator.kt
@@ -52,6 +52,8 @@ interface ProtocolGenerator {
         val DefaultServiceErrorProtocolSymbol: Symbol = ClientRuntimeTypes.Core.ServiceError
 
         val DefaultUnknownServiceErrorSymbol: Symbol = ClientRuntimeTypes.Http.UnknownHttpServiceError
+
+        val DefaultRetryErrorInfoProviderSymbol: Symbol = ClientRuntimeTypes.Core.DefaultRetryErrorInfoProvider
     }
 
     /**
@@ -86,6 +88,9 @@ interface ProtocolGenerator {
     val unknownServiceErrorSymbol: Symbol
         get() = DefaultUnknownServiceErrorSymbol
 
+    val retryErrorInfoProviderSymbol: Symbol
+        get() = DefaultRetryErrorInfoProviderSymbol
+
     /**
      * Generate serializers required by the protocol
      */

diff --git a/...in/kotlin/software/amazon/smithy/swift/codegen/integration/middlewares/RetryMiddleware.kt b/...in/kotlin/software/amazon/smithy/swift/codegen/integration/middlewares/RetryMiddleware.kt
@@ -5,6 +5,7 @@
 
 package software.amazon.smithy.swift.codegen.integration.middlewares
 
+import software.amazon.smithy.codegen.core.Symbol
 import software.amazon.smithy.codegen.core.SymbolProvider
 import software.amazon.smithy.model.Model
 import software.amazon.smithy.model.shapes.OperationShape
@@ -17,7 +18,8 @@ import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep
 
 class RetryMiddleware(
     val model: Model,
-    val symbolProvider: SymbolProvider
+    val symbolProvider: SymbolProvider,
+    val retryErrorInfoProviderSymbol: Symbol,
 ) : MiddlewareRenderable {
 
     override val name = "RetryMiddleware"
@@ -33,7 +35,7 @@ class RetryMiddleware(
             "$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: \$N<\$N, \$N, \$N, \$N>(options: config.retryStrategyOptions))",
             ClientRuntimeTypes.Middleware.RetryMiddleware,
             ClientRuntimeTypes.Core.DefaultRetryStrategy,
-            ClientRuntimeTypes.Core.DefaultRetryErrorInfoProvider,
+            retryErrorInfoProviderSymbol,
             output,
             outputError
         )