Fix double encoding of path parameters (#15)

czecy0 · web-flow · commit 7e40bff52db9 · 2023-09-07T14:53:14.000+02:00
Fix double encoding of path parameters ### Motivation Fixes apple/swift-openapi-generator#251. ### Modifications Use the already escaped path setter on `URLComponents` to avoid the second encoding pass. ### Result Path parameters that needed escaping are only escaped once, not twice. ### Test Plan Adapted the existing unit test to cover a path item that needs escaping. Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #15
diff --git a/Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift b/Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift
@@ -161,7 +161,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {
         guard var baseUrlComponents = URLComponents(string: baseURL.absoluteString) else {
             throw Error.invalidRequestURL(request: request, baseURL: baseURL)
         }
-        baseUrlComponents.path += request.path
+        baseUrlComponents.percentEncodedPath += request.path
         baseUrlComponents.percentEncodedQuery = request.query
         guard let url = baseUrlComponents.url else {
             throw Error.invalidRequestURL(request: request, baseURL: baseURL)
diff --git a/Tests/OpenAPIAsyncHTTPClientTests/Test_AsyncHTTPClientTransport.swift b/Tests/OpenAPIAsyncHTTPClientTests/Test_AsyncHTTPClientTransport.swift
@@ -38,7 +38,7 @@ class Test_AsyncHTTPClientTransport: XCTestCase {
 
     func testConvertRequest() throws {
         let request: OpenAPIRuntime.Request = .init(
-            path: "/hello/Maria",
+            path: "/hello%20world/Maria",
             query: "greeting=Howdy",
             method: .post,
             headerFields: [
@@ -50,7 +50,7 @@ class Test_AsyncHTTPClientTransport: XCTestCase {
             request,
             baseURL: try XCTUnwrap(URL(string: "http://example.com/api/v1"))
         )
-        XCTAssertEqual(httpRequest.url, "http://example.com/api/v1/hello/Maria?greeting=Howdy")
+        XCTAssertEqual(httpRequest.url, "http://example.com/api/v1/hello%20world/Maria?greeting=Howdy")
         XCTAssertEqual(httpRequest.method, .POST)
         XCTAssertEqual(
             httpRequest.headers,

Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {`
`161`	`161`	`guard var baseUrlComponents = URLComponents(string: baseURL.absoluteString) else {`
`162`	`162`	`throw Error.invalidRequestURL(request: request, baseURL: baseURL)`
`163`	`163`	`}`
`164`		`-baseUrlComponents.path += request.path`
	`164`	`+baseUrlComponents.percentEncodedPath += request.path`
`165`	`165`	`baseUrlComponents.percentEncodedQuery = request.query`
`166`	`166`	`guard let url = baseUrlComponents.url else {`
`167`	`167`	`throw Error.invalidRequestURL(request: request, baseURL: baseURL)`