1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type * as vscode from 'vscode';
import * as errors from 'vs/base/common/errors';
import { IDisposable } from 'vs/base/common/lifecycle';
import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/common/extensionDescriptionRegistry';
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
import { ExtensionActivationReason, MissingExtensionDependency } from 'vs/workbench/services/extensions/common/extensions';
import { ILogService } from 'vs/platform/log/common/log';
import { Barrier } from 'vs/base/common/async';
/**
* Represents the source code (module) of an extension.
*/
export interface IExtensionModule {
activate?(ctx: vscode.ExtensionContext): Promise<IExtensionAPI>;
deactivate?(): void;
}
/**
* Represents the API of an extension (return value of `activate`).
*/
export interface IExtensionAPI {
// _extensionAPIBrand: any;
}
export type ExtensionActivationTimesFragment = {
startup?: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; isMeasurement: true; comment: 'Activation occurred during startup' };
codeLoadingTime?: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; isMeasurement: true; comment: 'Time it took to load the extension\'s code' };
activateCallTime?: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; isMeasurement: true; comment: 'Time it took to call activate' };
activateResolvedTime?: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; isMeasurement: true; comment: 'Time it took for async-activation to finish' };
};
export class ExtensionActivationTimes {
public static readonly NONE = new ExtensionActivationTimes(false, -1, -1, -1);
public readonly startup: boolean;
public readonly codeLoadingTime: number;
public readonly activateCallTime: number;
public readonly activateResolvedTime: number;
constructor(startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number) {
this.startup = startup;
this.codeLoadingTime = codeLoadingTime;
this.activateCallTime = activateCallTime;
this.activateResolvedTime = activateResolvedTime;
}
}
export class ExtensionActivationTimesBuilder {
private readonly _startup: boolean;
private _codeLoadingStart: number;
private _codeLoadingStop: number;
private _activateCallStart: number;
private _activateCallStop: number;
private _activateResolveStart: number;
private _activateResolveStop: number;
constructor(startup: boolean) {
this._startup = startup;
this._codeLoadingStart = -1;
this._codeLoadingStop = -1;
this._activateCallStart = -1;
this._activateCallStop = -1;
this._activateResolveStart = -1;
this._activateResolveStop = -1;
}
private _delta(start: number, stop: number): number {
if (start === -1 || stop === -1) {
return -1;
}
return stop - start;
}
public build(): ExtensionActivationTimes {
return new ExtensionActivationTimes(
this._startup,
this._delta(this._codeLoadingStart, this._codeLoadingStop),
this._delta(this._activateCallStart, this._activateCallStop),
this._delta(this._activateResolveStart, this._activateResolveStop)
);
}
public codeLoadingStart(): void {
this._codeLoadingStart = Date.now();
}
public codeLoadingStop(): void {
this._codeLoadingStop = Date.now();
}
public activateCallStart(): void {
this._activateCallStart = Date.now();
}
public activateCallStop(): void {
this._activateCallStop = Date.now();
}
public activateResolveStart(): void {
this._activateResolveStart = Date.now();
}
public activateResolveStop(): void {
this._activateResolveStop = Date.now();
}
}
export class ActivatedExtension {
public readonly activationFailed: boolean;
public readonly activationFailedError: Error | null;
public readonly activationTimes: ExtensionActivationTimes;
public readonly module: IExtensionModule;
public readonly exports: IExtensionAPI | undefined;
public readonly subscriptions: IDisposable[];
constructor(
activationFailed: boolean,
activationFailedError: Error | null,
activationTimes: ExtensionActivationTimes,
module: IExtensionModule,
exports: IExtensionAPI | undefined,
subscriptions: IDisposable[]
) {
this.activationFailed = activationFailed;
this.activationFailedError = activationFailedError;
this.activationTimes = activationTimes;
this.module = module;
this.exports = exports;
this.subscriptions = subscriptions;
}
}
export class EmptyExtension extends ActivatedExtension {
constructor(activationTimes: ExtensionActivationTimes) {
super(false, null, activationTimes, { activate: undefined, deactivate: undefined }, undefined, []);
}
}
export class HostExtension extends ActivatedExtension {
constructor() {
super(false, null, ExtensionActivationTimes.NONE, { activate: undefined, deactivate: undefined }, undefined, []);
}
}
export class FailedExtension extends ActivatedExtension {
constructor(activationError: Error) {
super(true, activationError, ExtensionActivationTimes.NONE, { activate: undefined, deactivate: undefined }, undefined, []);
}
}
export interface IExtensionsActivatorHost {
onExtensionActivationError(extensionId: ExtensionIdentifier, error: Error | null, missingExtensionDependency: MissingExtensionDependency | null): void;
actualActivateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<ActivatedExtension>;
}
type ActivationIdAndReason = { id: ExtensionIdentifier; reason: ExtensionActivationReason };
export class ExtensionsActivator implements IDisposable {
private readonly _registry: ExtensionDescriptionRegistry;
private readonly _resolvedExtensionsSet: Set<string>;
private readonly _externalExtensionsMap: Map<string, ExtensionIdentifier>;
private readonly _host: IExtensionsActivatorHost;
private readonly _operations: Map<string, ActivationOperation>;
/**
* A map of already activated events to speed things up if the same activation event is triggered multiple times.
*/
private readonly _alreadyActivatedEvents: { [activationEvent: string]: boolean };
constructor(
registry: ExtensionDescriptionRegistry,
resolvedExtensions: ExtensionIdentifier[],
externalExtensions: ExtensionIdentifier[],
host: IExtensionsActivatorHost,
@ILogService private readonly _logService: ILogService
) {
this._registry = registry;
this._resolvedExtensionsSet = new Set<string>();
resolvedExtensions.forEach((extensionId) => this._resolvedExtensionsSet.add(ExtensionIdentifier.toKey(extensionId)));
this._externalExtensionsMap = new Map<string, ExtensionIdentifier>();
externalExtensions.forEach((extensionId) => this._externalExtensionsMap.set(ExtensionIdentifier.toKey(extensionId), extensionId));
this._host = host;
this._operations = new Map<string, ActivationOperation>();
this._alreadyActivatedEvents = Object.create(null);
}
public dispose(): void {
for (const [_, op] of this._operations) {
op.dispose();
}
}
public isActivated(extensionId: ExtensionIdentifier): boolean {
const op = this._operations.get(ExtensionIdentifier.toKey(extensionId));
return Boolean(op && op.value);
}
public getActivatedExtension(extensionId: ExtensionIdentifier): ActivatedExtension {
const op = this._operations.get(ExtensionIdentifier.toKey(extensionId));
if (!op || !op.value) {
throw new Error(`Extension '${extensionId.value}' is not known or not activated`);
}
return op.value;
}
public async activateByEvent(activationEvent: string, startup: boolean): Promise<void> {
if (this._alreadyActivatedEvents[activationEvent]) {
return;
}
const activateExtensions = this._registry.getExtensionDescriptionsForActivationEvent(activationEvent);
await this._activateExtensions(activateExtensions.map(e => ({
id: e.identifier,
reason: { startup, extensionId: e.identifier, activationEvent }
})));
this._alreadyActivatedEvents[activationEvent] = true;
}
public activateById(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void> {
const desc = this._registry.getExtensionDescription(extensionId);
if (!desc) {
throw new Error(`Extension '${extensionId}' is not known`);
}
return this._activateExtensions([{ id: desc.identifier, reason }]);
}
private async _activateExtensions(extensions: ActivationIdAndReason[]): Promise<void> {
const operations = extensions
.filter((p) => !this.isActivated(p.id))
.map(ext => this._handleActivationRequest(ext));
await Promise.all(operations.map(op => op.wait()));
}
/**
* Handle semantics related to dependencies for `currentExtension`.
* We don't need to worry about dependency loops because they are handled by the registry.
*/
private _handleActivationRequest(currentActivation: ActivationIdAndReason): ActivationOperation {
if (this._operations.has(ExtensionIdentifier.toKey(currentActivation.id))) {
return this._operations.get(ExtensionIdentifier.toKey(currentActivation.id))!;
}
if (this._externalExtensionsMap.has(ExtensionIdentifier.toKey(currentActivation.id))) {
return this._createAndSaveOperation(currentActivation, null, [], null);
}
const currentExtension = this._registry.getExtensionDescription(currentActivation.id);
if (!currentExtension) {
// Error condition 0: unknown extension
const error = new Error(`Cannot activate unknown extension '${currentActivation.id.value}'`);
const result = this._createAndSaveOperation(currentActivation, null, [], new FailedExtension(error));
this._host.onExtensionActivationError(
currentActivation.id,
error,
new MissingExtensionDependency(currentActivation.id.value)
);
return result;
}
const deps: ActivationOperation[] = [];
const depIds = (typeof currentExtension.extensionDependencies === 'undefined' ? [] : currentExtension.extensionDependencies);
for (const depId of depIds) {
if (this._resolvedExtensionsSet.has(ExtensionIdentifier.toKey(depId))) {
// This dependency is already resolved
continue;
}
const dep = this._operations.get(ExtensionIdentifier.toKey(depId));
if (dep) {
deps.push(dep);
continue;
}
if (this._externalExtensionsMap.has(ExtensionIdentifier.toKey(depId))) {
// must first wait for the dependency to activate
deps.push(this._handleActivationRequest({
id: this._externalExtensionsMap.get(ExtensionIdentifier.toKey(depId))!,
reason: currentActivation.reason
}));
continue;
}
const depDesc = this._registry.getExtensionDescription(depId);
if (depDesc) {
if (!depDesc.main && !depDesc.browser) {
// this dependency does not need to activate because it is descriptive only
continue;
}
// must first wait for the dependency to activate
deps.push(this._handleActivationRequest({
id: depDesc.identifier,
reason: currentActivation.reason
}));
continue;
}
// Error condition 1: unknown dependency
const currentExtensionFriendlyName = currentExtension.displayName || currentExtension.identifier.value;
const error = new Error(`Cannot activate the '${currentExtensionFriendlyName}' extension because it depends on unknown extension '${depId}'`);
const result = this._createAndSaveOperation(currentActivation, currentExtension.displayName, [], new FailedExtension(error));
this._host.onExtensionActivationError(
currentExtension.identifier,
error,
new MissingExtensionDependency(depId)
);
return result;
}
return this._createAndSaveOperation(currentActivation, currentExtension.displayName, deps, null);
}
private _createAndSaveOperation(activation: ActivationIdAndReason, displayName: string | null | undefined, deps: ActivationOperation[], value: ActivatedExtension | null): ActivationOperation {
const operation = new ActivationOperation(activation.id, displayName, activation.reason, deps, value, this._host, this._logService);
this._operations.set(ExtensionIdentifier.toKey(activation.id), operation);
return operation;
}
}
class ActivationOperation {
private readonly _barrier = new Barrier();
private _isDisposed = false;
public get value(): ActivatedExtension | null {
return this._value;
}
public get friendlyName(): string {
return this._displayName || this._id.value;
}
constructor(
private readonly _id: ExtensionIdentifier,
private readonly _displayName: string | null | undefined,
private readonly _reason: ExtensionActivationReason,
private readonly _deps: ActivationOperation[],
private _value: ActivatedExtension | null,
private readonly _host: IExtensionsActivatorHost,
@ILogService private readonly _logService: ILogService
) {
this._initialize();
}
public dispose(): void {
this._isDisposed = true;
}
public wait() {
return this._barrier.wait();
}
private async _initialize(): Promise<void> {
await this._waitForDepsThenActivate();
this._barrier.open();
}
private async _waitForDepsThenActivate(): Promise<void> {
if (this._value) {
// this operation is already finished
return;
}
while (this._deps.length > 0) {
// remove completed deps
for (let i = 0; i < this._deps.length; i++) {
const dep = this._deps[i];
if (dep.value && !dep.value.activationFailed) {
// the dependency is already activated OK
this._deps.splice(i, 1);
i--;
continue;
}
if (dep.value && dep.value.activationFailed) {
// Error condition 2: a dependency has already failed activation
const error = new Error(`Cannot activate the '${this.friendlyName}' extension because its dependency '${dep.friendlyName}' failed to activate`);
(<any>error).detail = dep.value.activationFailedError;
this._value = new FailedExtension(error);
this._host.onExtensionActivationError(this._id, error, null);
return;
}
}
if (this._deps.length > 0) {
// wait for one dependency
await Promise.race(this._deps.map(dep => dep.wait()));
}
}
await this._activate();
}
private async _activate(): Promise<void> {
try {
this._value = await this._host.actualActivateExtension(this._id, this._reason);
} catch (err) {
const error = new Error();
if (err && err.name) {
error.name = err.name;
}
if (err && err.message) {
error.message = `Activating extension '${this._id.value}' failed: ${err.message}.`;
} else {
error.message = `Activating extension '${this._id.value}' failed: ${err}.`;
}
if (err && err.stack) {
error.stack = err.stack;
}
// Treat the extension as being empty
this._value = new FailedExtension(error);
if (this._isDisposed && errors.isCancellationError(err)) {
// It is expected for ongoing activations to fail if the extension host is going down
// So simply ignore and don't log canceled errors in this case
return;
}
this._host.onExtensionActivationError(this._id, error, null);
this._logService.error(`Activating extension ${this._id.value} failed due to an error:`);
this._logService.error(err);
}
}
}
|