Rename terminal instance on enter in Windows #30732

Lixire · 2017-07-14T19:52:54Z

Fix part of #30152

Renames shell on enter in Windows (debounced)
Takes the lowest first child of the pid tree

Noted flaws:

Since it only updates on enter, it will not change from ie node to powershell if npm install is run and finishes

Tyriar · 2017-07-14T19:53:58Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
+*  Copyright (c) Microsoft Corporation. All rights reserved.


Not sure why there are diffs on this line? You might have committed the wrong line endings or something

Tyriar · 2017-07-14T19:54:27Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

+*  Licensed under the MIT License. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+'use strict';


I'm not sure this adds anything in a file compiled by strict TS

Tyriar · 2017-07-14T19:56:15Z

src/vs/workbench/parts/terminal/electron-browser/terminalPanel.ts

- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
+*  Copyright (c) Microsoft Corporation. All rights reserved.


This should also not have a diff

Tyriar · 2017-07-14T19:56:31Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

+			this._pidStack.push(this._processId);
+		}
+		return new TPromise<string>((resolve) => {
+			// wait 100ms before running getChildProcesses


We should explain why the wait is needed here

Tyriar · 2017-07-14T19:57:55Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -846,6 +867,57 @@ export class TerminalInstance implements ITerminalInstance {
 			this._messageTitleListener = null;
 		}
 	}
+
+	private static executeWMIC(pid: number): TPromise<{ executable: string, pid: number }[]> {


A more general name for what the function is actually doing here, is this accurate? getFirstWindowsChildProcess

Tyriar · 2017-07-14T20:00:13Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

+		});
+	}
+
+	private getChildProcesses(pid: number): TPromise<string> {


A better name might be refreshWindowsShellProcessTree?

Tyriar · 2017-07-14T20:02:39Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -135,6 +139,18 @@ export class TerminalInstance implements ITerminalInstance {
 		this._createProcess(this._shellLaunchConfig);
 		this._createXterm();

+		this._pidStack = [];
+		this._checkWindowShell = new Emitter<string>();
+		debounceEvent(this._checkWindowShell.event, (l, e) => e, 100, true)


This should only be called on Windows, otherwise we're still doing a lot of work on enter for nothing on macOS/Linux.

Tyriar · 2017-07-14T20:04:24Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -261,6 +277,11 @@ export class TerminalInstance implements ITerminalInstance {
 			if (TabFocus.getTabFocusMode() && event.keyCode === 9) {
 				return false;
 			}
+
+			if (platform.isWindows && event.keyCode === 13 /* ENTER */) {
+				this._checkWindowShell.fire();


I think we actually want to use this instead of bringing in the overhead of an event/emitter https://github.com/Microsoft/vscode/blob/e49ae72a37b22a7e7f2ed3a6bf052076e9a283d9/extensions/git/src/contentProvider.ts#L42

Tyriar · 2017-07-14T20:05:38Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -135,6 +139,18 @@ export class TerminalInstance implements ITerminalInstance {
 		this._createProcess(this._shellLaunchConfig);
 		this._createXterm();

+		this._pidStack = [];
+		this._checkWindowShell = new Emitter<string>();
+		debounceEvent(this._checkWindowShell.event, (l, e) => e, 100, true)


Maybe we should pull all this code out into another file so we don't clutter TerminalInstance? This would also simplify the function names as we can have Windows in the new class name.

Tyriar · 2017-07-14T20:06:12Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

+					}
+					resolve(this._shellLaunchConfig.executable);
+				}, error => { return error; });
+			}, 100);


