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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Workbench } from './workbench';
import { Code, launch, LaunchOptions } from './code';
import { Logger } from './logger';
export const enum Quality {
Dev,
Insiders,
Stable
}
export interface ApplicationOptions extends LaunchOptions {
quality: Quality;
workspacePath: string;
waitTime: number;
}
export class Application {
private static INSTANCES = 0;
constructor(private options: ApplicationOptions) {
Application.INSTANCES++;
this._userDataPath = options.userDataDir;
this._workspacePathOrFolder = options.workspacePath;
}
private _code: Code | undefined;
get code(): Code { return this._code!; }
private _workbench: Workbench | undefined;
get workbench(): Workbench { return this._workbench!; }
get quality(): Quality {
return this.options.quality;
}
get logger(): Logger {
return this.options.logger;
}
get remote(): boolean {
return !!this.options.remote;
}
get web(): boolean {
return !!this.options.web;
}
get legacy(): boolean {
return !!this.options.legacy;
}
private _workspacePathOrFolder: string;
get workspacePathOrFolder(): string {
return this._workspacePathOrFolder;
}
get extensionsPath(): string {
return this.options.extensionsPath;
}
private _userDataPath: string;
get userDataPath(): string {
return this._userDataPath;
}
async start(): Promise<any> {
await this._start();
await this.code.waitForElement('.explorer-folders-view');
}
async restart(options?: { workspaceOrFolder?: string; extraArgs?: string[] }): Promise<any> {
await this.stop();
await this._start(options?.workspaceOrFolder, options?.extraArgs);
}
private async _start(workspaceOrFolder = this.workspacePathOrFolder, extraArgs: string[] = []): Promise<any> {
this._workspacePathOrFolder = workspaceOrFolder;
// Launch Code...
const code = await this.startApplication(extraArgs);
// ...and make sure the window is ready to interact
const windowReady = this.checkWindowReady(code);
// Make sure to take a screenshot if waiting for window ready
// takes unusually long to help diagnose issues when Code does
// not seem to startup healthy.
const timeoutHandle = setTimeout(() => this.takeScreenshot(`checkWindowReady_instance_${Application.INSTANCES}`), 20000);
try {
await windowReady;
} finally {
clearTimeout(timeoutHandle);
}
}
async stop(): Promise<any> {
if (this._code) {
try {
await this._code.exit();
} finally {
this._code = undefined;
}
}
}
async startTracing(name: string): Promise<void> {
await this._code?.startTracing(name);
}
async stopTracing(name: string, persist: boolean): Promise<void> {
await this._code?.stopTracing(name, persist);
}
private async takeScreenshot(name: string): Promise<void> {
if (this.web || !this.legacy) {
return; // supported only on desktop (legacy)
}
// Desktop (legacy): call `stopTracing` to take a screenshot
return this._code?.stopTracing(name, true);
}
private async startApplication(extraArgs: string[] = []): Promise<Code> {
const code = this._code = await launch({
...this.options,
extraArgs: [...(this.options.extraArgs || []), ...extraArgs],
});
this._workbench = new Workbench(this._code, this.userDataPath);
return code;
}
private async checkWindowReady(code: Code): Promise<any> {
this.logger.log('checkWindowReady: begin');
await code.waitForWindowIds(ids => ids.length > 0);
await code.waitForElement('.monaco-workbench');
// Remote but not web: wait for a remote connection state change
if (this.remote) {
await code.waitForTextContent('.monaco-workbench .statusbar-item[id="status.host"]', undefined, s => {
this.logger.log(`checkWindowReady: remote indicator text is ${s}`);
// The absence of "Opening Remote" is not a strict
// indicator for a successful connection, but we
// want to avoid hanging here until timeout because
// this method is potentially called from a location
// that has no tracing enabled making it hard to
// diagnose this. As such, as soon as the connection
// state changes away from the "Opening Remote..." one
// we return.
return !s.includes('Opening Remote');
}, 300 /* = 30s of retry */);
}
this.logger.log('checkWindowReady: end');
}
}
|
