feat(realtime): lean livekit_join with passthrough flag #37
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| import Foundation | ||
|
|
||
| private struct InitialStateRequest: Sendable { | ||
| let message: OutgoingWebSocketMessage | ||
| let ackTarget: InitialStateAckTarget | ||
| } | ||
|
|
||
|
|
@@ -61,6 +61,7 @@ public final class DecartRealtimeManager: @unchecked Sendable { | |
| private var mediaConnectionStateTask: Task<Void, Never>? | ||
| private var mediaDisconnectTask: Task<Void, Never>? | ||
| private var connectionQualityTask: Task<Void, Never>? | ||
| private var initialStateAckTask: Task<Void, Never>? | ||
| private var reconnectTask: Task<Void, Never>? | ||
| private let initialStateAckTimeout: TimeInterval = 30 | ||
| private let promptAckTimeout: TimeInterval = 15 | ||
|
|
@@ -152,6 +153,7 @@ public final class DecartRealtimeManager: @unchecked Sendable { | |
| mediaConnectionStateTask?.cancel() | ||
| mediaDisconnectTask?.cancel() | ||
| connectionQualityTask?.cancel() | ||
| initialStateAckTask?.cancel() | ||
| reconnectTask?.cancel() | ||
| let liveKitMediaChannel = liveKitMediaChannel | ||
| let webSocketClient = webSocketClient | ||
|
|
@@ -289,10 +291,12 @@ private extension DecartRealtimeManager { | |
| } | ||
|
|
||
| let initialStateRequest = buildInitialStateRequest() | ||
|
|
||
| // Buffer any ack that lands before the out-of-band observer starts. | ||
| isWaitingForInitialStateAck = true | ||
| try await sendMessageThrowing(.liveKitJoin(passthrough: isPassthrough)) | ||
| try await sendMessageThrowing(initialStateRequest.message) | ||
|
|
||
| let roomInfo = try await waitForLiveKitRoomInfo(timeout: options.connection.connectionTimeout) | ||
|
|
||
| let mediaChannel = LiveKitMediaChannel( | ||
|
|
@@ -304,20 +308,11 @@ private extension DecartRealtimeManager { | |
| liveKitMediaChannel = mediaChannel | ||
| setupMediaListeners(mediaChannel) | ||
|
|
||
| // Watch the ack off the critical path: arm its timeout now that room_info | ||
| // arrived (a long queue wait can't trip it) and let it run concurrently | ||
| // with room connect + publish, surfacing an error only on rejection. | ||
| observeInitialStateAck(initialStateRequest) | ||
| try await mediaChannel.connect(roomInfo: roomInfo) | ||
| try await mediaChannel.publishLocalTracks(from: localStream) | ||
| return mediaChannel.currentRemoteStream | ||
| } | ||
|
|
@@ -327,6 +322,9 @@ private extension DecartRealtimeManager { | |
| // fail runtime waiters here. | ||
| failAllPendingRuntimeWaiters(DecartError.websocketError("WebSocket disconnected")) | ||
| clearPendingInitialState() | ||
| initialStateAckTask?.cancel() | ||
| initialStateAckTask = nil | ||
| isWaitingForInitialStateAck = false | ||
| webSocketListenerTask?.cancel() | ||
| webSocketListenerTask = nil | ||
| mediaListenerTask?.cancel() | ||
|
|
@@ -513,87 +511,80 @@ private extension DecartRealtimeManager { | |
| // MARK: - Messaging | ||
|
|
||
| private extension DecartRealtimeManager { | ||
| private func sendMessageThrowing(_ message: OutgoingWebSocketMessage) async throws { | ||
| guard let webSocketClient else { | ||
| throw DecartError.websocketError("WebSocket not connected") | ||
| } | ||
| try await webSocketClient.send(message) | ||
| } | ||
|
|
||
| // `false` when the user set a real image/prompt (one real frame follows), | ||
| // `true` otherwise (a null-bootstrap frame follows). Session config may override. | ||
| var isPassthrough: Bool { | ||
| if let override = options.connection.passthrough { return override } | ||
| let initialPrompt = options.initialPrompt | ||
| let hasImage = options.model.hasReferenceImage && initialPrompt.referenceImageData != nil | ||
| return !(hasImage || !initialPrompt.text.isEmpty) | ||
| } | ||
|
|
||
| func buildInitialStateRequest() -> InitialStateRequest { | ||
| let initialPrompt = options.initialPrompt | ||
| if options.model.hasReferenceImage, | ||
| let base64Image = initialPrompt.referenceImageData?.base64EncodedString() | ||
| { | ||
| return InitialStateRequest( | ||
| message: .setImage(SetImageMessage( | ||
| imageData: base64Image, | ||
| prompt: initialPrompt.text, | ||
| enhancePrompt: initialPrompt.enrich | ||
| )), | ||
| ackTarget: .setImage( | ||
| failureMessage: "Failed to set initial image", | ||
| timeoutMessage: "Initial image acknowledgment timed out" | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| if !initialPrompt.text.isEmpty { | ||
| return InitialStateRequest( | ||
| message: .prompt(PromptMessage(prompt: initialPrompt.text, enhancePrompt: initialPrompt.enrich)), | ||
| ackTarget: .prompt(initialPrompt.text) | ||
| ) | ||
| } | ||
|
|
||
| return InitialStateRequest( | ||
| message: .setImage(.passthrough()), | ||
| ackTarget: .setImage( | ||
| failureMessage: "Failed to apply initial passthrough state", | ||
| timeoutMessage: "Initial passthrough acknowledgment timed out" | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| func observeInitialStateAck(_ request: InitialStateRequest) { | ||
| initialStateAckTask?.cancel() | ||
| initialStateAckTask = Task { [weak self] in | ||
| guard let self else { return } | ||
| defer { | ||
| self.isWaitingForInitialStateAck = false | ||
| self.clearPendingInitialState() | ||
| } | ||
| do { | ||
| switch request.ackTarget { | ||
| case .prompt(let prompt): | ||
| try await self.waitForPromptAck(prompt: prompt, timeout: self.initialStateAckTimeout) | ||
| case .setImage(let failureMessage, let timeoutMessage): | ||
| try await self.waitForSetImageAck( | ||
| timeout: self.initialStateAckTimeout, | ||
| failureMessage: failureMessage, | ||
| timeoutMessage: timeoutMessage | ||
| ) | ||
| } | ||
| } catch is CancellationError { | ||
| return | ||
| } catch { | ||
| DecartLogger.log("Initial-state acknowledgment failed: \(error.localizedDescription)", level: .error) | ||
| } | ||
|
There was a problem hiding this comment. Initial ack timeout marks errorMedium Severity The out-of-band initial-state observer reuses Additional Locations (1)  Reviewed by Cursor Bugbot for commit e232327. Configure here. |
||
| } | ||
| } | ||
|
|
||
|
|
@@ -623,77 +614,6 @@ private extension DecartRealtimeManager { | |
| } | ||
| } | ||
|
|
||
| func waitForPromptAck(prompt: String, timeout: TimeInterval) async throws { | ||
| let startTime = Date() | ||
| while true { | ||
|
|
@@ -982,6 +902,7 @@ extension DecartRealtimeManager { | |
| internal func test_setConnectionState(_ state: DecartRealtimeConnectionState) { | ||
| connectionState = state | ||
| } | ||
| internal var test_isPassthrough: Bool { isPassthrough } | ||
| internal var test_hasPendingInitialStateAck: Bool { | ||
| !pendingPromptAcks.isEmpty || !pendingSetImageAcks.isEmpty || pendingInitialStateError != nil | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Runtime prompts lose acks after connect
High Severity
connectcan finish whileisWaitingForInitialStateAckis still true. AnysetPrompt/setImagein that window routes acks into the initial-state buffer; when the observer completes,clearPendingInitialState()drops unmatched acks, so runtime waiters time out or hang even though the server responded.Additional Locations (2)
Sources/DecartSDK/Realtime/DecartRealtimeManager.swift#L685-L690Sources/DecartSDK/Realtime/DecartRealtimeManager.swift#L567-L571Reviewed by Cursor Bugbot for commit e232327. Configure here.