diag - improve process titles (microsoft#175632)

* diag - improve process titles

* do not use correlation id

Author: bpasero

src/vs/base/node/ps.ts

@@ -48,13 +48,7 @@ export function listProcesses(rootPid: number): Promise<ProcessItem> {
 
 		function findName(cmd: string): string {
 
-			const SHARED_PROCESS_HINT = /--vscode-window-kind=shared-process/i; // TODO@bpasero remove me
-			const ISSUE_REPORTER_HINT = /--vscode-window-kind=issue-reporter/i;
-			const PROCESS_EXPLORER_HINT = /--vscode-window-kind=process-explorer/i;
 			const UTILITY_NETWORK_HINT = /--utility-sub-type=network/i;
-			const UTILITY_EXTENSION_HOST_HINT = /--vscode-utility-kind=extensionHost/i;
-			const UTILITY_FILE_WATCHER_HOST_HINT = /--vscode-utility-kind=fileWatcher/i;
-			const UTILITY_SHARED_PROCESS_HINT = /--vscode-utility-kind=shared-process/i;
 			const NODEJS_PROCESS_HINT = /--ms-enable-electron-run-as-node/i;
 			const WINDOWS_CRASH_REPORTER = /--crashes-directory/i;
 			const WINDOWS_PTY = /\\pipe\\winpty-control/i;
@@ -80,36 +74,12 @@ export function listProcesses(rootPid: number): Promise<ProcessItem> {
 			let matches = TYPE.exec(cmd);
 			if (matches && matches.length === 2) {
 				if (matches[1] === 'renderer') {
-					if (SHARED_PROCESS_HINT.exec(cmd)) {
-						return 'shared-process';
-					}
-
-					if (ISSUE_REPORTER_HINT.exec(cmd)) {
-						return 'issue-reporter';
-					}
-
-					if (PROCESS_EXPLORER_HINT.exec(cmd)) {
-						return 'process-explorer';
-					}
-
 					return `window`;
 				} else if (matches[1] === 'utility') {
 					if (UTILITY_NETWORK_HINT.exec(cmd)) {
 						return 'utility-network-service';
 					}
 
-					if (UTILITY_EXTENSION_HOST_HINT.exec(cmd)) {
-						return 'extension-host';
-					}
-
-					if (UTILITY_FILE_WATCHER_HOST_HINT.exec(cmd)) {
-						return 'file-watcher';
-					}
-
-					if (UTILITY_SHARED_PROCESS_HINT.exec(cmd)) {
-						return 'shared-process';
-					}
-
 					return 'utility-process';
 				} else if (matches[1] === 'extensionHost') {
 					return 'extension-host'; // normalize remote extension host type

src/vs/code/electron-sandbox/processExplorer/processExplorerMain.ts

@@ -163,7 +163,7 @@ class ErrorRenderer implements ITreeRenderer<IRemoteDiagnosticError, void, IProc
 
 
 class ProcessRenderer implements ITreeRenderer<ProcessItem, void, IProcessItemTemplateData> {
-	constructor(private platform: string, private totalMem: number, private mapPidToWindowTitle: Map<number, string>) { }
+	constructor(private platform: string, private totalMem: number, private mapPidToName: Map<number, string>) { }
 
 	templateId: string = 'process';
 	renderTemplate(container: HTMLElement): IProcessItemTemplateData {
@@ -179,12 +179,12 @@ class ProcessRenderer implements ITreeRenderer<ProcessItem, void, IProcessItemTe
 	renderElement(node: ITreeNode<ProcessItem, void>, index: number, templateData: IProcessItemTemplateData, height: number | undefined): void {
 		const { element } = node;
 
+		const pid = element.pid.toFixed(0);
+
 		let name = element.name;
-		if (name === 'window') {
-			const windowTitle = this.mapPidToWindowTitle.get(element.pid);
-			name = windowTitle !== undefined ? `${name} (${this.mapPidToWindowTitle.get(element.pid)})` : name;
+		if (this.mapPidToName.has(element.pid)) {
+			name = this.mapPidToName.get(element.pid)!;
 		}
-		const pid = element.pid.toFixed(0);
 
 		templateData.name.textContent = name;
 		templateData.name.title = element.cmd;
@@ -230,7 +230,7 @@ function isProcessItem(item: any): item is ProcessItem {
 class ProcessExplorer {
 	private lastRequestTime: number;
 
-	private mapPidToWindowTitle = new Map<number, string>();
+	private mapPidToName = new Map<number, string>();
 
 	private nativeHostService: INativeHostService;
 
@@ -243,10 +243,12 @@ class ProcessExplorer {
 		this.applyStyles(data.styles);
 		this.setEventHandlers(data);
 
-		// Map window process pids to titles, annotate process names with this when rendering to distinguish between them
-		ipcRenderer.on('vscode:windowsInfoResponse', (event: unknown, windows: any[]) => {
-			this.mapPidToWindowTitle = new Map<number, string>();
-			windows.forEach(window => this.mapPidToWindowTitle.set(window.pid, window.title));
+		ipcRenderer.on('vscode:pidToNameResponse', (event: unknown, pidToNames: [number, string][]) => {
+			this.mapPidToName = new Map<number, string>();
+
+			for (const [pid, name] of pidToNames) {
+				this.mapPidToName.set(pid, name);
+			}
 		});
 
 		ipcRenderer.on('vscode:listProcessesResponse', async (event: unknown, processRoots: MachineProcessInformation[]) => {
@@ -267,7 +269,7 @@ class ProcessExplorer {
 		});
 
 		this.lastRequestTime = Date.now();
-		ipcRenderer.send('vscode:windowsInfoRequest');
+		ipcRenderer.send('vscode:pidToNameRequest');
 		ipcRenderer.send('vscode:listProcesses');
 	}
 
@@ -304,7 +306,7 @@ class ProcessExplorer {
 		const { totalmem } = await this.nativeHostService.getOSStatistics();
 
 		const renderers = [
-			new ProcessRenderer(this.data.platform, totalmem, this.mapPidToWindowTitle),
+			new ProcessRenderer(this.data.platform, totalmem, this.mapPidToName),
 			new ProcessHeaderTreeRenderer(),
 			new MachineRenderer(),
 			new ErrorRenderer()
@@ -555,7 +557,7 @@ class ProcessExplorer {
 
 			// Wait at least a second between requests.
 			if (waited > 1000) {
-				ipcRenderer.send('vscode:windowsInfoRequest');
+				ipcRenderer.send('vscode:pidToNameRequest');
 				ipcRenderer.send('vscode:listProcesses');
 			} else {
 				this.requestProcessList(waited);

src/vs/platform/diagnostics/common/diagnostics.ts

@@ -124,16 +124,23 @@ export class NullDiagnosticsService implements IDiagnosticsService {
 }
 
 export interface IWindowDiagnostics {
+	readonly id: number;
 	readonly pid: number;
 	readonly title: string;
 	readonly folderURIs: UriComponents[];
 	readonly remoteAuthority?: string;
 }
 
+export interface IProcessDiagnostics {
+	readonly pid: number;
+	readonly name: string;
+}
+
 export interface IMainProcessDiagnostics {
 	readonly mainPID: number;
 	readonly mainArguments: string[]; // All arguments after argv[0], the exec path
 	readonly windows: IWindowDiagnostics[];
+	readonly pidToNames: IProcessDiagnostics[];
 	readonly screenReader: boolean;
 	readonly gpuFeatureStatus: any;
 }

src/vs/platform/diagnostics/electron-main/diagnosticsMainService.ts

@@ -7,14 +7,15 @@ import { app, BrowserWindow, Event as IpcEvent } from 'electron';
 import { validatedIpcMain } from 'vs/base/parts/ipc/electron-main/ipcMain';
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { URI } from 'vs/base/common/uri';
-import { IDiagnosticInfo, IDiagnosticInfoOptions, IMainProcessDiagnostics, IRemoteDiagnosticError, IRemoteDiagnosticInfo, IWindowDiagnostics } from 'vs/platform/diagnostics/common/diagnostics';
+import { IDiagnosticInfo, IDiagnosticInfoOptions, IMainProcessDiagnostics, IProcessDiagnostics, IRemoteDiagnosticError, IRemoteDiagnosticInfo, IWindowDiagnostics } from 'vs/platform/diagnostics/common/diagnostics';
 import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
 import { ICodeWindow } from 'vs/platform/window/electron-main/window';
 import { IWindowsMainService } from 'vs/platform/windows/electron-main/windows';
 import { isSingleFolderWorkspaceIdentifier, isWorkspaceIdentifier } from 'vs/platform/workspace/common/workspace';
 import { IWorkspacesManagementMainService } from 'vs/platform/workspaces/electron-main/workspacesManagementMainService';
 import { assertIsDefined } from 'vs/base/common/types';
 import { ILogService } from 'vs/platform/log/common/log';
+import { UtilityProcess } from 'vs/platform/utilityProcess/electron-main/utilityProcess';
 
 export const ID = 'diagnosticsMainService';
 export const IDiagnosticsMainService = createDecorator<IDiagnosticsMainService>(ID);
@@ -88,10 +89,16 @@ export class DiagnosticsMainService implements IDiagnosticsMainService {
 			}
 		}
 
+		const pidToNames: IProcessDiagnostics[] = [];
+		for (const { pid, name } of UtilityProcess.getAll()) {
+			pidToNames.push({ pid, name });
+		}
+
 		return {
 			mainPID: process.pid,
 			mainArguments: process.argv.slice(1),
 			windows,
+			pidToNames,
 			screenReader: !!app.accessibilitySupportEnabled,
 			gpuFeatureStatus: app.getGPUFeatureStatus()
 		};
@@ -106,6 +113,7 @@ export class DiagnosticsMainService implements IDiagnosticsMainService {
 
 	private browserWindowToInfo(window: BrowserWindow, folderURIs: URI[] = [], remoteAuthority?: string): IWindowDiagnostics {
 		return {
+			id: window.id,
 			pid: window.webContents.getOSProcessId(),
 			title: window.getTitle(),
 			folderURIs,

src/vs/platform/diagnostics/node/diagnosticsService.ts

@@ -456,32 +456,33 @@ export class DiagnosticsService implements IDiagnosticsService {
 	}
 
 	private formatProcessList(info: IMainProcessDiagnostics, rootProcess: ProcessItem): string {
-		const mapPidToWindowTitle = new Map<number, string>();
-		info.windows.forEach(window => mapPidToWindowTitle.set(window.pid, window.title));
+		const mapProcessToName = new Map<number, string>();
+		info.windows.forEach(window => mapProcessToName.set(window.pid, `window [${window.id}] (${window.title})`));
+		info.pidToNames.forEach(({ pid, name }) => mapProcessToName.set(pid, name));
 
 		const output: string[] = [];
 
 		output.push('CPU %\tMem MB\t   PID\tProcess');
 
 		if (rootProcess) {
-			this.formatProcessItem(info.mainPID, mapPidToWindowTitle, output, rootProcess, 0);
+			this.formatProcessItem(info.mainPID, mapProcessToName, output, rootProcess, 0);
 		}
 
 		return output.join('\n');
 	}
 
-	private formatProcessItem(mainPid: number, mapPidToWindowTitle: Map<number, string>, output: string[], item: ProcessItem, indent: number): void {
+	private formatProcessItem(mainPid: number, mapProcessToName: Map<number, string>, output: string[], item: ProcessItem, indent: number): void {
 		const isRoot = (indent === 0);
 
 		// Format name with indent
 		let name: string;
 		if (isRoot) {
 			name = item.pid === mainPid ? `${this.productService.applicationName} main` : 'remote agent';
 		} else {
-			name = `${'  '.repeat(indent)} ${item.name}`;
-
-			if (item.name === 'window') {
-				name = `${name} (${mapPidToWindowTitle.get(item.pid)})`;
+			if (mapProcessToName.has(item.pid)) {
+				name = mapProcessToName.get(item.pid)!;
+			} else {
+				name = `${'  '.repeat(indent)} ${item.name}`;
 			}
 		}
 
@@ -490,7 +491,7 @@ export class DiagnosticsService implements IDiagnosticsService {
 
 		// Recurse into children if any
 		if (Array.isArray(item.children)) {
-			item.children.forEach(child => this.formatProcessItem(mainPid, mapPidToWindowTitle, output, child, indent + 1));
+			item.children.forEach(child => this.formatProcessItem(mainPid, mapProcessToName, output, child, indent + 1));
 		}
 	}
 

src/vs/platform/issue/electron-main/issueMainService.ts

@@ -27,6 +27,7 @@ import { IWindowState } from 'vs/platform/window/electron-main/window';
 import { randomPath } from 'vs/base/common/extpath';
 import { withNullAsUndefined } from 'vs/base/common/types';
 import { IStateService } from 'vs/platform/state/node/state';
+import { UtilityProcess } from 'vs/platform/utilityProcess/electron-main/utilityProcess';
 
 export const IIssueMainService = createDecorator<IIssueMainService>('issueMainService');
 const processExplorerWindowState = 'issue.processExplorerWindowState';
@@ -178,9 +179,19 @@ export class IssueMainService implements IIssueMainService {
 			this.processExplorerWindow?.close();
 		});
 
-		validatedIpcMain.on('vscode:windowsInfoRequest', async event => {
+		validatedIpcMain.on('vscode:pidToNameRequest', async event => {
 			const mainProcessInfo = await this.diagnosticsMainService.getMainDiagnostics();
-			this.safeSend(event, 'vscode:windowsInfoResponse', mainProcessInfo.windows);
+
+			const pidToNames: [number, string][] = [];
+			for (const window of mainProcessInfo.windows) {
+				pidToNames.push([window.pid, `window [${window.id}] (${window.title})`]);
+			}
+
+			for (const { pid, name } of UtilityProcess.getAll()) {
+				pidToNames.push([pid, name]);
+			}
+
+			this.safeSend(event, 'vscode:pidToNameResponse', pidToNames);
 		});
 	}
 
@@ -343,7 +354,7 @@ export class IssueMainService implements IIssueMainService {
 			backgroundColor: options.backgroundColor || IssueMainService.DEFAULT_BACKGROUND_COLOR,
 			webPreferences: {
 				preload: FileAccess.asFileUri('vs/base/parts/sandbox/electron-browser/preload.js').fsPath,
-				additionalArguments: [`--vscode-window-config=${ipcObjectUrl.resource.toString()}`, `--vscode-window-kind=${windowKind}`],
+				additionalArguments: [`--vscode-window-config=${ipcObjectUrl.resource.toString()}`],
 				v8CacheOptions: this.environmentMainService.useCodeCache ? 'bypassHeatCheck' : 'none',
 				enableWebSQL: false,
 				spellcheck: false,

src/vs/platform/sharedProcess/electron-main/sharedProcess.ts

@@ -306,9 +306,10 @@ export class SharedProcess extends Disposable implements ISharedProcess {
 		this.window = new BrowserWindow({
 			show: false,
 			backgroundColor: this.themeMainService.getBackgroundColor(),
+			title: 'shared-process',
 			webPreferences: {
 				preload: FileAccess.asFileUri('vs/base/parts/sandbox/electron-browser/preload.js').fsPath,
-				additionalArguments: [`--vscode-window-config=${configObjectUrl.resource.toString()}`, '--vscode-window-kind=shared-process'],
+				additionalArguments: [`--vscode-window-config=${configObjectUrl.resource.toString()}`],
 				v8CacheOptions: this.environmentMainService.useCodeCache ? 'bypassHeatCheck' : 'none',
 				nodeIntegration: true,
 				nodeIntegrationInWorker: true,

src/vs/platform/utilityProcess/electron-main/utilityProcess.ts

@@ -88,6 +88,12 @@ export interface IWindowUtilityProcessConfiguration extends IUtilityProcessConfi
 	readonly windowLifecycleBound?: boolean;
 }
 
+function isWindowUtilityProcessConfiguration(config: IUtilityProcessConfiguration): config is IWindowUtilityProcessConfiguration {
+	const candidate = config as IWindowUtilityProcessConfiguration;
+
+	return typeof candidate.responseWindowId === 'number';
+}
+
 interface IUtilityProcessExitBaseEvent {
 
 	/**
@@ -118,10 +124,20 @@ export interface IUtilityProcessCrashEvent extends IUtilityProcessExitBaseEvent
 	readonly reason: 'clean-exit' | 'abnormal-exit' | 'killed' | 'crashed' | 'oom' | 'launch-failed' | 'integrity-failure';
 }
 
+export interface IUtilityProcessInfo {
+	readonly pid: number;
+	readonly name: string;
+}
+
 export class UtilityProcess extends Disposable {
 
 	private static ID_COUNTER = 0;
 
+	private static readonly all = new Map<number, IUtilityProcessInfo>();
+	static getAll(): IUtilityProcessInfo[] {
+		return Array.from(UtilityProcess.all.values());
+	}
+
 	private readonly id = String(++UtilityProcess.ID_COUNTER);
 
 	private readonly _onStdout = this._register(new Emitter<string>());
@@ -206,7 +222,7 @@ export class UtilityProcess extends Disposable {
 		const serviceName = `${this.configuration.type}-${this.id}`;
 		const modulePath = FileAccess.asFileUri('bootstrap-fork.js').fsPath;
 		const args = this.configuration.args ?? [];
-		const execArgv = this.configuration.execArgv ?? []; // TODO@deepak1556 this should be [...this.configuration.execArgv ?? [], `--vscode-utility-kind=${this.configuration.type}`] but is causing https://github.com/microsoft/vscode/issues/154549
+		const execArgv = this.configuration.execArgv ?? [];
 		const allowLoadingUnsignedLibraries = this.configuration.allowLoadingUnsignedLibraries;
 		const stdio = 'pipe';
 		const env = this.createEnv(configuration, isWindowSandboxed);
@@ -273,6 +289,10 @@ export class UtilityProcess extends Disposable {
 		this._register(Event.fromNodeEventEmitter<void>(process, 'spawn')(() => {
 			this.processPid = process.pid;
 
+			if (typeof process.pid === 'number') {
+				UtilityProcess.all.set(process.pid, { pid: process.pid, name: isWindowUtilityProcessConfiguration(configuration) ? `${configuration.type} [${configuration.responseWindowId}]` : configuration.type });
+			}
+
 			this.log('successfully created', Severity.Info);
 		}));
 
@@ -387,6 +407,10 @@ export class UtilityProcess extends Disposable {
 	}
 
 	private onDidExitOrCrashOrKill(): void {
+		if (typeof this.processPid === 'number') {
+			UtilityProcess.all.delete(this.processPid);
+		}
+
 		this.process = undefined;
 	}