Merge pull request #81 from pace/improve-401-response-handling

philippkno · web-flow · commit 8d66b1bd9144 · 2024-07-25T14:45:27.000+02:00
Improve 401 response handling in swift API templates
diff --git a/Sources/SwagGenKit/CodeFormatter.swift b/Sources/SwagGenKit/CodeFormatter.swift
@@ -369,6 +369,8 @@ public class CodeFormatter {
                return value == "OAuth2" || value == "OIDC" || value == "keycloak"
            }) {
             context["authorizationRequired"] = true
+        } else {
+            context["authorizationRequired"] = false
         }
 
         // Responses
diff --git a/Templates/SwiftPrivateAPIs/Common/APIClient.swift b/Templates/SwiftPrivateAPIs/Common/APIClient.swift
@@ -80,10 +80,69 @@ public class {{ options.name }}Client {
             urlRequest.allHTTPHeaderFields?[key] = value
         }
 
+        let cancellableRequest = Cancellable{{ options.name }}Request(request: request.asAny())
+
         urlRequest = requestBehaviour.modifyRequest(urlRequest)
 
-        let cancellableRequest = Cancellable{{ options.name }}Request(request: request.asAny())
+        if request.isAuthorizationRequired
+            && request.customHeaders[HttpHeaderFields.authorization.rawValue] == nil
+            && IDKit.isSessionAvailable {
+            IDKit.refreshToken { [weak self] result in
+                guard let self else { return }
+                guard case let .failure(error) = result else {
+                    guard case let .success(accessToken) = result, 
+                            let accessToken else { return }
+                    urlRequest.setValue("Bearer \(accessToken)", 
+                                        forHTTPHeaderField: HttpHeaderFields.authorization.rawValue)
+                    self.validateNetworkRequest(request: request,
+                                                urlRequest: urlRequest,
+                                                cancellableRequest: cancellableRequest,
+                                                requestBehaviour: requestBehaviour,
+                                                currentUnauthorizedRetryCount: currentUnauthorizedRetryCount,
+                                                currentRetryCount: currentRetryCount,
+                                                completionQueue: completionQueue,
+                                                complete: complete)
+                    return
+                }
+
+                if case .failedTokenRefresh = error {
+                    completionQueue.async {
+                        let response = {{ options.name }}Response<T>(request: request,
+                                                                     result: .failure(APIClientError
+                                                                        .unexpectedStatusCode(statusCode: 401,
+                                                                                              data: Data("UNAUTHORIZED".utf8))))
+                        complete(response)
+                    }
+                } else {
+                    completionQueue.async {
+                        let response = {{ options.name }}Response<T>(request: request,
+                                                                     result: .failure(APIClientError.unknownError(error)))
+                        complete(response)
+                    }
+                }
+            }
+        } else {
+            validateNetworkRequest(request: request,
+                                   urlRequest: urlRequest,
+                                   cancellableRequest: cancellableRequest,
+                                   requestBehaviour: requestBehaviour,
+                                   currentUnauthorizedRetryCount: currentUnauthorizedRetryCount,
+                                   currentRetryCount: currentRetryCount,
+                                   completionQueue: completionQueue,
+                                   complete: complete)
+        }
+
+        return cancellableRequest
+    }
 
