Skip to content

Commit 27082f3

Browse files
alexdimaalexdima
committed
Use an enum instead of a boolean to signal eager activation
1 parent 8871a28 commit 27082f3

6 files changed

Lines changed: 35 additions & 27 deletions

File tree

‎src/vs/workbench/api/browser/mainThreadAuthentication.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { INotificationService } from 'vs/platform/notification/common/notificati
1717
import { IStorageKeysSyncRegistryService } from 'vs/platform/userDataSync/common/storageKeys';
1818
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
1919
import { fromNow } from 'vs/base/common/date';
20-
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
20+
import { ActivationKind, IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
2121
import { Platform, platform } from 'vs/base/common/platform';
2222

2323
const VSO_ALLOWED_EXTENSIONS = ['github.vscode-pull-request-github', 'github.vscode-pull-request-github-insiders', 'vscode.git', 'ms-vsonline.vsonline', 'vscode.github-browser'];
@@ -249,7 +249,7 @@ export class MainThreadAuthentication extends Disposable implements MainThreadAu
249249
}
250250

251251
$ensureProvider(id: string): Promise<void> {
252-
return this.extensionService.activateByEvent(getAuthenticationProviderActivationEvent(id), true);
252+
return this.extensionService.activateByEvent(getAuthenticationProviderActivationEvent(id), ActivationKind.Eager);
253253
}
254254

