-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
SearchResultsView.tsx
430 lines (390 loc) · 18.2 KB
/
SearchResultsView.tsx
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
import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'
import classNames from 'classnames'
import { Observable } from 'rxjs'
import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect'
import {
SearchPatternType,
fetchAutoDefinedSearchContexts,
getUserSearchContextNamespaces,
QueryState,
} from '@sourcegraph/search'
import { IEditor, SearchBox, StreamingProgress, StreamingSearchResultsList } from '@sourcegraph/search-ui'
import { wrapRemoteObservable } from '@sourcegraph/shared/src/api/client/api/common'
import { FetchFileParameters, fetchHighlightedFileLineRanges } from '@sourcegraph/shared/src/backend/file'
import { collectMetrics } from '@sourcegraph/shared/src/search/query/metrics'
import {
appendContextFilter,
sanitizeQueryForTelemetry,
updateFilters,
} from '@sourcegraph/shared/src/search/query/transformer'
import { LATEST_VERSION, RepositoryMatch, SearchMatch } from '@sourcegraph/shared/src/search/stream'
import { globbingEnabledFromSettings } from '@sourcegraph/shared/src/util/globbing'
import { buildSearchURLQuery } from '@sourcegraph/shared/src/util/url'
import { SearchResultsState } from '../../state'
import { WebviewPageProps } from '../platform/context'
import { fetchSearchContexts } from './alias/fetchSearchContext'
import { setFocusSearchBox } from './api'
import { SavedSearchCreateForm } from './components/SavedSearchForm'
import { SearchResultsInfoBar } from './components/SearchResultsInfoBar'
import { MatchHandlersContext, useMatchHandlers } from './MatchHandlersContext'
import { RepoView } from './RepoView'
import styles from './index.module.scss'
export interface SearchResultsViewProps extends WebviewPageProps {
context: SearchResultsState['context']
}
export const SearchResultsView: React.FunctionComponent<React.PropsWithChildren<SearchResultsViewProps>> = ({
extensionCoreAPI,
authenticatedUser,
platformContext,
settingsCascade,
theme,
context,
instanceURL,
}) => {
const [userQueryState, setUserQueryState] = useState<QueryState>(context.submittedSearchQueryState.queryState)
const [repoToShow, setRepoToShow] = useState<Pick<
RepositoryMatch,
'repository' | 'branches' | 'description'
> | null>(null)
const isSourcegraphDotCom = useMemo(() => {
const hostname = new URL(instanceURL).hostname
return hostname === 'sourcegraph.com' || hostname === 'www.sourcegraph.com'
}, [instanceURL])
// Editor focus.
const editorReference = useRef<IEditor>()
const setEditor = useCallback((editor: IEditor) => {
editorReference.current = editor
setTimeout(() => editor.focus(), 0)
}, [])
// TODO explain
useEffect(() => {
setFocusSearchBox(() => editorReference.current?.focus())
return () => {
setFocusSearchBox(null)
}
}, [])
const onChange = useCallback(
(newState: QueryState) => {
setUserQueryState(newState)
extensionCoreAPI
.setSidebarQueryState({
queryState: newState,
searchCaseSensitivity: context.submittedSearchQueryState?.searchCaseSensitivity,
searchPatternType: context.submittedSearchQueryState?.searchPatternType,
})
.catch(error => {
// TODO surface error to users
console.error('Error updating sidebar query state from panel', error)
})
},
[
extensionCoreAPI,
context.submittedSearchQueryState.searchCaseSensitivity,
context.submittedSearchQueryState.searchPatternType,
]
)
const [allExpanded, setAllExpanded] = useState(false)
const onExpandAllResultsToggle = useCallback(() => {
setAllExpanded(oldValue => !oldValue)
platformContext.telemetryService.log(allExpanded ? 'allResultsExpanded' : 'allResultsCollapsed')
}, [allExpanded, platformContext])
const [showSavedSearchForm, setShowSavedSearchForm] = useState(false)
// Update local query state on sidebar query state updates.
useDeepCompareEffectNoCheck(() => {
if (context.searchSidebarQueryState.proposedQueryState?.queryState) {
setUserQueryState(context.searchSidebarQueryState.proposedQueryState?.queryState)
}
}, [context.searchSidebarQueryState.proposedQueryState?.queryState])
// Update local search query state on sidebar search submission.
useDeepCompareEffectNoCheck(() => {
setUserQueryState(context.submittedSearchQueryState.queryState)
// It's a whole new object on each state update, so we need
// to compare (alternatively, construct full query TODO)
// Clear repo view
setRepoToShow(null)
}, [context.submittedSearchQueryState.queryState])
// Track sidebar + keyboard shortcut search submissions
useEffect(() => {
platformContext.telemetryService.log('IDESearchSubmitted')
}, [platformContext, context.submittedSearchQueryState.queryState.query])
const onSubmit = useCallback(
(options?: { caseSensitive?: boolean; patternType?: SearchPatternType; newQuery?: string }) => {
const previousSearchQueryState = context.submittedSearchQueryState
const query = options?.newQuery ?? userQueryState.query
const caseSensitive = options?.caseSensitive ?? previousSearchQueryState.searchCaseSensitivity
const patternType = options?.patternType ?? previousSearchQueryState.searchPatternType
extensionCoreAPI
.streamSearch(query, {
caseSensitive,
patternType,
version: LATEST_VERSION,
trace: undefined,
chunkMatches: true,
})
.then(() => {
editorReference.current?.focus()
})
.catch(error => {
// TODO surface error to users? Errors will typically be caught and
// surfaced throught streaming search reuls.
console.error(error)
})
extensionCoreAPI
.setSidebarQueryState({
queryState: { query },
searchCaseSensitivity: caseSensitive,
searchPatternType: patternType,
})
.catch(error => {
// TODO surface error to users
console.error('Error updating sidebar query state from panel', error)
})
// Log Search History
const hostname = new URL(instanceURL).hostname
let queryString = `${userQueryState.query}${caseSensitive ? ' case:yes' : ''}`
if (context.selectedSearchContextSpec) {
queryString = appendContextFilter(queryString, context.selectedSearchContextSpec)
}
const metrics = queryString ? collectMetrics(queryString) : undefined
platformContext.telemetryService.log(
'SearchResultsQueried',
{
code_search: {
query_data: {
query: metrics,
combined: queryString,
empty: !queryString,
},
},
},
{
code_search: {
query_data: {
// 🚨 PRIVACY: never provide any private query data in the
// { code_search: query_data: query } property,
// which is also potentially exported in pings data.
query: metrics,
// 🚨 PRIVACY: Only collect the full query string for unauthenticated users
// on Sourcegraph.com, and only after sanitizing to remove certain filters.
combined:
!authenticatedUser && isSourcegraphDotCom
? sanitizeQueryForTelemetry(queryString)
: undefined,
empty: !queryString,
},
},
},
`https://${hostname}/search?q=${encodeURIComponent(queryString)}&patternType=${patternType}`
)
// Clear repo view
setRepoToShow(null)
},
[
context.submittedSearchQueryState,
context.selectedSearchContextSpec,
userQueryState.query,
extensionCoreAPI,
instanceURL,
platformContext.telemetryService,
authenticatedUser,
isSourcegraphDotCom,
]
)
// Submit new search on change
const setCaseSensitivity = useCallback(
(caseSensitive: boolean) => {
onSubmit({ caseSensitive })
},
[onSubmit]
)
// Submit new search on change
const setPatternType = useCallback(
(patternType: SearchPatternType) => {
onSubmit({ patternType })
},
[onSubmit]
)
const fetchHighlightedFileLineRangesWithContext = useCallback(
(parameters: FetchFileParameters) => fetchHighlightedFileLineRanges({ ...parameters, platformContext }),
[platformContext]
)
const fetchStreamSuggestions = useCallback(
(query: string): Observable<SearchMatch[]> =>
wrapRemoteObservable(extensionCoreAPI.fetchStreamSuggestions(query, instanceURL)),
[extensionCoreAPI, instanceURL]
)
const globbing = useMemo(() => globbingEnabledFromSettings(settingsCascade), [settingsCascade])
const setSelectedSearchContextSpec = useCallback(
(spec: string) => {
extensionCoreAPI
.setSelectedSearchContextSpec(spec)
.catch(error => {
console.error('Error persisting search context spec.', error)
})
.finally(() => {
// Execute search with new context state
onSubmit()
})
},
[extensionCoreAPI, onSubmit]
)
const onSearchAgain = useCallback(
(additionalFilters: string[]) => {
platformContext.telemetryService.log('SearchSkippedResultsAgainClicked')
onSubmit({
newQuery: applyAdditionalFilters(context.submittedSearchQueryState.queryState.query, additionalFilters),
})
},
[context.submittedSearchQueryState.queryState, platformContext, onSubmit]
)
const onShareResultsClick = useCallback(async (): Promise<void> => {
const queryState = context.submittedSearchQueryState
const path = `/search?${buildSearchURLQuery(
queryState.queryState.query,
queryState.searchPatternType,
queryState.searchCaseSensitivity,
context.selectedSearchContextSpec
)}&utm_campaign=vscode-extension&utm_medium=direct_traffic&utm_source=vscode-extension&utm_content=save-search`
await extensionCoreAPI.copyLink(new URL(path, instanceURL).href)
platformContext.telemetryService.log('VSCEShareLinkClick')
}, [context, instanceURL, extensionCoreAPI, platformContext])
const fullQuery = useMemo(
() =>
appendContextFilter(
context.submittedSearchQueryState.queryState.query ?? '',
context.selectedSearchContextSpec
),
[context]
)
const matchHandlers = useMatchHandlers({
platformContext,
extensionCoreAPI,
authenticatedUser,
onRepoSelected: setRepoToShow,
instanceURL,
})
const clearRepositoryToShow = (): void => setRepoToShow(null)
return (
<div className={styles.resultsViewLayout}>
{/* eslint-disable-next-line react/forbid-elements */}
<form
className="d-flex w-100 my-2 pb-2 border-bottom"
onSubmit={event => {
event.preventDefault()
onSubmit()
}}
>
<SearchBox
caseSensitive={context.submittedSearchQueryState?.searchCaseSensitivity}
setCaseSensitivity={setCaseSensitivity}
patternType={context.submittedSearchQueryState?.searchPatternType}
setPatternType={setPatternType}
isSourcegraphDotCom={isSourcegraphDotCom}
structuralSearchDisabled={false}
queryState={userQueryState}
onChange={onChange}
onSubmit={onSubmit}
authenticatedUser={authenticatedUser}
searchContextsEnabled={true}
showSearchContext={true}
showSearchContextManagement={false}
defaultSearchContextSpec="global"
setSelectedSearchContextSpec={setSelectedSearchContextSpec}
selectedSearchContextSpec={context.selectedSearchContextSpec}
fetchSearchContexts={fetchSearchContexts}
fetchAutoDefinedSearchContexts={fetchAutoDefinedSearchContexts}
getUserSearchContextNamespaces={getUserSearchContextNamespaces}
fetchStreamSuggestions={fetchStreamSuggestions}
settingsCascade={settingsCascade}
globbing={globbing}
isLightTheme={theme === 'theme-light'}
telemetryService={platformContext.telemetryService}
platformContext={platformContext}
className={classNames('flex-grow-1 flex-shrink-past-contents', styles.searchBox)}
containerClassName={styles.searchBoxContainer}
autoFocus={true}
onEditorCreated={setEditor}
editorComponent="monaco"
/>
</form>
{!repoToShow ? (
<div className={styles.resultsViewScrollContainer}>
<SearchResultsInfoBar
onShareResultsClick={onShareResultsClick}
showSavedSearchForm={showSavedSearchForm}
setShowSavedSearchForm={setShowSavedSearchForm}
extensionCoreAPI={extensionCoreAPI}
patternType={context.submittedSearchQueryState.searchPatternType}
authenticatedUser={authenticatedUser}
platformContext={platformContext}
stats={
<StreamingProgress
progress={
context.searchResults?.progress || { durationMs: 0, matchCount: 0, skipped: [] }
}
state={context.searchResults?.state || 'loading'}
onSearchAgain={onSearchAgain}
showTrace={false}
/>
}
allExpanded={allExpanded}
onExpandAllResultsToggle={onExpandAllResultsToggle}
instanceURL={instanceURL}
fullQuery={fullQuery}
/>
{authenticatedUser && showSavedSearchForm && (
<SavedSearchCreateForm
authenticatedUser={authenticatedUser}
submitLabel="Add saved search"
title="Add saved search"
fullQuery={`${fullQuery} patternType:${context.submittedSearchQueryState.searchPatternType}`}
onComplete={() => setShowSavedSearchForm(false)}
platformContext={platformContext}
instanceURL={instanceURL}
/>
)}
<MatchHandlersContext.Provider value={{ ...matchHandlers, instanceURL }}>
<StreamingSearchResultsList
isLightTheme={theme === 'theme-light'}
settingsCascade={settingsCascade}
telemetryService={platformContext.telemetryService}
allExpanded={allExpanded}
// Debt: dotcom prop used only for "run search" link
// for search examples. Fix on VSCE.
isSourcegraphDotCom={false}
searchContextsEnabled={true}
showSearchContext={true}
platformContext={platformContext}
results={context.searchResults ?? undefined}
fetchHighlightedFileLineRanges={fetchHighlightedFileLineRangesWithContext}
executedQuery={context.submittedSearchQueryState.queryState.query}
resultClassName="mr-0"
// TODO "no results" video thumbnail assets
// In build, copy ui/assets/img folder to dist/
assetsRoot="https://raw.githubusercontent.com/sourcegraph/sourcegraph/main/ui/assets"
/>
</MatchHandlersContext.Provider>
</div>
) : (
<div className={styles.resultsViewScrollContainer}>
<RepoView
extensionCoreAPI={extensionCoreAPI}
platformContext={platformContext}
onBackToSearchResults={clearRepositoryToShow}
repositoryMatch={repoToShow}
setQueryState={setUserQueryState}
instanceURL={instanceURL}
/>
</div>
)}
</div>
)
}
const applyAdditionalFilters = (query: string, additionalFilters: string[]): string => {
let newQuery = query
for (const filter of additionalFilters) {
const fieldValue = filter.split(':', 2)
newQuery = updateFilters(newQuery, fieldValue[0], fieldValue[1])
}
return newQuery
}