update and add examples to new APIs

tomerd · tomerd · commit e861641a9b51 · 2021-09-23T10:37:06.000-07:00
motivation: keep code up to date with API changes changes: * take advantage of @main where possible * move the top level Sample code to a new "Simple" examples subdirectory * add a sample that demonstrates how to test a lambda now that SwiftPM can test executables directly * update the test-sample docker setup to build & test th new samples * fix a few typos and In/Out typealias left overs
diff --git a/Examples/LambdaFunctions/Sources/Benchmark/main.swift b/Examples/LambdaFunctions/Sources/Benchmark/main.swift
@@ -19,7 +19,6 @@ import NIO
 // use this example which is more performant.
 // `EventLoopLambdaHandler` does not offload the Lambda processing to a separate thread
 // while the closure-based handlers do.
-Lambda.run { $0.eventLoop.makeSucceededFuture(BenchmarkHandler()) }
 
 struct BenchmarkHandler: EventLoopLambdaHandler {
     typealias Event = String
@@ -29,3 +28,5 @@ struct BenchmarkHandler: EventLoopLambdaHandler {
         context.eventLoop.makeSucceededFuture("hello, world!")
     }
 }
+
+Lambda.run { $0.eventLoop.makeSucceededFuture(BenchmarkHandler()) }
diff --git a/Examples/LocalDebugging/MyLambda/Lambda.swift b/Examples/LocalDebugging/MyLambda/Lambda.swift
@@ -17,8 +17,9 @@ import Shared
 
 // set LOCAL_LAMBDA_SERVER_ENABLED env variable to "true" to start
 // a local server simulator which will allow local debugging
+
 @main
-struct MyLambdaHandler: LambdaHandler {
+struct MyLambda: LambdaHandler {
     typealias Event = Request
     typealias Output = Response
 
diff --git a/Examples/LocalDebugging/MyLambda/Package.swift b/Examples/LocalDebugging/MyLambda/Package.swift
@@ -19,10 +19,12 @@ let package = Package(
     ],
     targets: [
         .executableTarget(
-            name: "MyLambda", dependencies: [
+            name: "MyLambda",
+            dependencies: [
                 .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
                 .product(name: "Shared", package: "Shared"),
-            ]
+            ],
+            path: "."
         ),
     ]
 )
diff --git a/Examples/LocalDebugging/MyLambda/Tests/LinuxMain.swift b/Examples/LocalDebugging/MyLambda/Tests/LinuxMain.swift
diff --git a/Examples/LocalDebugging/Shared/Tests/LinuxMain.swift b/Examples/LocalDebugging/Shared/Tests/LinuxMain.swift
diff --git a/Examples/Simple/Codable/Lambda.swift b/Examples/Simple/Codable/Lambda.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftAWSLambdaRuntime open source project
 //
-// Copyright (c) 2017-2020 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Copyright (c) 2021 Apple Inc. and the SwiftAWSLambdaRuntime project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -24,23 +24,19 @@ struct Response: Codable {
 }
 
 // in this example we are receiving and responding with codables. Request and Response above are examples of how to use
