Skip to content

feature: Create LambdaProxyEvent Type #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Nov 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions Sources/AWSLambdaEvents/LambdaGatewayProxyEvent.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftAWSLambdaRuntime open source project
//
// Copyright (c) 2017-2022 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
//
//===----------------------------------------------------------------------===//

/// LambdaGatewayProxyEvent contains data coming from the new HTTP API Gateway Proxy
public struct LambdaGatewayProxyEvent: Decodable {
public struct RequestContext: Decodable {
/// Authorizer contains authorizer information for the request context.
public struct Authorizer: Codable {
public let claims: [String: String]?
public let scopes: [String]?
}

public let accountID: String
public let apiID: String
public let domainName: String
public let domainPrefix: String
public let stage: String
public let requestID: String

public let httpMethod: HTTPMethod
public let authorizer: Authorizer?

public let resourcePath: String?
public let path: String?

/// The request time in format: 23/Apr/2020:11:08:18 +0000
public let requestTime: String?
public let requestTimeEpoch: UInt64

enum CodingKeys: String, CodingKey {
case accountID = "accountId"
case apiID = "apiId"
case domainName
case domainPrefix
case stage

case httpMethod
case authorizer

case requestID = "requestId"

case resourcePath
case path

case requestTime
case requestTimeEpoch
}
}

public let resource: String
public let path: String
public let httpMethod: String
public let stageVariables: [String: String]?

public let cookies: [String]?
public let headers: HTTPHeaders
public let queryStringParameters: [String: String]?
public let pathParameters: [String: String]?

public let requestContext: RequestContext

public let body: String?
public let isBase64Encoded: Bool
}

#if swift(>=5.6)
extension LambdaGatewayProxyEvent: Sendable {}
extension LambdaGatewayProxyEvent.RequestContext: Sendable {}
extension LambdaGatewayProxyEvent.RequestContext.Authorizer: Sendable {}
#endif
130 changes: 130 additions & 0 deletions Tests/AWSLambdaEventsTests/LambdaGatewayProxyEventTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftAWSLambdaRuntime open source project
//
// Copyright (c) 2017-2020 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
//
//===----------------------------------------------------------------------===//

@testable import AWSLambdaEvents
import XCTest

class LambdaGatewayProxyEventTests: XCTestCase {
static let exampleLambdaProxyEvent = """
{
"resource": "/hello",
"path": "/hello",
"httpMethod": "GET",
"headers": {
"x-forwarded-proto":"https",
"x-forwarded-for":"91.64.117.86",
"x-forwarded-port":"443",
"authorization":"Bearer abc123",
"host":"hello.test.com",
"x-amzn-trace-id":"Root=1-5ea3263d-07c5d5ddfd0788bed7dad831",
"user-agent":"Paw/3.1.10 (Macintosh; OS X/10.15.4) GCDHTTPRequest",
"content-length":"0"
},
"multiValueHeaders": {
"header1": [
"value1"
],
"header2": [
"value1",
"value2"
]
},
"queryStringParameters": {
"foo":"bar"
},
"multiValueQueryStringParameters": {
"parameter1": [
"value1",
"value2"
],
"parameter2": [
"value"
]
},
"requestContext": {
"accountId": "123456789012",
"apiId":"pb5dg6g3rg",
"authorizer": {
"scopes":[
"hello"
],
"claims":{
"aud":"customers",
"iss":"https://hello.test.com/",
"iat":"1587749276",
"exp":"1587756476"
}
},
"domainName": "id.execute-api.us-east-1.amazonaws.com",
"domainPrefix": "id",
"extendedRequestId": "request-id",
"httpMethod": "GET",
"identity": {
"accessKey": null,
"accountId": null,
"caller": null,
"cognitoAuthenticationProvider": null,
"cognitoAuthenticationType": null,
"cognitoIdentityId": null,
"cognitoIdentityPoolId": null,
"principalOrgId": null,
"sourceIp":"91.64.117.86",
"user": null,
"userAgent":"Paw/3.1.10 (Macintosh; OS X/10.15.4) GCDHTTPRequest",
"userArn": null,
"clientCert": {
"clientCertPem": "CERT_CONTENT",
"subjectDN": "www.example.com",
"issuerDN": "Example issuer",
"serialNumber": "a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1",
"validity": {
"notBefore": "May 28 12:30:02 2019 GMT",
"notAfter": "Aug 5 09:36:04 2021 GMT"
}
}
},
"path": "/hello",
"protocol": "HTTP/1.1",
"requestId":"LgLpnibOFiAEPCA=",
"requestTime": "04/Mar/2020:19:15:17 +0000",
"requestTimeEpoch": 1587750461466,
"resourceId": null,
"resourcePath": "/my/path",
"stage": "$default"
},
"pathParameters": null,
"stageVariables":{
"foo":"bar"
},
"body": "Hello from Lambda!",
"isBase64Encoded": false
}
"""

// MARK: - Request -

// MARK: Decoding

func testRequestDecodingExampleProxyRequest() {
let data = LambdaGatewayProxyEventTests.exampleLambdaProxyEvent.data(using: .utf8)!
var req: LambdaGatewayProxyEvent?
XCTAssertNoThrow(req = try JSONDecoder().decode(LambdaGatewayProxyEvent.self, from: data))

XCTAssertEqual(req?.path, "/hello")
XCTAssertEqual(req?.requestContext.httpMethod, .GET)
XCTAssertEqual(req?.queryStringParameters?.count, 1)
XCTAssertEqual(req?.headers.count, 8)
XCTAssertNotNil(req?.body)
}
}