[Generator] Add headerFields and body to UndocumentedPayload (#488)

czechboy0 · web-flow · commit cd88cbe95c76 · 2023-12-15T05:20:01.000-08:00
### Motivation Fixes #299. ~Depends on apple/swift-openapi-runtime#90 landing first and getting released, and the version dependency being bumped here.~ Runtime dependency bumped to 1.1.0. ### Modifications Adapted to the runtime changes, added `headerFields` and `body` properties to `UndocumentedPayload`. Now, the generated code actually also forwards the values to it. ### Result Easier access to the raw response data if an undocumented response is returned. ### Test Plan Adapted snippet and file-based reference tests, and also the unit tests of the generated code (PetstoreConsumerTests).
diff --git a/Package.swift b/Package.swift
@@ -60,7 +60,7 @@ let package = Package(
         // Tests-only: Runtime library linked by generated code, and also
         // helps keep the runtime library new enough to work with the generated
         // code.
-        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.1.0"),
         .package(url: "https://github.com/apple/swift-http-types", from: "1.0.2"),
 
         // Build and preview docs
diff --git a/Sources/_OpenAPIGeneratorCore/Translator/ClientTranslator/translateClientMethod.swift b/Sources/_OpenAPIGeneratorCore/Translator/ClientTranslator/translateClientMethod.swift
@@ -112,7 +112,17 @@ extension ClientFileTranslator {
                         .init(
                             label: "statusCode",
                             expression: .identifierPattern("response").dot("status").dot("code")
-                        ), .init(label: nil, expression: .dot("init").call([])),
+                        ),
+                        .init(
+                            label: nil,
+                            expression: .dot("init")
+                                .call([
+                                    .init(
+                                        label: "headerFields",
+                                        expression: .identifierPattern("response").dot("headerFields")
+                                    ), .init(label: "body", expression: .identifierPattern("responseBody")),
+                                ])
+                        ),
                     ])
             )
             cases.append(.init(kind: .default, body: [.expression(undocumentedExpr)]))
diff --git a/Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Client.swift b/Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Client.swift
@@ -274,7 +274,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -316,7 +319,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -389,7 +395,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -441,7 +450,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -472,7 +484,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -544,7 +559,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -656,7 +674,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -787,7 +808,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
@@ -891,7 +915,10 @@ public struct Client: APIProtocol {
                 default:
                     return .undocumented(
                         statusCode: response.status.code,
-                        .init()
+                        .init(
+                            headerFields: response.headerFields,
+                            body: responseBody
+                        )
                     )
                 }
             }
diff --git a/Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift b/Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift
@@ -4492,7 +4492,10 @@ final class SnippetBasedReferenceTests: XCTestCase {
                     default:
                         return .undocumented(
                             statusCode: response.status.code,
-                            .init()
+                            .init(
+                                headerFields: response.headerFields,
+                                body: responseBody
+                            )
                         )
                     }
                 }
@@ -4675,7 +4678,10 @@ final class SnippetBasedReferenceTests: XCTestCase {
                     default:
                         return .undocumented(
                             statusCode: response.status.code,
-                            .init()
+                            .init(
+                                headerFields: response.headerFields,
+                                body: responseBody
+                            )
                         )
                     }
                 }
