-
-
Notifications
You must be signed in to change notification settings - Fork 424
Expand file tree
/
Copy pathuseSearch.ts
More file actions
493 lines (417 loc) · 14.8 KB
/
useSearch.ts
File metadata and controls
493 lines (417 loc) · 14.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
import type { NpmSearchResponse, NpmSearchResult, SearchProvider } from '#shared/types'
import type { AlgoliaMultiSearchChecks } from './useAlgoliaSearch'
import { type SearchSuggestion, emptySearchResponse, parseSuggestionIntent } from './search-utils'
import { isValidNewPackageName, checkPackageExists } from '~/utils/package-name'
export const SEARCH_ENGINE_HITS_LIMIT: Record<SearchProvider, number> = {
algolia: 1000,
npm: 5000,
} as const
function emptySearchPayload() {
return {
searchResponse: emptySearchResponse(),
suggestions: [] as SearchSuggestion[],
packageAvailability: null as { name: string; available: boolean } | null,
}
}
export interface SearchOptions {
size?: number
}
export interface UseSearchConfig {
/**
* Enable org/user suggestion and package-availability checks alongside search.
* Algolia bundles these into the same multi-search request.
* npm runs them as separate API calls in parallel.
*/
suggestions?: boolean
}
interface SearchResponseCache {
query: string
provider: SearchProvider
objects: NpmSearchResult[]
totalUnlimited: number
total: number
}
export function useSearch(
query: MaybeRefOrGetter<string>,
searchProvider: MaybeRefOrGetter<SearchProvider>,
options: MaybeRefOrGetter<SearchOptions> = {},
config: UseSearchConfig = {},
) {
const { search: searchAlgolia, searchWithSuggestions: algoliaMultiSearch } = useAlgoliaSearch()
const {
search: searchNpm,
checkOrgExists: checkOrgNpm,
checkUserExists: checkUserNpm,
} = useNpmSearch()
const cache = shallowRef<SearchResponseCache | null>(null)
const isLoadingMore = shallowRef(false)
const isRateLimited = shallowRef(false)
const suggestions = shallowRef<SearchSuggestion[]>([])
const suggestionsLoading = shallowRef(false)
const packageAvailability = shallowRef<{ name: string; available: boolean } | null>(null)
const existenceCache = shallowRef<Record<string, boolean>>({})
const suggestionRequestId = shallowRef(0)
function setCache(objects: NpmSearchResult[] | null, total: number = 0): void {
if (objects === null) {
cache.value = null
return
}
const provider = toValue(searchProvider)
cache.value = {
query: toValue(query),
provider,
objects,
totalUnlimited: total,
total: Math.min(total, SEARCH_ENGINE_HITS_LIMIT[provider]),
}
}
/**
* Determine which extra checks to include in the Algolia multi-search.
* Returns `undefined` when nothing uncached needs checking.
*/
function buildAlgoliaChecks(q: string): AlgoliaMultiSearchChecks | undefined {
if (!config.suggestions) return undefined
const { intent, name } = parseSuggestionIntent(q)
const lowerName = name.toLowerCase()
const checks: AlgoliaMultiSearchChecks = {}
let hasChecks = false
if (intent && name) {
const wantOrg = intent === 'org' || intent === 'both'
const wantUser = intent === 'user' || intent === 'both'
if (wantOrg && existenceCache.value[`org:${lowerName}`] === undefined) {
checks.name = name
checks.checkOrg = true
hasChecks = true
}
if (wantUser && existenceCache.value[`user:${lowerName}`] === undefined) {
checks.name = name
checks.checkUser = true
hasChecks = true
}
}
const trimmed = q.trim()
if (isValidNewPackageName(trimmed)) {
checks.checkPackage = trimmed
hasChecks = true
}
return hasChecks ? checks : undefined
}
/**
* Update suggestion and package-availability state from multi-search results.
* Only writes to the cache for checks that were actually sent; reads from
* existing cache for the rest.
*/
function processAlgoliaChecks(
q: string,
checks: AlgoliaMultiSearchChecks | undefined,
result: { orgExists: boolean; userExists: boolean; packageExists: boolean | null },
) {
const { intent, name } = parseSuggestionIntent(q)
if (intent && name) {
const lowerName = name.toLowerCase()
const wantOrg = intent === 'org' || intent === 'both'
const wantUser = intent === 'user' || intent === 'both'
const updates: Record<string, boolean> = {}
if (checks?.checkOrg) updates[`org:${lowerName}`] = result.orgExists
if (checks?.checkUser) updates[`user:${lowerName}`] = result.userExists
if (Object.keys(updates).length > 0) {
existenceCache.value = { ...existenceCache.value, ...updates }
}
// Prefer org over user when both match (orgs always match owner.name too)
const isOrg = wantOrg && existenceCache.value[`org:${lowerName}`]
const isUser = wantUser && existenceCache.value[`user:${lowerName}`]
const newSuggestions: SearchSuggestion[] = []
if (isOrg) {
newSuggestions.push({ type: 'org', name: lowerName, exists: true })
}
if (isUser && !isOrg) {
newSuggestions.push({ type: 'user', name: lowerName, exists: true })
}
suggestions.value = newSuggestions
} else {
suggestions.value = []
}
const trimmed = q.trim()
if (result.packageExists !== null && isValidNewPackageName(trimmed)) {
packageAvailability.value = { name: trimmed, available: !result.packageExists }
} else if (!isValidNewPackageName(trimmed)) {
packageAvailability.value = null
}
suggestionsLoading.value = false
}
const asyncData = useLazyAsyncData(
() => `search:${toValue(searchProvider)}:${toValue(query)}`,
async (_nuxtApp, { signal }) => {
const q = toValue(query)
const provider = toValue(searchProvider)
if (!q.trim()) {
isRateLimited.value = false
return emptySearchPayload()
}
const opts = toValue(options)
setCache(null)
if (provider === 'algolia') {
const checks = config.suggestions ? buildAlgoliaChecks(q) : undefined
if (config.suggestions) {
suggestionsLoading.value = true
const result = await algoliaMultiSearch(q, { size: opts.size ?? 25 }, checks)
if (q !== toValue(query)) {
return emptySearchPayload()
}
isRateLimited.value = false
processAlgoliaChecks(q, checks, result)
return {
searchResponse: result.search,
suggestions: suggestions.value,
packageAvailability: packageAvailability.value,
}
}
const response = await searchAlgolia(q, { size: opts.size ?? 25 })
if (q !== toValue(query)) {
return emptySearchPayload()
}
isRateLimited.value = false
return {
searchResponse: response,
suggestions: [],
packageAvailability: null,
}
}
try {
const response = await searchNpm(q, { size: opts.size ?? 25 }, signal)
if (q !== toValue(query)) {
return emptySearchPayload()
}
setCache(response.objects, response.total)
isRateLimited.value = false
return {
searchResponse: response,
suggestions: [],
packageAvailability: null,
}
} catch (error: unknown) {
const errorMessage = (error as { message?: string })?.message || String(error)
const isRateLimitError =
errorMessage.includes('Failed to fetch') || errorMessage.includes('429')
if (isRateLimitError) {
isRateLimited.value = true
return emptySearchPayload()
}
throw error
}
},
{ default: emptySearchPayload },
)
async function fetchMore(targetSize: number): Promise<void> {
const q = toValue(query).trim()
const provider = toValue(searchProvider)
if (!q) {
setCache(null)
return
}
if (cache.value && (cache.value.query !== q || cache.value.provider !== provider)) {
setCache(null)
await asyncData.refresh()
return
}
// Seed cache from asyncData for Algolia (which skips cache on initial fetch)
if (!cache.value && asyncData.data.value) {
const { searchResponse } = asyncData.data.value
setCache([...searchResponse.objects], searchResponse.total)
}
const currentCount = cache.value?.objects.length ?? 0
const total = cache.value?.total ?? Infinity
if (currentCount >= targetSize || currentCount >= total) {
return
}
isLoadingMore.value = true
try {
const from = currentCount
const size = Math.min(targetSize - currentCount, total - currentCount)
const doSearch = provider === 'algolia' ? searchAlgolia : searchNpm
const response = await doSearch(q, { size, from })
if (cache.value && cache.value.query === q && cache.value.provider === provider) {
const existingNames = new Set(cache.value.objects.map(obj => obj.package.name))
const newObjects = response.objects.filter(obj => !existingNames.has(obj.package.name))
setCache([...cache.value.objects, ...newObjects], response.total)
} else {
setCache(response.objects, response.total)
}
if (
cache.value &&
cache.value.objects.length < targetSize &&
cache.value.objects.length < cache.value.total &&
cache.value.objects.length < SEARCH_ENGINE_HITS_LIMIT[provider] // additional protection from infinite loop
) {
await fetchMore(targetSize)
}
} finally {
isLoadingMore.value = false
}
}
watch(
() => toValue(options).size,
async (newSize, oldSize) => {
if (!newSize) return
if (oldSize && newSize > oldSize && toValue(query).trim()) {
await fetchMore(newSize)
}
},
)
watch(
() => toValue(searchProvider),
async () => {
setCache(null)
existenceCache.value = {}
await asyncData.refresh()
const targetSize = toValue(options).size
if (targetSize) {
await fetchMore(targetSize)
}
},
)
const data = computed<NpmSearchResponse | null>(() => {
if (cache.value) {
return {
isStale: false,
objects: cache.value.objects,
total: cache.value.total,
totalUnlimited: cache.value.totalUnlimited,
time: new Date().toISOString(),
}
}
return asyncData.data.value?.searchResponse ?? null
})
const hasMore = computed(() => {
if (!cache.value) return true
return cache.value.objects.length < cache.value.total
})
async function validateSuggestionsNpm(q: string) {
const requestId = ++suggestionRequestId.value
const { intent, name } = parseSuggestionIntent(q)
let availability: { name: string; available: boolean } | null = null
const promises: Promise<void>[] = []
const trimmed = q.trim()
if (isValidNewPackageName(trimmed)) {
promises.push(
checkPackageExists(trimmed)
.then(exists => {
if (trimmed === toValue(query).trim()) {
availability = { name: trimmed, available: !exists }
packageAvailability.value = availability
}
})
.catch(() => {
availability = null
}),
)
} else {
availability = null
}
if (!intent || !name) {
suggestionsLoading.value = false
await Promise.all(promises)
return { suggestions: [], packageAvailability: availability }
}
suggestionsLoading.value = true
const result: SearchSuggestion[] = []
const lowerName = name.toLowerCase()
try {
const wantOrg = intent === 'org' || intent === 'both'
const wantUser = intent === 'user' || intent === 'both'
if (wantOrg && existenceCache.value[`org:${lowerName}`] === undefined) {
promises.push(
checkOrgNpm(lowerName)
.then(exists => {
existenceCache.value = { ...existenceCache.value, [`org:${lowerName}`]: exists }
})
.catch(() => {
existenceCache.value = { ...existenceCache.value, [`org:${lowerName}`]: false }
}),
)
}
if (wantUser && existenceCache.value[`user:${lowerName}`] === undefined) {
promises.push(
checkUserNpm(lowerName)
.then(exists => {
existenceCache.value = { ...existenceCache.value, [`user:${lowerName}`]: exists }
})
.catch(() => {
existenceCache.value = { ...existenceCache.value, [`user:${lowerName}`]: false }
}),
)
}
if (promises.length > 0) {
await Promise.all(promises)
}
if (requestId !== suggestionRequestId.value)
return { suggestions: [], packageAvailability: availability }
const isOrg = wantOrg && existenceCache.value[`org:${lowerName}`]
const isUser = wantUser && existenceCache.value[`user:${lowerName}`]
if (isOrg) {
result.push({ type: 'org', name: lowerName, exists: true })
}
if (isUser && !isOrg) {
result.push({ type: 'user', name: lowerName, exists: true })
}
} finally {
if (requestId === suggestionRequestId.value) {
suggestionsLoading.value = false
}
}
if (requestId === suggestionRequestId.value) {
suggestions.value = result
return { suggestions: result, packageAvailability: availability }
}
return { suggestions: [], packageAvailability: availability }
}
const npmSuggestions = useLazyAsyncData(
() => `npm-suggestions:${toValue(searchProvider)}:${toValue(query)}`,
async () => {
const q = toValue(query).trim()
if (toValue(searchProvider) === 'algolia' || !q)
return { suggestions: [], packageAvailability: null }
const { intent, name } = parseSuggestionIntent(q)
if (!intent || !name) return { suggestions: [], packageAvailability: null }
return validateSuggestionsNpm(q)
},
{ default: () => ({ suggestions: [], packageAvailability: null }) },
)
watch(
[() => asyncData.data.value.suggestions, () => npmSuggestions.data.value.suggestions],
([algoliaSuggestions, npmSuggestionsValue]) => {
if (algoliaSuggestions.length || npmSuggestionsValue.length) {
suggestions.value = algoliaSuggestions.length ? algoliaSuggestions : npmSuggestionsValue
}
},
{ immediate: true },
)
watch(
[
() => asyncData.data.value?.packageAvailability,
() => npmSuggestions.data.value.packageAvailability,
],
([algoliaPackageAvailability, npmPackageAvailability]) => {
if (algoliaPackageAvailability || npmPackageAvailability) {
packageAvailability.value = algoliaPackageAvailability || npmPackageAvailability
}
},
{ immediate: true },
)
if (import.meta.client && asyncData.data.value?.searchResponse.isStale) {
onMounted(() => {
asyncData.refresh()
})
}
return {
...asyncData,
data,
isLoadingMore,
hasMore,
fetchMore,
isRateLimited: readonly(isRateLimited),
suggestions: readonly(suggestions),
suggestionsLoading: readonly(suggestionsLoading),
packageAvailability: readonly(packageAvailability),
}
}