Fix Safari multiple tabs by working around a Safari bug. #7316
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
Fixes jupyterlab#6921 We use local storage events to communicate between browser tabs in order to see if there are any other tabs with a particular workspace name. The standard says that local storage events are only supposed to be triggered by local storage changes from *other* tabs. However, Safari sometimes triggers these events from changes by the current tab. Here is an example illustrating this: ```html <html> <body> <div id='report'>No events received</div> <script> let date = new Date().getTime(); let report = document.getElementById('report'); window.addEventListener('storage', ev => { if (ev.key !== 'SOME KEY') { return; } if (ev.newValue === date.toString()) { report.innerText = `BUG: received my own local storage change (${date}) as an event.`; } else { report.innerText = `Another tab was reloaded with timestamp ${ev.newValue}`; } }); window.localStorage.setItem('SOME KEY', date); </script> </body> </html> ``` Open that page in two different Safari tabs and start refreshing each one alternately. It was pretty easy for me to get one of the tabs to indicate the bug was happening. Things worked fine in firefox and presumably would in Chrome too. A workaround implemented here is to manually ignore local storage events that we triggered. Even if we move to BroadcastChannel (see jupyterlab#7315), we'll still need to deal with this since Safari doesn't implement broadcast channel, so we'd have to fall back to something like local storage on Safari.
|
Thanks for making a pull request to JupyterLab! To try out this branch on binder, follow this link: |
jasongrout
added
tag:Backwards compatible
tag:Backport
|
@meeseeksdev backport to 1.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/jupyterlab
that referenced
this pull request
Oct 11, 2019
…nd a Safari bug.
jasongrout
added a commit
that referenced
this pull request
Oct 11, 2019
…6-on-1.x Backport PR #7316 on branch 1.x (Fix Safari multiple tabs by working around a Safari bug.)
jasongrout
removed
the
tag:Backport
lock
bot
added
the
status:resolved-locked
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.
References
Fixes #6921
Code changes
We use local storage events to communicate between browser tabs in order to see if there are any other tabs with a particular workspace name. The standard says that local storage events are only supposed to be triggered by local storage changes from other tabs. However, Safari sometimes triggers these events from changes by the current tab. Here is an example illustrating this:
Open that page in two different Safari tabs and start refreshing each one alternately. It was pretty easy for me to get one of the tabs to indicate the bug was happening. Things worked fine in firefox and presumably would in Chrome too.
A workaround implemented here is to manually ignore local storage events that we triggered.
Even if we move to BroadcastChannel (see #7315), we'll still need to deal with this since Safari doesn't implement broadcast channel, so we'd have to fall back to something like local storage on Safari.
User-facing changes
Backwards-incompatible changes
None