-// codables to model your reqeuest and response objects
-struct Handler: EventLoopLambdaHandler {
+// codables to model your request and response objects
+
+@main
+struct MyLambda: LambdaHandler {
     typealias Event = Request
     typealias Output = Response
 
-    func handle(_ event: Request, context: Lambda.Context) -> EventLoopFuture<Response> {
+    init(context: Lambda.InitializationContext) async throws {
+        // setup your resources that you want to reuse for every invocation here.
+    }
+
+    func handle(_ event: Request, context: Lambda.Context) async throws -> Response {
         // as an example, respond with the input event's reversed body
-        context.eventLoop.makeSucceededFuture(Response(body: String(event.body.reversed())))
+        Response(body: String(event.body.reversed()))
     }
 }
-
-Lambda.run { $0.eventLoop.makeSucceededFuture(Handler()) }
-
-// MARK: - this can also be expressed as a closure:
-
-/*
- Lambda.run { (_, request: Request, callback) in
-   callback(.success(Response(body: String(request.body.reversed()))))
- }
- */
diff --git a/Examples/Simple/Codable/Package.swift b/Examples/Simple/Codable/Package.swift
@@ -0,0 +1,28 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-aws-lambda-runtime-example",
+    platforms: [
+        .macOS(.v12),
+    ],
+    products: [
+        .executable(name: "MyLambda", targets: ["MyLambda"]),
+    ],
+    dependencies: [
+        // this is the dependency on the swift-aws-lambda-runtime library
+        // in real-world projects this would say
+        // .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", from: "1.0.0")
+        .package(name: "swift-aws-lambda-runtime", path: "../../.."),
+    ],
+    targets: [
+        .executableTarget(
+            name: "MyLambda",
+            dependencies: [
+                .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
+            ],
+            path: "."
+        ),
+    ]
+)
diff --git a/Examples/Simple/String/Lambda.swift b/Examples/Simple/String/Lambda.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftAWSLambdaRuntime open source project
 //
-// Copyright (c) 2017-2018 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Copyright (c) 2021 Apple Inc. and the SwiftAWSLambdaRuntime project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -13,17 +13,20 @@
 //===----------------------------------------------------------------------===//
 
 import AWSLambdaRuntimeCore
-import NIOCore
 
 // in this example we are receiving and responding with strings
-struct Handler: EventLoopLambdaHandler {
+
+@main
+struct MyLambda: LambdaHandler {
     typealias Event = String
     typealias Output = String
 
-    func handle(_ event: String, context: Lambda.Context) -> EventLoopFuture<String> {
+    init(context: Lambda.InitializationContext) async throws {
+        // setup your resources that you want to reuse for every invocation here.
+    }
+
+    func handle(_ event: String, context: Lambda.Context) async throws -> String {
         // as an example, respond with the event's reversed body
-        context.eventLoop.makeSucceededFuture(String(event.reversed()))
+        String(event.reversed())
     }
 }
-
-Lambda.run { $0.eventLoop.makeSucceededFuture(Handler()) }
diff --git a/Examples/Simple/String/Package.swift b/Examples/Simple/String/Package.swift
@@ -0,0 +1,28 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-aws-lambda-runtime-example",
+    platforms: [
+        .macOS(.v12),
+    ],
+    products: [
+        .executable(name: "MyLambda", targets: ["MyLambda"]),
+    ],
+    dependencies: [
+        // this is the dependency on the swift-aws-lambda-runtime library
+        // in real-world projects this would say
+        // .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", from: "1.0.0")
+        .package(name: "swift-aws-lambda-runtime", path: "../../.."),
+    ],
+    targets: [
+        .executableTarget(
+            name: "MyLambda",
+            dependencies: [
+                .product(name: "AWSLambdaRuntimeCore", package: "swift-aws-lambda-runtime"),
+            ],
+            path: "."
+        ),
+    ]
+)
diff --git a/Examples/Simple/Testing/Package.swift b/Examples/Simple/Testing/Package.swift
@@ -0,0 +1,30 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-aws-lambda-runtime-example",
+    platforms: [
+        .macOS(.v12),
+    ],
+    products: [
+        .executable(name: "MyLambda", targets: ["MyLambda"]),
+    ],
+    dependencies: [
+        // this is the dependency on the swift-aws-lambda-runtime library
+        // in real-world projects this would say
+        // .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", from: "1.0.0")
+        .package(name: "swift-aws-lambda-runtime", path: "../../.."),
+    ],
+    targets: [
+        .executableTarget(
+            name: "MyLambda",
+            dependencies: [
+                .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
+                .product(name: "AWSLambdaTesting", package: "swift-aws-lambda-runtime"),
+            ],
+            path: "Sources"
+        ),
+        .testTarget(name: "MyLambdaTests", dependencies: ["MyLambda"], path: "Tests"),
+    ]
+)
diff --git a/Examples/Simple/Testing/Sources/Lambda.swift b/Examples/Simple/Testing/Sources/Lambda.swift
@@ -0,0 +1,32 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) 2021 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import AWSLambdaRuntime
+
+// in this example we are receiving and responding with strings
+
+@main
+struct MyLambda: LambdaHandler {
+    typealias Event = String
+    typealias Output = String
+
+    init(context: Lambda.InitializationContext) async throws {
+        // setup your resources that you want to reuse for every invocation here.
+    }
+
+    func handle(_ event: String, context: Lambda.Context) async throws -> String {
+        // as an example, respond with the event's reversed body
+        String(event.reversed())
+    }
+}
diff --git a/Examples/Simple/Testing/Tests/LambdaTests.swift b/Examples/Simple/Testing/Tests/LambdaTests.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the SwiftAWSLambdaRuntime open source project
 //
-// Copyright (c) 2020 Apple Inc. and the SwiftAWSLambdaRuntime project authors
+// Copyright (c) 2021 Apple Inc. and the SwiftAWSLambdaRuntime project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -12,4 +12,15 @@
 //
 //===----------------------------------------------------------------------===//
 
-preconditionFailure("use `swift test --enable-test-discovery`")
+import AWSLambdaRuntime
+import AWSLambdaTesting
+@testable import MyLambda
+import XCTest
+
+class LambdaTest: XCTestCase {
+    func testIt() throws {
+        let input = UUID().uuidString
+        let result = try Lambda.test(MyLambda.self, with: input)
+        XCTAssertEqual(result, String(input.reversed()))
+    }
+}
diff --git a/Package.swift b/Package.swift
@@ -52,7 +52,5 @@ let package = Package(
             .product(name: "NIOHTTP1", package: "swift-nio"),
             .product(name: "NIO", package: "swift-nio"),
         ]),
