Add AWS SDK and Soto examples

.github/workflows/examples_matrix.yml

@@ -18,7 +18,7 @@ on:
       matrix_linux_swift_container_image:
         type: string
         description: "Container image for the matrix job. Defaults to matching latest Swift Ubuntu image."
-        default: "swift:latest"
+        default: "swift:amazonlinux2"
 
 ## We are cancelling previously triggered workflow runs
 concurrency:
@@ -33,28 +33,49 @@ jobs:
       fail-fast: false
       matrix:
         # This should be passed as an argument in input. Can we pass arrays as argument ?
-        examples : [ "HelloWorld", "APIGateway" ]
+        examples : [ "HelloWorld", "APIGateway", "S3_AWSSDK", "S3_Soto" ]
         # examples: ${{ inputs.examples }}
 
         # We are using only one Swift version
         swift:
         - image: ${{ inputs.matrix_linux_swift_container_image }}
-          swift_version: "6.0.1-noble"
+          swift_version: "6.0.1-amazonlinux2"
     container:
       image: ${{ matrix.swift.image }}
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-          persist-credentials: false
+
+    # GitHub checkout action has a dep on NodeJS 20 which is not running on Amazonlinux2
+    # workaround is to manually checkout the repository
+    # https://github.com/actions/checkout/issues/1487
+    - name: Manually Clone repository and checkout PR
+      env:
+        PR_NUMBER: ${{ github.event.pull_request.number }}
+      run: |
+        # Clone the repository
+        git clone https://github.com/${{ github.repository }}
+        cd ${{ github.event.repository.name }}
+
+        # Fetch the pull request
+        git fetch origin +refs/pull/$PR_NUMBER/merge:
+
+        # Checkout the pull request
+        git checkout -qf FETCH_HEAD
+
+    # - name: Checkout repository
+    #   uses: actions/checkout@v4
+    #   with:
+    #       persist-credentials: false
+
     - name: Mark the workspace as safe
-    # https://github.com/actions/checkout/issues/766
+      working-directory: ${{ github.event.repository.name }} # until we can use action/checkout@v4
+      # https://github.com/actions/checkout/issues/766
       run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+
     - name: Run matrix job
+      working-directory: ${{ github.event.repository.name }} # until we can use action/checkout@v4
       env:
         SWIFT_VERSION: ${{ matrix.swift.swift_version }}
         COMMAND: ${{ inputs.matrix_linux_command }}
         EXAMPLE: ${{ matrix.examples }}
       run: |
-        apt-get -qq update && apt-get -qq -y install curl
         ./scripts/integration_tests.sh

Examples/APIGateway/Package.swift

@@ -3,7 +3,6 @@
 import PackageDescription
 
 // needed for CI to test the local version of the library
-import class Foundation.ProcessInfo
 import struct Foundation.URL
 
 #if os(macOS)
@@ -16,17 +15,16 @@ let package = Package(
     name: "swift-aws-lambda-runtime-example",
     platforms: platforms,
     products: [
-        .executable(name: "APIGAtewayLambda", targets: ["APIGAtewayLambda"])
+        .executable(name: "APIGatewayLambda", targets: ["APIGatewayLambda"])
     ],
     dependencies: [
-        // dependency on 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")
+        // 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",
+            name: "APIGatewayLambda",
             dependencies: [
                 .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
                 .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events"),
@@ -36,20 +34,29 @@ let package = Package(
     ]
 )
 
-if let localDepsPath = ProcessInfo.processInfo.environment["LAMBDA_USE_LOCAL_DEPS"],
+if let localDepsPath = Context.environment["LAMBDA_USE_LOCAL_DEPS"],
     localDepsPath != "",
     let v = try? URL(fileURLWithPath: localDepsPath).resourceValues(forKeys: [.isDirectoryKey]),
-    let _ = v.isDirectory
+    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)
     ]
-
-} else {
-    print("[INFO] LAMBDA_USE_LOCAL_DEPS is not pointing to your local swift-aws-lambda-runtime code")
-    print("[INFO] This project will compile against the main branch of the Lambda Runtime on GitHub")
-    package.dependencies += [
-        .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", branch: "main")
-    ]
 }

Examples/APIGateway/README.md

@@ -26,7 +26,7 @@ swift package archive --allow-network-access 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/MyLambda/MyLambda.zip`
+The ZIP file is located at `.build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/APIGatewayLambda/APIGatewayLambda.zip`
 
 ## Deploy
 
@@ -40,9 +40,9 @@ To actually deploy your Lambda function and create the infrastructure, type the
 
 ```bash
 sam deploy \
