Remove LocalStorage synchronization on storage events in Safari #8408
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
dlarocque
requested review from
lisajian,
Xiaoshouzi-gh and
a team
as code owners
🦋 Changeset detectedLatest commit: 7d069bc The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1Affected Products
Test Logs |
NhienLam
approved these changes
Aug 6, 2024
sam-gc
approved these changes
Aug 6, 2024
hsubox76
approved these changes
Aug 6, 2024
| '@firebase/auth': patch | ||
| --- | ||
|
|
||
| Remove localStorage synchronization on storage events in Safari iframes. See [GitHub PR #8408](https://github.com/firebase/firebase-js-sdk/pull/8408). |
There was a problem hiding this comment.
FYI the changeset tool automatically links to the PR that the changeset was added in when creating the Version Packages PR, but this does make the copy-paste into release notes easier.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR removes a localStorage synchronization fix introduced in 2016 to address an issue in Safari 9 (Important: b/28330893). The fix, while necessary at the time, is now causing several Auth tests to fail in Safari. After removing this fix, all tests pass.
The Safari tests are failing because they assume that a storage event without a change to the underlying storage will not trigger callbacks that we attach. With this fix, if we dispatch a storage event without a change to the underlying storage, a manual synchronization will take place, which will then cause the callbacks to be called.
See:
local_storage.test.ts.Testing:
I tested localStorage behaviour in the latest Safari version with an app hosted at
127.0.0.1that contains an iframe hosted atlocalhost. I opened the app in two tabs and triggered localStorage events by signing in with Google in a popup, and observed that changes to localStorage are synchronized correctly across the iframes in both tabs.I created a repro with instructions to help others test this behaviour: https://github.com/dlarocque/safari-iframe-localstorage.