-        .target(name: "StringSample", dependencies: ["AWSLambdaRuntime"]),
-        .target(name: "CodableSample", dependencies: ["AWSLambdaRuntime"]),
     ]
 )
diff --git a/Sources/AWSLambdaTesting/Lambda+Testing.swift b/Sources/AWSLambdaTesting/Lambda+Testing.swift
@@ -13,18 +13,16 @@
 //===----------------------------------------------------------------------===//
 
 // This functionality is designed to help with Lambda unit testing with XCTest
-// #if filter required for release builds which do not support @testable import
-// @testable is used to access of internal functions
-// For exmaple:
+// For example:
 //
 // func test() {
 //     struct MyLambda: LambdaHandler {
-//         typealias In = String
-//         typealias Out = String
+//         typealias Event = String
+//         typealias Output = String
 //
 //         init(context: Lambda.InitializationContext) {}
 //
-//         func handle(event: String, context: Lambda.Context) async throws -> String {
+//         func handle(_ event: String, context: Lambda.Context) async throws -> String {
 //             "echo" + event
 //         }
 //     }
diff --git a/Tests/AWSLambdaRuntimeCoreTests/LambdaHandlers.swift b/Tests/AWSLambdaRuntimeCoreTests/LambdaHandlers.swift
@@ -16,17 +16,17 @@ import AWSLambdaRuntimeCore
 import NIOCore
 
 struct EchoHandler: EventLoopLambdaHandler {
-    typealias In = String
-    typealias Out = String
+    typealias Event = String
+    typealias Output = String
 
     func handle(_ event: String, context: Lambda.Context) -> EventLoopFuture<String> {
         context.eventLoop.makeSucceededFuture(event)
     }
 }
 
 struct FailedHandler: EventLoopLambdaHandler {
-    typealias In = String
-    typealias Out = Void
+    typealias Event = String
+    typealias Output = Void
 
     private let reason: String
 
diff --git a/Tests/AWSLambdaRuntimeTests/Lambda+CodeableTest.swift b/Tests/AWSLambdaRuntimeTests/Lambda+CodeableTest.swift
@@ -145,7 +145,7 @@ class CodableLambdaTest: XCTestCase {
     }
     #endif
 
-    // convencience method
+    // convenience method
     func newContext() -> Lambda.Context {
         Lambda.Context(requestID: UUID().uuidString,
                        traceID: "abc123",
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
diff --git a/docker/docker-compose.yaml b/docker/docker-compose.yaml
@@ -34,8 +34,12 @@ services:
     <<: *common
     command: >-
       /bin/bash -clx "
+      swift build --package-path Examples/Simple/String &&
+      swift build --package-path Examples/Simple/Codable &&
+      swift test --package-path Examples/Simple/Testing &&
       swift build --package-path Examples/LambdaFunctions &&
-      swift build --package-path Examples/LocalDebugging/MyLambda"
+      swift build --package-path Examples/LocalDebugging/MyLambda
+      "
 
   # util
 
diff --git a/scripts/soundness.sh b/scripts/soundness.sh
@@ -19,7 +19,7 @@ here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 function replace_acceptable_years() {
     # this needs to replace all acceptable forms with 'YEARS'
-    sed -e 's/2017-2018/YEARS/' -e 's/2017-2020/YEARS/' -e 's/2017-2021/YEARS/' -e 's/2019/YEARS/' -e 's/2020/YEARS/'
+    sed -e 's/2017-2018/YEARS/' -e 's/2017-2020/YEARS/' -e 's/2017-2021/YEARS/' -e 's/2019/YEARS/' -e 's/2020/YEARS/' -e 's/2021/YEARS/'
 }
 
 printf "=> Checking for unacceptable language... "

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ import NIO`
`19`	`19`	`// use this example which is more performant.`
`20`	`20`	// `EventLoopLambdaHandler` does not offload the Lambda processing to a separate thread
`21`	`21`	`// while the closure-based handlers do.`
`22`		`-Lambda.run { $0.eventLoop.makeSucceededFuture(BenchmarkHandler()) }`
`23`	`22`
`24`	`23`	`struct BenchmarkHandler: EventLoopLambdaHandler {`
`25`	`24`	`typealias Event = String`
`@@ -29,3 +28,5 @@ struct BenchmarkHandler: EventLoopLambdaHandler {`
`29`	`28`	`context.eventLoop.makeSucceededFuture("hello, world!")`
`30`	`29`	`}`
`31`	`30`	`}`
	`31`	`+`
	`32`	`+Lambda.run { $0.eventLoop.makeSucceededFuture(BenchmarkHandler()) }`