We should move this to a named constant (especially because the comment explaining is so far from this line.

Tyriar · 2017-07-17T20:13:00Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -81,6 +82,8 @@ export class TerminalInstance implements ITerminalInstance {
 	private _messageTitleListener: (message: { type: string, content: string }) => void;
 	private _preLaunchInputQueue: string;
 	private _initialCwd: string;
+	private _windowsShellService: WindowsShellService;
+	private _checkWindowShell: Emitter<string>;


Let's make this _onCheckWindowsShell to be consistent with other Emitters.

Tyriar · 2017-07-17T20:18:11Z

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -846,6 +862,15 @@ export class TerminalInstance implements ITerminalInstance {
 			this._messageTitleListener = null;
 		}
 	}
+
+	public eventuallyGetShellName(): void {


Let's return the promise here. Also a better name would be updateShellName (or updateWindowsShellName if it's in TerminalInstance. Since TerminalInstance.setTitle is on the interface let's move this whole function into WindowsShellService.

Tyriar · 2017-07-17T20:19:12Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+/** The amount of time to wait before getting the shell process name */
+const WAIT_FOR_SHELL_UPDATE = 100;
+
+export class WindowsShellService {


Let's make this WindowsShellHelper because it is not a "registered service" like TerminalService is.

Tyriar · 2017-07-17T20:20:30Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+
+export class WindowsShellService {
+	private _pidStack: number[];
+	private _processId: number;


_rootProcessId to differentiate from _pidStack

Tyriar · 2017-07-17T20:22:44Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+export class WindowsShellService {
+	private _pidStack: number[];
+	private _processId: number;
+	private _shellLaunchConfig: IShellLaunchConfig;


Let's pass in the executable instead (_rootProcessExecutable) as that's all this class cares about.

Tyriar · 2017-07-17T20:24:07Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+		this._shellLaunchConfig = shell;
+	}
+
+	private static getFirstWindowsChildProcess(pid: number): TPromise<{ executable: string, pid: number }[]> {


We can remove Windows from the name here since we're in a class containing "Windows" now. Also doesn't need to be static.

Tyriar · 2017-07-17T20:24:28Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+		});
+	}
+
+	private refreshWindowsShellProcessTree(pid: number, flag: boolean): TPromise<string> {


Same, remove "Windows"

Tyriar · 2017-07-17T20:25:01Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+	private refreshWindowsShellProcessTree(pid: number, flag: boolean): TPromise<string> {
+		return WindowsShellService.getFirstWindowsChildProcess(pid).then(result => {
+			if (result.length === 0) {
+				if (flag) {


Not sure what flag does?

Tyriar · 2017-07-17T20:26:50Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+	 */
+	public getShellName(): TPromise<string> {
+		if (platform.platform !== platform.Platform.Windows) {
+			throw null;


Let's move this to the constructor.

throw new Error(`WindowsShellHelper cannot be instantiated on ${platform.platform}`);

Tyriar · 2017-07-17T20:27:56Z

src/vs/workbench/parts/terminal/electron-browser/windowsShellService.ts

+import { TPromise } from 'vs/base/common/winjs.base';
+
+/** The amount of time to wait before getting the shell process name */
+const WAIT_FOR_SHELL_UPDATE = 100;


WAIT_AFTER_ENTER_TIME is a little more descriptive.

Tyriar · 2017-07-20T02:53:26Z

Woo! 🎉

rianadon and others added 3 commits July 3, 2017 12:57

Properly format file path on drop in Windows

53040a1

Fix conflicts

a9d93b8

Update Windows process name in integrated terminal on enter

8ec3665

Lixire requested a review from Tyriar July 14, 2017 19:52

msftclas added the cla-not-required label Jul 14, 2017

Tyriar requested changes Jul 14, 2017

View reviewed changes

Tyriar assigned Tyriar and Lixire Jul 14, 2017

Tyriar added this to the July 2017 milestone Jul 14, 2017

Address changes

c2772f3

Tyriar requested changes Jul 17, 2017

View reviewed changes

Lixire force-pushed the amqi/update-window-shellname branch from 0c1d2e9 to a737109 Compare July 17, 2017 21:40

Refactoring

a2a61b1

Lixire force-pushed the amqi/update-window-shellname branch from a737109 to a2a61b1 Compare July 17, 2017 21:42

Lixire added 7 commits July 17, 2017 15:42

Change filename

aeaafd3

Fix conflicts

90006b7

Address feedback

d8f2e3d

Reduce dependencies

509f4b3

Remove timeout and fix event trigger

ad62caf

Fix git executable name

ec3bfc8

Refactoring

b9f99bc

Tyriar approved these changes Jul 20, 2017

View reviewed changes

Tyriar merged commit 7d4e15a into master Jul 20, 2017

Tyriar deleted the amqi/update-window-shellname branch July 20, 2017 02:53

rianadon mentioned this pull request Jul 21, 2017

Properly format file path on when dragging and dropping a tab into the integrated terminal in Windows #30070

Merged

the-ress mentioned this pull request Aug 6, 2017

Terminal leaks processes #26807

Closed

github-actions bot locked and limited conversation to collaborators Mar 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename terminal instance on enter in Windows #30732

Rename terminal instance on enter in Windows #30732

Lixire commented Jul 14, 2017 •

edited

Loading

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 14, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar Jul 17, 2017

Tyriar commented Jul 20, 2017

Rename terminal instance on enter in Windows #30732

Rename terminal instance on enter in Windows #30732

Conversation

Lixire commented Jul 14, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tyriar commented Jul 20, 2017

Lixire commented Jul 14, 2017 •

edited

Loading