refactor(core): use KeyValueStore for recent searches #5872
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
|
cngonzalez
changed the title
|
No changes to documentation |
|
Component Testing Report Updated Mar 8, 2024 5:23 PM (UTC)
|
cngonzalez
force-pushed
the
sdx-1135
branch
2 times, most recently
from
6f0855d
to
ece8b23
Compare
bjoerge
approved these changes
Mar 8, 2024
There was a problem hiding this comment.
LGTM, great work @cngonzalez! Thank you for such an extensive test suite too, really appreciated!
packages/sanity/src/core/studio/components/navbar/search/datastores/recentSearches.test.tsx
Outdated
Show resolved
Hide resolved
| recentTerms = result.current.getRecentSearches() | ||
| expect(recentTerms.length).toEqual(2) | ||
|
|
||
| /* There's unfortunately a bit of flakiness with the schema |
There was a problem hiding this comment.
thanks for taking the time to explain <3
juice49
pushed a commit
that referenced
this pull request
Mar 13, 2024
* refactor(core): create useStoredSearch hook * refactor: pass useStoredSearch to recentSearchesStore * refactor(core): convert createRecentSearchesStore to useRecentSearchesStore * fix(core): use default studio client options * fix: pass recent terms for more predictable UI behavior * refactor: remove recent searches from search state and invoke hook wherever needed * fix: remove typos, spaces
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
This PR refactors the store for recent searches to be aligned with other user settings values (you can see another recent example of this kind of a refactor here: #5784)
The changes are:
useStoredSearchhook which depends on aKeyValueStorebackend, which is still currently localStorage. (previously, therecentSearchesfunctions mutated into localStorage directly)createRecentSearchesStoreintouseRecentSearchesStoreto better deal with asynchronous state coming in the future.useRecentSearchesStoreas a hook with dependencies elsewhere in the Studio.What to review
The changed files to look for any gotchas -- and any excessive re-renders or UI bugs. All seem to match the current experience from my checks.
Testing
The
recentSearchesunit tests were refactored but should still test for the exact same cases. One case was removed -- checking for versions, because this will be handled by KeyValueStore down the line.E2E UI tests were difficult because the recent search UI intercepts pointer events to some extent.