Skip to content

fix(realtime): make Push associated to MainActor #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 28, 2025
Merged

fix(realtime): make Push associated to MainActor #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
469d805
fix(realtime): make Push associated to MainActor
grdsdev May 1, 2025
74ede04
code format
grdsdev May 28, 2025
479680b
skip test in Linux
grdsdev May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Sources/Realtime/PushV2.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ public enum PushStatus: String, Sendable {
case timeout
}

actor PushV2 {
@MainActor
final class PushV2 {
private weak var channel: RealtimeChannelV2?
let message: RealtimeMessageV2

Expand Down
47 changes: 23 additions & 24 deletions Sources/Realtime/RealtimeChannelV2.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@
var pushes: [String: PushV2] = [:]
}

private let mutableState = LockIsolated(MutableState())
@MainActor
private var mutableState = MutableState()

Check warning on line 36 in Sources/Realtime/RealtimeChannelV2.swift

View workflow job for this annotation

GitHub Actions / xcodebuild (15) (IOS, 15.2) 

stored property 'mutableState' of 'Sendable'-conforming class 'RealtimeChannelV2' is mutable

Check warning on line 36 in Sources/Realtime/RealtimeChannelV2.swift

View workflow job for this annotation

GitHub Actions / xcodebuild (15) (MACOS, 15.2) 

stored property 'mutableState' of 'Sendable'-conforming class 'RealtimeChannelV2' is mutable

let topic: String
let config: RealtimeChannelConfig
let logger: (any SupabaseLogger)?
let socket: RealtimeClientV2
var joinRef: String? { mutableState.joinRef }

@MainActor var joinRef: String? { mutableState.joinRef }

let callbackManager = CallbackManager()
private let statusSubject = AsyncValueSubject<RealtimeChannelStatus>(.unsubscribed)
Expand Down Expand Up @@ -81,6 +83,7 @@
}

/// Subscribes to the channel
@MainActor
Copy link
Contributor Author

@grdsdev grdsdev May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't a breaking change since the method is async, the call site already have to call this method with an await independent of the running actor.

public func subscribe() async {
if socket.status != .connected {
if socket.options.connectOnSubscribe != true {
Expand Down Expand Up @@ -109,7 +112,7 @@
)

let joinRef = socket.makeRef()
mutableState.withValue { $0.joinRef = joinRef }
mutableState.joinRef = joinRef

logger?.debug("Subscribing to channel with body: \(joinConfig)")

Expand Down Expand Up @@ -497,8 +500,8 @@
filter: filter
)

mutableState.withValue {
$0.clientChanges.append(config)
Task { @MainActor in
mutableState.clientChanges.append(config)
}
Comment on lines +503 to 505
Copy link

Copilot AI May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the enclosing context is already on the MainActor, consider appending directly to mutableState.clientChanges instead of dispatching via a Task, to simplify execution and ensure immediate consistency.

Suggested change
Task { @MainActor in
mutableState.clientChanges.append(config)
}
mutableState.clientChanges.append(config)

Copilot uses AI. Check for mistakes.

let id = callbackManager.addPostgresCallback(filter: config, callback: callback)
Expand Down Expand Up @@ -538,32 +541,28 @@
self.onSystem { _ in callback() }
}

@MainActor
@discardableResult
func push(_ event: String, ref: String? = nil, payload: JSONObject = [:]) async -> PushStatus {
let push = mutableState.withValue {
let message = RealtimeMessageV2(
joinRef: $0.joinRef,
ref: ref ?? socket.makeRef(),
topic: self.topic,
event: event,
payload: payload
)

let push = PushV2(channel: self, message: message)
if let ref = message.ref {
$0.pushes[ref] = push
}
let message = RealtimeMessageV2(
joinRef: joinRef,
ref: ref ?? socket.makeRef(),
topic: self.topic,
event: event,
payload: payload
)

return push
let push = PushV2(channel: self, message: message)
if let ref = message.ref {
mutableState.pushes[ref] = push
}

return await push.send()
}

private func didReceiveReply(ref: String, status: String) async {
let push = mutableState.withValue {
$0.pushes.removeValue(forKey: ref)
}
await push?.didReceive(status: PushStatus(rawValue: status) ?? .ok)
@MainActor
private func didReceiveReply(ref: String, status: String) {
let push = mutableState.pushes.removeValue(forKey: ref)
push?.didReceive(status: PushStatus(rawValue: status) ?? .ok)
}
}
Loading
Loading