Add LambdaAPI Example of a Serverless REST API #125
Conversation
|
Can one of the admins verify this patch? |
3 similar comments
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
| @@ -42,5 +50,12 @@ let package = Package( | |||
| .target(name: "CurrencyExchange", dependencies: [ | |||
| .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"), | |||
| ]), | |||
| .target(name: "LambdaAPI", dependencies: [ | |||
There was a problem hiding this comment.
its great to have such a comprehensive example! I think it needs a more specific name though - one that describes better the kind of things it demonstrates (see CurrencyExchange for example)
There was a problem hiding this comment.
I agree, what do you think about ProductAPI ?
| } | ||
| return try decoder.decode(T.self, from: dataBody) | ||
| } | ||
| } |
| } | ||
| } | ||
|
|
||
| let defaultHeaders = ["Content-Type": "application/json", |
There was a problem hiding this comment.
static? also make note about XSS?
There was a problem hiding this comment.
- static 49aedc7
| ) | ||
| } | ||
|
|
||
| init<Out: Encodable>(with object: Out, statusCode: AWSLambdaEvents.HTTPResponseStatus) { |
| statusCode: statusCode, | ||
| headers: defaultHeaders, | ||
| multiValueHeaders: nil, | ||
| body: "{\"message\":\"\(error.localizedDescription)\"}", |
There was a problem hiding this comment.
localizedDescription not needed?
| } | ||
|
|
||
| init<Out: Encodable>(with result: Result<Out, Error>, statusCode: AWSLambdaEvents.HTTPResponseStatus) { | ||
|
|
There was a problem hiding this comment.
remove redundant empty lines (several spots)
| import Foundation | ||
| import AWSDynamoDB | ||
|
|
||
| public struct ProductField { |
There was a problem hiding this comment.
consider nesting under Product. also consider using enum
| self.createdAt = dictionary[ProductField.createdAt]?.s | ||
| self.updatedAt = dictionary[ProductField.updatedAt]?.s | ||
| } | ||
| } |
There was a problem hiding this comment.
I wonder if there is an opportunity to do something cool here based on encoder/decoder
There was a problem hiding this comment.
@adam-fowler has added something to simplify this soto-project/soto#319.
Here my original example with the implementation from his branch:
https://github.com/swift-sprinter/aws-serverless-swift-api-template/tree/feature/dynamodb-codable
| public let description: String | ||
| public var createdAt: String? | ||
| public var updatedAt: String? | ||
| } |
There was a problem hiding this comment.
some are var and some are let, intentional?
There was a problem hiding this comment.
Yes, the business logic updates them.
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import Foundation |
| public let name: String | ||
| public let description: String | ||
| public var createdAt: String? | ||
| public var updatedAt: String? |
There was a problem hiding this comment.
It could be, but I left the String to have a more clear output in the JSON:
With String
{
"updatedAt": "2020-06-20T10:31:39.633Z",
"description": "Finally! Swift 🚀 + AWS Lambda⚡️️",
"createdAt": "2020-06-20T10:31:39.633Z",
"name": "A new template 3",
"sku": "3"
}
With Date
{
"createdAt": 614341899.6329999,
"description": "Finally! Swift 🚀 + AWS Lambda⚡️️",
"updatedAt": 614341899.6329999,
"name": "A new template 3",
"sku": "3"
}
Note that in DynamoDB the date can be saved as Number o String. In the example is saved as String iso8061.
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes
| import Foundation | ||
| #if canImport(FoundationNetworking) | ||
| import FoundationNetworking | ||
| #endif |
| } | ||
|
|
||
| struct EmptyResponse: Codable { | ||
|
|
|
|
||
| struct ProductLambda: LambdaHandler { | ||
|
|
||
| //typealias In = APIGateway.SimpleRequest |
|
|
||
| static func currentRegion() -> Region { | ||
|
|
||
| if let awsRegion = ProcessInfo.processInfo.environment["AWS_REGION"] { |
There was a problem hiding this comment.
there is a helper for that: Lambda.env
There was a problem hiding this comment.
also may be worth caching to improve perf
There was a problem hiding this comment.
- 49aedc7
- It's called only once.
| } | ||
|
|
||
| static func tableName() throws -> String { | ||
| guard let tableName = ProcessInfo.processInfo.environment["PRODUCTS_TABLE_NAME"] else { |
| let timeout = HTTPClient.Configuration.Timeout(connect: lambdaRuntimeTimeout, | ||
| read: lambdaRuntimeTimeout) | ||
| let configuration = HTTPClient.Configuration(timeout: timeout) | ||
| self.httpClient = HTTPClient(eventLoopGroupProvider: .createNew, configuration: configuration) |
There was a problem hiding this comment.
share the event loop instead of creating new
| init(eventLoop: EventLoop) { | ||
|
|
||
| let handler = Lambda.env("_HANDLER") ?? "" | ||
| self.operation = Operation(rawValue: handler) ?? .unknown |
There was a problem hiding this comment.
Yes, if the lambda handler is not one of the supported case.
There was a problem hiding this comment.
refactor in
ff3326e
|
|
||
| init(eventLoop: EventLoop) { | ||
|
|
||
| let handler = Lambda.env("_HANDLER") ?? "" |
There was a problem hiding this comment.
is unknown handler an error case?
There was a problem hiding this comment.
Yes, it's set in the next line.
| self.operation = Operation(rawValue: handler) ?? .unknown | ||
|
|
||
| self.region = Self.currentRegion() | ||
| logger.info("\(Self.currentRegion())") |
There was a problem hiding this comment.
maybe log as part of more meaningful message with additional context/configuration data. also should this be logged at debug or info level?
There was a problem hiding this comment.
ff3326e
removed
| self.httpClient = HTTPClient(eventLoopGroupProvider: .createNew, configuration: configuration) | ||
|
|
||
| self.db = AWSDynamoDB.DynamoDB(region: region, httpClientProvider: .shared(self.httpClient)) | ||
| logger.info("DynamoDB") |
There was a problem hiding this comment.
Yes, I'll remove it.
| self.db = AWSDynamoDB.DynamoDB(region: region, httpClientProvider: .shared(self.httpClient)) | ||
| logger.info("DynamoDB") | ||
|
|
||
| self.tableName = (try? Self.tableName()) ?? "" |
| db: db, | ||
| tableName: tableName | ||
| ) | ||
| logger.info("ProductService") |
There was a problem hiding this comment.
Yes, I'll remove it.
| import Foundation | ||
| #if canImport(FoundationNetworking) | ||
| import FoundationNetworking | ||
| #endif |
| } | ||
| } | ||
| return list | ||
| case .unknown: |
There was a problem hiding this comment.
maybe this can be caught earlier so not included in the enum?
There was a problem hiding this comment.
Removed
| } | ||
| } | ||
|
|
||
| struct CreateLambdaHandler { |
There was a problem hiding this comment.
consider making these into functions, e.g. (did not try to compile, so maybe syntax errors):
func createHandler(service: ProductService, context: Lambda.Context, event: APIGateway.V2.Request) -> EventLoopFuture<Product> {
guard let product: Product = try? event.object() else {
return context.eventLoop.makeFailedFuture(APIError.invalidRequest)
}
return service.createItem(product: product)
}There was a problem hiding this comment.
Refactored in 8649522
| self.service = service | ||
| } | ||
|
|
||
| func handle(context: Lambda.Context, event: APIGateway.V2.Request) -> EventLoopFuture<Result<Product,Error>> { |
There was a problem hiding this comment.
it is not typical to need EventLoopFuture<Result<Product,Error>> since EventLoopFuture already covers the error case. so this should be EventLoopFuture<Product>
There was a problem hiding this comment.
Refactored in 8649522
| return future | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
similar comments to all these ^^
There was a problem hiding this comment.
Refactored in 8649522
| case handlerNotFound | ||
| } | ||
|
|
||
| extension Date { |
There was a problem hiding this comment.
Used after refactor of Operation
ff3326e
| var product = product | ||
| let date = Date().iso8601 | ||
| product.createdAt = date | ||
| product.updatedAt = date |
There was a problem hiding this comment.
can the date be stored in more native format like numeric or timestamp?
There was a problem hiding this comment.
Note that in DynamoDB the date can be saved as Number o String.
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes
| let input = DynamoDB.ScanInput(tableName: tableName) | ||
| return db.scan(input) | ||
| } | ||
| } |
There was a problem hiding this comment.
cc @tachyonics for dynmodb best practices
| import AWSLambdaRuntime | ||
| import Logging | ||
|
|
||
| let logger = Logger(label: "AWS.Lambda.Products") |
| @@ -0,0 +1,202 @@ | |||
| { | |||
There was a problem hiding this comment.
It's the Swagger you can open with PostMan to have the API definition and test it. I need to insert this in some README. Do you have suggestion for it?
There was a problem hiding this comment.
nice to see another comprehensive example @Andrea-Scuderi
some comments inline
| @@ -18,12 +18,20 @@ let package = Package( | |||
| .executable(name: "APIGateway", targets: ["APIGateway"]), | |||
| // fully featured example with domain specific business logic | |||
| .executable(name: "CurrencyExchange", targets: ["CurrencyExchange"]), | |||
There was a problem hiding this comment.
@tomerd / @fabianfett we need to remove all executables from the products. If you export it as a product, then other libraries can depend on them. swift run works on all targets, so just leave out everything that's not meant for other packages to depend on.
There was a problem hiding this comment.
Thanks @fabianfett for pointing out to me that this isn't the main Package.swift. So we don't need to remove those here. They still aren't necessary but not an issue to have them.
Andrea-Scuderi
force-pushed
the
as-add-api-example
branch
from
7f9c268 to
21ccb0d
Compare
Andrea-Scuderi
changed the title
Fix ProductLambda init
Andrea-Scuderi
force-pushed
the
as-add-api-example
branch
from
6cbf22b to
074b7a0
Compare
Andrea-Scuderi
changed the title
|
hi @Andrea-Scuderi how do you want to proceed with this PR? note some thoughts about such additional examples in https://forums.swift.org/t/examples-and-getting-started-guides/ |
|
hi @Andrea-Scuderi if you want to keep this around, could you please update this PR to be against the |
|
updated here #175 |
Motivation
Add an Example to show how to build a Serverless REST API using: