Skip to content

fix(realtime): wait for postgres_changes system ready before emitting SUBSCRIBED #2029

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

Open
7ttp wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(realtime): wait for postgres_changes system ready before emitting SUBSCRIBED #2029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
279f37e
fix(realtime): wait for backend ready before emitting SUBSCRIBED status
7ttp Jan 17, 2026
17add66
chore(realtime): fix ci
7ttp Jan 17, 2026
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
24 changes: 23 additions & 1 deletion packages/core/realtime-js/src/RealtimeChannel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,9 @@ export default class RealtimeChannel {
broadcastEndpointURL: string
subTopic: string
private: boolean
private _subscribeCallback: ((status: REALTIME_SUBSCRIBE_STATES, err?: Error) => void) | null =
null
private _pendingSystemReady: Set<string> = new Set()

/**
* Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.
Expand Down Expand Up @@ -352,7 +355,12 @@ export default class RealtimeChannel {

this.bindings.postgres_changes = newPostgresBindings

callback && callback(REALTIME_SUBSCRIBE_STATES.SUBSCRIBED)
if (bindingsLen > 0) {
this._subscribeCallback = callback || null
this._pendingSystemReady.add('postgres_changes')
} else {
callback?.(REALTIME_SUBSCRIBE_STATES.SUBSCRIBED)
}
return
}
})
Expand Down Expand Up @@ -819,6 +827,14 @@ export default class RealtimeChannel {
return this.joinPush.ref
}

/** @internal */
_maybeEmitSubscribed(): void {
if (this._pendingSystemReady.size === 0 && this._subscribeCallback) {
this._subscribeCallback(REALTIME_SUBSCRIBE_STATES.SUBSCRIBED)
this._subscribeCallback = null
}
}

/** @internal */
_trigger(type: string, payload?: any, ref?: string) {
const typeLower = type.toLocaleLowerCase()
Expand All @@ -827,6 +843,12 @@ export default class RealtimeChannel {
if (ref && events.indexOf(typeLower) >= 0 && ref !== this._joinRef()) {
return
}

if (typeLower === 'system' && payload?.extension && payload?.status === 'ok') {
Comment thread
7ttp marked this conversation as resolved.
this._pendingSystemReady.delete(payload.extension)
this._maybeEmitSubscribed()
}

let handledPayload = this._onMessage(typeLower, payload, ref)
if (payload && !handledPayload) {
throw 'channel onMessage callbacks must return the payload, modified or unmodified'
Expand Down
2 changes: 2 additions & 0 deletions packages/core/realtime-js/test/RealtimeChannel.lifecycle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,8 @@ describe('Channel Lifecycle Management', () => {
},
})

channel._trigger('system', { extension: 'postgres_changes', status: 'ok' })

expect(spy).toHaveBeenCalledTimes(1)
expect(spy).toHaveBeenCalledWith({
topic: 'realtime:topic',
Expand Down
Loading