Merge branch 'main' into sebsto/readme

Author: sebsto

.github/workflows/scripts/check-archive-plugin.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+##===----------------------------------------------------------------------===##
+##
+## This source file is part of the SwiftAWSLambdaRuntime open source project
+##
+## Copyright (c) 2017-2024 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
+##
+##===----------------------------------------------------------------------===##
+
+EXAMPLE=HelloWorld
+OUTPUT_DIR=.build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager
+OUTPUT_FILE=${OUTPUT_DIR}/MyLambda/bootstrap
+ZIP_FILE=${OUTPUT_DIR}/MyLambda/MyLambda.zip
+
+pushd Examples/${EXAMPLE} || exit 1
+
+# package the example (docker and swift toolchain are installed on the GH runner)
+LAMBDA_USE_LOCAL_DEPS=../.. swift package archive --allow-network-connections docker || exit 1
+
+# did the plugin generated a Linux binary?
+[ -f "${OUTPUT_FILE}" ]
+file "${OUTPUT_FILE}" | grep --silent ELF
+
+# did the plugin created a ZIP file?
+[ -f "${ZIP_FILE}" ]
+
+# does the ZIP file contain the bootstrap?
+unzip -l "${ZIP_FILE}" | grep --silent bootstrap
+
+echo "✅ The archive plugin is OK"
+popd || exit 1

scripts/integration_tests.sh renamed to .github/workflows/scripts/integration_tests.sh

@@ -32,3 +32,5 @@ Package.resolved
 .swiftformat
 *.yaml
 *.yml
