[Runtime] Integrate the new URI and String coders (#45)

[Runtime] Integrate the new URI and String coders ### Motivation See details in the generator PR on motivation (apple/swift-openapi-generator#226). ### Modifications - Deprecated `_AutoLosslessStringConvertible` and `_StringConvertible` 🎉 - Deprecated all `*Text` helper functions on `Converter`, it was a convoluted mix of `URI` and `String`, so they all need to go away. - Added `*URI` and `*String` helper functions for the appropriate parameters/bodies. Those use the new URI/String coders under the hood. - Note: we now manipulate the `Request.query` property more directly, instead of going through `URLQueryItem`. ### Result Now we fully rely on `Codable` and a combination of system and custom encoder/decoders, which allows us to much more easily support Foundation types (such as Date), generated types (such as string enums), and primitive types - all the same way. While this might not be fully evident in this PR, this refactoring actually makes it possible for us to support much more of the OpenAPI specification. ### Test Plan Deprecated tests of the `*Text` helpers, introduced new tests for the new helpers. Reviewed by: glbrntt Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (api breakage) - Build finished. ✔︎ pull request validation (docc test) - Build finished. ✔︎ pull request validation (integration test) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #45
apple · Aug 30, 2023 · 9d76a1d · 9d76a1d
1 parent 0769bd0
commit 9d76a1d
Show file tree

Hide file tree

Showing 16 changed files with 2,128 additions and 949 deletions.
diff --git a/Sources/OpenAPIRuntime/Conversion/Converter+Client.swift b/Sources/OpenAPIRuntime/Conversion/Converter+Client.swift
@@ -31,98 +31,61 @@ extension Converter {
         )
     }
 
