-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update http requests, responses and endpoint with URI (#719)
* chore: update http requests, responses and endpoint with uri * feat: add validations and builder to URI * Remove `try`, update `uri.query` to `uri.queryItems` and add `destination` to `RequestMessage` * Update `URI.query` to `URI.queryItems` * Refactor URI and add docs * Set `SdkHttpRequest.destination` to `let` * Update `URIBuilder` to always return a percent encoded path in `URI` * Update `URIBuilder` to add port to URLComponents and to be able to clear queryItems * Update port to be nullable in SdkHttpRequest and Endpoint * Add URITests * Remove `try` * Update query item related vars to func * Add fragment * Address swiftlint warnings in PR * Add more URI tests * Add isPercentEncoded check to username, password and host in URI * Set urlComponents.percentEncodedHost if os is not linux * Add URITests test cases with encoded and unencoded reserved characters * Address swiftlint warnings
- Loading branch information
1 parent
0599776
commit 16eb445
Showing
21 changed files
with
629 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,274 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0. | ||
| */ | ||
|
|
||
| import Foundation | ||
|
|
||
| /// A representation of the RFC 3986 Uniform Resource Identifier | ||
| /// Note: URIBuilder returns an URI instance with all components percent encoded | ||
| public struct URI: Hashable { | ||
| public let scheme: Scheme | ||
| public let path: String | ||
| public let host: String | ||
| public let port: Int16? | ||
| public var defaultPort: Int16 { | ||
| Int16(scheme.port) | ||
| } | ||
| public let queryItems: [SDKURLQueryItem] | ||
| public let username: String? | ||
| public let password: String? | ||
| public let fragment: String? | ||
| public var url: URL? { | ||
| self.toBuilder().getUrl() | ||
| } | ||
| public var queryString: String? { | ||
| self.queryItems.queryString | ||
| } | ||
|
|
||
| fileprivate init(scheme: Scheme, | ||
| path: String, | ||
| host: String, | ||
| port: Int16?, | ||
| queryItems: [SDKURLQueryItem], | ||
| username: String? = nil, | ||
| password: String? = nil, | ||
| fragment: String? = nil) { | ||
| self.scheme = scheme | ||
| self.path = path | ||
| self.host = host | ||
| self.port = port | ||
| self.queryItems = queryItems | ||
| self.username = username | ||
| self.password = password | ||
| self.fragment = fragment | ||
| } | ||
|
|
||
| public func toBuilder() -> URIBuilder { | ||
| return URIBuilder() | ||
| .withScheme(self.scheme) | ||
| .withPath(self.path) | ||
| .withHost(self.host) | ||
| .withPort(self.port) | ||
| .withQueryItems(self.queryItems) | ||
| .withUsername(self.username) | ||
| .withPassword(self.password) | ||
| .withFragment(self.fragment) | ||
| } | ||
| } | ||
|
|
||
| /// A builder class for URI | ||
| /// The builder performs validation to conform with RFC 3986 | ||
| /// Note: URIBuilder returns an URI instance with all components percent encoded | ||
| public final class URIBuilder { | ||
| var urlComponents: URLComponents | ||
|
|
||
| public init() { | ||
| self.urlComponents = URLComponents() | ||
| self.urlComponents.percentEncodedPath = "/" | ||
| self.urlComponents.scheme = Scheme.https.rawValue | ||
| self.urlComponents.host = "" | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withScheme(_ value: Scheme) -> URIBuilder { | ||
| self.urlComponents.scheme = value.rawValue | ||
| return self | ||
| } | ||
|
|
||
| /// According to https://developer.apple.com/documentation/foundation/nsurlcomponents/1408161-percentencodedpath | ||
| /// "Although an unencoded semicolon is a valid character in a percent-encoded path, | ||
| /// for compatibility with the NSURL class, you should always percent-encode it." | ||
| /// | ||
| /// URI also always return a percent-encoded path. | ||
| /// If an percent-encoded path is provided, we will replace the semicolon with %3B in the path. | ||
| /// If an unencoded path is provided, we should percent-encode the path including semicolon. | ||
| @discardableResult | ||
| public func withPath(_ value: String) -> URIBuilder { | ||
| if value.isPercentEncoded { | ||
| if value.contains(";") { | ||
| let encodedPath = value.replacingOccurrences( | ||
| of: ";", with: "%3B", options: NSString.CompareOptions.literal, range: nil) | ||
| self.urlComponents.percentEncodedPath = encodedPath | ||
| } else { | ||
| self.urlComponents.percentEncodedPath = value | ||
| } | ||
| } else { | ||
| if value.contains(";") { | ||
| self.urlComponents.percentEncodedPath = value.percentEncodePathIncludingSemicolon() | ||
| } else { | ||
| self.urlComponents.path = value | ||
| } | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withHost(_ value: String) -> URIBuilder { | ||
| if value.isPercentEncoded { | ||
| // URLComponents.percentEncodedHost follows RFC 3986 | ||
| // and returns a decoded value if it is set with a percent encoded value | ||
| // However on Linux platform, it returns a percent encoded value. | ||
| // To ensure consistent behaviour, we will decode it ourselves on Linux platform | ||
| if currentOS == .linux { | ||
| self.urlComponents.host = value.removingPercentEncoding! | ||
| } else { | ||
| self.urlComponents.percentEncodedHost = value | ||
| } | ||
| } else { | ||
| self.urlComponents.host = value | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withPort(_ value: Int16?) -> URIBuilder { | ||
| self.urlComponents.port = value.map { Int($0) } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withPort(_ value: Int?) -> URIBuilder { | ||
| self.urlComponents.port = value | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withQueryItems(_ value: [SDKURLQueryItem]) -> URIBuilder { | ||
| if value.isEmpty { | ||
| return self | ||
| } | ||
| if value.containsPercentEncode() { | ||
| self.urlComponents.percentEncodedQueryItems = value.toURLQueryItems() | ||
| } else { | ||
| self.urlComponents.queryItems = value.toURLQueryItems() | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func appendQueryItems(_ items: [SDKURLQueryItem]) -> URIBuilder { | ||
| guard !items.isEmpty else { | ||
| return self | ||
| } | ||
| var queryItems = self.urlComponents.percentEncodedQueryItems ?? [] | ||
| queryItems += items.toURLQueryItems() | ||
|
|
||
| if queryItems.containsPercentEncode() { | ||
| self.urlComponents.percentEncodedQueryItems = queryItems | ||
| } else { | ||
| self.urlComponents.queryItems = queryItems | ||
| } | ||
|
|
||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func appendQueryItem(_ item: SDKURLQueryItem) -> URIBuilder { | ||
| self.appendQueryItems([item]) | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withUsername(_ value: String?) -> URIBuilder { | ||
| if let username = value { | ||
| if username.isPercentEncoded { | ||
| self.urlComponents.percentEncodedUser = username | ||
| } else { | ||
| self.urlComponents.user = username | ||
| } | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withPassword(_ value: String?) -> URIBuilder { | ||
| if let password = value { | ||
| if password.isPercentEncoded { | ||
| self.urlComponents.percentEncodedPassword = password | ||
| } else { | ||
| self.urlComponents.password = password | ||
| } | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func withFragment(_ value: String?) -> URIBuilder { | ||
| if let fragment = value { | ||
| if fragment.isPercentEncoded { | ||
| self.urlComponents.percentEncodedFragment = fragment | ||
| } else { | ||
| self.urlComponents.fragment = fragment | ||
| } | ||
| } | ||
| return self | ||
| } | ||
|
|
||
| public func build() -> URI { | ||
| return URI(scheme: Scheme(rawValue: self.urlComponents.scheme!)!, | ||
| path: self.urlComponents.percentEncodedPath, | ||
| host: self.urlComponents.percentEncodedHost!, | ||
| port: self.urlComponents.port.map { Int16($0) }, | ||
| queryItems: self.urlComponents.percentEncodedQueryItems?.map { | ||
| SDKURLQueryItem(name: $0.name, value: $0.value) | ||
| } ?? [], | ||
| username: self.urlComponents.percentEncodedUser, | ||
| password: self.urlComponents.percentEncodedPassword, | ||
| fragment: self.urlComponents.percentEncodedFragment) | ||
| } | ||
|
|
||
| // We still have to keep 'url' as an optional, since we're | ||
| // dealing with dynamic components that could be invalid. | ||
| fileprivate func getUrl() -> URL? { | ||
| let isInvalidHost = self.urlComponents.host?.isEmpty ?? false | ||
| return isInvalidHost && self.urlComponents.path.isEmpty ? nil : self.urlComponents.url | ||
| } | ||
| } | ||
|
|
||
| extension String { | ||
| var isPercentEncoded: Bool { | ||
| let decoded = self.removingPercentEncoding | ||
| return decoded != nil && decoded != self | ||
| } | ||
|
|
||
| public func percentEncodePathIncludingSemicolon() -> String { | ||
| let allowed = | ||
| // swiftlint:disable force_cast | ||
| (CharacterSet.urlPathAllowed as NSCharacterSet).mutableCopy() as! NSMutableCharacterSet | ||
| // swiftlint:enable force_cast | ||
| allowed.removeCharacters(in: ";") | ||
| return self.addingPercentEncoding(withAllowedCharacters: allowed as CharacterSet)! | ||
| } | ||
|
|
||
| public func percentEncodeQuery() -> String { | ||
| return self.addingPercentEncoding(withAllowedCharacters: CharacterSet.urlQueryAllowed as CharacterSet)! | ||
| } | ||
| } | ||
|
|
||
| extension Array where Element == SDKURLQueryItem { | ||
| public var queryString: String? { | ||
| if self.isEmpty { | ||
| return nil | ||
| } | ||
| return self.map { [$0.name, $0.value].compactMap { $0 }.joined(separator: "=") }.joined(separator: "&") | ||
| } | ||
|
|
||
| public func toURLQueryItems() -> [URLQueryItem] { | ||
| return self.map { URLQueryItem(name: $0.name, value: $0.value) } | ||
| } | ||
|
|
||
| public func containsPercentEncode() -> Bool { | ||
| return self.contains { item in | ||
| return item.name.isPercentEncoded || (item.value?.isPercentEncoded ?? false) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension Array where Element == URLQueryItem { | ||
| public func containsPercentEncode() -> Bool { | ||
| return self.contains { item in | ||
| return item.name.isPercentEncoded || (item.value?.isPercentEncoded ?? false) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.