Skip to content
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

2.x.x: Fix multi-value query values and headers for APIGatewayV2 #24

Merged
merged 2 commits into from Mar 7, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 33 additions & 1 deletion Sources/HummingbirdLambda/APIGatewayLambda.swift
Expand Up @@ -57,7 +57,39 @@
}

// conform `APIGatewayRequest` to `APIRequest` so we can use HBRequest.init(context:application:from)
extension APIGatewayRequest: APIRequest {}
extension APIGatewayRequest: APIRequest {
var queryString: String {
func urlPercentEncoded(_ string: String) -> String {
return string.addingPercentEncoding(withAllowedCharacters: .urlQueryComponentAllowed) ?? string
}

Check warning on line 64 in Sources/HummingbirdLambda/APIGatewayLambda.swift

View check run for this annotation

Codecov / codecov/patch

Sources/HummingbirdLambda/APIGatewayLambda.swift#L63-L64

Added lines #L63 - L64 were not covered by tests
var queryParams: [String] = []
var queryStringParameters = self.queryStringParameters ?? [:]
// go through list of multi value query string params first, removing any
// from the single value list if they are found in the multi value list
self.multiValueQueryStringParameters?.forEach { multiValueQuery in
queryStringParameters[multiValueQuery.key] = nil
queryParams += multiValueQuery.value.map { "\(urlPercentEncoded(multiValueQuery.key))=\(urlPercentEncoded($0))" }
}

Check warning on line 72 in Sources/HummingbirdLambda/APIGatewayLambda.swift

View check run for this annotation

Codecov / codecov/patch

Sources/HummingbirdLambda/APIGatewayLambda.swift#L70-L72

Added lines #L70 - L72 were not covered by tests
queryParams += queryStringParameters.map {
"\(urlPercentEncoded($0.key))=\(urlPercentEncoded($0.value))"
}

Check warning on line 75 in Sources/HummingbirdLambda/APIGatewayLambda.swift

View check run for this annotation

Codecov / codecov/patch

Sources/HummingbirdLambda/APIGatewayLambda.swift#L74-L75

Added lines #L74 - L75 were not covered by tests
return queryParams.joined(separator: "&")
}

var httpHeaders: [(name: String, value: String)] {
var headerValues = [(name: String, value: String)].init()
var originalHeaders = self.headers
headerValues.reserveCapacity(headers.count)
for header in self.multiValueHeaders {
originalHeaders[header.key] = nil
for value in header.value {
headerValues.append((name: header.key, value: value))
}
}
headerValues.append(contentsOf: originalHeaders.map { (name: $0.key, value: $0.value) })
return headerValues
}
}

// conform `APIGatewayResponse` to `APIResponse` so we can use HBResponse.apiReponse()
extension APIGatewayResponse: APIResponse {}
11 changes: 9 additions & 2 deletions Sources/HummingbirdLambda/APIGatewayV2Lambda.swift
Expand Up @@ -63,8 +63,15 @@ extension APIGatewayV2Request: APIRequest {
}

var httpMethod: AWSLambdaEvents.HTTPMethod { context.http.method }
var multiValueQueryStringParameters: [String: [String]]? { nil }
var multiValueHeaders: HTTPMultiValueHeaders { [:] }
var queryString: String { self.rawQueryString }
var httpHeaders: [(name: String, value: String)] {
self.headers.flatMap { header in
let headers = header.value
.split(separator: ",")
.map { (name: header.key, value: String($0.drop(while: \.isWhitespace))) }
return headers
}
}
}

// conform `APIGatewayV2Response` to `APIResponse` so we can use HBResponse.apiReponse()
Expand Down
40 changes: 6 additions & 34 deletions Sources/HummingbirdLambda/Request+APIGateway.swift
Expand Up @@ -23,10 +23,8 @@ import NIOCore
protocol APIRequest {
var path: String { get }
var httpMethod: AWSLambdaEvents.HTTPMethod { get }
var queryStringParameters: [String: String]? { get }
var multiValueQueryStringParameters: [String: [String]]? { get }
var headers: AWSLambdaEvents.HTTPHeaders { get }
var multiValueHeaders: HTTPMultiValueHeaders { get }
var queryString: String { get }
var httpHeaders: [(name: String, value: String)] { get }
var body: String? { get }
var isBase64Encoded: Bool { get }
}
Expand All @@ -44,23 +42,12 @@ extension HBRequest {

// construct URI with query parameters
var uri = from.path
var queryParams: [String] = []
var queryStringParameters = from.queryStringParameters ?? [:]
// go through list of multi value query string params first, removing any
// from the single value list if they are found in the multi value list
from.multiValueQueryStringParameters?.forEach { multiValueQuery in
queryStringParameters[multiValueQuery.key] = nil
queryParams += multiValueQuery.value.map { "\(urlPercentEncoded(multiValueQuery.key))=\(urlPercentEncoded($0))" }
}
queryParams += queryStringParameters.map {
"\(urlPercentEncoded($0.key))=\(urlPercentEncoded($0.value))"
}
if queryParams.count > 0 {
uri += "?\(queryParams.joined(separator: "&"))"
if from.queryString.count > 0 {
uri += "?\(from.queryString)"
}
// construct headers
var authority: String?
let headers = HTTPFields(headers: from.headers, multiValueHeaders: from.multiValueHeaders, authority: &authority)
let headers = HTTPFields(headers: from.httpHeaders, authority: &authority)

// get body
let body: ByteBuffer?
Expand Down Expand Up @@ -94,32 +81,17 @@ extension HTTPFields {
/// - headers: headers
/// - multiValueHeaders: multi-value headers
/// - authority: reference to authority string
init(headers: AWSLambdaEvents.HTTPHeaders, multiValueHeaders: HTTPMultiValueHeaders, authority: inout String?) {
init(headers: [(name: String, value: String)], authority: inout String?) {
self.init()
self.reserveCapacity(headers.count)
var firstHost = true
for (name, values) in multiValueHeaders {
if firstHost, name.lowercased() == "host" {
if let value = values.first {
firstHost = false
authority = value
continue
}
}
if let fieldName = HTTPField.Name(name) {
for value in values {
self.append(HTTPField(name: fieldName, value: value))
}
}
}
for (name, value) in headers {
if firstHost, name.lowercased() == "host" {
firstHost = false
authority = value
continue
}
if let fieldName = HTTPField.Name(name) {
if self[fieldName] != nil { continue }
self.append(HTTPField(name: fieldName, value: value))
}
}
Expand Down