perf: search improvements #1431
+94
−127
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import { normalizeSearchParam } from '#shared/utils/url' | ||
| import { debounce } from 'perfect-debounce' | ||
|
|
||
| // Pages that have their own local filter using ?q | ||
| const pagesWithLocalFilter = new Set(['~username', 'org']) | ||
|
|
||
| export function useGlobalSearch() { | ||
| const { searchProvider } = useSearchProvider() | ||
| const searchProviderValue = computed(() => { | ||
| const p = normalizeSearchParam(route.query.p) | ||
| if (p === 'npm' || searchProvider.value === 'npm') return 'npm' | ||
| return 'algolia' | ||
| }) | ||
| const router = useRouter() | ||
| const route = useRoute() | ||
| const searchQuery = useState<string>('search-query', () => { | ||
| if (pagesWithLocalFilter.has(route.name as string)) { | ||
| return '' | ||
| } | ||
| return normalizeSearchParam(route.query.q) | ||
| }) | ||
|
|
||
| // clean search input when navigating away from search page | ||
| watch( | ||
| () => route.query.q, | ||
| urlQuery => { | ||
| const value = normalizeSearchParam(urlQuery) | ||
| if (!value) searchQuery.value = '' | ||
| }, | ||
| ) | ||
| const updateUrlQueryImpl = (value: string, provider: 'npm' | 'algolia') => { | ||
| const isSameQuery = route.query.q === value && route.query.p === provider | ||
| // Don't navigate away from pages that use ?q for local filtering | ||
| if (pagesWithLocalFilter.has(route.name as string) || isSameQuery) { | ||
| return | ||
|
Comment on lines
+31
to
+35
Contributor
There was a problem hiding this comment. Preserve route-level provider overrides when updating the URL. Right now the setter passes 💡 Suggested fix- const isSameQuery = route.query.q === value && route.query.p === provider
+ const currentQuery = normalizeSearchParam(route.query.q)
+ const currentProvider = normalizeSearchParam(route.query.p) === 'npm' ? 'npm' : 'algolia'
+ const isSameQuery = currentQuery === value && currentProvider === provider
@@
- if (!updateUrlQuery.isPending()) {
- updateUrlQueryImpl(value, searchProvider.value)
- }
- updateUrlQuery(value, searchProvider.value)
+ const effectiveProvider = searchProviderValue.value
+ if (!updateUrlQuery.isPending()) {
+ updateUrlQueryImpl(value, effectiveProvider)
+ }
+ updateUrlQuery(value, effectiveProvider)Also applies to: 64-71 |
||
| } | ||
|
|
||
| if (route.name === 'search') { | ||
| router.replace({ | ||
| query: { | ||
| ...route.query, | ||
| q: value || undefined, | ||
| p: provider === 'npm' ? 'npm' : undefined, | ||
| }, | ||
| }) | ||
| return | ||
| } | ||
| router.push({ | ||
| name: 'search', | ||
| query: { | ||
| q: value, | ||
| p: provider === 'npm' ? 'npm' : undefined, | ||
| }, | ||
| }) | ||
| } | ||
| const updateUrlQuery = debounce(updateUrlQueryImpl, 250) | ||
|
|
||
| function flushUpdateUrlQuery() { | ||
| updateUrlQuery.flush() | ||
| } | ||
|
Comment on lines
+58
to
+60
Contributor
There was a problem hiding this comment. Submitting a stable query can no‑op.
💡 Suggested fix function flushUpdateUrlQuery() {
- updateUrlQuery.flush()
+ if (updateUrlQuery.isPending()) {
+ updateUrlQuery.flush()
+ return
+ }
+ updateUrlQueryImpl(searchQuery.value, searchProviderValue.value)
} |
||
|
|
||
| const searchQueryValue = computed({ | ||
| get: () => searchQuery.value, | ||
| set: async (value: string) => { | ||
| searchQuery.value = value | ||
|
|
||
| // Leading debounce implementation as it doesn't work properly out of the box (https://github.com/unjs/perfect-debounce/issues/43) | ||
| if (!updateUrlQuery.isPending()) { | ||
| updateUrlQueryImpl(value, searchProvider.value) | ||
| } | ||
| updateUrlQuery(value, searchProvider.value) | ||
| }, | ||
| }) | ||
| return { model: searchQueryValue, provider: searchProviderValue, flushUpdateUrlQuery } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.