-----resolve-s3 \
+--resolve-s3 \
 --template-file template.yaml \
---stack-name MyLambda \
+--stack-name APIGatewayLambda \
 --capabilities CAPABILITY_IAM 
 ```
 
@@ -53,8 +53,8 @@ The output is similar to this one.
 -----------------------------------------------------------------------------------------------------------------------------
 Outputs                                                                                                                     
 -----------------------------------------------------------------------------------------------------------------------------
-Key                 APIGAtewayEndpoint                                                                                      
-Description         API Gateway endpoint UR"                                                                                
+Key                 APIGatewayEndpoint                                                                                      
+Description         API Gateway endpoint URL"                                                                                
 Value               https://a5q74es3k2.execute-api.us-east-1.amazonaws.com                                                  
 -----------------------------------------------------------------------------------------------------------------------------
 ```

Examples/APIGateway/template.yaml

@@ -4,12 +4,12 @@ Description: SAM Template for QuoteService
 
 Resources:
   # Lambda function
-  APIGAtewayLambda:
+  APIGatewayLambda:
     Type: AWS::Serverless::Function
     Properties:
-      CodeUri: .build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/APIGAtewayLambda/APIGAtewayLambda.zip
+      CodeUri: .build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/APIGatewayLambda/APIGatewayLambda.zip
       Timeout: 60
-      Handler: swift.bootstrap
+      Handler: swift.bootstrap # ignored by the Swift runtime
       Runtime: provided.al2
       MemorySize: 512
       Architectures:
@@ -19,13 +19,13 @@ Resources:
           # by default, AWS Lambda runtime produces no log
           # use `LOG_LEVEL: debug` for for lifecycle and event handling information
           # use `LOG_LEVEL: trace` for detailed input event information
-          LOG_LEVEL: trace
+          LOG_LEVEL: debug
       Events:
         HttpApiEvent:
             Type: HttpApi
 
 Outputs:
   # print API Gateway endpoint
-  APIGAtewayEndpoint:
+  APIGatewayEndpoint:
     Description: API Gateway endpoint UR"
     Value: !Sub "https://${ServerlessHttpApi}.execute-api.${AWS::Region}.amazonaws.com"

Examples/HelloWorld/Package.swift

@@ -3,7 +3,6 @@
 import PackageDescription
 
 // needed for CI to test the local version of the library
-import class Foundation.ProcessInfo
 import struct Foundation.URL
 
 #if os(macOS)
@@ -19,8 +18,8 @@ let package = Package(
         .executable(name: "MyLambda", targets: ["MyLambda"])
     ],
     dependencies: [
-        // dependency on swift-aws-lambda-runtime is added dynamically below
-        // .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", branch: "main")
+        // 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")
     ],
     targets: [
         .executableTarget(
@@ -33,20 +32,29 @@ let package = Package(
     ]
 )
 
-if let localDepsPath = ProcessInfo.processInfo.environment["LAMBDA_USE_LOCAL_DEPS"],
+if let localDepsPath = Context.environment["LAMBDA_USE_LOCAL_DEPS"],
     localDepsPath != "",
     let v = try? URL(fileURLWithPath: localDepsPath).resourceValues(forKeys: [.isDirectoryKey]),
-    let _ = v.isDirectory
+    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)
     ]
-
-} else {
-    print("[INFO] LAMBDA_USE_LOCAL_DEPS is not pointing to your local swift-aws-lambda-runtime code")
-    print("[INFO] This project will compile against the main branch of the Lambda Runtime on GitHub")
-    package.dependencies += [
-        .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", branch: "main")
-    ]
 }

Examples/S3_AWSSDK/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.aws-sam/
+.build
+samtemplate.toml
+*/build/*
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

Examples/S3_AWSSDK/Package.swift

@@ -0,0 +1,63 @@
+// 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: "AWSSDKExample",
+    platforms: platforms,
+    products: [
+        .executable(name: "AWSSDKExample", targets: ["AWSSDKExample"])
+    ],
+    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", branch: "main"),
+        .package(url: "https://github.com/awslabs/aws-sdk-swift", from: "1.0.0"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "AWSSDKExample",
+            dependencies: [
+                .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"),
+                .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events"),
+                .product(name: "AWSS3", package: "aws-sdk-swift"),
+            ]
+        )
+    ]
+)
+
+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)
+    ]
+}