Update swift-format version to 5.9

[takeshi-1000]

It seems that the following source code of Petstore was not properly formatted.

swift-openapi-generator/Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Server.swift

Line 86 in d22ddfe

deserializer: { request, metadata in let path: Operations.listPets.Input.Path = .init()

The source code inside swift-openapi-generator seems fine and I've confirmed that if I raise the swift-format version to the current commit revision, it's formatted properly. There seems to be no release version currently available on the swift-format side, so I open this issue.

If you want to check, change the code as below,

--- a/Package.swift
+++ b/Package.swift
@@ -52,7 +52,7 @@ let package = Package(
         // Format Swift code
         .package(
             url: "https://github.com/apple/swift-format.git",
-            from: "508.0.1"
+            revision: "8337523533bbd153cdac74c8fff4a1ac79a0b805"
         ),
 
         // General algorithms

and when you build it, an error will occur due to the change in the swift-format interface. (around here)

/path/to/swift-openapi-generator/Sources/_OpenAPIGeneratorCore/Extensions/SwiftFormat.swift:44:100: error: value of type 'SourceLocation' has no member 'debugDescription'
                    Formatting the following code produced diagnostic at location \(sourceLocation.debugDescription) (see end):

If you change the above code appropriately so that the build passes, and run the test, the output will be as follows.

diff --git a/ReferenceSources/Petstore/Server.swift b/var/folders/nn/80g9wmmd37lc63c9wqtnspj40000gp/T/5705E10F-715B-4E33-8295-2090E9E2FA85/Server.swift
index cd60e0c..fc5d004 100644
--- a/ReferenceSources/Petstore/Server.swift
+++ b/var/folders/nn/80g9wmmd37lc63c9wqtnspj40000gp/T/5705E10F-715B-4E33-8295-2090E9E2FA85/Server.swift
@@ -81,11 +81,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.listPets.id,
             using: { APIHandler.listPets($0) },
-            deserializer: { request, metadata in let path: Operations.listPets.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.listPets.Input.Path = .init()
                 let query: Operations.listPets.Input.Query = .init(
                     limit: try converter.getOptionalQueryItemAsText(
                         in: metadata.queryParameters,
                         name: "limit",
                         as: Swift.Int32.self
@@ -180,11 +181,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.createPet.id,
             using: { APIHandler.createPet($0) },
-            deserializer: { request, metadata in let path: Operations.createPet.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.createPet.Input.Path = .init()
                 let query: Operations.createPet.Input.Query = .init()
                 let headers: Operations.createPet.Input.Headers = .init(
                     X_Extra_Arguments: try converter.getOptionalHeaderFieldAsJSON(
                         in: request.headerFields,
                         name: "X-Extra-Arguments",
@@ -273,11 +275,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.getStats.id,
             using: { APIHandler.getStats($0) },
-            deserializer: { request, metadata in let path: Operations.getStats.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.getStats.Input.Path = .init()
                 let query: Operations.getStats.Input.Query = .init()
                 let headers: Operations.getStats.Input.Headers = .init()
                 let cookies: Operations.getStats.Input.Cookies = .init()
                 return Operations.getStats.Input(
                     path: path,
@@ -317,11 +320,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.postStats.id,
             using: { APIHandler.postStats($0) },
-            deserializer: { request, metadata in let path: Operations.postStats.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.postStats.Input.Path = .init()
                 let query: Operations.postStats.Input.Query = .init()
                 let headers: Operations.postStats.Input.Headers = .init()
                 let cookies: Operations.postStats.Input.Cookies = .init()
                 let contentType = converter.extractContentTypeIfPresent(in: request.headerFields)
                 let body: Operations.postStats.Input.Body
@@ -367,11 +371,12 @@ fileprivate exte
nsion UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.probe.id,
             using: { APIHandler.probe($0) },
-            deserializer: { request, metadata in let path: Operations.probe.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.probe.Input.Path = .init()
                 let query: Operations.probe.Input.Query = .init()
                 let headers: Operations.probe.Input.Headers = .init()
                 let cookies: Operations.probe.Input.Cookies = .init()
                 return Operations.probe.Input(
                     path: path,

diff --git a/ReferenceSources/Petstore_FF_MultipleContentTypes/Server.swift b/var/folders/nn/80g9wmmd37lc63c9wqtnspj40000gp/T/38A9C041-0D2B-4E2C-B842-F2A186367B2F/Server.swift
index 1a3753f..ffc0365 100644
--- a/ReferenceSources/Petstore_FF_MultipleContentTypes/Server.swift
+++ b/var/folders/nn/80g9wmmd37lc63c9wqtnspj40000gp/T/38A9C041-0D2B-4E2C-B842-F2A186367B2F/Server.swift
@@ -81,11 +81,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.listPets.id,
             using: { APIHandler.listPets($0) },
-            deserializer: { request, metadata in let path: Operations.listPets.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.listPets.Input.Path = .init()
                 let query: Operations.listPets.Input.Query = .init(
                     limit: try converter.getOptionalQueryItemAsText(
                         in: metadata.queryParameters,
                         name: "limit",
                         as: Swift.Int32.self
@@ -180,11 +181,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.createPet.id,
             using: { APIHandler.createPet($0) },
-            deserializer: { request, metadata in let path: Operations.createPet.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.createPet.Input.Path = .init()
                 let query: Operations.createPet.Input.Query = .init()
                 let headers: Operations.createPet.Input.Headers = .init(
                     X_Extra_Arguments: try converter.getOptionalHeaderFieldAsJSON(
                         in: request.headerFields,
                         name: "X-Extra-Arguments",
@@ -273,11 +275,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.getStats.id,
             using: { APIHandler.getStats($0) },
-            deserializer: { request, metadata in let path: Operations.getStats.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.getStats.Input.Path = .init()
                 let query: Operations.getStats.Input.Query = .init()
                 let headers: Operations.getStats.Input.Headers = .init()
                 let cookies: Operations.getStats.Input.Cookies = .init()
                 return Operations.getStats.Input(
                     path: path,
@@ -337,11 +340,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.postStats.id,
             using: { APIHandler.postStats($0) },
-            deserializer: { request, metadata in let path: Operations.postStats.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.postStats.Input.Path = .init()
                 let query: Operations.postStats.Input.Query = .init()
                 let headers: Operations.postStats.Input.Headers = .init()
                 let cookies: Operations.postStats.Input.Cookies = .init()
                 let contentType = converter.extractContentTypeIfPresent(in: request.headerFields)
let body: Operations.postStats.Input.Body
@@ -405,11 +409,12 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
         try await handle(
             request: request,
             with: metadata,
             forOperation: Operations.probe.id,
             using: { APIHandler.probe($0) },
-            deserializer: { request, metadata in let path: Operations.probe.Input.Path = .init()
+            deserializer: { request, metadata in
+                let path: Operations.probe.Input.Path = .init()
                 let query: Operations.probe.Input.Query = .init()
                 let headers: Operations.probe.Input.Headers = .init()
                 let cookies: Operations.probe.Input.Cookies = .init()
                 return Operations.probe.Input(
                     path: path,

Please note that the above behavior is the behavior of the current main branch of swift-format and is subject to change.

Thank you.

[czechboy0]

Hi @takeshi-1000, this is a great catch - I don't personally like how it puts the code on the first line of the closure. Happy to hear it's fixed.

Marking the issue as blocked, and we'll update to the new version of swift-format once Swift 5.9 is released.

[missingmario]

@czechboy0

Hey! This is my first time interacting with the Open Source community on GitHub, so please let me know if I make any mistakes and/or come across as rude/annoying.

It looks like swift-format 509.0.0 is available as of last week.

I was playing around with swift-format 5.9 on my own project; and found out that having the swift-openapi-generator plugin active caused a conflict due to major version requirements of the package.

This issue seems to be related to #250 as well.

I would like to help if possible, would it be okay if I tried increasing the versions and opening a pull request?

Thank you for your time.

[czechboy0]

Hi @missingmario, welcome!

We will require 5.9 at some point in the coming months, but aren't ready to do it yet.

Can you speak to how this is impacting your project? The generator uses the from: "508.0.1" version requirement, so 509.0.0 should still be able to resolve. What's the error you're seeing?

[missingmario]

Thank you @czechboy0 for the quick response!

I have a swift package which I use inside for my app: MyProjectNetwork.

I also have a separate swift package on a separate git repo (swift-myproject-openapi-client) which uses the generator as show in the code examples in this repo.

I then added both swift-myproject-openapi-client and swift-format (from: 509.0.0) as dependencies to MyProjectNetwork. Xcode shows me the following error:

Failed to resolve dependencies Dependencies could not be resolved because 'swift-myproject-openapi-client' depends on 'swift-openapi-generator' 0.2.2.
'swift-openapi-generator' 0.2.2 cannot be used because 'swift-openapi-generator' 0.2.2 depends on 'swift-format' 508.0.1..<509.0.0 and 'myprojectnetwork' depends on 'swift-format' 509.0.0..<510.0.0.

This makes sense to me as swift-format 508.y.z and 509.y.z are major versions and therefore may contain breaking changes according to SemVer.

[czechboy0]

You're totally right, I didn't realize. Unfortunately, until we can bump to 5.9, you'll need to use swift-format 5.8.

[missingmario]

Oh, I'll wait then.

There seems to be a workaround to use swift-format 509 if the generator is used inside a separate package: using the OpenAPIGeneratorCommand instead of the OpenAPIGenerator plugin and committing the generated files to source control prevents the swift-format 508 requirement from being passed on to the main project, allowing you to use swift-format 509 if needed.

This might help anyone with the same problem as me.

Thank you for your help!

[czechboy0]

Indeed, using ahead-of-time generation keeps the generator's dependencies out of your package's dependencies: https://swiftpackageindex.com/apple/swift-openapi-generator/0.2.2/documentation/swift-openapi-generator/manually-invoking-the-generator-cli

[czechboy0]

Already done in #331.

[czechboy0]

Actually, we haven't yet bumped the repo itself to swift-format 5.9, reopening.

[czechboy0]

Done now.