Use the blog prefix to store preferences by site in localstorage #47768
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
talldan
added
[Type] Bug
talldan
added
the
Backport to WP 6.7 Beta/RC
|
Size Change: +11 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in efee230. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4100540688
|
talldan
removed
the
Backport to WP 6.7 Beta/RC
|
I need to think about this some more, as there are a few different permutations for multisites, one of the main ones being whether the site uses subdomains or subdirectors (which affects how localstorage works). |
talldan
deleted the
fix/preferences-local-storage-data-not-split-by-blog-prefix
branch
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? Why?
The preferences persistence system primarily stores data in user meta (within the WordPress database), but also saves to localstorage as a failsafe (in case the HTTP request to save to user meta doesn't complete).
When saving to user meta, data is stored by blog prefix and user id, so that any retrieved preferences are specific to the individual blog (on a multisite) and user.
There's a bug in that the localstorage system only uses the user id, so the same user with multiple sites on a multisite installation that uses subdirectories might end up incorrectly overwriting their preferences with those from another site.
Hopefully the impact of this is fairly small, as the user meta data is the preferred storage medium and instances of data needing to be retrieved from localstorage shouldn't be common.
How?
Use the
blog_prefixas part of the localstorage key.Testing Instructions
This is a tricky one to test, as it requires a multisite installation.
It's also hard to write e2e tests (I don't think we have multisite e2e tests), or php unit tests (as it involves a client side script). Any suggestions welcome.
On one site:
On another site:
4. Set yourself back to being online
5. Load the post editor
6. The preference you changed should be unaffected by the change in step 3.
Screenshots or screencast