chore(docs): cleanup SlackClone example (#559)

grdsdev · web-flow · commit 45273e5325f5 · 2024-10-10T00:36:54.000+09:00
* chore(docs): cleanup SlackClone example

fix(realtime): allow to nullify access token

fix(realtime): deprecate `updateAuth` from channel
diff --git a/Examples/SlackClone/AppView.swift b/Examples/SlackClone/AppView.swift
@@ -5,6 +5,7 @@
 //  Created by Guilherme Souza on 27/12/23.
 //
 
+import OSLog
 import Supabase
 import SwiftUI
 
@@ -17,58 +18,42 @@ final class AppViewModel {
   var realtimeConnectionStatus: RealtimeClientV2.Status?
 
   init() {
-    Task { [weak self] in
-      for await (event, session) in await supabase.auth.authStateChanges {
-        guard [.signedIn, .signedOut, .initialSession].contains(event) else { return }
-        self?.session = session
+    Task {
+      for await (event, session) in supabase.auth.authStateChanges {
+        Logger.main.debug("AuthStateChange: \(event.rawValue)")
+        guard [.signedIn, .signedOut, .initialSession, .tokenRefreshed].contains(event) else { return }
+        self.session = session
 
         if session == nil {
-          for subscription in await supabase.realtimeV2.subscriptions.values {
+          for subscription in supabase.channels {
             await subscription.unsubscribe()
           }
         }
       }
     }
 
     Task {
-      for await status in await supabase.realtimeV2.statusChange {
+      for await status in supabase.realtimeV2.statusChange {
         realtimeConnectionStatus = status
       }
     }
   }
 }
 
-@MainActor
 struct AppView: View {
   @Bindable var model: AppViewModel
-  let log = LogStore.shared
-
   @State var logPresented = false
 
   @ViewBuilder
   var body: some View {
     if model.session != nil {
       NavigationSplitView {
         ChannelListView(channel: $model.selectedChannel)
-          .toolbar {
-            ToolbarItem {
-              Button("Log") {
-                logPresented = true
-              }
-            }
-          }
       } detail: {
         if let channel = model.selectedChannel {
           MessagesView(channel: channel).id(channel.id)
         }
       }
-      .sheet(isPresented: $logPresented) {
-        List {
-          ForEach(0 ..< log.messages.count, id: \.self) { i in
-            Text(log.messages[i].description)
-          }
-        }
-      }
     } else {
       AuthView()
     }
diff --git a/Examples/SlackClone/AuthView.swift b/Examples/SlackClone/AuthView.swift
@@ -31,7 +31,6 @@ final class AuthViewModel {
   }
 }
 
-@MainActor
 struct AuthView: View {
   @Bindable var model = AuthViewModel()
 
diff --git a/Examples/SlackClone/ChannelListView.swift b/Examples/SlackClone/ChannelListView.swift
@@ -7,7 +7,6 @@
 
 import SwiftUI
 
-@MainActor
 struct ChannelListView: View {
   @Bindable var store = Dependencies.shared.channel
   @Binding var channel: Channel?
diff --git a/Examples/SlackClone/ChannelStore.swift b/Examples/SlackClone/ChannelStore.swift
@@ -22,10 +22,10 @@ final class ChannelStore {
     Task {
       channels = await fetchChannels()
 
-      let channel = await supabase.realtimeV2.channel("public:channels")
+      let channel = supabase.channel("public:channels")
 
-      let insertions = await channel.postgresChange(InsertAction.self, table: "channels")
-      let deletions = await channel.postgresChange(DeleteAction.self, table: "channels")
+      let insertions = channel.postgresChange(InsertAction.self, table: "channels")
+      let deletions = channel.postgresChange(DeleteAction.self, table: "channels")
 
       await channel.subscribe()
 
@@ -47,7 +47,7 @@ final class ChannelStore {
     do {
       let userId = try await supabase.auth.session.user.id
       let channel = AddChannel(slug: name, createdBy: userId)
-      try await supabase.database
+      try await supabase
         .from("channels")
         .insert(channel)
         .execute()
@@ -62,7 +62,7 @@ final class ChannelStore {
       return channel
     }
 
-    let channel: Channel = try await supabase.database
+    let channel: Channel = try await supabase
       .from("channels")
       .select()
       .eq("id", value: id)
@@ -90,7 +90,7 @@ final class ChannelStore {
 
   private func fetchChannels() async -> [Channel] {
     do {
-      return try await supabase.database.from("channels").select().execute().value
+      return try await supabase.from("channels").select().execute().value
     } catch {
       dump(error)
       toast = .init(status: .error, title: "Error", description: error.localizedDescription)
diff --git a/Examples/SlackClone/Dependencies.swift b/Examples/SlackClone/Dependencies.swift
@@ -8,6 +8,7 @@
 import Foundation
 import Supabase
 
+@MainActor
 class Dependencies {
   static let shared = Dependencies()
 
diff --git a/Examples/SlackClone/Logger.swift b/Examples/SlackClone/Logger.swift
@@ -10,45 +10,19 @@ import OSLog
 import Supabase
 
 extension Logger {
-  static let main = Self(subsystem: "com.supabase.SlackClone", category: "app")
+  static let main = Self(subsystem: "com.supabase.slack-clone", category: "app")
+  static let supabase = Self(subsystem: "com.supabase.slack-clone", category: "supabase")
 }
 
-@Observable
-final class LogStore: SupabaseLogger {
-  private let lock = NSLock()
-  private var loggers: [String: Logger] = [:]
-
-  static let shared = LogStore()
-
-  @MainActor
-  var messages: [SupabaseLogMessage] = []
-
+struct SupaLogger: SupabaseLogger {
   func log(message: SupabaseLogMessage) {
-    Task {
-      await add(message: message)
-    }
+    let logger = Logger.supabase
 
-    lock.withLock {
-      if loggers[message.system] == nil {
-        loggers[message.system] = Logger(
-          subsystem: "com.supabase.SlackClone.supabase-swift",
-          category: message.system
-        )
-      }
-
-      let logger = loggers[message.system]!
-
-      switch message.level {
-      case .debug: logger.debug("\(message, privacy: .public)")
-      case .error: logger.error("\(message, privacy: .public)")
-      case .verbose: logger.info("\(message, privacy: .public)")
-      case .warning: logger.notice("\(message, privacy: .public)")
-      }
+    switch message.level {
+    case .debug: logger.debug("\(message, privacy: .public)")
+    case .error: logger.error("\(message, privacy: .public)")
+    case .verbose: logger.info("\(message, privacy: .public)")
+    case .warning: logger.notice("\(message, privacy: .public)")
     }
   }
-
-  @MainActor
-  private func add(message: SupabaseLogMessage) {
-    messages.insert(message, at: 0)
-  }
 }
diff --git a/Examples/SlackClone/MessageStore.swift b/Examples/SlackClone/MessageStore.swift
@@ -103,11 +103,11 @@ final class MessageStore {
 
   private init() {
     Task {
-      let channel = await supabase.realtimeV2.channel("public:messages")
+      let channel = supabase.channel("public:messages")
 
-      let insertions = await channel.postgresChange(InsertAction.self, table: "messages")
-      let updates = await channel.postgresChange(UpdateAction.self, table: "messages")
-      let deletions = await channel.postgresChange(DeleteAction.self, table: "messages")
+      let insertions = channel.postgresChange(InsertAction.self, table: "messages")
+      let updates = channel.postgresChange(UpdateAction.self, table: "messages")
+      let deletions = channel.postgresChange(DeleteAction.self, table: "messages")
 
       await channel.subscribe()
 
@@ -176,7 +176,7 @@ final class MessageStore {
 
   /// Fetch all messages and their authors.
   private func fetchMessages(_ channelId: Channel.ID) async throws -> [Message] {
-    try await supabase.database
+    try await supabase
       .from("messages")
       .select("*,user:user_id(*),channel:channel_id(*)")
       .eq("channel_id", value: channelId)
diff --git a/Examples/SlackClone/MessagesView.swift b/Examples/SlackClone/MessagesView.swift
@@ -9,7 +9,6 @@ import Realtime
 import Supabase
 import SwiftUI
 
-@MainActor
 struct MessagesView: View {
   let store = Dependencies.shared.messages
   let userStore = Dependencies.shared.users
@@ -74,7 +73,7 @@ struct MessagesView: View {
         channelId: channel.id
       )
 
-      try await supabase.database.from("messages").insert(message).execute()
+      try await supabase.from("messages").insert(message).execute()
       newMessage = ""
     } catch {
       dump(error)
diff --git a/Examples/SlackClone/Supabase.swift b/Examples/SlackClone/Supabase.swift
@@ -25,7 +25,7 @@ let supabase = SupabaseClient(
   supabaseKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0",
   options: SupabaseClientOptions(
     db: .init(encoder: encoder, decoder: decoder),
-    auth: .init(redirectToURL: URL(string: "com.supabase.slack-clone://")),
-    global: SupabaseClientOptions.GlobalOptions(logger: LogStore.shared)
+    auth: .init(redirectToURL: URL(string: "com.supabase.slack-clone://login-callback")),
+    global: SupabaseClientOptions.GlobalOptions(logger: SupaLogger())
   )
 )
diff --git a/Examples/SlackClone/UserStore.swift b/Examples/SlackClone/UserStore.swift
@@ -19,15 +19,15 @@ final class UserStore {
 
   private init() {
     Task {
-      let channel = await supabase.realtimeV2.channel("public:users")
-      let changes = await channel.postgresChange(AnyAction.self, table: "users")
+      let channel = supabase.channel("public:users")
+      let changes = channel.postgresChange(AnyAction.self, table: "users")
 
-      let presences = await channel.presenceChange()
+      let presences = channel.presenceChange()
 
       await channel.subscribe()
 
       Task {
-        let statusChange = await channel.statusChange
+        let statusChange = channel.statusChange
         for await _ in statusChange.filter({ $0 == .subscribed }) {
           let userId = try await supabase.auth.session.user.id
           try await channel.track(UserPresence(userId: userId, onlineAt: Date()))
@@ -45,15 +45,15 @@ final class UserStore {
           let joins = try presence.decodeJoins(as: UserPresence.self)
           let leaves = try presence.decodeLeaves(as: UserPresence.self)
 
-          for join in joins {
-            self.presences[join.userId] = join
-            Logger.main.debug("User \(join.userId) joined")
-          }
-
           for leave in leaves {
             self.presences[leave.userId] = nil
             Logger.main.debug("User \(leave.userId) leaved")
           }
+
+          for join in joins {
+            self.presences[join.userId] = join
+            Logger.main.debug("User \(join.userId) joined")
+          }
         }
       }
     }
@@ -64,7 +64,7 @@ final class UserStore {
       return user
     }
 
-    let user: User = try await supabase.database
+    let user: User = try await supabase
       .from("users")
       .select()
       .eq("id", value: id)
diff --git a/Examples/SlackClone/supabase/config.toml b/Examples/SlackClone/supabase/config.toml
@@ -71,7 +71,7 @@ enabled = true
 # in emails.
 site_url = "http://127.0.0.1:3000"
 # A list of *exact* URLs that auth providers are permitted to redirect to post authentication.
-additional_redirect_urls = ["https://127.0.0.1:3000", "com.supabase.slack-clone://"]
+additional_redirect_urls = ["https://127.0.0.1:3000", "com.supabase.slack-clone://*"]
 # How long tokens are valid for, in seconds. Defaults to 3600 (1 hour), maximum 604,800 (1 week).
 jwt_expiry = 3600
 # If disabled, the refresh token will never expire.
diff --git a/Sources/Realtime/V2/RealtimeChannelV2.swift b/Sources/Realtime/V2/RealtimeChannelV2.swift
diff --git a/Sources/Realtime/V2/RealtimeClientV2.swift b/Sources/Realtime/V2/RealtimeClientV2.swift
diff --git a/Sources/Realtime/V2/RealtimeJoinConfig.swift b/Sources/Realtime/V2/RealtimeJoinConfig.swift

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ final class AuthViewModel {`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`-@MainActor`
`35`	`34`	`struct AuthView: View {`
`36`	`35`	`@Bindable var model = AuthViewModel()`
`37`	`36`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ let supabase = SupabaseClient(`
`25`	`25`	`supabaseKey: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0",`
`26`	`26`	`options: SupabaseClientOptions(`
`27`	`27`	`db: .init(encoder: encoder, decoder: decoder),`
`28`		`- auth: .init(redirectToURL: URL(string: "com.supabase.slack-clone://")),`
`29`		`- global: SupabaseClientOptions.GlobalOptions(logger: LogStore.shared)`
	`28`	`+ auth: .init(redirectToURL: URL(string: "com.supabase.slack-clone://login-callback")),`
	`29`	`+ global: SupabaseClientOptions.GlobalOptions(logger: SupaLogger())`
`30`	`30`	`)`
`31`	`31`	`)`