255255
$sendDidChangeSessions(id: string, event: modes.AuthenticationSessionsChangeEvent): void {

‎src/vs/workbench/api/common/extHost.protocol.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import { IRevealOptions, ITreeItem } from 'vs/workbench/common/views';
4242
import { IAdapterDescriptor, IConfig, IDebugSessionReplMode } from 'vs/workbench/contrib/debug/common/debug';
4343
import { ITextQueryBuilderOptions } from 'vs/workbench/contrib/search/common/queryBuilder';
4444
import { ITerminalDimensions, IShellLaunchConfig, ITerminalLaunchError } from 'vs/workbench/contrib/terminal/common/terminal';
45-
import { ExtensionActivationError } from 'vs/workbench/services/extensions/common/extensions';
45+
import { ActivationKind, ExtensionActivationError } from 'vs/workbench/services/extensions/common/extensions';
4646
import { createExtHostContextProxyIdentifier as createExtId, createMainContextProxyIdentifier as createMainId, IRPCProtocol } from 'vs/workbench/services/extensions/common/proxyIdentifier';
4747
import * as search from 'vs/workbench/services/search/common/search';
4848
import { SaveReason } from 'vs/workbench/common/editor';
@@ -1074,7 +1074,7 @@ export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAut
10741074
export interface ExtHostExtensionServiceShape {
10751075
$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
10761076
$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
1077-
$activateByEvent(activationEvent: string, eager?: boolean): Promise<void>;
1077+
$activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void>;
10781078
$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
10791079
$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
10801080
$updateRemoteConnectionData(connectionData: IRemoteConnectionData): Promise<void>;

‎src/vs/workbench/api/common/extHostExtensionService.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { ExtHostConfiguration, IExtHostConfiguration } from 'vs/workbench/api/co
1717
import { ActivatedExtension, EmptyExtension, ExtensionActivationReason, ExtensionActivationTimes, ExtensionActivationTimesBuilder, ExtensionsActivator, IExtensionAPI, IExtensionModule, HostExtension, ExtensionActivationTimesFragment } from 'vs/workbench/api/common/extHostExtensionActivator';
1818
import { ExtHostStorage, IExtHostStorage } from 'vs/workbench/api/common/extHostStorage';
1919
import { ExtHostWorkspace, IExtHostWorkspace } from 'vs/workbench/api/common/extHostWorkspace';
20-
import { ExtensionActivationError, checkProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions';
20+
import { ExtensionActivationError, checkProposedApiEnabled, ActivationKind } from 'vs/workbench/services/extensions/common/extensions';
2121
import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/common/extensionDescriptionRegistry';
2222
import * as errors from 'vs/base/common/errors';
2323
import type * as vscode from 'vscode';
@@ -686,8 +686,8 @@ export abstract class AbstractExtHostExtensionService extends Disposable impleme
686686
return this._startExtensionHost();
687687
}
688688

689-
public $activateByEvent(activationEvent: string, eager: boolean = true): Promise<void> {
690-
if (eager) {
689+
public $activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void> {
690+
if (activationKind === ActivationKind.Eager) {
691691
return this._activateByEvent(activationEvent, false);
692692
}
693693

‎src/vs/workbench/services/extensions/common/abstractExtensionService.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { BetterMergeId } from 'vs/platform/extensionManagement/common/extensionM
1515
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
1616
import { INotificationService, Severity } from 'vs/platform/notification/common/notification';
1717
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
18-
import { ActivationTimes, ExtensionPointContribution, IExtensionService, IExtensionsStatus, IMessage, IWillActivateEvent, IResponsiveStateChangeEvent, toExtension, IExtensionHost } from 'vs/workbench/services/extensions/common/extensions';
18+
import { ActivationTimes, ExtensionPointContribution, IExtensionService, IExtensionsStatus, IMessage, IWillActivateEvent, IResponsiveStateChangeEvent, toExtension, IExtensionHost, ActivationKind } from 'vs/workbench/services/extensions/common/extensions';
1919
import { ExtensionMessageCollector, ExtensionPoint, ExtensionsRegistry, IExtensionPoint, IExtensionPointUser } from 'vs/workbench/services/extensions/common/extensionsRegistry';
2020
import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/common/extensionDescriptionRegistry';
2121
import { ResponsiveState } from 'vs/workbench/services/extensions/common/rpcProtocol';
@@ -186,7 +186,7 @@ export abstract class AbstractExtensionService extends Disposable implements IEx
186186
this._startExtensionHosts(false, Array.from(this._allRequestedActivateEvents.keys()));
187187
}
188188

189-
public activateByEvent(activationEvent: string, eager?: boolean): Promise<void> {
189+
public activateByEvent(activationEvent: string, activationKind: ActivationKind = ActivationKind.Normal): Promise<void> {
190190
if (this._installedExtensionsReady.isOpen()) {
191191
// Extensions have been scanned and interpreted
192192

@@ -198,24 +198,25 @@ export abstract class AbstractExtensionService extends Disposable implements IEx
198198
return NO_OP_VOID_PROMISE;
199199
}
200200

201-
return this._activateByEvent(activationEvent);
201+
return this._activateByEvent(activationEvent, activationKind);
202202
} else {
203203
// Extensions have not been scanned yet.
204204

205205
// Record the fact that this activationEvent was requested (in case of a restart)
206206
this._allRequestedActivateEvents.add(activationEvent);
207207

208-
if (eager) {
209-
return this._activateByEvent(activationEvent, eager);
208+
if (activationKind === ActivationKind.Eager) {
209+
// Do not wait for the normal start-up of the extension host(s)
210+
return this._activateByEvent(activationEvent, activationKind);
210211
}
211212

212-
return this._installedExtensionsReady.wait().then(() => this._activateByEvent(activationEvent));
213+
return this._installedExtensionsReady.wait().then(() => this._activateByEvent(activationEvent, activationKind));
213214
}
214215
}
215216

216-
private _activateByEvent(activationEvent: string, eager?: boolean): Promise<void> {
217+
private _activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void> {
217218
const result = Promise.all(
218-
this._extensionHostManagers.map(extHostManager => extHostManager.activateByEvent(activationEvent, eager))
219+
this._extensionHostManagers.map(extHostManager => extHostManager.activateByEvent(activationEvent, activationKind))
219220
).then(() => { });
220221
this._onWillActivateByEvent.fire({
221222
event: activationEvent,

‎src/vs/workbench/services/extensions/common/extensionHostManager.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { registerAction2, Action2 } from 'vs/platform/actions/common/actions';
2121
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
2222
import { StopWatch } from 'vs/base/common/stopwatch';
2323
import { VSBuffer } from 'vs/base/common/buffer';
24-
import { IExtensionHost, ExtensionHostKind } from 'vs/workbench/services/extensions/common/extensions';
24+
import { IExtensionHost, ExtensionHostKind, ActivationKind } from 'vs/workbench/services/extensions/common/extensions';
2525
import { ExtensionActivationReason } from 'vs/workbench/api/common/extHostExtensionActivator';
2626

2727
// Enable to see detailed message communication between window and extension host
@@ -76,7 +76,7 @@ export class ExtensionHostManager extends Disposable {
7676
}
7777
);
7878
this._proxy.then(() => {
79-
initialActivationEvents.forEach((activationEvent) => this.activateByEvent(activationEvent));
79+
initialActivationEvents.forEach((activationEvent) => this.activateByEvent(activationEvent, ActivationKind.Normal));
8080
this._register(registerLatencyTestProvider({
8181
measure: () => this.measure()
8282
}));
@@ -219,18 +219,18 @@ export class ExtensionHostManager extends Disposable {
219219
return proxy.$activate(extension, reason);
220220
}
221221

222-
public activateByEvent(activationEvent: string, eager?: boolean): Promise<void> {
223-
if (eager && !this._hasStarted) {
222+
public activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void> {
223+
if (activationKind === ActivationKind.Eager && !this._hasStarted) {
224224
return Promise.resolve();
225225
}
226226

227227
if (!this._cachedActivationEvents.has(activationEvent)) {
228-
this._cachedActivationEvents.set(activationEvent, this._activateByEvent(activationEvent, eager));
228+
this._cachedActivationEvents.set(activationEvent, this._activateByEvent(activationEvent, activationKind));
229229
}
230230
return this._cachedActivationEvents.get(activationEvent)!;
231231
}
232232

233-
private async _activateByEvent(activationEvent: string, eager?: boolean): Promise<void> {
233+
private async _activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void> {
234234
if (!this._proxy) {
235235
return;
236236
}
@@ -240,7 +240,7 @@ export class ExtensionHostManager extends Disposable {
240240
// i.e. the extension host could not be started
241241
return;
242242
}
243-
return proxy.value.$activateByEvent(activationEvent, eager);
243+
return proxy.value.$activateByEvent(activationEvent, activationKind);
244244
}
245245

246246
public async getInspectPort(tryEnableInspector: boolean): Promise<number> {

‎src/vs/workbench/services/extensions/common/extensions.ts‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,11 @@ export interface IResponsiveStateChangeEvent {
140140
isResponsive: boolean;
141141
}
142142

143+
export const enum ActivationKind {
144+
Normal = 0,
145+
Eager = 1
146+
}
147+
143148
export interface IExtensionService {
144149
readonly _serviceBrand: undefined;
145150

@@ -178,12 +183,14 @@ export interface IExtensionService {
178183
/**
179184
* Send an activation event and activate interested extensions.
180185
*
181-
* Normally, this will queue the activation event if the extension hosts are not ready
182-
* and send it to all of them. If the extension needs to be activated before this,
183-
* the eager flag can be used to ignore extension hosts that aren't yet started. Do not
184-
* use this flag unless necessary.
186+
* This will wait for the normal startup of the extension host(s).
187+
*
188+
* In extraordinary circumstances, if the activation event needs to activate
189+
* one or more extensions before the normal startup is finished, then you can use
190+
* `ActivationKind.Eager`. Please do not use this flag unless really necessary
191+
* and you understand all consequences.
185192
*/
186-
activateByEvent(activationEvent: string, eager?: boolean): Promise<void>;
193+
activateByEvent(activationEvent: string, activationKind?: ActivationKind): Promise<void>;
187194

188195
/**
189196
* An promise that resolves when the installed extensions are registered after

0 commit comments

Comments
 (0)