[Swift5][URLSession] Fix handling of customHeaders between retries (#7527)

* fix: correct handling of customHeaders

Problem: custom headers could be overwritten between 
request retries following, e.g. a token refresh ( for example,
while implementing @4brunu refresh code :
https://github.com/OpenAPITools/openapi-generator/issues/5462#issuecomment-592417371 ).
A simple reordering of the modifiedRequest headers construction
solves the problem.

* fix: correct PetStore samples implementation [PR#7527]

Co-authored-by: Franz Marini <f.marini@opengate.biz>

modules/openapi-generator/src/main/resources/swift5/libraries/urlsession/URLSessionImplementations.mustache

@@ -87,11 +87,11 @@ private var urlSessionStore = SynchronizedDictionary<String, URLSession>()
         
         originalRequest.httpMethod = method.rawValue
         
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
         
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
         
@@ -244,10 +244,13 @@ private var urlSessionStore = SynchronizedDictionary<String, URLSession>()
     }
 
     {{#nonPublicApi}}internal{{/nonPublicApi}}{{^nonPublicApi}}open{{/nonPublicApi}} func buildHeaders() -> [String: String] {
-        var httpHeaders = {{projectName}}API.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in {{projectName}}API.customHeaders {
+            httpHeaders[key] = value
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/combineLibrary/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/default/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/nonPublicApi/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ internal class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ internal class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     internal func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/objcCompatible/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/promisekitLibrary/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/readonlyProperties/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/resultLibrary/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/rxswiftLibrary/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }
 

samples/client/petstore/swift5/urlsessionLibrary/PetstoreClient/Classes/OpenAPIs/URLSessionImplementations.swift

@@ -87,11 +87,11 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
 
         originalRequest.httpMethod = method.rawValue
 
-        buildHeaders().forEach { key, value in
+        headers.forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
-        headers.forEach { key, value in
+        buildHeaders().forEach { key, value in
             originalRequest.setValue(value, forHTTPHeaderField: key)
         }
 
@@ -244,10 +244,13 @@ open class URLSessionRequestBuilder<T>: RequestBuilder<T> {
     }
 
     open func buildHeaders() -> [String: String] {
-        var httpHeaders = PetstoreClientAPI.customHeaders
+        var httpHeaders: [String : String] = [:]
         for (key, value) in self.headers {
             httpHeaders[key] = value
         }
+        for (key, value) in PetstoreClientAPI.customHeaders {
+            httpHeaders[key] = value    
+        }
         return httpHeaders
     }