{{ message }}
Repository navigation
Expand file tree
/
Copy pathprocess.ts
More file actions
370 lines (319 loc) · 13.8 KB
/
Copy pathprocess.ts
File metadata and controls
370 lines (319 loc) · 13.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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import cp = require("child_process");
import path = require("path");
import vscode = require("vscode");
import { promisify } from "util";
import type { ILogger } from "./logging";
import type { IEditorServicesSessionDetails } from "./session";
import { validateCwdSetting } from "./settings";
import utils = require("./utils");
export class PowerShellProcess {
private static title = "PowerShell Extension";
public onExited: vscode.Event<void>;
private onExitedEmitter?: vscode.EventEmitter<void>;
private consoleTerminal?: vscode.Terminal;
private consoleCloseSubscription?: vscode.Disposable;
private pid?: number;
private pidUpdateEmitter?: vscode.EventEmitter<number | undefined>;
// Captured when the terminal closes so callers can report why the process
// exited (e.g. a non-zero exit code) instead of a generic failure message.
private exitStatus?: vscode.TerminalExitStatus;
constructor(
public exePath: string,
private bundledModulesPath: string,
private isTemp: boolean,
private shellIntegrationEnabled: boolean,
private logger: ILogger,
private logDirectoryPath: vscode.Uri,
private startPsesArgs: string,
private sessionFilePath: vscode.Uri,
private devMode = false,
) {
this.onExitedEmitter = new vscode.EventEmitter<void>();
this.onExited = this.onExitedEmitter.event;
this.pidUpdateEmitter = new vscode.EventEmitter<number | undefined>();
}
public async start(
cancellationToken: vscode.CancellationToken,
): Promise<IEditorServicesSessionDetails | undefined> {
const psesModulePath = path.resolve(
__dirname,
this.bundledModulesPath,
"PowerShellEditorServices/PowerShellEditorServices.psd1",
);
const featureFlags = vscode.workspace
.getConfiguration("powershell.developer")
.get<string[]>("featureFlags", [])
.map((f) => `'${f}'`)
.join(", ");
this.startPsesArgs +=
`-LogPath '${utils.escapeSingleQuotes(this.logDirectoryPath.fsPath)}' ` +
`-SessionDetailsPath '${utils.escapeSingleQuotes(this.sessionFilePath.fsPath)}' ` +
`-FeatureFlags @(${featureFlags}) `;
const useLegacyReadLine = vscode.workspace
.getConfiguration("powershell.integratedConsole")
.get<boolean>("useLegacyReadLine");
if (useLegacyReadLine) {
this.startPsesArgs += "-UseLegacyReadLine";
}
const powerShellArgs: string[] = [];
const useLoginShell =
(utils.isMacOS &&
vscode.workspace
.getConfiguration("powershell.startAsLoginShell")
.get<boolean>("osx", true)) ||
(utils.isLinux &&
vscode.workspace
.getConfiguration("powershell.startAsLoginShell")
.get<boolean>("linux"));
if (useLoginShell && this.isLoginShell(this.exePath)) {
// This MUST be the first argument.
powerShellArgs.push("-Login");
}
powerShellArgs.push("-NoProfile");
// Only add ExecutionPolicy param on Windows
const setExecutionPolicy =
utils.isWindows &&
vscode.workspace
.getConfiguration("powershell.developer")
.get<boolean>("setExecutionPolicy", true);
if (setExecutionPolicy) {
powerShellArgs.push("-ExecutionPolicy", "Bypass");
}
const startEditorServices =
"Import-Module '" +
utils.escapeSingleQuotes(psesModulePath) +
"'; Start-EditorServices " +
this.startPsesArgs;
// On Windows we unfortunately can't Base64 encode the startup command
// because it annoys some poorly implemented anti-virus scanners.
if (utils.isWindows) {
powerShellArgs.push("-Command", startEditorServices);
} else {
// Otherwise use -EncodedCommand for better quote support.
this.logger.writeDebug(
"Using Base64 -EncodedCommand but logging as -Command equivalent.",
);
powerShellArgs.push(
"-EncodedCommand",
Buffer.from(startEditorServices, "utf16le").toString("base64"),
);
}
this.logger.writeDebug(
`Starting process: ${this.exePath} ${powerShellArgs.slice(0, -2).join(" ")} -Command ${startEditorServices}`,
);
// Make sure no old session file exists
await this.deleteSessionFile(this.sessionFilePath);
// When VS Code shell integration is enabled, the script expects certain
// variables to be added to the environment.
let envMixin = {};
if (this.shellIntegrationEnabled) {
envMixin = {
VSCODE_INJECTION: "1",
// There is no great way to check if we are running stable VS
// Code. Since this is used to disable experimental features, we
// default to stable unless we're definitely running Insiders.
VSCODE_STABLE: vscode.env.appName.includes("Insiders")
? "0"
: "1",
// Maybe one day we can set VSCODE_NONCE...
};
}
// Enables Hot Reload in .NET for the attached process
// https://devblogs.microsoft.com/devops/net-enc-support-for-lambdas-and-other-improvements-in-visual-studio-2015/
if (this.devMode) {
(envMixin as Record<string, string>).COMPLUS_FORCEENC = "1";
}
// Launch PowerShell in the integrated terminal
const startLocation = vscode.workspace
.getConfiguration("powershell.integratedConsole")
.get<string>("startLocation", "Panel");
const terminalOptions: vscode.TerminalOptions = {
name: this.isTemp
? `${PowerShellProcess.title} (TEMP)`
: PowerShellProcess.title,
shellPath: this.exePath,
shellArgs: powerShellArgs,
cwd: await validateCwdSetting(this.logger),
env: envMixin,
iconPath: new vscode.ThemeIcon("terminal-powershell"),
isTransient: true,
hideFromUser: vscode.workspace
.getConfiguration("powershell.integratedConsole")
.get<boolean>("startInBackground"),
location:
startLocation === "Editor"
? vscode.TerminalLocation.Editor
: vscode.TerminalLocation.Panel,
};
// Subscribe a log event for when the terminal closes (this fires for
// all terminals and the event itself checks if it's our terminal). This
// subscription should happen before we create the terminal so if it
// fails immediately, the event fires.
this.consoleCloseSubscription = vscode.window.onDidCloseTerminal(
(terminal) => {
this.onTerminalClose(terminal);
},
);
this.consoleTerminal = vscode.window.createTerminal(terminalOptions);
this.pid = await this.getPid();
this.logger.write(`PowerShell process started with PID: ${this.pid}`);
this.pidUpdateEmitter?.fire(this.pid);
const showOnStartup = vscode.workspace
.getConfiguration("powershell.integratedConsole")
.get<boolean>("showOnStartup", true);
const startInBackground = vscode.workspace
.getConfiguration("powershell.integratedConsole")
.get<boolean>("startInBackground");
if (showOnStartup && !startInBackground) {
// We still need to run this to set the active terminal to the extension terminal.
this.consoleTerminal.show(true);
}
return await this.waitForSessionFile(cancellationToken);
}
// This function is used to clean-up stale PowerShell Extension terminals,
// which can happen with `restartExtensionHost` is called because we are
// unable to finish diposing before we're gone.
public static cleanUpTerminals(): void {
for (const terminal of vscode.window.terminals) {
if (terminal.name.startsWith(PowerShellProcess.title)) {
terminal.dispose();
}
}
}
// This function should only be used after a failure has occurred because it is slow!
public async getVersionCli(): Promise<string> {
const exec = promisify(cp.execFile);
const { stdout } = await exec(this.exePath, [
"-NoProfile",
"-NoLogo",
"-Command",
"$PSVersionTable.PSVersion.ToString()",
]);
return stdout.trim();
}
// Returns the process Id of the consoleTerminal
public async getPid(): Promise<number | undefined> {
return await this.consoleTerminal?.processId;
}
// Returns the exit status of the terminal, if it has closed. This is
// captured before the terminal is disposed so callers can report a non-zero
// exit code when the process terminates before connecting.
public getExitStatus(): vscode.TerminalExitStatus | undefined {
return this.exitStatus;
}
public showTerminal(preserveFocus?: boolean): void {
this.consoleTerminal?.show(preserveFocus);
}
public dispose(): void {
this.logger.writeDebug(
`Disposing PowerShell process with PID: ${this.pid}`,
);
void this.deleteSessionFile(this.sessionFilePath);
this.onExitedEmitter?.fire();
this.onExitedEmitter = undefined;
this.consoleTerminal?.dispose();
this.consoleTerminal = undefined;
this.consoleCloseSubscription?.dispose();
this.consoleCloseSubscription = undefined;
this.pidUpdateEmitter?.dispose();
this.pidUpdateEmitter = undefined;
}
public sendKeyPress(): void {
// NOTE: This is a regular character instead of something like \0
// because non-printing characters can cause havoc with different
// languages and terminal settings. We discard the character server-side
// anyway, so it doesn't matter what we send.
this.consoleTerminal?.sendText("p", false);
}
private isLoginShell(pwshPath: string): boolean {
try {
// We can't know what version of PowerShell we have without running it
// So we try to start PowerShell with -Login
// If it exits successfully, we return true
// If it exits unsuccessfully, node throws, we catch, and return false
cp.execFileSync(pwshPath, [
"-Login",
"-NoProfile",
"-NoLogo",
"-Command",
"exit 0",
]);
} catch {
return false;
}
return true;
}
private async readSessionFile(
sessionFilePath: vscode.Uri,
): Promise<IEditorServicesSessionDetails> {
const fileContents =
await vscode.workspace.fs.readFile(sessionFilePath);
return JSON.parse(fileContents.toString());
}
private async deleteSessionFile(
sessionFilePath: vscode.Uri,
): Promise<void> {
try {
await vscode.workspace.fs.delete(sessionFilePath);
} catch {
// We don't care about any reasons for it to fail.
}
}
private async waitForSessionFile(
cancellationToken: vscode.CancellationToken,
): Promise<IEditorServicesSessionDetails | undefined> {
const numOfTries = // We sleep for 1/5 of a second each try
5 *
vscode.workspace
.getConfiguration("powershell.developer")
.get("waitForSessionFileTimeoutSeconds", 240);
const warnAt = numOfTries - 5 * 30; // Warn at 30 seconds
// Check every second.
this.logger.writeDebug(
`Waiting for session file: ${this.sessionFilePath}`,
);
for (let i = numOfTries; i > 0; i--) {
if (cancellationToken.isCancellationRequested) {
this.logger.writeWarning(
"Canceled while waiting for session file.",
);
return undefined;
}
if (this.consoleTerminal === undefined) {
this.logger.writeError("Extension Terminal is undefined.");
return undefined;
}
if (await utils.checkIfFileExists(this.sessionFilePath)) {
this.logger.writeDebug("Session file found.");
return await this.readSessionFile(this.sessionFilePath);
}
if (warnAt === i) {
void this.logger.writeAndShowWarning(
"Loading the PowerShell extension is taking longer than expected. If you're using privilege enforcement software, this can affect start up performance.",
);
}
// Wait 1/5 of a second and try again
await utils.sleep(200);
}
this.logger.writeError("Timed out waiting for session file!");
return undefined;
}
private onTerminalClose(terminal: vscode.Terminal): void {
if (terminal !== this.consoleTerminal) {
return;
}
// Capture the exit status before disposing so it can be reported. A
// non-zero code means the process failed to start; `undefined` means
// the user (or VS Code) closed the terminal.
this.exitStatus = terminal.exitStatus;
const code = this.exitStatus?.code;
this.logger.writeWarning(
`PowerShell process terminated or Extension Terminal was closed${
code !== undefined ? ` with exit code: ${code}` : ""
}, PID: ${this.pid}`,
);
this.dispose();
}
}
You can’t perform that action at this time.