fix: decoder and encoder default instances (#711)

grdsdev · web-flow · commit 01043316f94c · 2025-04-29T09:12:48.000-03:00
diff --git a/Sources/Auth/Defaults.swift b/Sources/Auth/Defaults.swift
@@ -10,46 +10,23 @@ import Foundation
 import Helpers
 
 extension AuthClient.Configuration {
-  private static let supportedDateFormatters: [UncheckedSendable<ISO8601DateFormatter>] = [
-    ISO8601DateFormatter.iso8601WithFractionalSeconds,
-    ISO8601DateFormatter.iso8601,
-  ]
-
   /// The default JSONEncoder instance used by the ``AuthClient``.
   public static let jsonEncoder: JSONEncoder = {
-    let encoder = JSONEncoder()
+    let encoder = JSONEncoder.supabase()
     encoder.keyEncodingStrategy = .convertToSnakeCase
-    encoder.dateEncodingStrategy = .custom { date, encoder in
-      let string = ISO8601DateFormatter.iso8601WithFractionalSeconds.value.string(from: date)
-      var container = encoder.singleValueContainer()
-      try container.encode(string)
-    }
     return encoder
   }()
 
   /// The default JSONDecoder instance used by the ``AuthClient``.
   public static let jsonDecoder: JSONDecoder = {
-    let decoder = JSONDecoder()
+    let decoder = JSONDecoder.supabase()
     decoder.keyDecodingStrategy = .convertFromSnakeCase
-    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.value.date(from: string) {
-          return date
-        }
-      }
-
-      throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
-      )
-    }
     return decoder
   }()
 
+  /// The default headers used by the ``AuthClient``.
   public static let defaultHeaders: [String: String] = [
-    "X-Client-Info": "auth-swift/\(version)",
+    "X-Client-Info": "auth-swift/\(version)"
   ]
 
   /// The default ``AuthFlowType`` used when initializing a ``AuthClient`` instance.
