Refactor default initialization values

Author: Guilherme Souza

Sources/Auth/AuthClient.swift

@@ -33,28 +33,20 @@ public actor AuthClient {
     public init(
       url: URL,
       headers: [String: String] = [:],
-      flowType: AuthFlowType? = nil,
-      localStorage: AuthLocalStorage? = nil,
-      encoder: JSONEncoder? = nil,
-      decoder: JSONDecoder? = nil,
+      flowType: AuthFlowType = Configuration.defaultFlowType,
+      localStorage: AuthLocalStorage = Configuration.defaultLocalStorage,
+      encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
+      decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
       fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }
     ) {
-      var headers = headers
-      if headers["X-Client-Info"] == nil {
-        headers["X-Client-Info"] = "gotrue-swift/\(version)"
-      }
+      let headers = headers.merging(Configuration.defaultHeaders) { l, _ in l }
 
       self.url = url
       self.headers = headers
-      self.flowType = flowType ?? .implicit
-      self.localStorage =
-        localStorage
-          ?? KeychainLocalStorage(
-            service: "supabase.gotrue.swift",
-            accessGroup: nil
-          )
-      self.encoder = encoder ?? .auth
-      self.decoder = decoder ?? .auth
+      self.flowType = flowType
+      self.localStorage = localStorage
+      self.encoder = encoder
+      self.decoder = decoder
       self.fetch = fetch
     }
   }
