-
Notifications
You must be signed in to change notification settings - Fork 9
feat(realtime): add postgres_changes_wait capability #106
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.
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
grdsdev
wants to merge
2
commits into
main
Choose a base branch
from
guilherme/sdk-1650-realtime-postgres-changes-wait
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+34
−10
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
21 changes: 21 additions & 0 deletions
21
packages/capability-matrix/specs/realtime/subscriptions/postgres_changes_wait.md
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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Wait for Postgres Changes Confirmation | ||
|
|
||
| ## Behavior | ||
|
|
||
| By default, a channel is reported as successfully subscribed as soon as it joins the topic on the server, before the server has necessarily started streaming Postgres change events for that subscription. This creates a race: if replication for the subscription isn't active yet when the client starts treating the channel as ready, changes emitted in that gap can be missed. | ||
|
|
||
| Setting `postgres_changes_options.wait` to `true` on the channel config defers reporting a successful subscription until the server sends an explicit confirmation that the postgres_changes subscription is active and streaming. `postgres_changes_options.timeout` controls how long to wait for that confirmation, in milliseconds (default `15000`). Without `wait: true`, a successful subscription is reported on channel join regardless of postgres_changes streaming state — the default behavior is unchanged for callers who don't opt in. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Only meaningful on a channel with a `postgres_changes` binding; has no effect on channels without one. Requires a Realtime server version that sends the subscription-active confirmation message. | ||
|
|
||
| ## Errors | ||
|
|
||
| - subscription not confirmed — the server responds with `wait` enabled but the subscription cannot be confirmed active (e.g. replication setup failure); the subscribe outcome carries the server's reason instead of a false success | ||
| - timeout — the server does not confirm within `postgres_changes_options.timeout` milliseconds | ||
|
|
||
| ## Related | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the GitHub renderer these links don't work... is there tooling downstream that comprehends them? They're nominally relative in nature but when that's interpreted for this markdown document then they're clearly invalid. 😕 |
||
|
|
||
| - [Subscribe to Postgres Changes](realtime.subscriptions.postgres_changes) — the underlying subscription this option confirms | ||
| - [Subscribe](realtime.channel.subscribe) — the join call whose success is delayed by this option | ||
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.
Perhaps including that server version here might be useful.