Simplify logger

supabase · Jan 16, 2024 · 1b339f4 · 1b339f4
1 parent bc9d6ad
commit 1b339f4
Show file tree

Hide file tree

Showing 20 changed files with 201 additions and 268 deletions.
diff --git a/Examples/UserManagement/Supabase.swift b/Examples/UserManagement/Supabase.swift
@@ -6,13 +6,31 @@
 //
 
 import Foundation
+import OSLog
 import Supabase
 
 let supabase = SupabaseClient(
   supabaseURL: URL(string: "https://PROJECT_ID.supabase.co")!,
   supabaseKey: "YOUR_SUPABASE_ANON_KEY",
-  options: .init(auth: .init(storage: KeychainLocalStorage(
-    service: "supabase.gotrue.swift",
-    accessGroup: nil
-  )))
+  options: .init(
+    auth: .init(
+      storage: KeychainLocalStorage(service: "supabase.gotrue.swift", accessGroup: nil)
+    ),
+    global: .init(logger: AppLogger())
+  )
 )
+
+struct AppLogger: SupabaseLogger {
+  let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "supabase")
+
+  func log(message: SupabaseLogMessage) {
+    switch message.level {
+    case .verbose:
+      logger.log(level: .info, "\(message.description)")
+    case .debug:
+      logger.log(level: .debug, "\(message.description)")
+    case .warning, .error:
+      logger.log(level: .error, "\(message.description)")
+    }
+  }
+}
diff --git a/Package.resolved b/Package.resolved
@@ -1,5 +1,14 @@
 {
   "pins" : [
+    {
+      "identity" : "keychainaccess",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/kishikawakatsumi/KeychainAccess",
+      "state" : {
+        "revision" : "84e546727d66f1adc5439debad16270d0fdd04e7",
+        "version" : "4.2.2"
+      }
+    },
     {
       "identity" : "swift-concurrency-extras",
       "kind" : "remoteSourceControl",
@@ -47,4 +56,4 @@
     }
   ],
   "version" : 2
-}
+}
diff --git a/Sources/Auth/AuthClient.swift b/Sources/Auth/AuthClient.swift
@@ -16,7 +16,7 @@ public actor AuthClient {
     public var headers: [String: String]
     public let flowType: AuthFlowType
     public let localStorage: AuthLocalStorage
-    public let loggingConfiguration: SupabaseLoggingConfiguration
+    public let logger: SupabaseLogger?
     public let encoder: JSONEncoder
     public let decoder: JSONDecoder
     public let fetch: FetchHandler
@@ -28,7 +28,7 @@ public actor AuthClient {
     ///   - headers: Custom headers to be included in requests.
     ///   - flowType: The authentication flow type.
     ///   - localStorage: The storage mechanism for local data.
-    ///   - loggingConfiguration: The configuration used for the internal logger.
+    ///   - logger: The logger to use.
     ///   - 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.
@@ -37,7 +37,7 @@ public actor AuthClient {
       headers: [String: String] = [:],
       flowType: AuthFlowType = Configuration.defaultFlowType,
       localStorage: AuthLocalStorage,
-      loggingConfiguration: SupabaseLoggingConfiguration = SupabaseLoggingConfiguration(),
+      logger: SupabaseLogger? = nil,
       encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
       decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
       fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }
@@ -48,7 +48,7 @@ public actor AuthClient {
       self.headers = headers
       self.flowType = flowType
       self.localStorage = localStorage
-      self.loggingConfiguration = loggingConfiguration
+      self.logger = logger
       self.encoder = encoder
       self.decoder = decoder
       self.fetch = fetch
@@ -79,7 +79,7 @@ public actor AuthClient {
     Dependencies.current.value!.currentDate
   }
 
-  private var logger: SupabaseLogger {
+  private var logger: SupabaseLogger? {
     Dependencies.current.value!.logger
   }
 
@@ -102,7 +102,7 @@ public actor AuthClient {
   ///   - headers: Custom headers to be included in requests.
   ///   - flowType: The authentication flow type..
   ///   - localStorage: The storage mechanism for local data..
-  ///   - loggingConfiguration: The configuration used for the internal logger.
+  ///   - logger: The logger to use.
   ///   - 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.
@@ -111,7 +111,7 @@ public actor AuthClient {
     headers: [String: String] = [:],
     flowType: AuthFlowType = AuthClient.Configuration.defaultFlowType,
     localStorage: AuthLocalStorage,
-    loggingConfiguration: SupabaseLoggingConfiguration = SupabaseLoggingConfiguration(),
+    logger: SupabaseLogger? = nil,
     encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
     decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
     fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }
@@ -122,7 +122,7 @@ public actor AuthClient {
         headers: headers,
         flowType: flowType,
         localStorage: localStorage,
-        loggingConfiguration: loggingConfiguration,
+        logger: logger,
         encoder: encoder,
         decoder: decoder,
         fetch: fetch
@@ -135,7 +135,10 @@ public actor AuthClient {
   /// - Parameters:
   ///   - configuration: The client configuration.
   public init(configuration: Configuration) {
-    let api = APIClient.live(http: HTTPClient(fetchHandler: configuration.fetch))
+    let api = APIClient.live(http: HTTPClient(
+      logger: configuration.logger,
+      fetchHandler: configuration.fetch
+    ))
 
     self.init(
       configuration: configuration,
@@ -144,10 +147,7 @@ public actor AuthClient {
       api: api,
       eventEmitter: .live,
       sessionStorage: .live,
-      logger: SupabaseLogger(
-        system: "AuthClient",
-        configuration: configuration.loggingConfiguration
-      )
+      logger: configuration.logger
     )
   }
 
@@ -159,7 +159,7 @@ public actor AuthClient {
     api: APIClient,
     eventEmitter: EventEmitter,
     sessionStorage: SessionStorage,
-    logger: SupabaseLogger
+    logger: SupabaseLogger?
   ) {
     mfa = AuthMFA()
 
@@ -189,11 +189,11 @@ public actor AuthClient {
     session: Session?
   )> {
     let (id, stream) = eventEmitter.attachListener()
-    logger.debug("auth state change listener with id '\(id.uuidString)' attached.")
+    logger?.debug("auth state change listener with id '\(id.uuidString)' attached.")
 
     Task { [id] in
       await emitInitialSession(forStreamWithID: id)
-      logger.debug("initial session for listener with id '\(id.uuidString)' emitted.")
+      logger?.debug("initial session for listener with id '\(id.uuidString)' emitted.")
     }
 
     return stream

diff --git a/Sources/Auth/Internal/Dependencies.swift b/Sources/Auth/Internal/Dependencies.swift
@@ -13,5 +13,5 @@ struct Dependencies: Sendable {
   var sessionRefresher: SessionRefresher
   var codeVerifierStorage: CodeVerifierStorage
   var currentDate: @Sendable () -> Date = { Date() }
-  var logger: SupabaseLogger
+  var logger: SupabaseLogger?
 }
diff --git a/Sources/PostgREST/PostgrestBuilder.swift b/Sources/PostgREST/PostgrestBuilder.swift
@@ -26,7 +26,7 @@ public class PostgrestBuilder: @unchecked Sendable {
     request: Request
   ) {
     self.configuration = configuration
-    http = HTTPClient(fetchHandler: configuration.fetch)
+    http = HTTPClient(logger: configuration.logger, fetchHandler: configuration.fetch)
 
     mutableState = LockIsolated(
       MutableState(
@@ -74,7 +74,7 @@ public class PostgrestBuilder: @unchecked Sendable {
       do {
         return try configuration.decoder.decode(T.self, from: data)
       } catch {
-        configuration.logger.error("Fail to decode type '\(T.self) with error: \(error)")
+        configuration.logger?.error("Fail to decode type '\(T.self) with error: \(error)")
         throw error
       }
     }

diff --git a/Sources/PostgREST/PostgrestClient.swift b/Sources/PostgREST/PostgrestClient.swift
@@ -20,34 +20,33 @@ public actor PostgrestClient {
     public var encoder: JSONEncoder
     public var decoder: JSONDecoder
 
-    let logger: SupabaseLogger
+    let logger: SupabaseLogger?
 
     /// Initializes a new configuration for the PostgREST client.
     /// - Parameters:
     ///   - url: The URL of the PostgREST server.
     ///   - schema: The schema to use.
     ///   - headers: The headers to include in requests.
-    ///   - loggingConfiguration: The configuration used for the internal logger.
+    ///   - logger: The logger to use.
     ///   - fetch: The fetch handler to use for requests.
     ///   - encoder: The JSONEncoder to use for encoding.
     ///   - decoder: The JSONDecoder to use for decoding.
     public init(
       url: URL,
       schema: String? = nil,
       headers: [String: String] = [:],
-      loggingConfiguration: SupabaseLoggingConfiguration = SupabaseLoggingConfiguration(),
+      logger: SupabaseLogger? = nil,
       fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) },
       encoder: JSONEncoder = PostgrestClient.Configuration.jsonEncoder,
       decoder: JSONDecoder = PostgrestClient.Configuration.jsonDecoder
     ) {
       self.url = url
       self.schema = schema
       self.headers = headers
+      self.logger = logger
       self.fetch = fetch
       self.encoder = encoder
       self.decoder = decoder
-
-      logger = SupabaseLogger(system: "Postgrest", configuration: loggingConfiguration)
     }
   }
 
@@ -66,15 +65,15 @@ public actor PostgrestClient {
   ///   - url: The URL of the PostgREST server.
   ///   - schema: The schema to use.
   ///   - headers: The headers to include in requests.
-  ///   - loggingConfiguration: The configuration used for the internal logger.
+  ///   - logger: The logger to use.
   ///   - session: The URLSession to use for requests.
   ///   - encoder: The JSONEncoder to use for encoding.
   ///   - decoder: The JSONDecoder to use for decoding.
   public init(
     url: URL,
     schema: String? = nil,
     headers: [String: String] = [:],
-    loggingConfiguration: SupabaseLoggingConfiguration = SupabaseLoggingConfiguration(),
+    logger: SupabaseLogger? = nil,
     fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) },
     encoder: JSONEncoder = PostgrestClient.Configuration.jsonEncoder,
     decoder: JSONDecoder = PostgrestClient.Configuration.jsonDecoder
@@ -84,7 +83,7 @@ public actor PostgrestClient {
         url: url,
         schema: schema,
         headers: headers,
-        loggingConfiguration: loggingConfiguration,
+        logger: logger,
         fetch: fetch,
         encoder: encoder,
         decoder: decoder

diff --git a/Sources/Realtime/RealtimeClient.swift b/Sources/Realtime/RealtimeClient.swift
@@ -186,14 +186,16 @@ public class RealtimeClient: PhoenixTransportDelegate {
     _ endPoint: String,
     headers: [String: String] = [:],
     params: Payload? = nil,
-    vsn: String = Defaults.vsn
+    vsn: String = Defaults.vsn,
+    logger: SupabaseLogger? = nil
   ) {
     self.init(
       endPoint: endPoint,
       headers: headers,
       transport: { url in URLSessionTransport(url: url) },
       paramsClosure: { params },
-      vsn: vsn
+      vsn: vsn,
+      logger: logger
     )
   }
 
@@ -202,14 +204,16 @@ public class RealtimeClient: PhoenixTransportDelegate {
     _ endPoint: String,
     headers: [String: String] = [:],
     paramsClosure: PayloadClosure?,
-    vsn: String = Defaults.vsn
+    vsn: String = Defaults.vsn,
+    logger: SupabaseLogger? = nil
   ) {
     self.init(
       endPoint: endPoint,
       headers: headers,
       transport: { url in URLSessionTransport(url: url) },
       paramsClosure: paramsClosure,
-      vsn: vsn
+      vsn: vsn,
+      logger: logger
     )
   }
 
@@ -218,7 +222,8 @@ public class RealtimeClient: PhoenixTransportDelegate {
     headers: [String: String] = [:],
     transport: @escaping ((URL) -> PhoenixTransport),
     paramsClosure: PayloadClosure? = nil,
-    vsn: String = Defaults.vsn
+    vsn: String = Defaults.vsn,
+    logger: SupabaseLogger? = nil
   ) {
     self.transport = transport
     self.paramsClosure = paramsClosure
@@ -230,7 +235,7 @@ public class RealtimeClient: PhoenixTransportDelegate {
       headers["X-Client-Info"] = "realtime-swift/\(version)"
     }
     self.headers = headers
-    http = HTTPClient(fetchHandler: { try await URLSession.shared.data(for: $0) })
+    http = HTTPClient(logger: logger, fetchHandler: { try await URLSession.shared.data(for: $0) })
 
     let params = paramsClosure?()
     if let jwt = (params?["Authorization"] as? String)?.split(separator: " ").last {

diff --git a/Sources/Storage/StorageApi.swift b/Sources/Storage/StorageApi.swift
@@ -16,7 +16,7 @@ public class StorageApi: @unchecked Sendable {
       configuration.headers["X-Client-Info"] = "storage-swift/\(version)"
     }
     self.configuration = configuration
-    http = HTTPClient(fetchHandler: configuration.session.fetch)
+    http = HTTPClient(logger: configuration.logger, fetchHandler: configuration.session.fetch)
   }
 
   @discardableResult

diff --git a/Sources/Storage/SupabaseStorage.swift b/Sources/Storage/SupabaseStorage.swift
@@ -1,3 +1,4 @@
+import _Helpers
 import Foundation
 
 public struct StorageClientConfiguration {
@@ -6,19 +7,22 @@ public struct StorageClientConfiguration {
   public let encoder: JSONEncoder
   public let decoder: JSONDecoder
   public let session: StorageHTTPSession
+  public let logger: SupabaseLogger?
 
   public init(
     url: URL,
     headers: [String: String],
     encoder: JSONEncoder = .defaultStorageEncoder,
     decoder: JSONDecoder = .defaultStorageDecoder,
-    session: StorageHTTPSession = .init()
+    session: StorageHTTPSession = .init(),
+    logger: SupabaseLogger? = nil
   ) {
     self.url = url
     self.headers = headers
     self.encoder = encoder
     self.decoder = decoder
     self.session = session
+    self.logger = logger
   }
 }