Async room id (#296)

Sources/LiveKit/Core/Room.swift

@@ -30,9 +30,17 @@ public class Room: NSObject, ObservableObject, Loggable {
 
     @objc
     /// Server assigned id of the Room.
-    /// This will be empty until ``RoomDelegate/room(_:didUpdateRoomId:)`` is called.
     public var sid: Sid? { _state.sid }
 
+    // Work-around error: Property with 'throws' or 'async' is not representable in Objective-C
+    /// Server assigned id of the Room. **async** version of ``Room/sid``.
+    /// Example: `let sid = try await room.asyncSid`
+    public var asyncSid: Sid {
+        get async throws {
+            try await _sidCompleter.wait()
+        }
+    }
+
     @objc
     public var name: String? { _state.name }
 
@@ -132,6 +140,8 @@ public class Room: NSObject, ObservableObject, Loggable {
 
     var _state: StateSync<State>
 
+    private let _sidCompleter = AsyncCompleter<Sid>(label: "sid", timeOut: .sid)
+
     // MARK: Objective-C Support
 
     @objc
@@ -172,11 +182,10 @@ public class Room: NSObject, ObservableObject, Loggable {
 
             guard let self else { return }
 
-            // roomId updated
-            if let roomId = newState.sid, roomId != oldState.sid {
-                self.delegates.notify(label: { "room.didUpdateRoomId:" }) {
-                    $0.room?(self, didUpdateRoomId: roomId)
-                }
+            // sid updated
+            if let sid = newState.sid, sid != oldState.sid {
+                // Resolve sid
+                self._sidCompleter.resume(returning: sid)
             }
 
             // metadata updated
@@ -299,6 +308,9 @@ extension Room {
         await cleanUpParticipants()
         // Reset state
         _state.mutate { $0 = State(options: $0.options) }
+
+        // Reset completers
+        _sidCompleter.reset()
     }
 }
 

Sources/LiveKit/Extensions/TimeInterval.swift

@@ -34,4 +34,6 @@ public extension DispatchTimeInterval {
     static let defaultTransportState: Self = .seconds(10)
     // used for validation mode
     static let defaultPublisherDataChannelOpen: Self = .seconds(7)
+
+    static let sid: Self = .seconds(7 + 5) // Join response + 5
 }

Sources/LiveKit/Protocols/RoomDelegate.swift

@@ -61,10 +61,6 @@ public protocol RoomDelegate: AnyObject {
 
     // MARK: - Room State Updates
 
-    /// ``Room/sid`` has updated.
-    @objc optional
-    func room(_ room: Room, didUpdateRoomId roomId: String)
-
     /// ``Room/metadata`` has updated.
     @objc optional
     func room(_ room: Room, didUpdateMetadata metadata: String?)