fix: use private Realtime channel for .stream()#1324
Open
jeremiahseun wants to merge 2 commits intosupabase:mainfrom
Open
fix: use private Realtime channel for .stream()#1324jeremiahseun wants to merge 2 commits intosupabase:mainfrom
jeremiahseun wants to merge 2 commits intosupabase:mainfrom
Conversation
When public channels are disabled in a Supabase project ("Allow public access to channels" is false), attempting to use `.stream()` results in an Exception: "PrivateOnly: This project only allows private channels". This happens because `.stream()` creates a Realtime channel without specifying it as private. By explicitly configuring the `RealtimeChannelConfig` with `private: true`, `.stream()` bypasses this restriction and instead relies on Row Level Security (RLS) policies, effectively allowing users to track Postgres changes on tables with private realtime channel settings.
When public channels are disabled in a Supabase project ("Allow public access to channels" is false), attempting to use `.stream()` results in an Exception: "PrivateOnly: This project only allows private channels". This happens because `.stream()` creates a Realtime channel without specifying it as private. By explicitly configuring the `RealtimeChannelConfig` with `private: true`, `.stream()` bypasses this restriction and instead relies on Row Level Security (RLS) policies, effectively allowing users to track Postgres changes on tables with private realtime channel settings.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What kind of change does this PR introduce?
Bug fix.
What is the current behavior?
When public channels are disabled in a Supabase project ("Allow public access to channels" is false), attempting to use
.stream()results in an Exception: "PrivateOnly: This project only allows private channels". This happens because.stream()creates a Realtime channel without specifying it as private. By explicitly configuring theRealtimeChannelConfigwithprivate: true,.stream()bypasses this restriction and instead relies on Row Level Security (RLS) policies, effectively allowing users to track Postgres changes on tables with private realtime channel settings.What is the new behavior?
Fixes an issue where
supabase.from('table').stream(...)throws aRealtimeSubscribeException("PrivateOnly: This project only allows private channels") when the "Allow public access to channels" setting is disabled in the Supabase project.This changes
_realtimeClient.channel(...)insideSupabaseStreamBuilderto useRealtimeChannelConfig(private: true), ensuring the stream function respects table RLS policies and successfully connects even if public channels are disabled.Additional context
This resolves #1311