feat(core): store and fetch user settings from backend #5939
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Mar 14, 2024 5:29 PM (UTC)
|
cngonzalez
force-pushed
the
feat/fetch-settings-from-backend
branch
from
e40ccc6
to
edea1f6
Compare
cngonzalez
requested review from
hermanwikner and
binoy14
and removed request for
a team
cngonzalez
force-pushed
the
feat/fetch-settings-from-backend
branch
from
5f1b86d
to
20cacef
Compare
jtpetty
reviewed
Mar 14, 2024
jtpetty
reviewed
Mar 14, 2024
| const keyValueLoader = new DataLoader<string, KeyValueStoreValue | null>(async (keys) => { | ||
| const value = await client | ||
| .request<KeyValuePair[]>({ | ||
| uri: `/users/me/keyvalue/${keys.join(',')}`, |
There was a problem hiding this comment.
this is probably fine now but if we get to where we do not have complete control over the key names, we may want to be more defensive here
There was a problem hiding this comment.
good point, the API will reject it right now but validating client side early would be nice. Not needed right now tho. Edit: not for GET
jtpetty
reviewed
Mar 14, 2024
jtpetty
approved these changes
Mar 14, 2024
* fix: update tests to match api * fix: comment out flaky tests for now
cngonzalez
force-pushed
the
feat/fetch-settings-from-backend
branch
from
20cacef
to
79da333
Compare
binoy14
approved these changes
Mar 14, 2024
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
We do not currently persist user settings and actions taken in the Studio in a way that follows the user. We store some user choices and actions to browser localStorage which means they do not follow users between desktop and mobile or different browsers. Browsers may also evict localStorage manually or automatically. These settings and actions are then lost and the user may need to reconfigure their experience or accept that things like search history is lost.
Not persisting this data in a universal manner gives a bad user experience since users need to make the same preference choices and settings again and again. Not having this capability also makes it harder for Sanity to develop new features that should follow the user, and we risk either continuing the localStorage limitation in new feature work, or that new initiatives all have to design their own solution for server-side settings and metadata.
What to review
Every code change in this branch was previously reviewed as part of a separate PR. However, this branch stands as the final state of this feature, and should be given "one last review."
Testing
Tests were mostly introduced in previous pull requests. This PR updates some of these tests to reflect settings no longer residing in local storage.
Notes for release
User settings (like desk list sort orders, view modes, and global search history) are now stored securely server-side by Sanity. This means that these settings do not need to be re-selected across devices or browsers, and will be persisted.