forked from sourcegraph/sourcegraph-public-snapshot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSourcegraphWebApp.tsx
More file actions
375 lines (340 loc) · 15.8 KB
/
Copy pathSourcegraphWebApp.tsx
File metadata and controls
375 lines (340 loc) · 15.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
import { Notifications } from '@sourcegraph/extensions-client-common/lib/app/notifications/Notifications'
import { createController as createExtensionsController } from '@sourcegraph/extensions-client-common/lib/client/controller'
import { ConfiguredExtension } from '@sourcegraph/extensions-client-common/lib/extensions/extension'
import { ClientConnection, connectAsPage } from '@sourcegraph/extensions-client-common/lib/messaging'
import {
ConfigurationCascadeOrError,
ConfigurationSubject,
ConfiguredSubject,
Settings,
} from '@sourcegraph/extensions-client-common/lib/settings'
import AlertCircleIcon from 'mdi-react/AlertCircleIcon'
import ServerIcon from 'mdi-react/ServerIcon'
import * as React from 'react'
import { Route } from 'react-router'
import { BrowserRouter } from 'react-router-dom'
import { combineLatest, from, Subscription } from 'rxjs'
import { startWith } from 'rxjs/operators'
import { EMPTY_ENVIRONMENT as EXTENSIONS_EMPTY_ENVIRONMENT } from 'sourcegraph/module/client/environment'
import { TextDocumentItem } from 'sourcegraph/module/client/types/textDocument'
import { currentUser } from './auth'
import * as GQL from './backend/graphqlschema'
import { FeedbackText } from './components/FeedbackText'
import { HeroPage } from './components/HeroPage'
import { Tooltip } from './components/tooltip/Tooltip'
import { ExtensionsEnvironmentProps } from './extensions/environment/ExtensionsEnvironment'
import { ExtensionAreaRoute } from './extensions/extension/ExtensionArea'
import { ExtensionAreaHeaderNavItem } from './extensions/extension/ExtensionAreaHeader'
import { ExtensionsAreaRoute } from './extensions/ExtensionsArea'
import { ExtensionsAreaHeaderActionButton } from './extensions/ExtensionsAreaHeader'
import { createExtensionsContextController } from './extensions/ExtensionsClientCommonContext'
import {
ConfigurationCascadeProps,
createMessageTransports,
ExtensionsControllerProps,
ExtensionsProps,
} from './extensions/ExtensionsClientCommonContext'
import { Layout, LayoutProps } from './Layout'
import { updateUserSessionStores } from './marketing/util'
import { RepoHeaderActionButton } from './repo/RepoHeader'
import { RepoRevContainerRoute } from './repo/RepoRevContainer'
import { clientConfiguration } from './settings/configuration'
import { SiteAdminAreaRoute } from './site-admin/SiteAdminArea'
import { SiteAdminSideBarGroups } from './site-admin/SiteAdminSidebar'
import { eventLogger } from './tracking/eventLogger'
import { UserAccountAreaRoute } from './user/account/UserAccountArea'
import { UserAccountSidebarItems } from './user/account/UserAccountSidebar'
import { UserAreaRoute } from './user/area/UserArea'
import { UserAreaHeaderNavItem } from './user/area/UserAreaHeader'
import { isErrorLike } from './util/errors'
export interface SourcegraphWebAppProps {
extensionAreaRoutes: ReadonlyArray<ExtensionAreaRoute>
extensionAreaHeaderNavItems: ReadonlyArray<ExtensionAreaHeaderNavItem>
extensionsAreaRoutes: ReadonlyArray<ExtensionsAreaRoute>
extensionsAreaHeaderActionButtons: ReadonlyArray<ExtensionsAreaHeaderActionButton>
siteAdminAreaRoutes: ReadonlyArray<SiteAdminAreaRoute>
siteAdminSideBarGroups: SiteAdminSideBarGroups
siteAdminOverviewComponents: ReadonlyArray<React.ComponentType>
userAreaHeaderNavItems: ReadonlyArray<UserAreaHeaderNavItem>
userAreaRoutes: ReadonlyArray<UserAreaRoute>
userAccountSideBarItems: UserAccountSidebarItems
userAccountAreaRoutes: ReadonlyArray<UserAccountAreaRoute>
repoRevContainerRoutes: ReadonlyArray<RepoRevContainerRoute>
repoHeaderActionButtons: ReadonlyArray<RepoHeaderActionButton>
}
interface SourcegraphWebAppState
extends ConfigurationCascadeProps,
ExtensionsProps,
ExtensionsEnvironmentProps,
ExtensionsControllerProps {
error?: Error
user?: GQL.IUser | null
viewerSubject: LayoutProps['viewerSubject']
/**
* Whether the light theme is enabled or not
*/
isLightTheme: boolean
/**
* Whether the user is on MainPage and therefore not logged in
*/
isMainPage: boolean
/**
* The current search query in the navbar.
*/
navbarSearchQuery: string
/** Whether the help popover is shown. */
showHelpPopover: boolean
clientConnection: Promise<ClientConnection>
}
const LIGHT_THEME_LOCAL_STORAGE_KEY = 'light-theme'
/** A fallback configuration subject that can be constructed synchronously at initialization time. */
const SITE_SUBJECT_NO_ADMIN: Pick<GQL.IConfigurationSubject, 'id' | 'viewerCanAdminister'> = {
id: window.context.siteGQLID,
viewerCanAdminister: false,
}
/**
* The root component
*/
export class SourcegraphWebApp extends React.Component<SourcegraphWebAppProps, SourcegraphWebAppState> {
constructor(props: SourcegraphWebAppProps) {
super(props)
const clientConnection = connectAsPage()
const extensions = createExtensionsContextController(clientConnection)
this.state = {
isLightTheme: localStorage.getItem(LIGHT_THEME_LOCAL_STORAGE_KEY) !== 'false',
navbarSearchQuery: '',
showHelpPopover: false,
configurationCascade: { subjects: null, merged: null },
extensions,
extensionsEnvironment: EXTENSIONS_EMPTY_ENVIRONMENT,
extensionsController: createExtensionsController(extensions.context, createMessageTransports),
viewerSubject: SITE_SUBJECT_NO_ADMIN,
clientConnection,
isMainPage: false,
}
}
private subscriptions = new Subscription()
public componentDidMount(): void {
updateUserSessionStores()
document.body.classList.add('theme')
this.subscriptions.add(
currentUser.subscribe(user => this.setState({ user }), () => this.setState({ user: null }))
)
this.state.clientConnection
.then(connection => {
connection
.getSettings()
.then(settings => clientConfiguration.next(settings))
.catch(error => console.error(error))
connection.onSettings(settings => clientConfiguration.next(settings))
})
.catch(error => console.error(error))
this.subscriptions.add(
combineLatest(
from(this.state.extensions.context.configurationCascade).pipe(startWith(null)),
currentUser.pipe(startWith(null)),
clientConfiguration
).subscribe(([cascade, user, clientConfiguration]) => {
this.setState(() => {
if (clientConfiguration !== undefined) {
return {
viewerSubject: {
id: 'Client',
viewerCanAdminister: true,
},
}
} else if (user) {
return { viewerSubject: user }
} else if (
cascade &&
!isErrorLike(cascade) &&
cascade.subjects &&
!isErrorLike(cascade.subjects) &&
cascade.subjects.length > 0
) {
return { viewerSubject: cascade.subjects[0].subject }
} else {
return { viewerSubject: SITE_SUBJECT_NO_ADMIN }
}
})
})
)
this.subscriptions.add(this.state.extensionsController)
this.subscriptions.add(
this.state.extensions.context.configurationCascade.subscribe(
v => this.onConfigurationCascadeChange(v),
err => console.error(err)
)
)
// Keep the Sourcegraph extensions controller's extensions up-to-date.
//
// TODO(sqs): handle loading and errors
this.subscriptions.add(
this.state.extensions.viewerConfiguredExtensions.subscribe(
extensions => this.onViewerConfiguredExtensionsChange(extensions),
err => console.error(err)
)
)
}
public componentWillUnmount(): void {
this.subscriptions.unsubscribe()
document.body.classList.remove('theme')
document.body.classList.remove('theme-light')
document.body.classList.remove('theme-dark')
}
public componentDidUpdate(): void {
// Always show MainPage in dark theme look
if (this.state.isMainPage && this.state.isLightTheme) {
document.body.classList.remove('theme-light')
document.body.classList.add('theme-dark')
} else {
localStorage.setItem(LIGHT_THEME_LOCAL_STORAGE_KEY, this.state.isLightTheme + '')
document.body.classList.toggle('theme-light', this.state.isLightTheme)
document.body.classList.toggle('theme-dark', !this.state.isLightTheme)
}
}
public render(): React.ReactFragment | null {
if (this.state.error) {
return <HeroPage icon={AlertCircleIcon} title={'Something happened'} subtitle={this.state.error.message} />
}
if (window.pageError && window.pageError.statusCode !== 404) {
const statusCode = window.pageError.statusCode
const statusText = window.pageError.statusText
const errorMessage = window.pageError.error
const errorID = window.pageError.errorID
let subtitle: JSX.Element | undefined
if (errorID) {
subtitle = <FeedbackText headerText="Sorry, there's been a problem." />
}
if (errorMessage) {
subtitle = (
<div className="app__error">
{subtitle}
{subtitle && <hr />}
<pre>{errorMessage}</pre>
</div>
)
} else {
subtitle = <div className="app__error">{subtitle}</div>
}
return <HeroPage icon={ServerIcon} title={`${statusCode}: ${statusText}`} subtitle={subtitle} />
}
const { user } = this.state
if (user === undefined) {
return null
}
const { children, ...props } = this.props
return (
<>
<BrowserRouter key={0}>
<Route
path="/"
// tslint:disable-next-line:jsx-no-lambda RouteProps.render is an exception
render={routeComponentProps => (
<Layout
{...props}
{...routeComponentProps}
user={user}
viewerSubject={this.state.viewerSubject}
configurationCascade={this.state.configurationCascade}
// Theme
isLightTheme={this.state.isLightTheme}
onThemeChange={this.onThemeChange}
isMainPage={this.state.isMainPage}
onMainPage={this.onMainPage}
// Search query
navbarSearchQuery={this.state.navbarSearchQuery}
onNavbarQueryChange={this.onNavbarQueryChange}
// Help popover
showHelpPopover={this.state.showHelpPopover}
onHelpPopoverToggle={this.onHelpPopoverToggle}
// Extensions
extensions={this.state.extensions}
extensionsEnvironment={this.state.extensionsEnvironment}
extensionsOnVisibleTextDocumentsChange={this.extensionsOnVisibleTextDocumentsChange}
extensionsController={this.state.extensionsController}
clientConnection={this.state.clientConnection}
/>
)}
/>
</BrowserRouter>
<Tooltip key={1} />
<Notifications key={2} extensionsController={this.state.extensionsController} />
</>
)
}
private onThemeChange = () => {
this.setState(
state => ({ isLightTheme: !state.isLightTheme }),
() => {
eventLogger.log(this.state.isLightTheme ? 'LightThemeClicked' : 'DarkThemeClicked')
}
)
}
private onMainPage = (mainPage: boolean) => {
this.setState(state => ({ isMainPage: mainPage }))
}
private onNavbarQueryChange = (navbarSearchQuery: string) => {
this.setState({ navbarSearchQuery })
}
private onHelpPopoverToggle = (visible?: boolean): void => {
eventLogger.log('HelpPopoverToggled')
this.setState(prevState => ({
// If visible is any non-boolean type (e.g., MouseEvent), treat it as undefined. This lets callers use
// onHelpPopoverToggle directly in an event handler without wrapping it in an another function.
showHelpPopover: visible !== true && visible !== false ? !prevState.showHelpPopover : visible,
}))
}
private onConfigurationCascadeChange(
configurationCascade: ConfigurationCascadeOrError<ConfigurationSubject, Settings>
): void {
this.setState(
prevState => {
const update: Pick<SourcegraphWebAppState, 'configurationCascade' | 'extensionsEnvironment'> = {
configurationCascade,
extensionsEnvironment: prevState.extensionsEnvironment,
}
if (
configurationCascade.subjects !== null &&
!isErrorLike(configurationCascade.subjects) &&
configurationCascade.merged !== null &&
!isErrorLike(configurationCascade.merged)
) {
// Only update Sourcegraph extensions environment configuration if the configuration was
// successfully parsed.
//
// TODO(sqs): Think through how this error should be handled.
update.extensionsEnvironment = {
...prevState.extensionsEnvironment,
configuration: {
subjects: configurationCascade.subjects.filter(
(subject): subject is ConfiguredSubject<ConfigurationSubject, Settings> =>
subject.settings !== null && !isErrorLike(subject.settings)
),
merged: configurationCascade.merged,
},
}
}
return update
},
() => this.state.extensionsController.setEnvironment(this.state.extensionsEnvironment)
)
}
private onViewerConfiguredExtensionsChange(viewerConfiguredExtensions: ConfiguredExtension[]): void {
this.setState(
prevState => ({
extensionsEnvironment: {
...prevState.extensionsEnvironment,
extensions: viewerConfiguredExtensions,
},
}),
() => this.state.extensionsController.setEnvironment(this.state.extensionsEnvironment)
)
}
private extensionsOnVisibleTextDocumentsChange = (visibleTextDocuments: TextDocumentItem[] | null): void => {
this.setState(
prevState => ({ extensionsEnvironment: { ...prevState.extensionsEnvironment, visibleTextDocuments } }),
() => this.state.extensionsController.setEnvironment(this.state.extensionsEnvironment)
)
}
}