-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
DataContext.ts
430 lines (351 loc) · 10.5 KB
/
DataContext.ts
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 type { AllModeOptions } from '@packages/types'
import fsExtra from 'fs-extra'
import path from 'path'
import util from 'util'
import chalk from 'chalk'
import assert from 'assert'
import str from 'underscore.string'
import 'server-destroy'
import { AppApiShape, DataEmitterActions, LocalSettingsApiShape, ProjectApiShape } from './actions'
import type { NexusGenAbstractTypeMembers } from '@packages/graphql/src/gen/nxs.gen'
import type { AuthApiShape } from './actions/AuthActions'
import type { ElectronApiShape } from './actions/ElectronActions'
import debugLib from 'debug'
import { CoreDataShape, makeCoreData } from './data/coreDataShape'
import { DataActions } from './DataActions'
import {
FileDataSource,
ProjectDataSource,
WizardDataSource,
BrowserDataSource,
CloudDataSource,
EnvDataSource,
HtmlDataSource,
UtilDataSource,
BrowserApiShape,
MigrationDataSource,
} from './sources/'
import { cached } from './util/cached'
import type { GraphQLSchema, OperationTypeNode, DocumentNode } from 'graphql'
import type { IncomingHttpHeaders, Server } from 'http'
import type { AddressInfo } from 'net'
import type { App as ElectronApp } from 'electron'
import { VersionsDataSource } from './sources/VersionsDataSource'
import type { SocketIONamespace, SocketIOServer } from '@packages/socket'
import { globalPubSub } from '.'
import { InjectedConfigApi, ProjectLifecycleManager } from './data/ProjectLifecycleManager'
import type { CypressError } from '@packages/errors'
import { ErrorDataSource } from './sources/ErrorDataSource'
const IS_DEV_ENV = process.env.CYPRESS_INTERNAL_ENV !== 'production'
export type Updater = (proj: CoreDataShape) => void | undefined | CoreDataShape
export type CurrentProjectUpdater = (proj: Exclude<CoreDataShape['currentProject'], null | undefined>) => void | undefined | CoreDataShape['currentProject']
export interface InternalDataContextOptions {
loadCachedProjects: boolean
}
export interface DataContextConfig {
schema: GraphQLSchema
mode: 'run' | 'open'
modeOptions: Partial<AllModeOptions>
electronApp?: ElectronApp
coreData?: CoreDataShape
/**
* Injected from the server
*/
appApi: AppApiShape
localSettingsApi: LocalSettingsApiShape
authApi: AuthApiShape
configApi: InjectedConfigApi
projectApi: ProjectApiShape
electronApi: ElectronApiShape
browserApi: BrowserApiShape
}
export interface GraphQLRequestInfo {
app: 'app' | 'launchpad'
operationName: string | null
document: DocumentNode
operation: OperationTypeNode
variables: Record<string, any> | null
headers: IncomingHttpHeaders
}
export class DataContext {
readonly graphqlRequestInfo?: GraphQLRequestInfo
private _config: Omit<DataContextConfig, 'modeOptions'>
private _modeOptions: Readonly<Partial<AllModeOptions>>
private _coreData: CoreDataShape
readonly lifecycleManager: ProjectLifecycleManager
constructor (_config: DataContextConfig) {
const { modeOptions, ...rest } = _config
this._config = rest
this._modeOptions = modeOptions ?? {} // {} For legacy tests
this._coreData = _config.coreData ?? makeCoreData(this._modeOptions)
this.lifecycleManager = new ProjectLifecycleManager(this)
}
get isRunMode () {
return this._config.mode === 'run'
}
get electronApp () {
return this._config.electronApp
}
get electronApi () {
return this._config.electronApi
}
get localSettingsApi () {
return this._config.localSettingsApi
}
get isGlobalMode () {
return !this.currentProject
}
get modeOptions () {
return this._modeOptions
}
get coreData () {
return this._coreData
}
get user () {
return this.coreData.user
}
get browserList () {
return this.coreData.app.browsers
}
get nodePath () {
return this.coreData.app.nodePath
}
get baseError () {
return this.coreData.baseError
}
@cached
get file () {
return new FileDataSource(this)
}
@cached
get versions () {
return new VersionsDataSource(this)
}
@cached
get browser () {
return new BrowserDataSource(this)
}
/**
* All mutations (update / delete / create), fs writes, etc.
* should run through this namespace. Everything else should be a "getter"
*/
@cached
get actions () {
return new DataActions(this)
}
get appData () {
return this.coreData.app
}
@cached
get wizard () {
return new WizardDataSource(this)
}
get wizardData () {
return this.coreData.wizard
}
get currentProject () {
return this.coreData.currentProject
}
@cached
get project () {
return new ProjectDataSource(this)
}
@cached
get cloud () {
return new CloudDataSource(this)
}
@cached
get env () {
return new EnvDataSource(this)
}
@cached
get emitter () {
return new DataEmitterActions(this)
}
@cached
get html () {
return new HtmlDataSource(this)
}
@cached
get error () {
return new ErrorDataSource(this)
}
@cached
get util () {
return new UtilDataSource(this)
}
@cached
get migration () {
return new MigrationDataSource(this)
}
get projectsList () {
return this.coreData.app.projects
}
// Servers
setAppServerPort (port: number | undefined) {
this.update((d) => {
d.servers.appServerPort = port ?? null
})
}
setAppSocketServer (socketServer: SocketIOServer | undefined) {
this.update((d) => {
d.servers.appSocketServer?.disconnectSockets(true)
d.servers.appSocketNamespace?.disconnectSockets(true)
d.servers.appSocketServer = socketServer
d.servers.appSocketNamespace = socketServer?.of('/data-context')
})
}
setGqlServer (srv: Server) {
this.update((d) => {
d.servers.gqlServer = srv
d.servers.gqlServerPort = (srv.address() as AddressInfo).port
})
}
setGqlSocketServer (socketServer: SocketIONamespace | undefined) {
this.update((d) => {
d.servers.gqlSocketServer?.disconnectSockets(true)
d.servers.gqlSocketServer = socketServer
})
}
/**
* This will be replaced with Immer, for immutable state updates.
*/
update = (updater: Updater): void => {
updater(this._coreData)
}
get appServerPort () {
return this.coreData.servers.appServerPort
}
get gqlServerPort () {
return this.coreData.servers.gqlServerPort
}
// Utilities
@cached
get fs () {
return fsExtra
}
@cached
get path () {
return path
}
get _apis () {
return {
appApi: this._config.appApi,
authApi: this._config.authApi,
browserApi: this._config.browserApi,
configApi: this._config.configApi,
projectApi: this._config.projectApi,
electronApi: this._config.electronApi,
localSettingsApi: this._config.localSettingsApi,
}
}
makeId<T extends NexusGenAbstractTypeMembers['Node']> (typeName: T, nodeString: string) {
return Buffer.from(`${typeName}:${nodeString}`).toString('base64')
}
// TODO(tim): type check
fromId (str: string, accepted: NexusGenAbstractTypeMembers['Node']): string {
const result = Buffer.from(str, 'base64').toString('utf-8')
const [type, val] = result.split(':') as [string, string]
if (type !== accepted) {
throw new Error(`Expecting node with type ${accepted} saw ${type}`)
}
return val
}
debug = debugLib('cypress:data-context')
private _debugCache: Record<string, debug.Debugger> = {}
debugNs = (ns: string, evt: string, ...args: any[]) => {
const _debug = this._debugCache[ns] ??= debugLib(`cypress:data-context:${ns}`)
_debug(evt, ...args)
}
logTraceError (e: unknown) {
// TODO(tim): handle this consistently
// eslint-disable-next-line no-console
console.error(e)
}
onError = (cypressError: CypressError, title?: string) => {
if (this.isRunMode) {
if (this.lifecycleManager?.runModeExitEarly) {
this.lifecycleManager.runModeExitEarly(cypressError)
} else {
throw cypressError
}
} else {
this.update((coreData) => {
coreData.baseError = { title, cypressError }
})
this.emitter.baseErrorChange()
this.emitter.toLaunchpad()
this.emitter.toApp()
}
}
onWarning = (err: CypressError) => {
if (this.isRunMode) {
// eslint-disable-next-line
console.log(chalk.yellow(err.message))
} else {
this.coreData.warnings.push({
title: `Warning: ${str.titleize(str.humanize(err.type ?? ''))}`,
cypressError: err,
})
this.emitter.toLaunchpad()
}
}
async destroy () {
const destroy = util.promisify(this.coreData.servers.gqlServer?.destroy || (() => {}))
return Promise.all([
destroy(),
this._reset(),
])
}
/**
* Resets all of the state for the data context,
* so we can initialize fresh for each E2E test
*/
async reinitializeCypress (modeOptions: Partial<AllModeOptions> = {}) {
await this._reset()
this._modeOptions = modeOptions
this._coreData = makeCoreData(modeOptions)
// @ts-expect-error - we've already cleaned up, this is for testing only
this.lifecycleManager = new ProjectLifecycleManager(this)
globalPubSub.emit('reset:data-context', this)
}
private _reset () {
this.setAppSocketServer(undefined)
this.setGqlSocketServer(undefined)
return Promise.all([
this.lifecycleManager.destroy(),
this.cloud.reset(),
this.actions.project.clearCurrentProject(),
this.actions.dev.dispose(),
])
}
async initializeMode () {
assert(!this.coreData.hasInitializedMode)
this.coreData.hasInitializedMode = this._config.mode
if (this._config.mode === 'run') {
await this.lifecycleManager.initializeRunMode(this.coreData.currentTestingType)
} else if (this._config.mode === 'open') {
await this.initializeOpenMode()
await this.lifecycleManager.initializeOpenMode(this.coreData.currentTestingType)
} else {
throw new Error(`Missing DataContext config "mode" setting, expected run | open`)
}
}
private async initializeOpenMode () {
if (IS_DEV_ENV && !process.env.CYPRESS_INTERNAL_E2E_TESTING_SELF) {
this.actions.dev.watchForRelaunch()
}
// We want to fetch the user immediately, but we don't need to block the UI on this
this.actions.auth.getUser().catch((e) => {
// This error should never happen, since it's internally handled by getUser
// Log anyway, just incase
this.logTraceError(e)
})
const toAwait: Promise<any>[] = [
this.actions.localSettings.refreshLocalSettings(),
]
// load projects from cache on start
toAwait.push(this.actions.project.loadProjects())
await Promise.all(toAwait)
}
}