Repository navigation
feat(realtime): service worker support and FCM fallback for device tokens - #12
Merged
Merged
Conversation
…kens
- deviceToken({ serviceWorker }) accepts a ServiceWorkerRegistration or a
script URL; a URL is registered with the Firebase web config passed as the
firebaseConfig query parameter, so a static worker can initialize Firebase.
- Returns null where web push is unsupported instead of throwing.
- RealtimeClient.deviceToken() falls back to the firebase config when the
streaming transport cannot issue tokens (push over FCM, stream over Pusher
or polling). requestDeviceToken() issues a token without a client.
- Document browser push registration with a ready-to-use service worker.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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
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.
Summary
Makes
RealtimeClient.deviceToken()usable for browser push in real apps.deviceToken({ serviceWorker })accepts aServiceWorkerRegistrationor a script URL. A URL is registered with the Firebase web config passed as thefirebaseConfigquery parameter, so a static worker file can initialize Firebase with no build step or secrets. Without the option, Firebase's default/firebase-messaging-sw.jslookup still applies.nullwhere web push is unavailable (viaisSupported()) instead of throwing.deviceToken()uses the client'sfirebaseconfig. This covers notifications streamed over Pusher or polling and pushed over FCM; the server'sBroadcast.clientConfig()already includes that config whendrivers.realtime.pushis'firebase'.requestDeviceToken(firebaseConfig, options)issues a token without a realtime client.push-sw.js. It shows the notification, honors retractions, and opens the notification's link on click.Test plan
nullwhere push is unsupported;firebaseconfig;nullwhen nothing can issue a token.pnpm lint,pnpm build,pnpm docs:build, realtimetsc --noEmitvitest run: 576 passed, 5 skipped