-    //    | client | set | request path | text | string-convertible | required | renderedRequestPath |
-    public func renderedRequestPath(
+    //    | client | set | request path | URI | required | renderedPath |
+    public func renderedPath(
         template: String,
-        parameters: [any _StringConvertible]
+        parameters: [any Encodable]
     ) throws -> String {
         var renderedString = template
+        let encoder = URIEncoder(
+            configuration: .init(
+                style: .simple,
+                explode: false,
+                spaceEscapingCharacter: .percentEncoded,
+                dateTranscoder: configuration.dateTranscoder
+            )
+        )
         for parameter in parameters {
+            let value = try encoder.encode(parameter, forKey: "")
             if let range = renderedString.range(of: "{}") {
                 renderedString = renderedString.replacingOccurrences(
                     of: "{}",
-                    with: parameter.description,
+                    with: value,
                     range: range
                 )
             }
         }
         return renderedString
     }
 
-    //    | client | set | request query | text | string-convertible | both | setQueryItemAsText |
-    public func setQueryItemAsText<T: _StringConvertible>(
+    //    | client | set | request query | URI | both | setQueryItemAsURI |
+    public func setQueryItemAsURI<T: Encodable>(
         in request: inout Request,
         style: ParameterStyle?,
         explode: Bool?,
         name: String,
         value: T?
     ) throws {
-        try setQueryItem(
+        try setEscapedQueryItem(
             in: &request,
             style: style,
             explode: explode,
             name: name,
             value: value,
-            convert: convertStringConvertibleToText
-        )
-    }
-
-    //    | client | set | request query | text | array of string-convertibles | both | setQueryItemAsText |
-    public func setQueryItemAsText<T: _StringConvertible>(
-        in request: inout Request,
-        style: ParameterStyle?,
-        explode: Bool?,
-        name: String,
-        value: [T]?
-    ) throws {
-        try setQueryItems(
-            in: &request,
-            style: style,
-            explode: explode,
-            name: name,
-            values: value,
-            convert: convertStringConvertibleToText
-        )
-    }
-
-    //    | client | set | request query | text | date | both | setQueryItemAsText |
-    public func setQueryItemAsText(
-        in request: inout Request,
-        style: ParameterStyle?,
-        explode: Bool?,
-        name: String,
-        value: Date?
-    ) throws {
-        try setQueryItem(
-            in: &request,
-            style: style,
-            explode: explode,
-            name: name,
-            value: value,
-            convert: convertDateToText
-        )
-    }
-
-    //    | client | set | request query | text | array of dates | both | setQueryItemAsText |
-    public func setQueryItemAsText(
-        in request: inout Request,
-        style: ParameterStyle?,
-        explode: Bool?,
-        name: String,
-        value: [Date]?
-    ) throws {
-        try setQueryItems(
-            in: &request,
-            style: style,
-            explode: explode,
-            name: name,
-            values: value,
-            convert: convertDateToText
+            convert: { value, style, explode in
+                try convertToURI(
+                    style: style,
+                    explode: explode,
+                    inBody: false,
+                    key: name,
+                    value: value
+                )
+            }
         )
     }
 
-    //    | client | set | request body | text | string-convertible | optional | setOptionalRequestBodyAsText |
-    public func setOptionalRequestBodyAsText<T: _StringConvertible>(
+    //    | client | set | request body | string | optional | setOptionalRequestBodyAsString |
+    public func setOptionalRequestBodyAsString<T: Encodable>(
         _ value: T?,
         headerFields: inout [HeaderField],
         contentType: String
@@ -131,12 +94,12 @@ extension Converter {
             value,
             headerFields: &headerFields,
             contentType: contentType,
-            convert: convertStringConvertibleToTextData
+            convert: convertToStringData
         )
     }
 
-    //    | client | set | request body | text | string-convertible | required | setRequiredRequestBodyAsText |
-    public func setRequiredRequestBodyAsText<T: _StringConvertible>(
+    //    | client | set | request body | string | required | setRequiredRequestBodyAsString |
+    public func setRequiredRequestBodyAsString<T: Encodable>(
         _ value: T,
         headerFields: inout [HeaderField],
         contentType: String
@@ -145,39 +108,11 @@ extension Converter {
             value,
             headerFields: &headerFields,
             contentType: contentType,
-            convert: convertStringConvertibleToTextData
-        )
-    }
-
-    //    | client | set | request body | text | date | optional | setOptionalRequestBodyAsText |
-    public func setOptionalRequestBodyAsText(
-        _ value: Date?,
-        headerFields: inout [HeaderField],
-        contentType: String
-    ) throws -> Data? {
-        try setOptionalRequestBody(
-            value,
-            headerFields: &headerFields,
-            contentType: contentType,
-            convert: convertDateToTextData
+            convert: convertToStringData
         )
     }
 
-    //    | client | set | request body | text | date | required | setRequiredRequestBodyAsText |
-    public func setRequiredRequestBodyAsText(
-        _ value: Date,
-        headerFields: inout [HeaderField],
-        contentType: String
-    ) throws -> Data {
-        try setRequiredRequestBody(
-            value,
-            headerFields: &headerFields,
-            contentType: contentType,
-            convert: convertDateToTextData
-        )
-    }
-
-    //    | client | set | request body | JSON | codable | optional | setOptionalRequestBodyAsJSON |
+    //    | client | set | request body | JSON | optional | setOptionalRequestBodyAsJSON |
     public func setOptionalRequestBodyAsJSON<T: Encodable>(
         _ value: T?,
         headerFields: inout [HeaderField],
@@ -191,7 +126,7 @@ extension Converter {
         )
     }
 
-    //    | client | set | request body | JSON | codable | required | setRequiredRequestBodyAsJSON |
+    //    | client | set | request body | JSON | required | setRequiredRequestBodyAsJSON |
     public func setRequiredRequestBodyAsJSON<T: Encodable>(
         _ value: T,
         headerFields: inout [HeaderField],
@@ -205,7 +140,7 @@ extension Converter {
         )
     }
 
-    //    | client | set | request body | binary | data | optional | setOptionalRequestBodyAsBinary |
+    //    | client | set | request body | binary | optional | setOptionalRequestBodyAsBinary |
     public func setOptionalRequestBodyAsBinary(
         _ value: Data?,
         headerFields: inout [HeaderField],
@@ -219,7 +154,7 @@ extension Converter {
         )
     }
 
-    //    | client | set | request body | binary | data | required | setRequiredRequestBodyAsBinary |
+    //    | client | set | request body | binary | required | setRequiredRequestBodyAsBinary |
     public func setRequiredRequestBodyAsBinary(
         _ value: Data,
         headerFields: inout [HeaderField],
@@ -233,8 +168,8 @@ extension Converter {
         )
     }
 
-    //    | client | get | response body | text | string-convertible | required | getResponseBodyAsText |
-    public func getResponseBodyAsText<T: _StringConvertible, C>(
+    //    | client | get | response body | string | required | getResponseBodyAsString |
+    public func getResponseBodyAsString<T: Decodable, C>(
         _ type: T.Type,
         from data: Data,
         transforming transform: (T) -> C
@@ -243,25 +178,11 @@ extension Converter {
             type,
             from: data,
             transforming: transform,
-            convert: convertTextDataToStringConvertible
-        )
-    }
-
-    //    | client | get | response body | text | date | required | getResponseBodyAsText |
-    public func getResponseBodyAsText<C>(
-        _ type: Date.Type,
-        from data: Data,
-        transforming transform: (Date) -> C
-    ) throws -> C {
-        try getResponseBody(
-            type,
-            from: data,
-            transforming: transform,
-            convert: convertTextDataToDate
+            convert: convertFromStringData
         )
     }
 
-    //    | client | get | response body | JSON | codable | required | getResponseBodyAsJSON |
+    //    | client | get | response body | JSON | required | getResponseBodyAsJSON |
     public func getResponseBodyAsJSON<T: Decodable, C>(
         _ type: T.Type,
         from data: Data,
@@ -271,11 +192,11 @@ extension Converter {
             type,
             from: data,
             transforming: transform,
-            convert: convertJSONToCodable
+            convert: convertJSONToBodyCodable
         )
     }
 
-    //    | client | get | response body | binary | data | required | getResponseBodyAsBinary |
+    //    | client | get | response body | binary | required | getResponseBodyAsBinary |
     public func getResponseBodyAsBinary<C>(
         _ type: Data.Type,
         from data: Data,