🚀 Swift Vapor Lambda Client

Support for Amazon's Lambda with Vapor 4.0 using aws-sdk-swift

Usage

In the 💧Vapor 4.0 project update the following files:

Package.swift

• Add the package vapor-lambda-client to the Package.dependencies

dependencies: [
    // ...
    // 💧 A server-side Swift web framework.
        .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),

    // 🚀 A server-side Swift Lambda client for Vapor.
    .package(name: "vapor-lambda-client", url: "https://github.com/Andrea-Scuderi/vapor-lambda-client.git", from: "1.0.0-alpha"),
]

• Add the product VaporLambdaClient to the App target

    .target(name: "App", dependencies: [
            .product(name: "Vapor", package: "vapor"),
            .product(name: "VaporLambdaClient", package: "vapor-lambda-client"),
    ]),

Example:

// swift-tools-version:5.2
import PackageDescription

let package = Package(
    name: "LocalLambdaGateway",
    platforms: [
        .macOS(.v10_15),
    ],
    products: [
        .library(name: "LocalLambdaGateway", targets: ["App"]),
    ],
    dependencies: [
        // 💧 A server-side Swift web framework.
        .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),

        // 🚀 A server-side Swift Lambda client for Vapor.
        .package(name: "vapor-lambda-client", url: "https://github.com/Andrea-Scuderi/vapor-lambda-client.git", from: "1.0.0-alpha"),
    ],
    targets: [
        .target(name: "App", dependencies: [
            .product(name: "Vapor", package: "vapor"),
            .product(name: "VaporLambdaClient", package: "vapor-lambda-client"),
        ]),
        .target(name: "Run", dependencies: ["App"]),
        .testTarget(name: "AppTests", dependencies: [
            .target(name: "App"),
            .product(name: "XCTVapor", package: "vapor"),
        ])
    ]
)

configure.swift

• Add the LambdaHandler to the app lifecycle.

  • accessKeyID: <AWS_ACCESS_KEY_ID>
  • secretAccessKey: <AWS_SECRET_ACCESS_KEY>
  • region: <AWS_REGION>
  • endpoint: nil or a custom endpoint for local test

• Optional Add the HTMLResponseMiddleware to convert the response to HTML

public func configure(_ app: Application) throws {
    // Register routes to the router
    try routes(app)

    // Register middleware
    let htmlMiddleware = HTMLResponseMiddleware()
    app.middleware.use(htmlMiddleware)

    // Register LambdaHandler
    let lambdaConfig = LambdaConfiguration(
        accessKeyId: "123456",
        secretAccessKey: "789012",
        region: .useast1,
        endpoint: "http://localhost:9001"
    )

    let lambdaHandler = LambdaHandler(config: lambdaConfig)
    app.lifecycle.use(lambdaHandler)
}

routes.swift

• Add the lambda invocation in the route.

import Lambda
import VaporLambdaClient
import Vapor

public func routes(_ app: Application) throws {
    // Lambda invocation example
    app.get { req -> EventLoopFuture<String> in

        let invocationRequest = Lambda.InvocationRequest.makeInvocation(
            functionName: "Hello.hello"
        )

        return try req.lambda()
            .invokeForProxy(invocationRequest)
            .map { (result) -> String in
                result.body
            }
    }
}

• The invoke function can return different results:

  • Lambda.InvocationResponse:

  func invoke(_ query: Lambda.InvocationRequest) -> EventLoopFuture<Lambda.InvocationResponse>

  • APIGatewayProxyResult:

  func invokeForProxy(_ query: Lambda.InvocationRequest) -> EventLoopFuture<APIGatewayProxyResult>