fix(realtime): make Apikey required #760
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR makes the API key required for the Realtime client, fixing a bug where the client could be initialized without an API key. The change ensures proper authentication by enforcing API key presence during client initialization.
- Enforced API key requirement during RealtimeClientV2 initialization with a precondition check
- Updated method calls from deprecated
subscribe()tosubscribeWithError()throughout the codebase - Modified test configurations to include required API key headers
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Sources/Realtime/RealtimeClientV2.swift | Made apikey property non-optional and added precondition to enforce API key requirement |
| Sources/Realtime/RealtimeChannelV2.swift | Updated channel resubscription to use subscribeWithError() method |
| Tests/RealtimeTests/RealtimeChannelTests.swift | Updated test configuration to include required API key and modernized subscription method calls |
grdsdev
commented
Aug 5, 2025
| @@ -499,7 +499,7 @@ public final class RealtimeChannelV2: Sendable, RealtimeChannelProtocol { | |||
| ) | |||
| Task { | |||
| await unsubscribe() | |||
| await subscribe() | |||
| try? await subscribeWithError() | |||
There was a problem hiding this comment.
unrelated change, but it just fixes a deprecation warning
filipecabaco
approved these changes
Aug 5, 2025
grdsdev
deleted the
guilherme/clibs-246-make-api-key-mandatory-in-supabase-swift-realtime-client
branch
|
🎉 This PR is included in version 2.31.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
Realtime client can be initialized without an apikey
What is the new behavior?
Realtime client now requires apikey to be present
Additional context
supabase/realtime-js#502