diff --git a/Sources/Auth/Internal/SessionStorage.swift b/Sources/Auth/Internal/SessionStorage.swift
@@ -34,6 +34,7 @@ extension SessionStorage {
     let migrations: [StorageMigration] = [
       .sessionNewKey(clientID: clientID),
       .storeSessionDirectly(clientID: clientID),
+      .useDefaultEncoder(clientID: clientID),
     ]
 
     var key: String {
@@ -46,14 +47,16 @@ extension SessionStorage {
           do {
             try migration.run()
           } catch {
-            logger?.error("Storage migration failed: \(error.localizedDescription)")
+            logger?.error(
+              "Storage migration '\(migration.name)' failed: \(error.localizedDescription)"
+            )
           }
         }
 
         do {
           let storedData = try storage.retrieve(key: key)
           return try storedData.flatMap {
-            try AuthClient.Configuration.jsonDecoder.decode(Session.self, from: $0)
+            try JSONDecoder().decode(Session.self, from: $0)
           }
         } catch {
           logger?.error("Failed to retrieve session: \(error.localizedDescription)")
@@ -64,7 +67,7 @@ extension SessionStorage {
         do {
           try storage.store(
             key: key,
-            value: AuthClient.Configuration.jsonEncoder.encode(session)
+            value: JSONEncoder().encode(session)
           )
         } catch {
           logger?.error("Failed to store session: \(error.localizedDescription)")
@@ -82,14 +85,15 @@ extension SessionStorage {
 }
 
 struct StorageMigration {
+  var name: String
   var run: @Sendable () throws -> Void
 }
 
 extension StorageMigration {
   /// Migrate stored session from `supabase.session` key to the custom provided storage key
   /// or the default `supabase.auth.token` key.
   static func sessionNewKey(clientID: AuthClientID) -> StorageMigration {
-    StorageMigration {
+    StorageMigration(name: "sessionNewKey") {
       let storage = Dependencies[clientID].configuration.localStorage
       let newKey = SessionStorage.key(clientID)
 
@@ -117,16 +121,38 @@ extension StorageMigration {
       var expirationDate: Date
     }
 
-    return StorageMigration {
+    return StorageMigration(name: "storeSessionDirectly") {
       let storage = Dependencies[clientID].configuration.localStorage
       let key = SessionStorage.key(clientID)
 
       if let data = try? storage.retrieve(key: key),
-         let storedSession = try? AuthClient.Configuration.jsonDecoder.decode(StoredSession.self, from: data)
+        let storedSession = try? AuthClient.Configuration.jsonDecoder.decode(
+          StoredSession.self,
+          from: data
+        )
       {
         let session = try AuthClient.Configuration.jsonEncoder.encode(storedSession.session)
         try storage.store(key: key, value: session)
       }
     }
   }
+
+  static func useDefaultEncoder(clientID: AuthClientID) -> StorageMigration {
+    StorageMigration(name: "useDefaultEncoder") {
+      let storage = Dependencies[clientID].configuration.localStorage
+      let key = SessionStorage.key(clientID)
+
+      let storedData = try? storage.retrieve(key: key)
+      let sessionUsingOldDecoder = storedData.flatMap {
+        try? AuthClient.Configuration.jsonDecoder.decode(Session.self, from: $0)
+      }
+
+      if let sessionUsingOldDecoder {
+        try storage.store(
+          key: key,
+          value: JSONEncoder().encode(sessionUsingOldDecoder)
+        )
+      }
+    }
+  }
 }
diff --git a/Sources/Helpers/AnyJSON/AnyJSON+Codable.swift b/Sources/Helpers/AnyJSON/AnyJSON+Codable.swift
@@ -10,37 +10,12 @@ import Foundation
 extension AnyJSON {
   /// The decoder instance used for transforming AnyJSON to some Codable type.
   public static let decoder: JSONDecoder = {
-    let decoder = JSONDecoder()
-    decoder.dataDecodingStrategy = .base64
-    decoder.dateDecodingStrategy = .custom { decoder in
-      let container = try decoder.singleValueContainer()
-      let dateString = try container.decode(String.self)
-
-      let date =
-        ISO8601DateFormatter.iso8601WithFractionalSeconds.value.date(from: dateString)
-        ?? ISO8601DateFormatter.iso8601.value.date(from: dateString)
-
-      guard let decodedDate = date else {
-        throw DecodingError.dataCorruptedError(
-          in: container, debugDescription: "Invalid date format: \(dateString)"
-        )
-      }
-
-      return decodedDate
-    }
-    return decoder
+    JSONDecoder.supabase()
   }()
 
   /// The encoder instance used for transforming AnyJSON to some Codable type.
   public static let encoder: JSONEncoder = {
-    let encoder = JSONEncoder()
-    encoder.dataEncodingStrategy = .base64
-    encoder.dateEncodingStrategy = .custom { date, encoder in
-      let string = ISO8601DateFormatter.iso8601WithFractionalSeconds.value.string(from: date)
-      var container = encoder.singleValueContainer()
-      try container.encode(string)
-    }
-    return encoder
+    JSONEncoder.supabase()
   }()
 }
 
diff --git a/Sources/Helpers/Codable.swift b/Sources/Helpers/Codable.swift
@@ -9,28 +9,33 @@ import ConcurrencyExtras
 import Foundation
 
 extension JSONDecoder {
-  private static let supportedDateFormatters: [UncheckedSendable<ISO8601DateFormatter>] = [
-    ISO8601DateFormatter.iso8601WithFractionalSeconds,
-    ISO8601DateFormatter.iso8601,
-  ]
-
   /// Default `JSONDecoder` for decoding types from Supabase.
-  package static let `default`: JSONDecoder = {
+  package static func supabase() -> JSONDecoder {
     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.value.date(from: string) {
-          return date
-        }
+      if let date = string.date {
+        return date
       }
 
       throw DecodingError.dataCorruptedError(
         in: container, debugDescription: "Invalid date format: \(string)"
       )
     }
     return decoder
-  }()
+  }
+}
+extension JSONEncoder {
+  /// Default `JSONEncoder` for encoding types to Supabase.
+  package static func supabase() -> JSONEncoder {
+    let encoder = JSONEncoder()
+    encoder.dateEncodingStrategy = .custom { date, encoder in
+      var container = encoder.singleValueContainer()
+      let string = date.iso8601String
+      try container.encode(string)
+    }
+    return encoder
+  }
 }
diff --git a/Sources/Helpers/DateFormatter.swift b/Sources/Helpers/DateFormatter.swift
@@ -5,19 +5,72 @@
 //  Created by Guilherme Souza on 28/12/23.
 //
 
-import ConcurrencyExtras
 import Foundation
 
-extension ISO8601DateFormatter {
-  package static let iso8601: UncheckedSendable<ISO8601DateFormatter> = {
-    let formatter = ISO8601DateFormatter()
-    formatter.formatOptions = [.withInternetDateTime]
-    return UncheckedSendable(formatter)
+extension DateFormatter {
+  fileprivate static func iso8601(includingFractionalSeconds: Bool) -> DateFormatter {
+    includingFractionalSeconds ? iso8601Fractional : iso8601Whole
+  }
+
+  fileprivate static let iso8601Fractional: DateFormatter = {
+    let formatter = DateFormatter()
+    formatter.calendar = Calendar(identifier: .iso8601)
+    formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSS"
+    formatter.locale = Locale(identifier: "en_US_POSIX")
+    formatter.timeZone = TimeZone(secondsFromGMT: 0)
+    return formatter
   }()
 
-  package static let iso8601WithFractionalSeconds: UncheckedSendable<ISO8601DateFormatter> = {
-    let formatter = ISO8601DateFormatter()
-    formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
-    return UncheckedSendable(formatter)
+  fileprivate static let iso8601Whole: DateFormatter = {
+    let formatter = DateFormatter()
+    formatter.calendar = Calendar(identifier: .iso8601)
+    formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss"
+    formatter.locale = Locale(identifier: "en_US_POSIX")
+    formatter.timeZone = TimeZone(secondsFromGMT: 0)
+    return formatter
   }()
 }
+
+@available(iOS 15, macOS 12, tvOS 15, watchOS 8, *)
+extension Date.ISO8601FormatStyle {
+  fileprivate func currentTimestamp(includingFractionalSeconds: Bool) -> Self {
+    year().month().day()
+      .dateTimeSeparator(.standard)
+      .time(includingFractionalSeconds: includingFractionalSeconds)
+  }
+}
+
+extension Date {
+  package var iso8601String: String {
+    if #available(iOS 15, macOS 12, tvOS 15, watchOS 8, *) {
+      return formatted(.iso8601.currentTimestamp(includingFractionalSeconds: true))
+    } else {
+      return DateFormatter.iso8601(includingFractionalSeconds: true).string(from: self)
+    }
+  }
+}
+
+extension String {
+  package var date: Date? {
+    if #available(iOS 15, macOS 12, tvOS 15, watchOS 8, *) {
+      if let date = try? Date(
+        self,
+        strategy: .iso8601.currentTimestamp(includingFractionalSeconds: true)
+      ) {
+        return date
+      }
+      return try? Date(
+        self,
+        strategy: .iso8601.currentTimestamp(includingFractionalSeconds: false)
+      )
+    } else {
+      guard
+        let date = DateFormatter.iso8601(includingFractionalSeconds: true).date(from: self)
+          ?? DateFormatter.iso8601(includingFractionalSeconds: false).date(from: self)
+      else {
+        return nil
+      }
+      return date
+    }
+  }
+}
diff --git a/Sources/Helpers/SupabaseLogger.swift b/Sources/Helpers/SupabaseLogger.swift
@@ -55,8 +55,7 @@ public struct SupabaseLogMessage: Codable, CustomStringConvertible, Sendable {
   }
 
   public var description: String {
-    let date = ISO8601DateFormatter.iso8601.value.string(
-      from: Date(timeIntervalSince1970: timestamp))
+    let date = Date(timeIntervalSince1970: timestamp).iso8601String
     let file = fileID.split(separator: ".", maxSplits: 1).first.map(String.init) ?? fileID
     var description = "\(date) [\(level)] [\(system)] [\(file).\(function):\(line)] \(message)"
     if !additionalContext.isEmpty {
diff --git a/Sources/PostgREST/Defaults.swift b/Sources/PostgREST/Defaults.swift
@@ -12,39 +12,18 @@ import Helpers
 let version = Helpers.version
 
 extension PostgrestClient.Configuration {
-  private static let supportedDateFormatters: [UncheckedSendable<ISO8601DateFormatter>] = [
-    ISO8601DateFormatter.iso8601WithFractionalSeconds,
-    ISO8601DateFormatter.iso8601,
-  ]
-
   /// 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.value.date(from: string) {
-          return date
-        }
-      }
-
-      throw DecodingError.dataCorruptedError(
-        in: container, debugDescription: "Invalid date format: \(string)"
-      )
-    }
-    return decoder
+  public static let jsonDecoder: JSONDecoder = {
+    JSONDecoder.supabase()
   }()
 
   /// The default `JSONEncoder` instance for ``PostgrestClient`` requests.
-  public static let jsonEncoder = { () -> JSONEncoder in
-    let encoder = JSONEncoder()
-    encoder.dateEncodingStrategy = .iso8601
-    return encoder
+  public static let jsonEncoder: JSONEncoder = {
+    JSONEncoder.supabase()
   }()
 
+  /// The default headers for ``PostgrestClient`` requests.
   public static let defaultHeaders: [String: String] = [
-    "X-Client-Info": "postgrest-swift/\(version)",
+    "X-Client-Info": "postgrest-swift/\(version)"
   ]
 }
diff --git a/Sources/Storage/Codable.swift b/Sources/Storage/Codable.swift
@@ -21,7 +21,7 @@ extension JSONEncoder {
 
 extension JSONDecoder {
   @available(*, deprecated, message: "Access to storage decoder is going to be removed.")
-  public static var defaultStorageDecoder: JSONDecoder {
-    .default
-  }
+  public static let defaultStorageDecoder: JSONDecoder = {
+    JSONDecoder.supabase()
+  }()
 }
diff --git a/Tests/AuthTests/AuthClientTests.swift b/Tests/AuthTests/AuthClientTests.swift
diff --git a/Tests/AuthTests/Resources/local-storage.json b/Tests/AuthTests/Resources/local-storage.json
diff --git a/Tests/AuthTests/SessionManagerTests.swift b/Tests/AuthTests/SessionManagerTests.swift
diff --git a/Tests/IntegrationTests/DotEnv.swift b/Tests/IntegrationTests/DotEnv.swift

Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,7 @@ public struct SupabaseLogMessage: Codable, CustomStringConvertible, Sendable {`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`public var description: String {`
`58`		`- let date = ISO8601DateFormatter.iso8601.value.string(`
`59`		`- from: Date(timeIntervalSince1970: timestamp))`
	`58`	`+ let date = Date(timeIntervalSince1970: timestamp).iso8601String`
`60`	`59`	`let file = fileID.split(separator: ".", maxSplits: 1).first.map(String.init) ?? fileID`
`61`	`60`	`var description = "\(date) [\(level)] [\(system)] [\(file).\(function):\(line)] \(message)"`
`62`	`61`	`if !additionalContext.isEmpty {`