+    private func validateNetworkRequest<T>(request: {{ options.name }}Request<T>,
+                                           urlRequest: URLRequest,
+                                           cancellableRequest: Cancellable{{ options.name }}Request,
+                                           requestBehaviour: {{ options.name }}RequestBehaviourGroup,
+                                           currentUnauthorizedRetryCount: Int,
+                                           currentRetryCount: Int,
+                                           completionQueue: DispatchQueue,
+                                           complete: @escaping ({{ options.name }}Response<T>) -> Void) {
         requestBehaviour.validate(urlRequest) { result in
             switch result {
             case .success(let urlRequest):
@@ -101,7 +160,6 @@ public class {{ options.name }}Client {
                 complete(response)
             }
         }
-        return cancellableRequest
     }
 
     private func makeNetworkRequest<T>(request: {{ options.name }}Request<T>,
@@ -267,9 +325,10 @@ public class {{ options.name }}Client {
         }
 
         if response.statusCode == HttpStatusCode.unauthorized.rawValue
+            && request.customHeaders[HttpHeaderFields.authorization.rawValue] == nil
             && currentUnauthorizedRetryCount < maxUnauthorizedRetryCount
             && IDKit.isSessionAvailable {
-            IDKit.refreshToken { [weak self] result in
+            IDKit.refreshToken(force: true) { [weak self] result in
                 guard case .failure(let error) = result else {
                     self?.makeRequest(request,
                                       behaviours: requestBehaviour.behaviours,
diff --git a/Templates/SwiftPrivateAPIs/Common/APIRequest.swift b/Templates/SwiftPrivateAPIs/Common/APIRequest.swift
@@ -12,6 +12,7 @@ public class {{ options.name }}Request<ResponseType: APIResponseValue> {
     public var customHeaders: [String: String] = [:]
     public var version: String = "{{ info.version }}"
     public var contentType: String = "application/json"
+    public private(set) var isAuthorizationRequired: Bool = false
 
     public var headers: [String: String] {
         return headerParameters.merging(customHeaders) { param, custom in return custom }
diff --git a/Templates/SwiftPrivateAPIs/Common/Request.swift b/Templates/SwiftPrivateAPIs/Common/Request.swift
@@ -158,26 +158,14 @@ extension {{ options.name }}{% if tag %}.{{ options.tagPrefix }}{{ tag|upperCame
                 headers["{{ param.value }}"] = {% if param.type == "String" %}options.{{ param.encodedValue }}{% else %}String(describing: options.{{ param.encodedValue }}){% endif %}
                 {% endif %}
                 {% endfor %}
-                {% if authorizationRequired %}
-                if let token = API.accessToken {
-                    headers["Authorization"] = "Bearer \(token)"
-                }
-                {% endif %}
 
                 return headers
             }
-            {% else %}
-            {% if authorizationRequired %}
+            {% endif %}
 
-            override var headerParameters: [String: String] {
-                var headers: [String: String] = [:]
-                if let token = API.accessToken {
-                    headers["Authorization"] = "Bearer \(token)"
-                }
-                return headers
+            public override var isAuthorizationRequired: Bool {
+                {% if authorizationRequired == true %}true{% else %}false{% endif %}
             }
-            {% endif %}
-            {% endif %}
         }
 
         public enum Response: APIResponseValue, CustomStringConvertible, CustomDebugStringConvertible {
diff --git a/Templates/SwiftPublicAPIs/Common/APIClient.swift b/Templates/SwiftPublicAPIs/Common/APIClient.swift
@@ -80,10 +80,69 @@ public class {{ options.name }}Client {
             urlRequest.allHTTPHeaderFields?[key] = value
         }
 
+        let cancellableRequest = Cancellable{{ options.name }}Request(request: request.asAny())
+
         urlRequest = requestBehaviour.modifyRequest(urlRequest)
 
-        let cancellableRequest = Cancellable{{ options.name }}Request(request: request.asAny())
+        if request.isAuthorizationRequired
+            && request.customHeaders[HttpHeaderFields.authorization.rawValue] == nil
+            && IDKit.isSessionAvailable {
+            IDKit.refreshToken { [weak self] result in
+                guard let self else { return }
+                guard case let .failure(error) = result else {
+                    guard case let .success(accessToken) = result, 
+                            let accessToken else { return }
+                    urlRequest.setValue("Bearer \(accessToken)", 
+                                        forHTTPHeaderField: HttpHeaderFields.authorization.rawValue)
+                    self.validateNetworkRequest(request: request,
+                                                urlRequest: urlRequest,
+                                                cancellableRequest: cancellableRequest,
+                                                requestBehaviour: requestBehaviour,
+                                                currentUnauthorizedRetryCount: currentUnauthorizedRetryCount,
+                                                currentRetryCount: currentRetryCount,
+                                                completionQueue: completionQueue,
+                                                complete: complete)
+                    return
+                }
+
+                if case .failedTokenRefresh = error {
+                    completionQueue.async {
+                        let response = {{ options.name }}Response<T>(request: request,
+                                                                     result: .failure(APIClientError
+                                                                        .unexpectedStatusCode(statusCode: 401,
+                                                                                              data: Data("UNAUTHORIZED".utf8))))
+                        complete(response)
+                    }
+                } else {
+                    completionQueue.async {
+                        let response = {{ options.name }}Response<T>(request: request,
+                                                                     result: .failure(APIClientError.unknownError(error)))
+                        complete(response)
+                    }
+                }
+            }
+        } else {
+            validateNetworkRequest(request: request,
+                                   urlRequest: urlRequest,
+                                   cancellableRequest: cancellableRequest,
+                                   requestBehaviour: requestBehaviour,
+                                   currentUnauthorizedRetryCount: currentUnauthorizedRetryCount,
+                                   currentRetryCount: currentRetryCount,
+                                   completionQueue: completionQueue,
+                                   complete: complete)
+        }
+
+        return cancellableRequest
+    }
 
+    private func validateNetworkRequest<T>(request: {{ options.name }}Request<T>,
+                                           urlRequest: URLRequest,
+                                           cancellableRequest: Cancellable{{ options.name }}Request,
+                                           requestBehaviour: {{ options.name }}RequestBehaviourGroup,
+                                           currentUnauthorizedRetryCount: Int,
+                                           currentRetryCount: Int,
+                                           completionQueue: DispatchQueue,
+                                           complete: @escaping ({{ options.name }}Response<T>) -> Void) {
         requestBehaviour.validate(urlRequest) { result in
             switch result {
             case .success(let urlRequest):
@@ -101,7 +160,6 @@ public class {{ options.name }}Client {
                 complete(response)
             }
         }
-        return cancellableRequest
     }
 
     private func makeNetworkRequest<T>(request: {{ options.name }}Request<T>,
@@ -267,9 +325,10 @@ public class {{ options.name }}Client {
         }
 
         if response.statusCode == HttpStatusCode.unauthorized.rawValue
+            && request.customHeaders[HttpHeaderFields.authorization.rawValue] == nil
             && currentUnauthorizedRetryCount < maxUnauthorizedRetryCount
             && IDKit.isSessionAvailable {
-            IDKit.refreshToken { [weak self] result in
+            IDKit.refreshToken(force: true) { [weak self] result in
                 guard case .failure(let error) = result else {
                     self?.makeRequest(request,
                                       behaviours: requestBehaviour.behaviours,
diff --git a/Templates/SwiftPublicAPIs/Common/APIRequest.swift b/Templates/SwiftPublicAPIs/Common/APIRequest.swift
@@ -12,6 +12,7 @@ public class {{ options.name }}Request<ResponseType: APIResponseValue> {
     public var customHeaders: [String: String] = [:]
     public var version: String = "{{ info.version }}"
     public var contentType: String = "application/json"
+    public private(set) var isAuthorizationRequired: Bool = false
 
     public var headers: [String: String] {
         return headerParameters.merging(customHeaders) { param, custom in return custom }
diff --git a/Templates/SwiftPublicAPIs/Common/Request.swift b/Templates/SwiftPublicAPIs/Common/Request.swift
@@ -158,26 +158,14 @@ extension {{ options.name }}{% if tag %}.{{ options.tagPrefix }}{{ tag|upperCame
                 headers["{{ param.value }}"] = {% if param.type == "String" %}options.{{ param.encodedValue }}{% else %}String(describing: options.{{ param.encodedValue }}){% endif %}
                 {% endif %}
                 {% endfor %}
-                {% if authorizationRequired %}
-                if let token = API.accessToken {
-                    headers["Authorization"] = "Bearer \(token)"
-                }
-                {% endif %}
 
                 return headers
             }
-            {% else %}
-            {% if authorizationRequired %}
+            {% endif %}
 
-            override var headerParameters: [String: String] {
-                var headers: [String: String] = [:]
-                if let token = API.accessToken {
-                    headers["Authorization"] = "Bearer \(token)"
-                }
-                return headers
+            public override var isAuthorizationRequired: Bool {
+                {% if authorizationRequired == true %}true{% else %}false{% endif %}
             }
-            {% endif %}
-            {% endif %}
         }
 
         public enum Response: APIResponseValue, CustomStringConvertible, CustomDebugStringConvertible {

Original file line number	Diff line number	Diff line change
`@@ -369,6 +369,8 @@ public class CodeFormatter {`
`369`	`369`	`return value == "OAuth2" \|\| value == "OIDC" \|\| value == "keycloak"`
`370`	`370`	`}) {`
`371`	`371`	`context["authorizationRequired"] = true`
	`372`	`+ } else {`
	`373`	`+ context["authorizationRequired"] = false`
`372`	`374`	`}`
`373`	`375`
`374`	`376`	`// Responses`