@@ -96,18 +88,18 @@ public actor AuthClient {
   /// - Parameters:
   ///   - url: The base URL of the Auth server.
   ///   - headers: Custom headers to be included in requests.
-  ///   - flowType: The authentication flow type. Default is `.implicit`.
+  ///   - flowType: The authentication flow type..
   ///   - localStorage: The storage mechanism for local data..
   ///   - encoder: The JSON encoder to use for encoding requests.
   ///   - decoder: The JSON decoder to use for decoding responses.
   ///   - fetch: The asynchronous fetch handler for network requests.
   public init(
     url: URL,
     headers: [String: String] = [:],
-    flowType: AuthFlowType? = nil,
-    localStorage: AuthLocalStorage? = nil,
-    encoder: JSONEncoder? = nil,
-    decoder: JSONDecoder? = nil,
+    flowType: AuthFlowType = AuthClient.Configuration.defaultFlowType,
+    localStorage: AuthLocalStorage = AuthClient.Configuration.defaultLocalStorage,
+    encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
+    decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
     fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }
   ) {
     self.init(

Sources/Auth/Defaults.swift

@@ -0,0 +1,71 @@
+//
+//  Defaults.swift
+//
+//
+//  Created by Guilherme Souza on 14/12/23.
+//
+
+@_spi(Internal) import _Helpers
+import Foundation
+
+extension AuthClient.Configuration {
+  private static let dateFormatterWithFractionalSeconds = { () -> ISO8601DateFormatter in
+    let formatter = ISO8601DateFormatter()
+    formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
+    return formatter
+  }()
+
+  private static let dateFormatter = { () -> ISO8601DateFormatter in
+    let formatter = ISO8601DateFormatter()
+    formatter.formatOptions = [.withInternetDateTime]
+    return formatter
+  }()
+
+  /// The default JSONEncoder instance used by the ``AuthClient``.
+  public static let jsonEncoder: JSONEncoder = {
+    let encoder = JSONEncoder()
+    encoder.keyEncodingStrategy = .convertToSnakeCase
+    encoder.dateEncodingStrategy = .custom { date, encoder in
+      var container = encoder.singleValueContainer()
+      let string = dateFormatter.string(from: date)
+      try container.encode(string)
+    }
+    return encoder
+  }()
+
+  /// The default JSONDecoder instance used by the ``AuthClient``.
+  public static let jsonDecoder: JSONDecoder = {
+    let decoder = JSONDecoder()
+    decoder.keyDecodingStrategy = .convertFromSnakeCase
+    decoder.dateDecodingStrategy = .custom { decoder in
+      let container = try decoder.singleValueContainer()
+      let string = try container.decode(String.self)
+
+      let supportedFormatters = [dateFormatterWithFractionalSeconds, dateFormatter]
+
+      for formatter in supportedFormatters {
+        if let date = formatter.date(from: string) {
+          return date
+        }
+      }
+
+      throw DecodingError.dataCorruptedError(
+        in: container, debugDescription: "Invalid date format: \(string)"
+      )
+    }
+    return decoder
+  }()
+
+  public static let defaultHeaders: [String: String] = [
+    "X-Client-Info": "auth-swift/\(version)",
+  ]
+
+  /// The default ``AuthFlowType`` used when initializing a ``AuthClient`` instance.
+  public static let defaultFlowType: AuthFlowType = .pkce
+
+  /// The default ``AuthLocalStorage`` instance used by the ``AuthClient``.
+  public static let defaultLocalStorage: AuthLocalStorage = KeychainLocalStorage(
+    service: "supabase.gotrue.swift",
+    accessGroup: nil
+  )
+}

Sources/Auth/Deprecated.swift

@@ -26,20 +26,22 @@ extension JSONEncoder {
   @available(
     *,
     deprecated,
-    message: "Access to the default JSONEncoder instance will be removed on the next major release, please use your own instance of JSONEncoder."
+    renamed: "AuthClient.Configuration.jsonEncoder",
+    message: "Access to the default JSONEncoder instance moved to AuthClient.Configuration.jsonEncoder"
   )
   public static var goTrue: JSONEncoder {
-    auth
+    AuthClient.Configuration.jsonEncoder
   }
 }
 
 extension JSONDecoder {
   @available(
     *,
     deprecated,
-    message: "Access to the default JSONDecoder instance will be removed on the next major release, please use your own instance of JSONDecoder."
+    renamed: "AuthClient.Configuration.jsonDecoder",
+    message: "Access to the default JSONDecoder instance moved to AuthClient.Configuration.jsonDecoder"
   )
   public static var goTrue: JSONDecoder {
-    auth
+    AuthClient.Configuration.jsonDecoder
   }
 }

Sources/Auth/Internal/SessionStorage.swift

@@ -38,11 +38,14 @@ extension SessionStorage {
     return Self(
       getSession: {
         try localStorage.retrieve(key: "supabase.session").flatMap {
-          try JSONDecoder.auth.decode(StoredSession.self, from: $0)
+          try AuthClient.Configuration.jsonDecoder.decode(StoredSession.self, from: $0)
         }
       },
       storeSession: {
-        try localStorage.store(key: "supabase.session", value: JSONEncoder.auth.encode($0))
+        try localStorage.store(
+          key: "supabase.session",
+          value: AuthClient.Configuration.jsonEncoder.encode($0)
+        )
       },
       deleteSession: {
         try localStorage.remove(key: "supabase.session")

Sources/Auth/Types.swift

@@ -586,54 +586,3 @@ public enum SignOutScope: String, Sendable {
   /// session.
   case others
 }
-
-// MARK: - Encodable & Decodable
-
-private let dateFormatterWithFractionalSeconds = { () -> ISO8601DateFormatter in
-  let formatter = ISO8601DateFormatter()
-  formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
-  return formatter
-}()
-
-private let dateFormatter = { () -> ISO8601DateFormatter in
-  let formatter = ISO8601DateFormatter()
-  formatter.formatOptions = [.withInternetDateTime]
-  return formatter
-}()
-
-extension JSONDecoder {
-  static let auth = { () -> JSONDecoder in
-    let decoder = JSONDecoder()
-    decoder.keyDecodingStrategy = .convertFromSnakeCase
-    decoder.dateDecodingStrategy = .custom { decoder in
-      let container = try decoder.singleValueContainer()
-      let string = try container.decode(String.self)
-
-      let supportedFormatters = [dateFormatterWithFractionalSeconds, dateFormatter]
-
-      for formatter in supportedFormatters {
-        if let date = formatter.date(from: string) {
-          return date
-        }
-      }
-
-      throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
-      )
-    }
-    return decoder
-  }()
-}
-
-extension JSONEncoder {
-  static let auth = { () -> JSONEncoder in
-    let encoder = JSONEncoder()
-    encoder.keyEncodingStrategy = .convertToSnakeCase
-    encoder.dateEncodingStrategy = .custom { date, encoder in
-      var container = encoder.singleValueContainer()
-      let string = dateFormatter.string(from: date)
-      try container.encode(string)
-    }
-    return encoder
-  }()
-}

Sources/PostgREST/Defaults.swift

@@ -0,0 +1,57 @@
+//
+//  Defaults.swift
+//
+//
+//  Created by Guilherme Souza on 14/12/23.
+//
+
+import Foundation
+@_spi(Internal) import _Helpers
+
+let version = _Helpers.version
+
+extension PostgrestClient.Configuration {
+  private static let supportedDateFormatters: [ISO8601DateFormatter] = [
+    { () -> ISO8601DateFormatter in
+      let formatter = ISO8601DateFormatter()
+      formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
+      return formatter
+    }(),
+    { () -> ISO8601DateFormatter in
+      let formatter = ISO8601DateFormatter()
+      formatter.formatOptions = [.withInternetDateTime]
+      return formatter
+    }(),
+  ]
+
+  /// The default `JSONDecoder` instance for ``PostgrestClient`` responses.
+  public static let jsonDecoder = { () -> JSONDecoder in
+    let decoder = JSONDecoder()
+    decoder.dateDecodingStrategy = .custom { decoder in
+      let container = try decoder.singleValueContainer()
+      let string = try container.decode(String.self)
+
+      for formatter in supportedDateFormatters {
+        if let date = formatter.date(from: string) {
+          return date
+        }
+      }
+
+      throw DecodingError.dataCorruptedError(
+        in: container, debugDescription: "Invalid date format: \(string)"
+      )
+    }
+    return decoder
+  }()
+
+  /// The default `JSONEncoder` instance for ``PostgrestClient`` requests.
+  public static let jsonEncoder = { () -> JSONEncoder in
+    let encoder = JSONEncoder()
+    encoder.dateEncodingStrategy = .iso8601
+    return encoder
+  }()
+
+  public static let defaultHeaders: [String: String] = [
+    "X-Client-Info": "postgrest-swift/\(version)",
+  ]
+}

Sources/PostgREST/PostgrestClient.swift

@@ -1,8 +1,6 @@
 import Foundation
 @_spi(Internal) import _Helpers
 
-let version = _Helpers.version
-
 /// PostgREST client.
 public actor PostgrestClient {
   public typealias FetchHandler = @Sendable (_ request: URLRequest) async throws -> (
@@ -31,15 +29,15 @@ public actor PostgrestClient {
       schema: String? = nil,
       headers: [String: String] = [:],
       fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) },
-      encoder: JSONEncoder? = nil,
-      decoder: JSONDecoder? = nil
+      encoder: JSONEncoder = PostgrestClient.Configuration.jsonEncoder,
+      decoder: JSONDecoder = PostgrestClient.Configuration.jsonDecoder
     ) {
       self.url = url
       self.schema = schema
       self.headers = headers
       self.fetch = fetch
-      self.encoder = encoder ?? .postgrest
-      self.decoder = decoder ?? .postgrest
+      self.encoder = encoder
+      self.decoder = decoder
     }
   }
 
@@ -49,9 +47,7 @@ public actor PostgrestClient {
   /// - Parameter configuration: The configuration for the client.
   public init(configuration: Configuration) {
     var configuration = configuration
-    if configuration.headers["X-Client-Info"] == nil {
-      configuration.headers["X-Client-Info"] = "postgrest-swift/\(version)"
-    }
+    configuration.headers.merge(Configuration.defaultHeaders) { l, _ in l }
     self.configuration = configuration
   }
 
@@ -68,8 +64,8 @@ public actor PostgrestClient {
     schema: String? = nil,
     headers: [String: String] = [:],
     fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) },
-    encoder: JSONEncoder? = nil,
-    decoder: JSONDecoder? = nil
+    encoder: JSONEncoder = PostgrestClient.Configuration.jsonEncoder,
+    decoder: JSONDecoder = PostgrestClient.Configuration.jsonDecoder
   ) {
     self.init(
       configuration: Configuration(
@@ -139,47 +135,3 @@ public actor PostgrestClient {
     try rpc(fn, params: NoParams(), count: count)
   }
 }
-
-private let supportedDateFormatters: [ISO8601DateFormatter] = [
-  { () -> ISO8601DateFormatter in
-    let formatter = ISO8601DateFormatter()
-    formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
-    return formatter
-  }(),
-  { () -> ISO8601DateFormatter in
-    let formatter = ISO8601DateFormatter()
-    formatter.formatOptions = [.withInternetDateTime]
-    return formatter
-  }(),
-]
-
-extension JSONDecoder {
-  /// The JSONDecoder instance for PostgREST responses.
-  public static let postgrest = { () -> JSONDecoder in
-    let decoder = JSONDecoder()
-    decoder.dateDecodingStrategy = .custom { decoder in
-      let container = try decoder.singleValueContainer()
-      let string = try container.decode(String.self)
-
-      for formatter in supportedDateFormatters {
-        if let date = formatter.date(from: string) {
-          return date
-        }
-      }
-
-      throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
-      )
-    }
-    return decoder
-  }()
-}
-
-extension JSONEncoder {
-  /// The JSONEncoder instance for PostgREST requests.
-  public static let postgrest = { () -> JSONEncoder in
-    let encoder = JSONEncoder()
-    encoder.dateEncodingStrategy = .iso8601
-    return encoder
-  }()
-}