Adjust API templates

patrickniepel · patrickniepel · commit 6261aa2659ee · 2024-05-29T16:09:57.000+02:00
diff --git a/Templates/Swift/Common/APIClient.swift b/Templates/Swift/Common/APIClient.swift
@@ -269,8 +269,8 @@ public class {{ options.name }}Client {
         if response.statusCode == HttpStatusCode.unauthorized.rawValue
             && currentUnauthorizedRetryCount < maxUnauthorizedRetryCount
             && IDKit.isSessionAvailable {
-            IDKit.apiInducedRefresh { [weak self] error in
-                guard let error = error else {
+            IDKit.refreshToken { [weak self] result in
+                guard case .failure(let error) = result else {
                     self?.makeRequest(request,
                                       behaviours: requestBehaviour.behaviours,
                                       currentUnauthorizedRetryCount: currentUnauthorizedRetryCount + 1,
diff --git a/Templates/Swift/Common/APIContainer.swift b/Templates/Swift/Common/APIContainer.swift
@@ -0,0 +1,46 @@
+{% include "Common/Includes/Header.stencil" %}
+
+import Foundation
+
+public struct API {
+    /**
+     The access token to be used for API requests.
+
+     This token will be set automatically when using IDKit.
+     */
+    public static var accessToken: String?
+}
+
+public extension API {
+    /**
+     Determines if an API request should be retried.
+
+     It takes into account if the request has failed due to network connection errors or timeouts and if the maximum number of retries has been exceeded.
+
+     - parameter currentRetryCount: The current number of retries for a specific request.
+     - parameter maxRetryCount: The maximum number of retries allowed for a specific request.
+     - parameter response: The most recent URL response of a specific request or `nil` if not available.
+     */
+    static func shouldRetryRequest(currentRetryCount: Int,
+                                   maxRetryCount: Int,
+                                   response: URLResponse?) -> Bool {
+        guard currentRetryCount <= maxRetryCount else { return false }
+        guard let response = response as? HTTPURLResponse else { return true }
+        return response.statusCode == HttpStatusCode.requestTimeout.rawValue
+    }
+
+    /**
+     Returns the number of seconds an API request should be delayed before the next retry is executed.
+
+     It calculates the number of seconds based on an exponential backoff algorithm.
+
+     - parameter currentRetryCount: The current number of retries for a specific request.
+     - parameter delayUpperBound: The maximum number of seconds a request should be delayed. Defaults to `64`.
+     - returns: The request delay in seconds.
+     */
+    static func nextExponentialBackoffRequestDelay(currentRetryCount: Int, delayUpperBound: Int = 64) -> Int {
+        let nextDelayIteration = NSDecimalNumber(decimal: pow(2, currentRetryCount - 1))
+        let delay = min(Int(truncating: nextDelayIteration), delayUpperBound)
+        return delay
+    }
+}
diff --git a/Templates/Swift/Fueling/template.yml b/Templates/Swift/Fueling/template.yml
@@ -57,6 +57,8 @@ templateFiles:
     destination: "./../../Generated/Common/AnyCodable.swift"
   - path: Common/URLEncoding.swift
     destination: "./../../Generated/Common/URLEncoding.swift"
+  - path: Common/APIContainer.swift
+    destination: "./../../Generated/Common/API.swift"
   - path: Common/Enum.swift
     context: enums
     destination: "Enums/{{ enumName }}.swift"
diff --git a/Templates/Swift/GeoJSON/template.yml b/Templates/Swift/GeoJSON/template.yml
diff --git a/Templates/Swift/POI/template.yml b/Templates/Swift/POI/template.yml
@@ -57,6 +57,8 @@ templateFiles:
     destination: "./../../Generated/Common/AnyCodable.swift"
   - path: Common/URLEncoding.swift
     destination: "./../../Generated/Common/URLEncoding.swift"
+  - path: Common/APIContainer.swift
+    destination: "./../../Generated/Common/API.swift"
   - path: Common/Enum.swift
     context: enums
     destination: "Enums/{{ enumName }}.swift"
diff --git a/Templates/Swift/Pay/template.yml b/Templates/Swift/Pay/template.yml
@@ -57,6 +57,8 @@ templateFiles:
     destination: "./../../Generated/Common/AnyCodable.swift"
   - path: Common/URLEncoding.swift
     destination: "./../../Generated/Common/URLEncoding.swift"
+  - path: Common/APIContainer.swift
+    destination: "./../../Generated/Common/API.swift"
   - path: Common/Enum.swift
     context: enums
     destination: "Enums/{{ enumName }}.swift"
diff --git a/Templates/Swift/User/template.yml b/Templates/Swift/User/template.yml
@@ -57,6 +57,8 @@ templateFiles:
     destination: "./../../Generated/Common/AnyCodable.swift"
   - path: Common/URLEncoding.swift
     destination: "./../../Generated/Common/URLEncoding.swift"
+  - path: Common/APIContainer.swift
+    destination: "./../../Generated/Common/API.swift"
   - path: Common/Enum.swift
     context: enums
     destination: "Enums/{{ enumName }}.swift"
diff --git a/Templates/Swift/Wallet/template.yml b/Templates/Swift/Wallet/template.yml
