[Fix] Service Worker race condition, when a 2nd sw is in play, causing User not to register #1136
Conversation
This file contains 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
jkasten2
force-pushed
the
fix/sw_race_condition
branch
2 times, most recently
from
bbb2181 to
42fb865
Compare
This is to test OneSignal with conflicting a root service worker. This causes the OneSignal SDK to sometimes not include a push token when it makes a REST API to POST /users. This is due to the OneSignal SDK sometimes getting the registration for the root service worker due to a race condition, instead of the OneSignal service worker. We will fix this problem in a follow up commit.
jkasten2
force-pushed
the
fix/sw_race_condition
branch
from
42fb865 to
7930f20
Compare
rgomezp
approved these changes
Nov 16, 2023
jkasten2
force-pushed
the
fix/sw_race_condition
branch
from
25628d2 to
c7a7d45
Compare
If you attempt to get the service worker registration immediately after registering it the browser can give you a different registration than exepected. This is due to the fact the new registeration may not be ready yet and there migth be sw in scope at a higher level. The problem noted above cause the OneSignal SDK to register for a push token on the wrong service worker. This in turn causes the SDK to attempt to create a user with a push susbcription but without a push token, which results in a 400 error on POST /users. To fix, instead of calling navigator.serviceWorker.getRegistration we are now simply using the ServiceWorkerRegistration give to us by navigator.serviceWorker.register to avoid this race condition completely
jkasten2
force-pushed
the
fix/sw_race_condition
branch
from
c7a7d45 to
a3798c5
Compare
Merged
16 tasks
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.
Description
1 Line Summary
Fix Service Worker race condition, when a 2nd sw is in play, causing User not to register.
Details
If you attempt to get the service worker registration immediately after registering it the browser can give you a different registration than expected. This is due to the fact the new registration may not be ready yet and there might be sw in scope at a higher level.
The problem noted above cause the OneSignal SDK to register for a push token on the wrong service worker. This in turn causes the SDK to attempt to create a user with a push subscription but without a push token, which results in a
400error onPOST /users.To fix, instead of calling
navigator.serviceWorker.getRegistrationwe are now simply using theServiceWorkerRegistrationgive to us bynavigator.serviceWorker.registerto avoid this race condition completelyValidation
Tests
Test on Chrome 119 on Windows 11
Info
Checklist
Programming Checklist
Interfaces:
Functions:
Typescript:
Other:
elem of arraysyntax. PreferforEachor usemapcontextif possible. Instead, we can pass it to function/constructor so that we don't callOneSignal.contextScreenshots
Info
Checklist
Related Tickets
This change is