diff --git a/Tests/PetstoreConsumerTests/Test_Client.swift b/Tests/PetstoreConsumerTests/Test_Client.swift
@@ -613,13 +613,16 @@ final class Test_Client: XCTestCase {
     }
 
     func testProbe_undocumented() async throws {
-        transport = .init { request, requestBody, baseURL, operationID in (.init(status: .serviceUnavailable), nil) }
+        transport = .init { request, requestBody, baseURL, operationID in (.init(status: .serviceUnavailable), "oh no")
+        }
         let response = try await client.probe(.init())
-        guard case let .undocumented(statusCode, _) = response else {
+        guard case let .undocumented(statusCode, payload) = response else {
             XCTFail("Unexpected response: \(response)")
             return
         }
         XCTAssertEqual(statusCode, 503)
+        XCTAssertEqual(payload.headerFields, [:])
+        try await XCTAssertEqualStringifiedData(payload.body, "oh no")
     }
 
     func testUploadAvatarForPet_200() async throws {

Original file line number	Diff line number	Diff line change
`@@ -274,7 +274,10 @@ public struct Client: APIProtocol {`
`274`	`274`	`default:`
`275`	`275`	`return .undocumented(`
`276`	`276`	`statusCode: response.status.code,`
`277`		`- .init()`
	`277`	`+ .init(`
	`278`	`+ headerFields: response.headerFields,`
	`279`	`+ body: responseBody`
	`280`	`+ )`
`278`	`281`	`)`
`279`	`282`	`}`
`280`	`283`	`}`
`@@ -316,7 +319,10 @@ public struct Client: APIProtocol {`
`316`	`319`	`default:`
`317`	`320`	`return .undocumented(`
`318`	`321`	`statusCode: response.status.code,`
`319`		`- .init()`
	`322`	`+ .init(`
	`323`	`+ headerFields: response.headerFields,`
	`324`	`+ body: responseBody`
	`325`	`+ )`
`320`	`326`	`)`
`321`	`327`	`}`
`322`	`328`	`}`
`@@ -389,7 +395,10 @@ public struct Client: APIProtocol {`
`389`	`395`	`default:`
`390`	`396`	`return .undocumented(`
`391`	`397`	`statusCode: response.status.code,`
`392`		`- .init()`
	`398`	`+ .init(`
	`399`	`+ headerFields: response.headerFields,`
	`400`	`+ body: responseBody`
	`401`	`+ )`
`393`	`402`	`)`
`394`	`403`	`}`
`395`	`404`	`}`
`@@ -441,7 +450,10 @@ public struct Client: APIProtocol {`
`441`	`450`	`default:`
`442`	`451`	`return .undocumented(`
`443`	`452`	`statusCode: response.status.code,`
`444`		`- .init()`
	`453`	`+ .init(`
	`454`	`+ headerFields: response.headerFields,`
	`455`	`+ body: responseBody`
	`456`	`+ )`
`445`	`457`	`)`
`446`	`458`	`}`
`447`	`459`	`}`
`@@ -472,7 +484,10 @@ public struct Client: APIProtocol {`
`472`	`484`	`default:`
`473`	`485`	`return .undocumented(`
`474`	`486`	`statusCode: response.status.code,`
`475`		`- .init()`
	`487`	`+ .init(`
	`488`	`+ headerFields: response.headerFields,`
	`489`	`+ body: responseBody`
	`490`	`+ )`
`476`	`491`	`)`
`477`	`492`	`}`
`478`	`493`	`}`
`@@ -544,7 +559,10 @@ public struct Client: APIProtocol {`
`544`	`559`	`default:`
`545`	`560`	`return .undocumented(`
`546`	`561`	`statusCode: response.status.code,`
`547`		`- .init()`
	`562`	`+ .init(`
	`563`	`+ headerFields: response.headerFields,`
	`564`	`+ body: responseBody`
	`565`	`+ )`
`548`	`566`	`)`
`549`	`567`	`}`
`550`	`568`	`}`
`@@ -656,7 +674,10 @@ public struct Client: APIProtocol {`
`656`	`674`	`default:`
`657`	`675`	`return .undocumented(`
`658`	`676`	`statusCode: response.status.code,`
`659`		`- .init()`
	`677`	`+ .init(`
	`678`	`+ headerFields: response.headerFields,`
	`679`	`+ body: responseBody`
	`680`	`+ )`
`660`	`681`	`)`
`661`	`682`	`}`
`662`	`683`	`}`
`@@ -787,7 +808,10 @@ public struct Client: APIProtocol {`
`787`	`808`	`default:`
`788`	`809`	`return .undocumented(`
`789`	`810`	`statusCode: response.status.code,`
`790`		`- .init()`
	`811`	`+ .init(`
	`812`	`+ headerFields: response.headerFields,`
	`813`	`+ body: responseBody`
	`814`	`+ )`
`791`	`815`	`)`
`792`	`816`	`}`
`793`	`817`	`}`
`@@ -891,7 +915,10 @@ public struct Client: APIProtocol {`
`891`	`915`	`default:`
`892`	`916`	`return .undocumented(`
`893`	`917`	`statusCode: response.status.code,`
`894`		`- .init()`
	`918`	`+ .init(`
	`919`	`+ headerFields: response.headerFields,`
	`920`	`+ body: responseBody`
	`921`	`+ )`
`895`	`922`	`)`
`896`	`923`	`}`
`897`	`924`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4492,7 +4492,10 @@ final class SnippetBasedReferenceTests: XCTestCase {`
`4492`	`4492`	`default:`
`4493`	`4493`	`return .undocumented(`
`4494`	`4494`	`statusCode: response.status.code,`
`4495`		`- .init()`
	`4495`	`+ .init(`
	`4496`	`+ headerFields: response.headerFields,`
	`4497`	`+ body: responseBody`
	`4498`	`+ )`
`4496`	`4499`	`)`
`4497`	`4500`	`}`
`4498`	`4501`	`}`
`@@ -4675,7 +4678,10 @@ final class SnippetBasedReferenceTests: XCTestCase {`
`4675`	`4678`	`default:`
`4676`	`4679`	`return .undocumented(`
`4677`	`4680`	`statusCode: response.status.code,`
`4678`		`- .init()`
	`4681`	`+ .init(`
	`4682`	`+ headerFields: response.headerFields,`
	`4683`	`+ body: responseBody`
	`4684`	`+ )`
`4679`	`4685`	`)`
`4680`	`4686`	`}`
`4681`	`4687`	`}`
Original file line number	Diff line number	Diff line change
`@@ -613,13 +613,16 @@ final class Test_Client: XCTestCase {`
`613`	`613`	`}`
`614`	`614`
`615`	`615`	`func testProbe_undocumented() async throws {`
`616`		`- transport = .init { request, requestBody, baseURL, operationID in (.init(status: .serviceUnavailable), nil) }`
	`616`	`+ transport = .init { request, requestBody, baseURL, operationID in (.init(status: .serviceUnavailable), "oh no")`
	`617`	`+ }`
`617`	`618`	`let response = try await client.probe(.init())`
`618`		`- guard case let .undocumented(statusCode, _) = response else {`
	`619`	`+ guard case let .undocumented(statusCode, payload) = response else {`
`619`	`620`	`XCTFail("Unexpected response: \(response)")`
`620`	`621`	`return`
`621`	`622`	`}`
`622`	`623`	`XCTAssertEqual(statusCode, 503)`
	`624`	`+ XCTAssertEqual(payload.headerFields, [:])`
	`625`	`+ try await XCTAssertEqualStringifiedData(payload.body, "oh no")`
`623`	`626`	`}`
`624`	`627`
`625`	`628`	`func testUploadAvatarForPet_200() async throws {`