API Refactoring (#273)

motivation: define stable API in preperation 1.0 release

changes:
* require swift 5.7, remove redundant backwards compatibility code
* make LambdaHandler, EventLoopLambdaHandler, and ByteBufferLambdaHandler disjointed protocols to reduce API surface area
* create coding wrappers for LambdaHandler and EventLoopLambdaHandler to provide bridge to ByteBufferLambdaHandler
* reuse output ByteBuffer to reduce allocations
* add new SimpleLambdaHandler with no-op initializer for simple lambda use cases
* update callsites and tests
* update examples

Co-authored-by: Yim Lee <yim_lee@apple.com>
Co-authored-by: Fabian Fett <fabianfett@apple.com>

Author: 3 people

Examples/Benchmark/BenchmarkHandler.swift

@@ -22,9 +22,6 @@ import NIOCore
 
 @main
 struct BenchmarkHandler: EventLoopLambdaHandler {
-    typealias Event = String
-    typealias Output = String
-
     static func makeHandler(context: LambdaInitializationContext) -> EventLoopFuture<Self> {
         context.eventLoop.makeSucceededFuture(BenchmarkHandler())
     }

Examples/Benchmark/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/Deployment/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/Deployment/Sources/Benchmark/BenchmarkHandler.swift

@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 import AWSLambdaRuntimeCore
-import NIO
+import NIOCore
 
 // If you would like to benchmark Swift's Lambda Runtime,
 // use this example which is more performant.
@@ -22,9 +22,6 @@ import NIO
 
 @main
 struct BenchmarkHandler: EventLoopLambdaHandler {
-    typealias Event = String
-    typealias Output = String
-
     static func makeHandler(context: LambdaInitializationContext) -> EventLoopFuture<Self> {
         context.eventLoop.makeSucceededFuture(BenchmarkHandler())
     }

Examples/Deployment/Sources/HelloWorld/HelloWorldHandler.swift

@@ -16,14 +16,7 @@ import AWSLambdaRuntime
 
 // introductory example, the obligatory "hello, world!"
 @main
-struct HelloWorldHandler: LambdaHandler {
-    typealias Event = String
-    typealias Output = String
-
-    init(context: LambdaInitializationContext) async throws {
-        // setup your resources that you want to reuse here.
-    }
-
+struct HelloWorldHandler: SimpleLambdaHandler {
     func handle(_ event: String, context: LambdaContext) async throws -> String {
         "hello, world"
     }

Examples/Echo/Lambda.swift

@@ -17,14 +17,7 @@ import AWSLambdaRuntime
 // in this example we are receiving and responding with strings
 
 @main
-struct MyLambda: LambdaHandler {
-    typealias Event = String
-    typealias Output = String
-
-    init(context: LambdaInitializationContext) async throws {
-        // setup your resources that you want to reuse for every invocation here.
-    }
-
+struct MyLambda: SimpleLambdaHandler {
     func handle(_ input: String, context: LambdaContext) async throws -> String {
         // as an example, respond with the input's reversed
         String(input.reversed())

Examples/Echo/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/ErrorHandling/Lambda.swift

@@ -17,12 +17,7 @@ import AWSLambdaRuntime
 // MARK: - Run Lambda
 
 @main
-struct MyLambda: LambdaHandler {
-    typealias Event = Request
-    typealias Output = Response
-
-    init(context: LambdaInitializationContext) async throws {}
-
+struct MyLambda: SimpleLambdaHandler {
     func handle(_ request: Request, context: LambdaContext) async throws -> Response {
         // switch over the error type "requested" by the request, and trigger such error accordingly
         switch request.error {

Examples/ErrorHandling/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/Foundation/Lambda.swift

@@ -25,9 +25,6 @@ import Logging
 
 @main
 struct MyLambda: LambdaHandler {
-    typealias Event = Request
-    typealias Output = [Exchange]
-
     let calculator: ExchangeRatesCalculator
 
     init(context: LambdaInitializationContext) async throws {

Examples/Foundation/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/JSON/Lambda.swift

@@ -26,14 +26,7 @@ struct Response: Codable {
 // codables to model your request and response objects
 
 @main
-struct MyLambda: LambdaHandler {
-    typealias Event = Request
-    typealias Output = Response
-
-    init(context: LambdaInitializationContext) async throws {
-        // setup your resources that you want to reuse for every invocation here.
-    }
-
+struct MyLambda: SimpleLambdaHandler {
     func handle(_ event: Request, context: LambdaContext) async throws -> Response {
         // as an example, respond with the input event's reversed body
         Response(body: String(event.body.reversed()))

Examples/JSON/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/LocalDebugging/MyLambda/Lambda.swift

@@ -19,14 +19,7 @@ import Shared
 // a local server simulator which will allow local debugging
 
 @main
-struct MyLambda: LambdaHandler {
-    typealias Event = Request
-    typealias Output = Response
-
-    init(context: LambdaInitializationContext) async throws {
-        // setup your resources that you want to reuse for every invocation here.
-    }
-
+struct MyLambda: SimpleLambdaHandler {
     func handle(_ request: Request, context: LambdaContext) async throws -> Response {
         // TODO: something useful
         Response(message: "Hello, \(request.name)!")

Examples/LocalDebugging/MyLambda/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/Testing/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.7
 
 import PackageDescription
 

Examples/Testing/Sources/Lambda.swift

@@ -17,14 +17,7 @@ import AWSLambdaRuntime
 // in this example we are receiving and responding with strings
 
 @main
-struct MyLambda: LambdaHandler {
-    typealias Event = String
-    typealias Output = String
-
-    init(context: LambdaInitializationContext) async throws {
-        // setup your resources that you want to reuse for every invocation here.
-    }
-
+struct MyLambda: SimpleLambdaHandler {
     func handle(_ event: String, context: LambdaContext) async throws -> String {
         // as an example, respond with the event's reversed body
         String(event.reversed())

Examples/Testing/Tests/LambdaTests.swift

@@ -18,9 +18,9 @@ import AWSLambdaTesting
 import XCTest
 
 class LambdaTest: XCTestCase {
-    func testIt() throws {
+    func testIt() async throws {
         let input = UUID().uuidString
-        let result = try Lambda.test(MyLambda.self, with: input)
+        let result = try await Lambda.test(MyLambda.self, with: input)
         XCTAssertEqual(result, String(input.reversed()))
     }
 }

Package.swift

@@ -1,9 +1,15 @@
-// swift-tools-version:5.6
+// swift-tools-version:5.7
 
 import PackageDescription
 
 let package = Package(
     name: "swift-aws-lambda-runtime",
+    platforms: [
+        .macOS(.v12),
+        .iOS(.v15),
+        .tvOS(.v15),
+        .watchOS(.v8),
+    ],
     products: [
         // this library exports `AWSLambdaRuntimeCore` and adds Foundation convenience methods
         .library(name: "AWSLambdaRuntime", targets: ["AWSLambdaRuntime"]),
@@ -15,7 +21,7 @@ let package = Package(
         .library(name: "AWSLambdaTesting", targets: ["AWSLambdaTesting"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", .upToNextMajor(from: "2.33.0")),
+        .package(url: "https://github.com/apple/swift-nio.git", .upToNextMajor(from: "2.43.1")),
         .package(url: "https://github.com/apple/swift-log.git", .upToNextMajor(from: "1.4.2")),
         .package(url: "https://github.com/swift-server/swift-backtrace.git", .upToNextMajor(from: "1.2.3")),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),