Add typealias AWSMiddlewareNextHandler (#580)

adam-fowler · adam-fowler · commit 497dc472cb83 · 2023-08-12T10:05:28.000+01:00
diff --git a/Sources/SotoCore/Middleware/Middleware.swift b/Sources/SotoCore/Middleware/Middleware.swift
@@ -21,12 +21,14 @@ public struct AWSMiddlewareContext {
     public var logger: Logger
 }
 
+/// Function to call next middleware in the chain
+public typealias AWSMiddlewareNextHandler = (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse
 /// Middleware handler, function that takes a request, context and the next function to call
-public typealias AWSMiddlewareHandler = @Sendable (AWSHTTPRequest, AWSMiddlewareContext, _ next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse
+public typealias AWSMiddlewareHandler = @Sendable (AWSHTTPRequest, AWSMiddlewareContext, _ next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse
 
 /// Middleware protocol, with function that takes a request, context and the next function to call
 public protocol AWSMiddlewareProtocol: Sendable {
-    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse
+    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse
 }
 
 /// Middleware initialized with a middleware handle
@@ -39,7 +41,7 @@ public struct AWSMiddleware: AWSMiddlewareProtocol {
     }
 
     @inlinable
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         try await self.middleware(request, context, next)
     }
 }
@@ -56,7 +58,7 @@ public struct AWSMiddleware2<M0: AWSMiddlewareProtocol, M1: AWSMiddlewareProtoco
     }
 
     @inlinable
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         try await self.m0.handle(request, context: context) { request, context in
             try await self.m1.handle(request, context: context, next: next)
         }
@@ -80,7 +82,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {
     }
 
     @inlinable
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         let iterator = self.stack.makeIterator()
         return try await self.run(request, context: context, iterator: iterator, finally: next)
     }
