Merge pull request microsoft#185777 from microsoft/tyriar/185393_2__ptyhost_marks

Track local and remote pty host perf marks

Author: Tyriar

src/vs/platform/terminal/common/terminal.ts

@@ -14,6 +14,7 @@ import { ISerializableEnvironmentVariableCollections } from 'vs/platform/termina
 import { RawContextKey } from 'vs/platform/contextkey/common/contextkey';
 import { IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
 import { Registry } from 'vs/platform/registry/common/platform';
+import type * as performance from 'vs/base/common/performance';
 
 export const terminalTabFocusContextKey = new RawContextKey<boolean>('terminalTabFocusMode', false, true);
 
@@ -310,6 +311,7 @@ export interface IPtyService extends IPtyHostController {
 	 * Lists all orphaned processes, ie. those without a connected frontend.
 	 */
 	listProcesses(): Promise<IProcessDetails[]>;
+	getPerformanceMarks(): Promise<performance.PerformanceMark[]>;
 
 	start(id: number): Promise<ITerminalLaunchError | { injectedArgs: string[] } | undefined>;
 	shutdown(id: number, immediate: boolean): Promise<void>;
@@ -982,6 +984,7 @@ export interface ITerminalBackend {
 	updateTitle(id: number, title: string, titleSource: TitleEventSource): Promise<void>;
 	updateIcon(id: number, userInitiated: boolean, icon: TerminalIcon, color?: string): Promise<void>;
 	getTerminalLayoutInfo(): Promise<ITerminalsLayoutInfo | undefined>;
+	getPerformanceMarks(): Promise<performance.PerformanceMark[]>;
 	reduceConnectionGraceTime(): Promise<void>;
 	requestDetachInstance(workspaceId: string, instanceId: number): Promise<IProcessDetails | undefined>;
 	acceptDetachInstanceReply(requestId: number, persistentProcessId?: number): Promise<void>;

src/vs/platform/terminal/node/ptyHostService.ts

@@ -18,6 +18,7 @@ import { registerTerminalPlatformConfiguration } from 'vs/platform/terminal/comm
 import { IGetTerminalLayoutInfoArgs, IProcessDetails, ISetTerminalLayoutInfoArgs } from 'vs/platform/terminal/common/terminalProcess';
 import { IPtyHostConnection, IPtyHostStarter } from 'vs/platform/terminal/node/ptyHost';
 import { detectAvailableProfiles } from 'vs/platform/terminal/node/terminalProfiles';
+import * as performance from 'vs/base/common/performance';
 
 enum Constants {
 	MaxRestarts = 5
@@ -229,6 +230,9 @@ export class PtyHostService extends Disposable implements IPtyService {
 	listProcesses(): Promise<IProcessDetails[]> {
 		return this._proxy.listProcesses();
 	}
+	getPerformanceMarks(): Promise<performance.PerformanceMark[]> {
+		return this._proxy.getPerformanceMarks();
+	}
 	reduceConnectionGraceTime(): Promise<void> {
 		return this._proxy.reduceConnectionGraceTime();
 	}

src/vs/platform/terminal/node/ptyService.ts

@@ -31,6 +31,7 @@ import { IPtyHostProcessReplayEvent } from 'vs/platform/terminal/common/capabili
 import { IProductService } from 'vs/platform/product/common/productService';
 import { join } from 'path';
 import { memoize } from 'vs/base/common/decorators';
+import * as performance from 'vs/base/common/performance';
 
 export function traceRpc(_target: any, key: string, descriptor: any) {
 	if (typeof descriptor.value !== 'function') {
@@ -344,6 +345,11 @@ export class PtyService extends Disposable implements IPtyService {
 		return allTerminals.filter(entry => entry.isOrphan);
 	}
 
+	@traceRpc
+	async getPerformanceMarks(): Promise<performance.PerformanceMark[]> {
+		return performance.getMarks();
+	}
+
 	@traceRpc
 	async start(id: number): Promise<ITerminalLaunchError | { injectedArgs: string[] } | undefined> {
 		const pty = this._ptys.get(id);
@@ -495,13 +501,16 @@ export class PtyService extends Disposable implements IPtyService {
 
 	@traceRpc
 	async getTerminalLayoutInfo(args: IGetTerminalLayoutInfoArgs): Promise<ITerminalsLayoutInfo | undefined> {
+		performance.mark('code/willGetTerminalLayoutInfo');
 		const layout = this._workspaceLayoutInfos.get(args.workspaceId);
 		if (layout) {
 			const expandedTabs = await Promise.all(layout.tabs.map(async tab => this._expandTerminalTab(tab)));
 			const tabs = expandedTabs.filter(t => t.terminals.length > 0);
 			this._logService.trace('PtyService.getTerminalLayoutInfo result', tabs);
+			performance.mark('code/didGetTerminalLayoutInfo');
 			return { tabs };
 		}
+		performance.mark('code/didGetTerminalLayoutInfo');
 		return undefined;
 	}
 
@@ -537,10 +546,11 @@ export class PtyService extends Disposable implements IPtyService {
 	}
 
 	private async _buildProcessDetails(id: number, persistentProcess: PersistentTerminalProcess, wasRevived: boolean = false): Promise<IProcessDetails> {
+		performance.mark(`code/willBuildProcessDetails/${id}`);
 		// If the process was just revived, don't do the orphan check as it will
 		// take some time
 		const [cwd, isOrphan] = await Promise.all([persistentProcess.getCwd(), wasRevived ? true : persistentProcess.isOrphaned()]);
-		return {
+		const result = {
 			id,
 			title: persistentProcess.title,
 			titleSource: persistentProcess.titleSource,
@@ -561,6 +571,8 @@ export class PtyService extends Disposable implements IPtyService {
 			hasChildProcesses: persistentProcess.hasChildProcesses,
 			shellIntegrationNonce: persistentProcess.processLaunchOptions.options.shellIntegration.nonce
 		};
+		performance.mark(`code/didBuildProcessDetails/${id}`);
+		return result;
 	}
 
 	private _throwIfNoPty(id: number): PersistentTerminalProcess {

src/vs/server/node/remoteTerminalChannel.ts

@@ -117,6 +117,7 @@ export class RemoteTerminalChannel extends Disposable implements IServerChannel<
 			case '$detachFromProcess': return this._ptyService.detachFromProcess.apply(this._ptyService, args);
 
 			case '$listProcesses': return this._ptyService.listProcesses.apply(this._ptyService, args);
+			case '$getPerformanceMarks': return this._ptyService.getPerformanceMarks.apply(this._ptyService, args);
 			case '$orphanQuestionReply': return this._ptyService.orphanQuestionReply.apply(this._ptyService, args);
 			case '$acceptPtyHostResolvedVariables': return this._ptyService.acceptPtyHostResolvedVariables?.apply(this._ptyService, args);
 

src/vs/workbench/contrib/terminal/browser/remoteTerminalBackend.ts

@@ -6,6 +6,7 @@
 import { DeferredPromise } from 'vs/base/common/async';
 import { Emitter } from 'vs/base/common/event';
 import { revive } from 'vs/base/common/marshalling';
+import { PerformanceMark } from 'vs/base/common/performance';
 import { IProcessEnvironment, OperatingSystem } from 'vs/base/common/platform';
 import { ICommandService } from 'vs/platform/commands/common/commands';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
@@ -70,7 +71,7 @@ class RemoteTerminalBackend extends BaseTerminalBackend implements ITerminalBack
 		@IConfigurationResolverService configurationResolverService: IConfigurationResolverService,
 		@IHistoryService private readonly _historyService: IHistoryService,
 		@IConfigurationService private readonly _configurationService: IConfigurationService,
-		@IStatusbarService statusBarService: IStatusbarService,
+		@IStatusbarService statusBarService: IStatusbarService
 	) {
 		super(_remoteTerminalChannel, logService, _historyService, configurationResolverService, statusBarService, workspaceContextService);
 
@@ -343,4 +344,8 @@ class RemoteTerminalBackend extends BaseTerminalBackend implements ITerminalBack
 
 		return this._remoteTerminalChannel.getTerminalLayoutInfo();
 	}
+
+	async getPerformanceMarks(): Promise<PerformanceMark[]> {
+		return this._remoteTerminalChannel.getPerformanceMarks();
+	}
 }

src/vs/workbench/contrib/terminal/browser/terminalService.ts

@@ -51,6 +51,7 @@ import { XtermTerminal } from 'vs/workbench/contrib/terminal/browser/xterm/xterm
 import { TerminalInstance } from 'vs/workbench/contrib/terminal/browser/terminalInstance';
 import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
 import { TerminalCapabilityStore } from 'vs/platform/terminal/common/capabilities/terminalCapabilityStore';
+import { ITimerService } from 'vs/workbench/services/timer/browser/timerService';
 import { mark } from 'vs/base/common/performance';
 
 export class TerminalService implements ITerminalService {
@@ -175,7 +176,8 @@ export class TerminalService implements ITerminalService {
 		@INotificationService private readonly _notificationService: INotificationService,
 		@IWorkspaceContextService private readonly _workspaceContextService: IWorkspaceContextService,
 		@ICommandService private readonly _commandService: ICommandService,
-		@IKeybindingService private readonly _keybindingService: IKeybindingService
+		@IKeybindingService private readonly _keybindingService: IKeybindingService,
+		@ITimerService private readonly _timerService: ITimerService
 	) {
 		this._configHelper = this._instantiationService.createInstance(TerminalConfigHelper);
 		// the below avoids having to poll routinely.
@@ -285,10 +287,13 @@ export class TerminalService implements ITerminalService {
 		} else {
 			reconnectedPromise = Promise.resolve();
 		}
-		reconnectedPromise.then(() => {
+		reconnectedPromise.then(async () => {
 			this._setConnected();
 			mark('code/terminal/didReconnect');
 			for (const backend of this._terminalInstanceService.getRegisteredBackends()) {
+				mark('code/terminal/willGetPerformanceMarks');
+				this._timerService.setPerformanceMarks(backend.remoteAuthority === undefined ? 'localPtyHost' : 'remotePtyHost', await backend.getPerformanceMarks());
+				mark('code/terminal/didGetPerformanceMarks');
 				backend.setConnected();
 			}
 			this._whenConnected.complete();

src/vs/workbench/contrib/terminal/common/remoteTerminalChannel.ts

@@ -24,6 +24,7 @@ import { IProcessEnvironment, OperatingSystem } from 'vs/base/common/platform';
 import { ICompleteTerminalConfiguration } from 'vs/workbench/contrib/terminal/common/terminal';
 import { IPtyHostProcessReplayEvent } from 'vs/platform/terminal/common/capabilities/capabilities';
 import { ISerializableEnvironmentDescriptionMap as ISerializableEnvironmentDescriptionMap, ISerializableEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';
+import type * as performance from 'vs/base/common/performance';
 
 export const REMOTE_TERMINAL_CHANNEL_NAME = 'remoteterminal';
 
@@ -202,6 +203,9 @@ export class RemoteTerminalChannelClient implements IPtyHostController {
 	listProcesses(): Promise<IProcessDetails[]> {
 		return this._channel.call('$listProcesses');
 	}
+	getPerformanceMarks(): Promise<performance.PerformanceMark[]> {
+		return this._channel.call('$getPerformanceMarks');
+	}
 	reduceConnectionGraceTime(): Promise<void> {
 		return this._channel.call('$reduceConnectionGraceTime');
 	}

src/vs/workbench/contrib/terminal/electron-sandbox/localTerminalBackend.ts

@@ -32,7 +32,7 @@ import { INativeWorkbenchEnvironmentService } from 'vs/workbench/services/enviro
 import { Client as MessagePortClient } from 'vs/base/parts/ipc/common/ipc.mp';
 import { acquirePort } from 'vs/base/parts/ipc/electron-sandbox/ipc.mp';
 import { getDelayedChannel, ProxyChannel } from 'vs/base/parts/ipc/common/ipc';
-import { mark } from 'vs/base/common/performance';
+import { mark, PerformanceMark } from 'vs/base/common/performance';
 import { ILifecycleService, LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
 import { DeferredPromise } from 'vs/base/common/async';
 import { IStatusbarService } from 'vs/workbench/services/statusbar/browser/statusbar';
@@ -219,6 +219,10 @@ class LocalTerminalBackend extends BaseTerminalBackend implements ITerminalBacke
 		return this._proxy.listProcesses();
 	}
 
+	async getPerformanceMarks(): Promise<PerformanceMark[]> {
+		return this._proxy.getPerformanceMarks();
+	}
+
 	async reduceConnectionGraceTime(): Promise<void> {
 		this._proxy.reduceConnectionGraceTime();
 	}