extHostExtensionService.ts 29.6 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

A
Alex Dima 已提交
6
import * as nls from 'vs/nls';
7
import * as path from 'vs/base/common/path';
8
import { originalFSPath } from 'vs/base/common/resources';
A
Alex Dima 已提交
9
import { Barrier } from 'vs/base/common/async';
A
Alex Dima 已提交
10
import { IDisposable, dispose, toDisposable } from 'vs/base/common/lifecycle';
A
Alex Dima 已提交
11 12
import { TernarySearchTree } from 'vs/base/common/map';
import { URI } from 'vs/base/common/uri';
A
Alex Dima 已提交
13
import * as pfs from 'vs/base/node/pfs';
A
Alex Dima 已提交
14
import { ILogService } from 'vs/platform/log/common/log';
A
Alex Dima 已提交
15
import { createApiFactory, initializeExtensionApi, IExtensionApiFactory } from 'vs/workbench/api/node/extHost.api.impl';
16
import { ExtHostExtensionServiceShape, IEnvironment, IInitData, IMainContext, MainContext, MainThreadExtensionServiceShape, MainThreadTelemetryShape, MainThreadWorkspaceShape, IStaticWorkspaceData } from 'vs/workbench/api/node/extHost.protocol';
17
import { ExtHostConfiguration } from 'vs/workbench/api/node/extHostConfiguration';
18
import { ActivatedExtension, EmptyExtension, ExtensionActivatedByAPI, ExtensionActivatedByEvent, ExtensionActivationReason, ExtensionActivationTimes, ExtensionActivationTimesBuilder, ExtensionsActivator, IExtensionAPI, IExtensionContext, IExtensionMemento, IExtensionModule, HostExtension } from 'vs/workbench/api/node/extHostExtensionActivator';
19
import { ExtHostLogService } from 'vs/workbench/api/node/extHostLogService';
A
Alex Dima 已提交
20
import { ExtHostStorage } from 'vs/workbench/api/node/extHostStorage';
21
import { ExtHostWorkspace } from 'vs/workbench/api/node/extHostWorkspace';
22
import { IExtensionDescription, ExtensionActivationError } from 'vs/workbench/services/extensions/common/extensions';
A
Alex Dima 已提交
23
import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/node/extensionDescriptionRegistry';
24
import { connectProxyResolver } from 'vs/workbench/services/extensions/node/proxyResolver';
A
Alex Dima 已提交
25 26 27
import { CancellationTokenSource } from 'vs/base/common/cancellation';
import * as errors from 'vs/base/common/errors';
import { ResolvedAuthority } from 'vs/platform/remote/common/remoteAuthorityResolver';
A
Alex Dima 已提交
28
import * as vscode from 'vscode';
29
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
30
import { IWorkspace } from 'vs/platform/workspace/common/workspace';
31
import { Schemas } from 'vs/base/common/network';
A
Alex Dima 已提交
32

A
Alex Dima 已提交
33
class ExtensionMemento implements IExtensionMemento {
A
Alex Dima 已提交
34

35 36 37
	private readonly _id: string;
	private readonly _shared: boolean;
	private readonly _storage: ExtHostStorage;
A
Alex Dima 已提交
38

J
Johannes Rieken 已提交
39
	private readonly _init: Promise<ExtensionMemento>;
A
Alex Dima 已提交
40
	private _value: { [n: string]: any; };
41
	private readonly _storageListener: IDisposable;
A
Alex Dima 已提交
42

A
Alex Dima 已提交
43
	constructor(id: string, global: boolean, storage: ExtHostStorage) {
A
Alex Dima 已提交
44 45 46 47 48 49 50 51
		this._id = id;
		this._shared = global;
		this._storage = storage;

		this._init = this._storage.getValue(this._shared, this._id, Object.create(null)).then(value => {
			this._value = value;
			return this;
		});
52 53 54 55 56 57

		this._storageListener = this._storage.onDidChangeStorage(e => {
			if (e.shared === this._shared && e.key === this._id) {
				this._value = e.value;
			}
		});
A
Alex Dima 已提交
58 59
	}

J
Johannes Rieken 已提交
60
	get whenReady(): Promise<ExtensionMemento> {
A
Alex Dima 已提交
61 62 63 64 65 66 67 68 69 70 71
		return this._init;
	}

	get<T>(key: string, defaultValue: T): T {
		let value = this._value[key];
		if (typeof value === 'undefined') {
			value = defaultValue;
		}
		return value;
	}

J
Johannes Rieken 已提交
72
	update(key: string, value: any): Promise<boolean> {
A
Alex Dima 已提交
73 74 75 76 77
		this._value[key] = value;
		return this._storage
			.setValue(this._shared, this._id, this._value)
			.then(() => true);
	}
78 79 80 81

	dispose(): void {
		this._storageListener.dispose();
	}
A
Alex Dima 已提交
82 83
}