@@ -90,7 +92,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {
         _ request: AWSHTTPRequest,
         context: AWSMiddlewareContext,
         iterator: Stack.Iterator,
-        finally: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse
+        finally: AWSMiddlewareNextHandler
     ) async throws -> AWSHTTPResponse {
         var iterator = iterator
         switch iterator.next() {
@@ -107,7 +109,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {
 public struct PassThruMiddleware: AWSMiddlewareProtocol {
     public init() {}
 
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         try await next(request, context)
     }
 }
diff --git a/Sources/SotoCore/Middleware/Middleware/EditHeadersMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/EditHeadersMiddleware.swift
@@ -34,7 +34,7 @@ public struct AWSEditHeadersMiddleware: AWSMiddlewareProtocol {
     }
 
     @inlinable
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         var request = request
         for edit in self.edits {
             switch edit {
diff --git a/Sources/SotoCore/Middleware/Middleware/EndpointDiscoveryMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/EndpointDiscoveryMiddleware.swift
@@ -37,7 +37,7 @@ public struct EndpointDiscoveryMiddleware: AWSMiddlewareProtocol {
         self.isRequired = required
     }
 
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         let isEnabled = context.serviceConfig.options.contains(.enableEndpointDiscovery)
         guard isEnabled || self.isRequired else {
             return try await next(request, context)
diff --git a/Sources/SotoCore/Middleware/Middleware/ErrorHandlingMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/ErrorHandlingMiddleware.swift
@@ -20,7 +20,7 @@ import SotoSignerV4
 struct ErrorHandlingMiddleware: AWSMiddlewareProtocol {
     let options: AWSClient.Options
 
-    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         let response = try await next(request, context)
 
         // if response has an HTTP status code outside 2xx then throw an error
diff --git a/Sources/SotoCore/Middleware/Middleware/LoggingMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/LoggingMiddleware.swift
@@ -38,7 +38,7 @@ public struct AWSLoggingMiddleware: AWSMiddlewareProtocol {
     }
 
     @inlinable
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         self.log(
             "Request:\n" +
                 "  \(context.operation)\n" +
diff --git a/Sources/SotoCore/Middleware/Middleware/RetryMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/RetryMiddleware.swift
@@ -22,7 +22,7 @@ struct RetryMiddleware: AWSMiddlewareProtocol {
     let retryPolicy: RetryPolicy
 
     @inlinable
-    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         var attempt = 0
         while true {
             do {
diff --git a/Sources/SotoCore/Middleware/Middleware/S3Middleware.swift b/Sources/SotoCore/Middleware/Middleware/S3Middleware.swift
@@ -30,7 +30,7 @@ import Foundation
 /// - Fixes up the GetBucketLocation response, so it can be decoded correctly
 /// - Creates error body for notFound responses to HEAD requests
 public struct S3Middleware: AWSMiddlewareProtocol {
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         var request = request
 
         self.virtualAddressFixup(request: &request, context: context)
diff --git a/Sources/SotoCore/Middleware/Middleware/SigningMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/SigningMiddleware.swift
@@ -22,7 +22,7 @@ struct SigningMiddleware: AWSMiddlewareProtocol {
     let credentialProvider: any CredentialProvider
 
     @inlinable
-    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         var request = request
         // get credentials
         let credential = try await self.credentialProvider.getCredential(logger: context.logger)
diff --git a/Sources/SotoCore/Middleware/Middleware/TracingMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/TracingMiddleware.swift
@@ -24,7 +24,7 @@ public struct AWSTracingMiddleware: AWSMiddlewareProtocol {
     public func handle(
         _ request: AWSHTTPRequest,
         context: AWSMiddlewareContext,
-        next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse
+        next: AWSMiddlewareNextHandler
     ) async throws -> AWSHTTPResponse {
         try await InstrumentationSystem.tracer.withSpan(
             "\(context.serviceConfig.serviceName).\(context.operation)",
diff --git a/Sources/SotoCore/Middleware/Middleware/TreeHashMiddleware.swift b/Sources/SotoCore/Middleware/Middleware/TreeHashMiddleware.swift
@@ -21,7 +21,7 @@ let MEGA_BYTE = 1024 * 1024
 /// Calculates a tree hash calculated from the SHA256 of each 1MB section of the request body
 /// and adds it to the request as a header value
 public struct TreeHashMiddleware: AWSMiddlewareProtocol {
-    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {
+    public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {
         var request = request
         if request.headers[self.treeHashHeader].first == nil {
             if case .byteBuffer(let buffer) = request.body.storage {

Original file line number	Diff line number	Diff line change
`@@ -21,12 +21,14 @@ public struct AWSMiddlewareContext {`
`21`	`21`	`public var logger: Logger`
`22`	`22`	`}`
`23`	`23`
	`24`	`+/// Function to call next middleware in the chain`
	`25`	`+public typealias AWSMiddlewareNextHandler = (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse`
`24`	`26`	`/// Middleware handler, function that takes a request, context and the next function to call`
`25`		`-public typealias AWSMiddlewareHandler = @Sendable (AWSHTTPRequest, AWSMiddlewareContext, _ next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse`
	`27`	`+public typealias AWSMiddlewareHandler = @Sendable (AWSHTTPRequest, AWSMiddlewareContext, _ next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse`
`26`	`28`
`27`	`29`	`/// Middleware protocol, with function that takes a request, context and the next function to call`
`28`	`30`	`public protocol AWSMiddlewareProtocol: Sendable {`
`29`		`- func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse`
	`31`	`+ func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse`
`30`	`32`	`}`
`31`	`33`
`32`	`34`	`/// Middleware initialized with a middleware handle`
`@@ -39,7 +41,7 @@ public struct AWSMiddleware: AWSMiddlewareProtocol {`
`39`	`41`	`}`
`40`	`42`
`41`	`43`	`@inlinable`
`42`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`44`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`43`	`45`	`try await self.middleware(request, context, next)`
`44`	`46`	`}`
`45`	`47`	`}`
`@@ -56,7 +58,7 @@ public struct AWSMiddleware2<M0: AWSMiddlewareProtocol, M1: AWSMiddlewareProtoco`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`@inlinable`
`59`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`61`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`60`	`62`	`try await self.m0.handle(request, context: context) { request, context in`
`61`	`63`	`try await self.m1.handle(request, context: context, next: next)`
`62`	`64`	`}`
`@@ -80,7 +82,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {`
`80`	`82`	`}`
`81`	`83`
`82`	`84`	`@inlinable`
`83`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`85`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`84`	`86`	`let iterator = self.stack.makeIterator()`
`85`	`87`	`return try await self.run(request, context: context, iterator: iterator, finally: next)`
`86`	`88`	`}`
`@@ -90,7 +92,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {`
`90`	`92`	`_ request: AWSHTTPRequest,`
`91`	`93`	`context: AWSMiddlewareContext,`
`92`	`94`	`iterator: Stack.Iterator,`
`93`		`- finally: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse`
	`95`	`+ finally: AWSMiddlewareNextHandler`
`94`	`96`	`) async throws -> AWSHTTPResponse {`
`95`	`97`	`var iterator = iterator`
`96`	`98`	`switch iterator.next() {`
`@@ -107,7 +109,7 @@ public struct AWSDynamicMiddlewareStack: AWSMiddlewareProtocol {`
`107`	`109`	`public struct PassThruMiddleware: AWSMiddlewareProtocol {`
`108`	`110`	`public init() {}`
`109`	`111`
`110`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`112`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`111`	`113`	`try await next(request, context)`
`112`	`114`	`}`
`113`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public struct AWSEditHeadersMiddleware: AWSMiddlewareProtocol {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`@inlinable`
`37`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`37`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`38`	`38`	`var request = request`
`39`	`39`	`for edit in self.edits {`
`40`	`40`	`switch edit {`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public struct EndpointDiscoveryMiddleware: AWSMiddlewareProtocol {`
`37`	`37`	`self.isRequired = required`
`38`	`38`	`}`
`39`	`39`
`40`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`40`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`41`	`41`	`let isEnabled = context.serviceConfig.options.contains(.enableEndpointDiscovery)`
`42`	`42`	`guard isEnabled \|\| self.isRequired else {`
`43`	`43`	`return try await next(request, context)`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public struct AWSLoggingMiddleware: AWSMiddlewareProtocol {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@inlinable`
`41`		`- public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse) async throws -> AWSHTTPResponse {`
	`41`	`+ public func handle(_ request: AWSHTTPRequest, context: AWSMiddlewareContext, next: AWSMiddlewareNextHandler) async throws -> AWSHTTPResponse {`
`42`	`42`	`self.log(`
`43`	`43`	`"Request:\n" +`
`44`	`44`	`" \(context.operation)\n" +`