Add API sketch for profiling the extension host

alexdima · alexdima · commit 8584b4564100 · 2017-11-29T12:52:41.000+01:00
diff --git a/src/vs/platform/actions/test/common/menuService.test.ts b/src/vs/platform/actions/test/common/menuService.test.ts
@@ -12,7 +12,7 @@ import { NullCommandService } from 'vs/platform/commands/common/commands';
 import { MockContextKeyService } from 'vs/platform/keybinding/test/common/mockKeybindingService';
 import { IExtensionPoint } from 'vs/platform/extensions/common/extensionsRegistry';
 import { TPromise } from 'vs/base/common/winjs.base';
-import { ExtensionPointContribution, IExtensionDescription, IExtensionsStatus, IExtensionService } from 'vs/platform/extensions/common/extensions';
+import { ExtensionPointContribution, IExtensionDescription, IExtensionsStatus, IExtensionService, ProfileSession } from 'vs/platform/extensions/common/extensions';
 import Event, { Emitter } from 'vs/base/common/event';
 
 // --- service instances
@@ -48,6 +48,10 @@ class MockExtensionService implements IExtensionService {
 		throw new Error('Not implemented');
 	}
 
+	public startExtensionHostProfile(): ProfileSession {
+		throw new Error('Not implemented');
+	}
+
 	public restartExtensionHost(): void {
 		throw new Error('Method not implemented.');
 	}
diff --git a/src/vs/platform/commands/test/commandService.test.ts b/src/vs/platform/commands/test/commandService.test.ts
@@ -9,7 +9,7 @@ import { IDisposable } from 'vs/base/common/lifecycle';
 import { TPromise } from 'vs/base/common/winjs.base';
 import { CommandsRegistry } from 'vs/platform/commands/common/commands';
 import { CommandService } from 'vs/platform/commands/common/commandService';
-import { IExtensionService, ExtensionPointContribution, IExtensionDescription, IExtensionHostInformation } from 'vs/platform/extensions/common/extensions';
+import { IExtensionService, ExtensionPointContribution, IExtensionDescription, IExtensionHostInformation, ProfileSession } from 'vs/platform/extensions/common/extensions';
 import { InstantiationService } from 'vs/platform/instantiation/common/instantiationService';
 import { IExtensionPoint } from 'vs/platform/extensions/common/extensionsRegistry';
 import { ContextKeyService } from 'vs/platform/contextkey/browser/contextKeyService';
@@ -42,6 +42,9 @@ class SimpleExtensionService implements IExtensionService {
 	getExtensions(): TPromise<IExtensionDescription[]> {
 		return TPromise.wrap([]);
 	}
+	startExtensionHostProfile(): ProfileSession {
+		throw new Error('Not implemented');
+	}
 	restartExtensionHost(): void {
 	}
 	startExtensionHost(): void {
diff --git a/src/vs/platform/extensions/common/extensions.ts b/src/vs/platform/extensions/common/extensions.ts
@@ -45,6 +45,39 @@ export interface IExtensionsStatus {
 	activationTimes: ActivationTimes;
 }
 
+/**
+ * e.g.
+ * {
+ *    startTime: 1511954813493000,
+ *    endTime: 1511954835590000,
+ *    deltas: [ 100, 1500, 123456, 1500, 100000 ],
+ *    ids: [ 'idle', 'self', 'extension1', 'self', 'idle' ]
+ * }
+ */
+export interface IExtensionHostProfile {
+	/**
+	 * Profiling start timestamp in microseconds.
+	 */
+	startTime: number;
+	/**
+	 * Profiling end timestamp in microseconds.
+	 */
+	endTime: number;
+	/**
+	 * Duration of segment in microseconds.
+	 */
+	deltas: number[];
+	/**
+	 * Segment identifier: extension id or one of the four known strings.
+	 */
+	ids: (string | 'idle' | 'program' | 'gc' | 'self')[];
+
+	/**
+	 * Get the information as a .cpuprofile.
+	 */
+	data: object;
+}
+
 export class ActivationTimes {
 	constructor(
 		public readonly startup: boolean,
@@ -116,6 +149,11 @@ export interface IExtensionService {
 	 */
 	getExtensionsStatus(): { [id: string]: IExtensionsStatus };
 
+	/**
+	 * Begin an extension host process profile session.
+	 */
+	startExtensionHostProfile(): ProfileSession;
+
 	/**
 	 * Restarts the extension host.
 	 */
@@ -136,3 +174,9 @@ export interface IExtensionService {
 	 */
 	getExtensionHostInformation(): IExtensionHostInformation;
 }
+
+export interface ProfileSession {
+
+	stop(): TPromise<IExtensionHostProfile>;
+
+}
diff --git a/src/vs/workbench/services/extensions/electron-browser/extensionService.ts b/src/vs/workbench/services/extensions/electron-browser/extensionService.ts
@@ -12,7 +12,7 @@ import pkg from 'vs/platform/node/package';
 import * as path from 'path';
 import URI from 'vs/base/common/uri';
 import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/node/extensionDescriptionRegistry';
-import { IMessage, IExtensionDescription, IExtensionsStatus, IExtensionService, ExtensionPointContribution, ActivationTimes, IExtensionHostInformation } from 'vs/platform/extensions/common/extensions';
+import { IMessage, IExtensionDescription, IExtensionsStatus, IExtensionService, ExtensionPointContribution, ActivationTimes, IExtensionHostInformation, ProfileSession } from 'vs/platform/extensions/common/extensions';
 import { IExtensionEnablementService, IExtensionIdentifier, EnablementState } from 'vs/platform/extensionManagement/common/extensionManagement';
 import { areSameExtensions, BetterMergeId, BetterMergeDisabledNowKey } from 'vs/platform/extensionManagement/common/extensionManagementUtil';
 import { ExtensionsRegistry, ExtensionPoint, IExtensionPointUser, ExtensionMessageCollector, IExtensionPoint } from 'vs/platform/extensions/common/extensionsRegistry';
@@ -327,6 +327,10 @@ export class ExtensionService extends Disposable implements IExtensionService {
 		return result;
 	}
 
+	public startExtensionHostProfile(): ProfileSession {
+		return null;
+	}
+
 	// ---- end IExtensionService
 
 	// --- impl