84 85
class ExtensionStoragePath {

M
Matt Bierner 已提交
86
	private readonly _workspace?: IStaticWorkspaceData;
87 88
	private readonly _environment: IEnvironment;

M
Matt Bierner 已提交
89 90
	private readonly _ready: Promise<string | undefined>;
	private _value?: string;
91

M
Matt Bierner 已提交
92
	constructor(workspace: IStaticWorkspaceData | undefined, environment: IEnvironment) {
93 94 95 96 97 98 99 100 101
		this._workspace = workspace;
		this._environment = environment;
		this._ready = this._getOrCreateWorkspaceStoragePath().then(value => this._value = value);
	}

	get whenReady(): Promise<any> {
		return this._ready;
	}

M
Matt Bierner 已提交
102
	workspaceValue(extension: IExtensionDescription): string | undefined {
103
		if (this._value) {
104
			return path.join(this._value, extension.identifier.value);
105 106 107 108
		}
		return undefined;
	}

109
	globalValue(extension: IExtensionDescription): string {
S
Sandeep Somavarapu 已提交
110
		return path.join(this._environment.globalStorageHome.fsPath, extension.identifier.value.toLowerCase());
111 112
	}

M
Matt Bierner 已提交
113
	private async _getOrCreateWorkspaceStoragePath(): Promise<string | undefined> {
114 115 116 117
		if (!this._workspace) {
			return Promise.resolve(undefined);
		}

118 119 120
		if (!this._environment.appSettingsHome) {
			return undefined;
		}
121
		const storageName = this._workspace.id;
A
Alex Dima 已提交
122
		const storagePath = path.join(this._environment.appSettingsHome.fsPath, 'workspaceStorage', storageName);
123

A
Alex Dima 已提交
124
		const exists = await pfs.dirExists(storagePath);
125 126 127 128 129 130

		if (exists) {
			return storagePath;
		}

		try {
A
Alex Dima 已提交
131 132 133
			await pfs.mkdirp(storagePath);
			await pfs.writeFile(
				path.join(storagePath, 'meta.json'),
134 135 136 137 138 139 140 141 142 143 144 145 146 147
				JSON.stringify({
					id: this._workspace.id,
					configuration: this._workspace.configuration && URI.revive(this._workspace.configuration).toString(),
					name: this._workspace.name
				}, undefined, 2)
			);
			return storagePath;

		} catch (e) {
			console.error(e);
			return undefined;
		}
	}
}
A
Alex Dima 已提交
148 149 150 151 152

interface ITestRunner {
	run(testsRoot: string, clb: (error: Error, failures?: number) => void): void;
}

A
Alex Dima 已提交
153
export class ExtHostExtensionService implements ExtHostExtensionServiceShape {
A
Alex Dima 已提交
154

A
Alex Dima 已提交
155 156 157 158 159 160 161 162 163 164 165 166 167
	private static readonly WORKSPACE_CONTAINS_TIMEOUT = 7000;

	private readonly _nativeExit: (code?: number) => void;
	private readonly _initData: IInitData;
	private readonly _extHostContext: IMainContext;
	private readonly _extHostWorkspace: ExtHostWorkspace;
	private readonly _extHostConfiguration: ExtHostConfiguration;
	private readonly _extHostLogService: ExtHostLogService;

	private readonly _mainThreadWorkspaceProxy: MainThreadWorkspaceShape;
	private readonly _mainThreadTelemetryProxy: MainThreadTelemetryShape;
	private readonly _mainThreadExtensionsProxy: MainThreadExtensionServiceShape;

A
Alex Dima 已提交
168
	private readonly _almostReadyToRunExtensions: Barrier;
A
Alex Dima 已提交
169
	private readonly _readyToRunExtensions: Barrier;
A
Alex Dima 已提交
170 171
	private readonly _registry: ExtensionDescriptionRegistry;
	private readonly _storage: ExtHostStorage;
172
	private readonly _storagePath: ExtensionStoragePath;
A
Alex Dima 已提交
173
	private readonly _activator: ExtensionsActivator;
A
Alex Dima 已提交
174
	private _extensionPathIndex: Promise<TernarySearchTree<IExtensionDescription>> | null;
A
Alex Dima 已提交
175 176
	private readonly _extensionApiFactory: IExtensionApiFactory;

A
Alex Dima 已提交
177 178
	private readonly _resolvers: { [authorityPrefix: string]: vscode.RemoteAuthorityResolver; };

A
Alex Dima 已提交
179 180 181 182 183
	private _started: boolean;