+**/.npmignore
+**/*.json

.licenseignore

@@ -29,7 +29,7 @@ let package = Package(
                 .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
                 .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events"),
             ],
-            path: "."
+            path: "Sources"
         )
     ]
 )

Examples/APIGateway/Package.swift

@@ -15,13 +15,6 @@
 import AWSLambdaEvents
 import AWSLambdaRuntime
 
-#if canImport(FoundationEssentials)
-import FoundationEssentials
-#else
-import Foundation
-#endif
-
-let encoder = JSONEncoder()
 let runtime = LambdaRuntime {
     (event: APIGatewayV2Request, context: LambdaContext) -> APIGatewayV2Response in
 
@@ -31,10 +24,7 @@ let runtime = LambdaRuntime {
     header["content-type"] = "application/json"
 
     // echo the request in the response
-    let data = try encoder.encode(event)
-    let response = String(decoding: data, as: Unicode.UTF8.self)
-
-    return APIGatewayV2Response(statusCode: .ok, headers: header, body: response)
+    return try APIGatewayV2Response(statusCode: .ok, headers: header, encodableBody: event)
 }
 
 try await runtime.run()

Examples/APIGateway/Sources/main.swift

@@ -27,7 +27,7 @@ let package = Package(
             dependencies: [
                 .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime")
             ],
-            path: "."
+            path: "Sources"
         )
     ]
 )

Examples/BackgroundTasks/Package.swift

@@ -13,7 +13,12 @@
 //===----------------------------------------------------------------------===//
 
 import AWSLambdaRuntime
+
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
 import Foundation
+#endif
 
 struct BackgroundProcessingHandler: LambdaWithBackgroundProcessingHandler {
     struct Input: Decodable {

Examples/BackgroundTasks/Sources/main.swift

@@ -0,0 +1,62 @@
+// swift-tools-version:6.0
+
+import PackageDescription
+
+// needed for CI to test the local version of the library
+import struct Foundation.URL
+
+#if os(macOS)
+let platforms: [PackageDescription.SupportedPlatform]? = [.macOS(.v15)]
+#else
+let platforms: [PackageDescription.SupportedPlatform]? = nil
+#endif
+
+let package = Package(
+    name: "swift-aws-lambda-runtime-example",
+    platforms: platforms,
+    products: [
+        .executable(name: "APIGatewayLambda", targets: ["APIGatewayLambda"])
+    ],
+    dependencies: [
+        // during CI, the dependency on local version of swift-aws-lambda-runtime is added dynamically below
+        .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", branch: "main"),
+        .package(url: "https://github.com/swift-server/swift-aws-lambda-events.git", branch: "main"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "APIGatewayLambda",
+            dependencies: [
+                .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
+                .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events"),
+            ],
+            path: "Sources"
+        )
+    ]
+)
+
+if let localDepsPath = Context.environment["LAMBDA_USE_LOCAL_DEPS"],
+    localDepsPath != "",
+    let v = try? URL(fileURLWithPath: localDepsPath).resourceValues(forKeys: [.isDirectoryKey]),
+    v.isDirectory == true
+{
+    // when we use the local runtime as deps, let's remove the dependency added above
+    let indexToRemove = package.dependencies.firstIndex { dependency in
+        if case .sourceControl(
+            name: _,
+            location: "https://github.com/swift-server/swift-aws-lambda-runtime.git",
+            requirement: _
+        ) = dependency.kind {
+            return true
+        }
+        return false
+    }
+    if let indexToRemove {
+        package.dependencies.remove(at: indexToRemove)
+    }
+
+    // then we add the dependency on LAMBDA_USE_LOCAL_DEPS' path (typically ../..)
+    print("[INFO] Compiling against swift-aws-lambda-runtime located at \(localDepsPath)")
+    package.dependencies += [
+        .package(name: "swift-aws-lambda-runtime", path: localDepsPath)
+    ]
+}

Examples/CDK/Package.swift

@@ -0,0 +1,121 @@
+# API Gateway and Cloud Development Kit
+
+This is a simple example of an AWS Lambda function invoked through an Amazon API Gateway and deployed with the Cloud Development Kit (CDK).
+
+## Code 
+
+The Lambda function takes all HTTP headers it receives as input and returns them as output. See the [API Gateway example](Examples/APIGateway/README.md) for a complete description of the code.
+
+## Build & Package 
+
+To build the package, type the following commands.
+
+```bash
+swift build
+swift package archive --allow-network-connections docker
+```
+
+If there is no error, there is a ZIP file ready to deploy. 
+The ZIP file is located at `.build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/APIGatewayLambda/APIGatewayLambda.zip`
+
+## Deploy
+
+>[NOTE]
+>Before deploying the infrastructure, you need to have NodeJS and the AWS CDK installed and configured.
+>For more information, see the [AWS CDK documentation](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html).
+
+To deploy the infrastructure, type the following commands.
+
+```sh
+# Change to the infra directory
+cd infra
+
+# Install the dependencies (only before the first deployment)
+npm install 
+
+cdk deploy
+
+✨  Synthesis time: 2.88s
+... redacted for brevity ...
+Do you wish to deploy these changes (y/n)? y
+... redacted for brevity ...
+ ✅  LambdaApiStack
+
+✨  Deployment time: 42.96s
+
+Outputs:
+LambdaApiStack.ApiUrl = https://tyqnjcawh0.execute-api.eu-central-1.amazonaws.com/
+Stack ARN:
+arn:aws:cloudformation:eu-central-1:401955065246:stack/LambdaApiStack/e0054390-be05-11ef-9504-065628de4b89
+
+✨  Total time: 45.84s
+```
+
+## Invoke your Lambda function
+
+To invoke the Lambda function, use this `curl` command line.
+
+```bash
+curl https://tyqnjcawh0.execute-api.eu-central-1.amazonaws.com
+```
+
+Be sure to replace the URL with the API Gateway endpoint returned in the previous step.
+
+This should print a JSON similar to 
+
+```bash 
+{"version":"2.0","rawPath":"\/","isBase64Encoded":false,"rawQueryString":"","headers":{"user-agent":"curl\/8.7.1","accept":"*\/*","host":"a5q74es3k2.execute-api.us-east-1.amazonaws.com","content-length":"0","x-amzn-trace-id":"Root=1-66fb0388-691f744d4bd3c99c7436a78d","x-forwarded-port":"443","x-forwarded-for":"81.0.0.43","x-forwarded-proto":"https"},"requestContext":{"requestId":"e719cgNpoAMEcwA=","http":{"sourceIp":"81.0.0.43","path":"\/","protocol":"HTTP\/1.1","userAgent":"curl\/8.7.1","method":"GET"},"stage":"$default","apiId":"a5q74es3k2","time":"30\/Sep\/2024:20:01:12 +0000","timeEpoch":1727726472922,"domainPrefix":"a5q74es3k2","domainName":"a5q74es3k2.execute-api.us-east-1.amazonaws.com","accountId":"012345678901"}
+```
+
+If you have `jq` installed, you can use it to pretty print the output.
+
+```bash
+curl -s  https://tyqnjcawh0.execute-api.eu-central-1.amazonaws.com | jq   
+{
+  "version": "2.0",
+  "rawPath": "/",
+  "requestContext": {
+    "domainPrefix": "a5q74es3k2",
+    "stage": "$default",
+    "timeEpoch": 1727726558220,
+    "http": {
+      "protocol": "HTTP/1.1",
+      "method": "GET",
+      "userAgent": "curl/8.7.1",
+      "path": "/",
+      "sourceIp": "81.0.0.43"
+    },
+    "apiId": "a5q74es3k2",
+    "accountId": "012345678901",
+    "requestId": "e72KxgsRoAMEMSA=",
+    "domainName": "a5q74es3k2.execute-api.us-east-1.amazonaws.com",
+    "time": "30/Sep/2024:20:02:38 +0000"
+  },
+  "rawQueryString": "",
+  "routeKey": "$default",
+  "headers": {
+    "x-forwarded-for": "81.0.0.43",
+    "user-agent": "curl/8.7.1",
+    "host": "a5q74es3k2.execute-api.us-east-1.amazonaws.com",
+    "accept": "*/*",
+    "x-amzn-trace-id": "Root=1-66fb03de-07533930192eaf5f540db0cb",
+    "content-length": "0",
+    "x-forwarded-proto": "https",
+    "x-forwarded-port": "443"
+  },
+  "isBase64Encoded": false
+}
+```
+
+## Undeploy
+
+When done testing, you can delete the infrastructure with this command.
+
+```bash
+cdk destroy
+
+Are you sure you want to delete: LambdaApiStack (y/n)? y
+LambdaApiStack: destroying... [1/1]
+... redacted for brevity ...
+ ✅  LambdaApiStack: destroyed
+```

Examples/CDK/README.md

@@ -0,0 +1,40 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the SwiftAWSLambdaRuntime open source project
+//
+// Copyright (c) 2024 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 AWSLambdaEvents
+import AWSLambdaRuntime
+
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+let encoder = JSONEncoder()
+let runtime = LambdaRuntime {
+    (event: APIGatewayV2Request, context: LambdaContext) -> APIGatewayV2Response in
+
+    var header = HTTPHeaders()
+    context.logger.debug("HTTP API Message received")
+
+    header["content-type"] = "application/json"
+
+    // echo the request in the response
+    let data = try encoder.encode(event)
+    let response = String(decoding: data, as: Unicode.UTF8.self)
+
+    return APIGatewayV2Response(statusCode: .ok, headers: header, body: response)
+}
+
+try await runtime.run()