	constructor(
		nativeExit: (code?: number) => void,
		initData: IInitData,
184
		extHostContext: IMainContext,
185
		extHostWorkspace: ExtHostWorkspace,
J
Joao Moreno 已提交
186
		extHostConfiguration: ExtHostConfiguration,
A
Alex Dima 已提交
187
		extHostLogService: ExtHostLogService
188
	) {
A
Alex Dima 已提交
189 190 191 192 193 194 195 196 197 198 199
		this._nativeExit = nativeExit;
		this._initData = initData;
		this._extHostContext = extHostContext;
		this._extHostWorkspace = extHostWorkspace;
		this._extHostConfiguration = extHostConfiguration;
		this._extHostLogService = extHostLogService;

		this._mainThreadWorkspaceProxy = this._extHostContext.getProxy(MainContext.MainThreadWorkspace);
		this._mainThreadTelemetryProxy = this._extHostContext.getProxy(MainContext.MainThreadTelemetry);
		this._mainThreadExtensionsProxy = this._extHostContext.getProxy(MainContext.MainThreadExtensionService);

A
Alex Dima 已提交
200
		this._almostReadyToRunExtensions = new Barrier();
A
Alex Dima 已提交
201
		this._readyToRunExtensions = new Barrier();
A
Alex Dima 已提交
202
		this._registry = new ExtensionDescriptionRegistry(initData.extensions);
A
Alex Dima 已提交
203
		this._storage = new ExtHostStorage(this._extHostContext);
204
		this._storagePath = new ExtensionStoragePath(initData.workspace, initData.environment);
205 206 207 208 209

		const hostExtensions = new Set<string>();
		initData.hostExtensions.forEach((extensionId) => hostExtensions.add(ExtensionIdentifier.toKey(extensionId)));

		this._activator = new ExtensionsActivator(this._registry, initData.resolvedExtensions, initData.hostExtensions, {
210 211
			onExtensionActivationError: (extensionId: ExtensionIdentifier, error: ExtensionActivationError): void => {
				this._mainThreadExtensionsProxy.$onExtensionActivationError(extensionId, error);
A
Alex Dima 已提交
212 213
			},

214 215
			actualActivateExtension: async (extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<ActivatedExtension> => {
				if (hostExtensions.has(ExtensionIdentifier.toKey(extensionId))) {
216
					const activationEvent = (reason instanceof ExtensionActivatedByEvent ? reason.activationEvent : null);
217 218 219
					await this._mainThreadExtensionsProxy.$activateExtension(extensionId, activationEvent);
					return new HostExtension();
				}
A
Alex Dima 已提交
220
				const extensionDescription = this._registry.getExtensionDescription(extensionId)!;
A
Alex Dima 已提交
221 222 223 224
				return this._activateExtension(extensionDescription, reason);
			}
		});
		this._extensionPathIndex = null;
225

A
Alex Dima 已提交
226
		// initialize API first (i.e. do not release barrier until the API is initialized)
A
Alex Dima 已提交
227
		this._extensionApiFactory = createApiFactory(this._initData, this._extHostContext, this._extHostWorkspace, this._extHostConfiguration, this, this._extHostLogService, this._storage);
228

A
Alex Dima 已提交
229 230
		this._resolvers = Object.create(null);

A
Alex Dima 已提交
231 232
		this._started = false;

233
		this._initialize();
A
Alex Dima 已提交
234 235 236 237

		if (this._initData.autoStart) {
			this._startExtensionHost();
		}
238 239
	}

240 241 242
	private async _initialize(): Promise<void> {
		try {
			const configProvider = await this._extHostConfiguration.getConfigProvider();
243
			await initializeExtensionApi(this, this._extensionApiFactory, this._registry, configProvider);
244
			// Do this when extension service exists, but extensions are not being activated yet.
245
			await connectProxyResolver(this._extHostWorkspace, configProvider, this, this._extHostLogService, this._mainThreadTelemetryProxy);
A
Alex Dima 已提交
246 247 248
			this._almostReadyToRunExtensions.open();

			await this._extHostWorkspace.waitForInitializeCall();
A
Alex Dima 已提交
249
			this._readyToRunExtensions.open();
250 251 252 253 254
		} catch (err) {
			errors.onUnexpectedError(err);
		}
	}

A
Alex Dima 已提交
255
	public async deactivateAll(): Promise<void> {
J
Johannes Rieken 已提交
256
		let allPromises: Promise<void>[] = [];
A
Alex Dima 已提交
257 258
		try {
			const allExtensions = this._registry.getAllExtensionDescriptions();
259
			const allExtensionsIds = allExtensions.map(ext => ext.identifier);
A
Alex Dima 已提交
260 261 262 263 264 265 266 267 268
			const activatedExtensions = allExtensionsIds.filter(id => this.isActivated(id));

			allPromises = activatedExtensions.map((extensionId) => {
				return this._deactivate(extensionId);
			});
		} catch (err) {
			// TODO: write to log once we have one
		}
		await allPromises;
269 270
	}

271
	public isActivated(extensionId: ExtensionIdentifier): boolean {
A
Alex Dima 已提交
272
		if (this._readyToRunExtensions.isOpen()) {
A
Alex Dima 已提交
273 274 275
			return this._activator.isActivated(extensionId);
		}
		return false;
276 277
	}

J
Johannes Rieken 已提交
278
	private _activateByEvent(activationEvent: string, startup: boolean): Promise<void> {
A
Alex Dima 已提交
279
		const reason = new ExtensionActivatedByEvent(startup, activationEvent);
A
Alex Dima 已提交
280
		return this._activator.activateByEvent(activationEvent, reason);
281 282
	}

283
	private _activateById(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void> {
A
Alex Dima 已提交
284
		return this._activator.activateById(extensionId, reason);
285 286
	}

287
	public activateByIdWithErrors(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void> {
A
Alex Dima 已提交
288
		return this._activateById(extensionId, reason).then(() => {
289 290 291
			const extension = this._activator.getActivatedExtension(extensionId);
			if (extension.activationFailed) {
				// activation failed => bubble up the error as the promise result
292
				return Promise.reject(extension.activationFailedError);
293
			}
R
Rob Lourens 已提交
294
			return undefined;
295 296 297
		});
	}

A
Alex Dima 已提交
298
	public getExtensionRegistry(): Promise<ExtensionDescriptionRegistry> {
A
Alex Dima 已提交
299
		return this._readyToRunExtensions.wait().then(_ => this._registry);
300 301
	}

A
Alex Dima 已提交
302
	public getExtensionExports(extensionId: ExtensionIdentifier): IExtensionAPI | null | undefined {
A
Alex Dima 已提交
303
		if (this._readyToRunExtensions.isOpen()) {
A
Alex Dima 已提交
304 305 306
			return this._activator.getActivatedExtension(extensionId).exports;
		} else {
			return null;
E
Erich Gamma 已提交
307 308 309
		}
	}

310
	// create trie to enable fast 'filename -> extension id' look up
311
	public getExtensionPathIndex(): Promise<TernarySearchTree<IExtensionDescription>> {
312
		if (!this._extensionPathIndex) {
313
			const tree = TernarySearchTree.forPaths<IExtensionDescription>();
A
Alex Dima 已提交
314
			const extensions = this._registry.getAllExtensionDescriptions().map(ext => {
315 316 317
				if (!ext.main) {
					return undefined;
				}
A
Alex Dima 已提交
318
				return pfs.realpath(ext.extensionLocation.fsPath).then(value => tree.set(URI.file(value).fsPath, ext));
319
			});
320
			this._extensionPathIndex = Promise.all(extensions).then(() => tree);
321 322 323 324
		}
		return this._extensionPathIndex;
	}

325
	private _deactivate(extensionId: ExtensionIdentifier): Promise<void> {
R
Rob Lourens 已提交
326
		let result = Promise.resolve(undefined);
327

A
Alex Dima 已提交
328
		if (!this._readyToRunExtensions.isOpen()) {
A
Alex Dima 已提交
329 330 331 332
			return result;
		}

		if (!this._activator.isActivated(extensionId)) {
A
Alex Dima 已提交
333 334 335
			return result;
		}

336
		const extension = this._activator.getActivatedExtension(extensionId);
A
Alex Dima 已提交
337
		if (!extension) {
338
			return result;
339 340 341 342
		}

		// call deactivate if available
		try {
A
Alex Dima 已提交
343
			if (typeof extension.module.deactivate === 'function') {
R
Rob Lourens 已提交
344
				result = Promise.resolve(extension.module.deactivate()).then(undefined, (err) => {
345
					// TODO: Do something with err if this is not the shutdown case
R
Rob Lourens 已提交
346
					return Promise.resolve(undefined);
347
				});
348
			}
B
Benjamin Pasero 已提交
349
		} catch (err) {
350 351 352 353 354
			// TODO: Do something with err if this is not the shutdown case
		}

		// clean up subscriptions
		try {
J
Joao Moreno 已提交
355
			dispose(extension.subscriptions);
B
Benjamin Pasero 已提交
356
		} catch (err) {
357 358
			// TODO: Do something with err if this is not the shutdown case
		}
359 360

		return result;
361
	}
E
Erich Gamma 已提交
362

A
Alex Dima 已提交
363
	// --- impl
A
Alex Dima 已提交
364

365
	private _activateExtension(extensionDescription: IExtensionDescription, reason: ExtensionActivationReason): Promise<ActivatedExtension> {
366
		this._mainThreadExtensionsProxy.$onWillActivateExtension(extensionDescription.identifier);
A
Alex Dima 已提交
367
		return this._doActivateExtension(extensionDescription, reason).then((activatedExtension) => {
368
			const activationTimes = activatedExtension.activationTimes;
369
			const activationEvent = (reason instanceof ExtensionActivatedByEvent ? reason.activationEvent : null);
370
			this._mainThreadExtensionsProxy.$onDidActivateExtension(extensionDescription.identifier, activationTimes.startup, activationTimes.codeLoadingTime, activationTimes.activateCallTime, activationTimes.activateResolvedTime, activationEvent);
371
			this._logExtensionActivationTimes(extensionDescription, reason, 'success', activationTimes);
A
Alex Dima 已提交
372 373
			return activatedExtension;
		}, (err) => {
374
			this._logExtensionActivationTimes(extensionDescription, reason, 'failure');
A
Alex Dima 已提交
375 376
			throw err;
		});
E
Erich Gamma 已提交
377 378
	}

379
	private _logExtensionActivationTimes(extensionDescription: IExtensionDescription, reason: ExtensionActivationReason, outcome: string, activationTimes?: ExtensionActivationTimes) {
380
		const event = getTelemetryActivationEvent(extensionDescription, reason);
381 382 383 384 385 386 387 388 389
		/* __GDPR__
			"extensionActivationTimes" : {
				"${include}": [
					"${TelemetryActivationEvent}",
					"${ExtensionActivationTimes}"
				],
				"outcome" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
			}
		*/
A
Alex Dima 已提交
390
		this._mainThreadTelemetryProxy.$publicLog('extensionActivationTimes', {
391 392 393 394 395 396
			...event,
			...(activationTimes || {}),
			outcome,
		});
	}

397
	private _doActivateExtension(extensionDescription: IExtensionDescription, reason: ExtensionActivationReason): Promise<ActivatedExtension> {
398
		const event = getTelemetryActivationEvent(extensionDescription, reason);
K
kieferrm 已提交
399
		/* __GDPR__
K
kieferrm 已提交
400 401 402 403 404 405
			"activatePlugin" : {
				"${include}": [
					"${TelemetryActivationEvent}"
				]
			}
		*/
A
Alex Dima 已提交
406
		this._mainThreadTelemetryProxy.$publicLog('activatePlugin', event);
A
Alex Dima 已提交
407 408
		if (!extensionDescription.main) {
			// Treat the extension as being empty => NOT AN ERROR CASE
409
			return Promise.resolve(new EmptyExtension(ExtensionActivationTimes.NONE));
A
Alex Dima 已提交
410
		}
411

412
		this._extHostLogService.info(`ExtensionService#_doActivateExtension ${extensionDescription.identifier.value} ${JSON.stringify(reason)}`);
413

A
Alex Dima 已提交
414
		const activationTimesBuilder = new ExtensionActivationTimesBuilder(reason.startup);
415
		return Promise.all<any>([
416
			loadCommonJSModule(this._extHostLogService, extensionDescription.main, activationTimesBuilder),
A
Alex Dima 已提交
417 418
			this._loadExtensionContext(extensionDescription)
		]).then(values => {
419
			return ExtHostExtensionService._callActivate(this._extHostLogService, extensionDescription.identifier, <IExtensionModule>values[0], <IExtensionContext>values[1], activationTimesBuilder);
A
Alex Dima 已提交
420
		});
E
Erich Gamma 已提交
421 422
	}

423
	private _loadExtensionContext(extensionDescription: IExtensionDescription): Promise<IExtensionContext> {
E
Erich Gamma 已提交
424

425 426
		const globalState = new ExtensionMemento(extensionDescription.identifier.value, true, this._storage);
		const workspaceState = new ExtensionMemento(extensionDescription.identifier.value, false, this._storage);
E
Erich Gamma 已提交
427

428
		this._extHostLogService.trace(`ExtensionService#loadExtensionContext ${extensionDescription.identifier.value}`);
429
		return Promise.all([
430
			globalState.whenReady,
431 432
			workspaceState.whenReady,
			this._storagePath.whenReady
433
		]).then(() => {
434
			const that = this;
A
Alex Dima 已提交
435
			return Object.freeze(<IExtensionContext>{
E
Erich Gamma 已提交
436 437 438
				globalState,
				workspaceState,
				subscriptions: [],
439
				get extensionPath() { return extensionDescription.extensionLocation.fsPath; },
440
				storagePath: this._storagePath.workspaceValue(extensionDescription),
S
Sandeep Somavarapu 已提交
441
				globalStoragePath: this._storagePath.globalValue(extensionDescription),
A
Alex Dima 已提交
442
				asAbsolutePath: (relativePath: string) => { return path.join(extensionDescription.extensionLocation.fsPath, relativePath); },
443
				logPath: that._extHostLogService.getLogDirectory(extensionDescription.identifier)
E
Erich Gamma 已提交
444 445 446 447
			});
		});
	}

448
	private static _callActivate(logService: ILogService, extensionId: ExtensionIdentifier, extensionModule: IExtensionModule, context: IExtensionContext, activationTimesBuilder: ExtensionActivationTimesBuilder): Promise<ActivatedExtension> {
A
Alex Dima 已提交
449 450
		// Make sure the extension's surface is not undefined
		extensionModule = extensionModule || {
451 452 453 454
			activate: undefined,
			deactivate: undefined
		};

455
		return this._callActivateOptional(logService, extensionId, extensionModule, context, activationTimesBuilder).then((extensionExports) => {
456
			return new ActivatedExtension(false, null, activationTimesBuilder.build(), extensionModule, extensionExports, context.subscriptions);
457 458 459
		});
	}

460
	private static _callActivateOptional(logService: ILogService, extensionId: ExtensionIdentifier, extensionModule: IExtensionModule, context: IExtensionContext, activationTimesBuilder: ExtensionActivationTimesBuilder): Promise<IExtensionAPI> {
A
Alex Dima 已提交
461
		if (typeof extensionModule.activate === 'function') {
462
			try {
463
				activationTimesBuilder.activateCallStart();
464
				logService.trace(`ExtensionService#_callActivateOptional ${extensionId.value}`);
J
Johannes Rieken 已提交
465
				const activateResult: Promise<IExtensionAPI> = extensionModule.activate.apply(global, [context]);
466 467 468
				activationTimesBuilder.activateCallStop();

				activationTimesBuilder.activateResolveStart();
469
				return Promise.resolve(activateResult).then((value) => {
470 471 472
					activationTimesBuilder.activateResolveStop();
					return value;
				});
473
			} catch (err) {
474
				return Promise.reject(err);
475 476
			}
		} else {
A
Alex Dima 已提交
477
			// No activate found => the module is the extension's exports
478
			return Promise.resolve<IExtensionAPI>(extensionModule);
479 480 481
		}
	}

A
Alex Dima 已提交
482 483 484
	// -- eager activation

	// Handle "eager" activation extensions
485
	private _handleEagerExtensions(): Promise<void> {
R
Rob Lourens 已提交
486
		this._activateByEvent('*', true).then(undefined, (err) => {
A
Alex Dima 已提交
487 488 489
			console.error(err);
		});

490
		return this._handleWorkspaceContainsEagerExtensions(this._extHostWorkspace.workspace);
A
Alex Dima 已提交
491 492
	}

M
Matt Bierner 已提交
493
	private _handleWorkspaceContainsEagerExtensions(workspace: IWorkspace | undefined): Promise<void> {
A
Alex Dima 已提交
494
		if (!workspace || workspace.folders.length === 0) {
R
Rob Lourens 已提交
495
			return Promise.resolve(undefined);
A
Alex Dima 已提交
496 497 498 499 500 501 502 503 504
		}

		return Promise.all(
			this._registry.getAllExtensionDescriptions().map((desc) => {
				return this._handleWorkspaceContainsEagerExtension(workspace, desc);
			})
		).then(() => { });
	}

505
	private _handleWorkspaceContainsEagerExtension(workspace: IWorkspace, desc: IExtensionDescription): Promise<void> {
A
Alex Dima 已提交
506 507
		const activationEvents = desc.activationEvents;
		if (!activationEvents) {
R
Rob Lourens 已提交
508
			return Promise.resolve(undefined);
A
Alex Dima 已提交
509 510 511 512 513
		}

		const fileNames: string[] = [];
		const globPatterns: string[] = [];

514 515 516
		for (const activationEvent of activationEvents) {
			if (/^workspaceContains:/.test(activationEvent)) {
				const fileNameOrGlob = activationEvent.substr('workspaceContains:'.length);
A
Alex Dima 已提交
517 518 519 520 521 522 523 524 525
				if (fileNameOrGlob.indexOf('*') >= 0 || fileNameOrGlob.indexOf('?') >= 0) {
					globPatterns.push(fileNameOrGlob);
				} else {
					fileNames.push(fileNameOrGlob);
				}
			}
		}

		if (fileNames.length === 0 && globPatterns.length === 0) {
R
Rob Lourens 已提交
526
			return Promise.resolve(undefined);
A
Alex Dima 已提交
527 528
		}

529 530
		const fileNamePromise = Promise.all(fileNames.map((fileName) => this._activateIfFileName(workspace, desc.identifier, fileName))).then(() => { });
		const globPatternPromise = this._activateIfGlobPatterns(desc.identifier, globPatterns);
A
Alex Dima 已提交
531 532 533 534

		return Promise.all([fileNamePromise, globPatternPromise]).then(() => { });
	}

535
	private async _activateIfFileName(workspace: IWorkspace, extensionId: ExtensionIdentifier, fileName: string): Promise<void> {
A
Alex Dima 已提交
536 537 538 539 540 541 542

		// find exact path
		for (const { uri } of workspace.folders) {
			if (await pfs.exists(path.join(URI.revive(uri).fsPath, fileName))) {
				// the file was found
				return (
					this._activateById(extensionId, new ExtensionActivatedByEvent(true, `workspaceContains:${fileName}`))
R
Rob Lourens 已提交
543
						.then(undefined, err => console.error(err))
A
Alex Dima 已提交
544 545 546 547 548 549 550
				);
			}
		}

		return undefined;
	}

551
	private async _activateIfGlobPatterns(extensionId: ExtensionIdentifier, globPatterns: string[]): Promise<void> {
552
		this._extHostLogService.trace(`extensionHostMain#activateIfGlobPatterns: fileSearch, extension: ${extensionId.value}, entryPoint: workspaceContains`);
A
Alex Dima 已提交
553 554

		if (globPatterns.length === 0) {
R
Rob Lourens 已提交
555
			return Promise.resolve(undefined);
A
Alex Dima 已提交
556 557 558 559 560 561 562 563
		}

		const tokenSource = new CancellationTokenSource();
		const searchP = this._mainThreadWorkspaceProxy.$checkExists(globPatterns, tokenSource.token);

		const timer = setTimeout(async () => {
			tokenSource.cancel();
			this._activateById(extensionId, new ExtensionActivatedByEvent(true, `workspaceContainsTimeout:${globPatterns.join(',')}`))
R
Rob Lourens 已提交
564
				.then(undefined, err => console.error(err));
A
Alex Dima 已提交
565 566
		}, ExtHostExtensionService.WORKSPACE_CONTAINS_TIMEOUT);

M
Matt Bierner 已提交
567
		let exists: boolean = false;
A
Alex Dima 已提交
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
		try {
			exists = await searchP;
		} catch (err) {
			if (!errors.isPromiseCanceledError(err)) {
				console.error(err);
			}
		}

		tokenSource.dispose();
		clearTimeout(timer);

		if (exists) {
			// a file was found matching one of the glob patterns
			return (
				this._activateById(extensionId, new ExtensionActivatedByEvent(true, `workspaceContains:${globPatterns.join(',')}`))
R
Rob Lourens 已提交
583
					.then(undefined, err => console.error(err))
A
Alex Dima 已提交
584 585 586
			);
		}

R
Rob Lourens 已提交
587
		return Promise.resolve(undefined);
A
Alex Dima 已提交
588 589 590
	}

	private _handleExtensionTests(): Promise<void> {
591 592 593 594 595 596 597 598
		return this._doHandleExtensionTests().then(undefined, error => {
			console.error(error); // ensure any error message makes it onto the console

			return Promise.reject(error);
		});
	}

	private _doHandleExtensionTests(): Promise<void> {
599 600
		const { extensionDevelopmentLocationURI, extensionTestsLocationURI } = this._initData.environment;
		if (!(extensionDevelopmentLocationURI && extensionTestsLocationURI && extensionTestsLocationURI.scheme === Schemas.file)) {
R
Rob Lourens 已提交
601
			return Promise.resolve(undefined);
A
Alex Dima 已提交
602 603
		}

604
		const extensionTestsPath = originalFSPath(extensionTestsLocationURI);
B
Benjamin Pasero 已提交
605

A
Alex Dima 已提交
606
		// Require the test runner via node require from the provided path
M
Matt Bierner 已提交
607 608
		let testRunner: ITestRunner | undefined;
		let requireError: Error | undefined;
A
Alex Dima 已提交
609
		try {
610
			testRunner = <any>require.__$__nodeRequire(extensionTestsPath);
A
Alex Dima 已提交
611 612 613 614 615 616 617
		} catch (error) {
			requireError = error;
		}

		// Execute the runner if it follows our spec
		if (testRunner && typeof testRunner.run === 'function') {
			return new Promise<void>((c, e) => {
618
				testRunner!.run(extensionTestsPath, (error, failures) => {
A
Alex Dima 已提交
619 620 621
					if (error) {
						e(error.toString());
					} else {
R
Rob Lourens 已提交
622
						c(undefined);
A
Alex Dima 已提交
623 624 625
					}

					// after tests have run, we shutdown the host
626
					this._gracefulExit(error || (typeof failures === 'number' && failures > 0) ? 1 /* ERROR */ : 0 /* OK */);
A
Alex Dima 已提交
627 628 629 630 631 632 633 634 635
				});
			});
		}

		// Otherwise make sure to shutdown anyway even in case of an error
		else {
			this._gracefulExit(1 /* ERROR */);
		}

636
		return Promise.reject(new Error(requireError ? requireError.toString() : nls.localize('extensionTestError', "Path {0} does not point to a valid extension test runner.", extensionTestsPath)));
A
Alex Dima 已提交
637 638 639 640 641 642 643 644
	}

	private _gracefulExit(code: number): void {
		// to give the PH process a chance to flush any outstanding console
		// messages to the main process, we delay the exit() by some time
		setTimeout(() => this._nativeExit(code), 500);
	}

J
Johannes Rieken 已提交
645
	private _startExtensionHost(): Promise<void> {
A
Alex Dima 已提交
646 647 648 649 650
		if (this._started) {
			throw new Error(`Extension host is already started!`);
		}
		this._started = true;

A
Alex Dima 已提交
651
		return this._readyToRunExtensions.wait()
652
			.then(() => this._handleEagerExtensions())
A
Alex Dima 已提交
653 654 655 656 657 658
			.then(() => this._handleExtensionTests())
			.then(() => {
				this._extHostLogService.info(`eager extensions activated`);
			});
	}

A
Alex Dima 已提交
659 660 661 662 663
	// -- called by extensions

	public registerRemoteAuthorityResolver(authorityPrefix: string, resolver: vscode.RemoteAuthorityResolver): vscode.Disposable {
		this._resolvers[authorityPrefix] = resolver;
		return toDisposable(() => {
A
Alex Dima 已提交
664
			delete this._resolvers[authorityPrefix];
A
Alex Dima 已提交
665 666 667
		});
	}

E
Erich Gamma 已提交
668 669
	// -- called by main thread

A
Alex Dima 已提交
670
	public async $resolveAuthority(remoteAuthority: string): Promise<ResolvedAuthority> {
A
Alex Dima 已提交
671 672 673 674 675 676
		const authorityPlusIndex = remoteAuthority.indexOf('+');
		if (authorityPlusIndex === -1) {
			throw new Error(`Not an authority that can be resolved!`);
		}
		const authorityPrefix = remoteAuthority.substr(0, authorityPlusIndex);

A
Alex Dima 已提交
677
		await this._almostReadyToRunExtensions.wait();
A
Alex Dima 已提交
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
		await this._activateByEvent(`onResolveRemoteAuthority:${authorityPrefix}`, false);

		const resolver = this._resolvers[authorityPrefix];
		if (!resolver) {
			throw new Error(`No resolver available for ${authorityPrefix}`);
		}

		const result = await resolver.resolve(remoteAuthority);
		return {
			authority: remoteAuthority,
			host: result.host,
			port: result.port,
			debugListenPort: result.debugListenPort,
			debugConnectPort: result.debugConnectPort,
		};
A
Alex Dima 已提交
693 694
	}

695
	public $startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void> {
A
Alex Dima 已提交
696 697 698 699
		this._registry.keepOnly(enabledExtensionIds);
		return this._startExtensionHost();
	}

J
Johannes Rieken 已提交
700
	public $activateByEvent(activationEvent: string): Promise<void> {
A
Alex Dima 已提交
701
		return (
A
Alex Dima 已提交
702
			this._readyToRunExtensions.wait()
A
Alex Dima 已提交
703 704
				.then(_ => this._activateByEvent(activationEvent, false))
		);
705
	}
706

707
	public async $activate(extensionId: ExtensionIdentifier, activationEvent: string): Promise<boolean> {
A
Alex Dima 已提交
708
		await this._readyToRunExtensions.wait();
709 710 711 712 713 714
		if (!this._registry.getExtensionDescription(extensionId)) {
			// unknown extension => ignore
			return false;
		}
		await this._activateById(extensionId, new ExtensionActivatedByEvent(false, activationEvent));
		return true;
715 716
	}

717
	public async $deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void> {
718
		toAdd.forEach((extension) => (<any>extension).extensionLocation = URI.revive(extension.extensionLocation));
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735

		const trie = await this.getExtensionPathIndex();

		await Promise.all(toRemove.map(async (extensionId) => {
			const extensionDescription = this._registry.getExtensionDescription(extensionId);
			if (!extensionDescription) {
				return;
			}
			const realpath = await pfs.realpath(extensionDescription.extensionLocation.fsPath);
			trie.delete(URI.file(realpath).fsPath);
		}));

		await Promise.all(toAdd.map(async (extensionDescription) => {
			const realpath = await pfs.realpath(extensionDescription.extensionLocation.fsPath);
			trie.set(URI.file(realpath).fsPath, extensionDescription);
		}));

736
		this._registry.deltaExtensions(toAdd, toRemove);
737 738 739
		return Promise.resolve(undefined);
	}

740 741 742 743 744 745 746 747 748
	public async $test_latency(n: number): Promise<number> {
		return n;
	}

	public async $test_up(b: Buffer): Promise<number> {
		return b.length;
	}

	public async $test_down(size: number): Promise<Buffer> {
749
		const b = Buffer.alloc(size, Math.random() % 256);
750 751 752
		return b;
	}

753 754
}

755
function loadCommonJSModule<T>(logService: ILogService, modulePath: string, activationTimesBuilder: ExtensionActivationTimesBuilder): Promise<T> {
756
	let r: T | null = null;
757
	activationTimesBuilder.codeLoadingStart();
758
	logService.info(`ExtensionService#loadCommonJSModule ${modulePath}`);
E
Erich Gamma 已提交
759 760
	try {
		r = require.__$__nodeRequire<T>(modulePath);
B
Benjamin Pasero 已提交
761
	} catch (e) {
762
		return Promise.reject(e);
763 764
	} finally {
		activationTimesBuilder.codeLoadingStop();
E
Erich Gamma 已提交
765
	}
766
	return Promise.resolve(r);
E
Erich Gamma 已提交
767
}
A
Alex Dima 已提交
768

R
Rob Lourens 已提交
769 770 771 772 773
function getTelemetryActivationEvent(extensionDescription: IExtensionDescription, reason: ExtensionActivationReason): any {
	const reasonStr = reason instanceof ExtensionActivatedByEvent ? reason.activationEvent :
		reason instanceof ExtensionActivatedByAPI ? 'api' :
			'';

K
kieferrm 已提交
774
	/* __GDPR__FRAGMENT__
K
kieferrm 已提交
775 776 777
		"TelemetryActivationEvent" : {
			"id": { "classification": "PublicNonPersonalData", "purpose": "FeatureInsight" },
			"name": { "classification": "PublicNonPersonalData", "purpose": "FeatureInsight" },
C
Christof Marti 已提交
778
			"extensionVersion": { "classification": "PublicNonPersonalData", "purpose": "FeatureInsight" },
779
			"publisherDisplayName": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
K
kieferrm 已提交
780
			"activationEvents": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
R
Rob Lourens 已提交
781 782
			"isBuiltin": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"reason": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
K
kieferrm 已提交
783 784
		}
	*/
785
	const event = {
786
		id: extensionDescription.identifier.value,
A
Alex Dima 已提交
787
		name: extensionDescription.name,
C
Christof Marti 已提交
788
		extensionVersion: extensionDescription.version,
789
		publisherDisplayName: extensionDescription.publisher,
790
		activationEvents: extensionDescription.activationEvents ? extensionDescription.activationEvents.join(',') : null,
R
Rob Lourens 已提交
791 792
		isBuiltin: extensionDescription.isBuiltin,
		reason: reasonStr
A
Alex Dima 已提交
793 794 795
	};

	return event;
796
}