development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-27 13:00:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix frequent refresh of available profiles (#138096)

Browse source
This commit is contained in:
Megan Rogge 2021-11-29 15:45:31 -08:00 committed by GitHub
parent 37e1fac582
commit 730e0da4ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
src/vs/workbench/contrib/terminal/browser/terminalProfileService.ts
View file

@ -34,6 +34,7 @@ export class TerminalProfileService implements ITerminalProfileService {
private _availableProfiles: ITerminalProfile[] | undefined;
private _contributedProfiles: IExtensionTerminalProfile[] = [];
private _defaultProfileName?: string;
private _platformConfigJustRefreshed = false;
private readonly _profileProviders: Map</*ext id*/string, Map</*provider id*/string, ITerminalProfileProvider>> = new Map();
private readonly _onDidChangeAvailableProfiles = new Emitter<ITerminalProfile[]>();
@ -41,7 +42,9 @@ export class TerminalProfileService implements ITerminalProfileService {
get profilesReady(): Promise<void> { return this._profilesReadyBarrier.wait().then(() => { }); }
get availableProfiles(): ITerminalProfile[] {
this.refreshAvailableProfiles();
if (!this._platformConfigJustRefreshed) {
this.refreshAvailableProfiles();
}
return this._availableProfiles || [];
}
get contributedProfiles(): IExtensionTerminalProfile[] {
@ -60,14 +63,6 @@ export class TerminalProfileService implements ITerminalProfileService {
// that contributes a profile
this._extensionService.onDidChangeExtensions(() => this.refreshAvailableProfiles());
this._configurationService.onDidChangeConfiguration(async e => {
const platformKey = await this.getPlatformKey();
if (e.affectsConfiguration(TerminalSettingPrefix.DefaultProfile + platformKey) ||
e.affectsConfiguration(TerminalSettingPrefix.Profiles + platformKey) ||
e.affectsConfiguration(TerminalSettingId.UseWslProfiles)) {
this.refreshAvailableProfiles();
}
});
this._webExtensionContributedProfileContextKey = TerminalContextKeys.webExtensionContributedProfile.bindTo(this._contextKeyService);
this._updateWebContextKey();
// Wait up to 5 seconds for profiles to be ready so it's assured that we know the actual
@ -75,6 +70,26 @@ export class TerminalProfileService implements ITerminalProfileService {
// this long.
this._profilesReadyBarrier = new AutoOpenBarrier(5000);
this.refreshAvailableProfiles();
this._setupConfigListener();
}
private async _setupConfigListener(): Promise<void> {
const platformKey = await this.getPlatformKey();
this._configurationService.onDidChangeConfiguration(async e => {
if (e.affectsConfiguration(TerminalSettingPrefix.DefaultProfile + platformKey) ||
e.affectsConfiguration(TerminalSettingPrefix.Profiles + platformKey) ||
e.affectsConfiguration(TerminalSettingId.UseWslProfiles)) {
if (e.source !== ConfigurationTarget.DEFAULT) {
// when _refreshPlatformConfig is called within refreshAvailableProfiles
// on did change configuration is fired. this can lead to an infinite recursion
this.refreshAvailableProfiles();
this._platformConfigJustRefreshed = false;
} else {
this._platformConfigJustRefreshed = true;
}
}
});
}
_serviceBrand: undefined;
@ -107,7 +122,7 @@ export class TerminalProfileService implements ITerminalProfileService {
this._onDidChangeAvailableProfiles.fire(this._availableProfiles);
this._profilesReadyBarrier.open();
this._updateWebContextKey();
await this._refreshPlatformConfig(profiles);
await this._refreshPlatformConfig(this._availableProfiles);
}
}

9
src/vs/workbench/contrib/terminal/test/browser/terminalProfileService.test.ts
View file

@ -13,7 +13,7 @@ import { IExtensionTerminalProfile, ITerminalProfile } from 'vs/platform/termina
import { ITerminalInstanceService } from 'vs/workbench/contrib/terminal/browser/terminal';
import { isLinux, isWindows, OperatingSystem } from 'vs/base/common/platform';
import { MockContextKeyService } from 'vs/platform/keybinding/test/common/mockKeybindingService';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { ConfigurationTarget, IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
@ -213,7 +213,7 @@ suite('TerminalProfileService', () => {
}
}
});
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true } as any);
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true, source: ConfigurationTarget.USER } as any);
await terminalProfileService.refreshAndAwaitAvailableProfiles();
deepStrictEqual(terminalProfileService.availableProfiles, [powershellProfile]);
deepStrictEqual(terminalProfileService.contributedProfiles, []);
@ -229,7 +229,7 @@ suite('TerminalProfileService', () => {
}
}
});
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true } as any);
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true, source: ConfigurationTarget.USER } as any);
await terminalProfileService.refreshAndAwaitAvailableProfiles();
deepStrictEqual(terminalProfileService.availableProfiles, [powershellProfile]);
deepStrictEqual(terminalProfileService.contributedProfiles, []);
@ -245,7 +245,7 @@ suite('TerminalProfileService', () => {
}
}
});
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true } as any);
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true, source: ConfigurationTarget.USER } as any);
await terminalProfileService.refreshAndAwaitAvailableProfiles();
deepStrictEqual(terminalProfileService.availableProfiles, [powershellProfile]);
deepStrictEqual(terminalProfileService.contributedProfiles, []);
@ -283,7 +283,6 @@ suite('TerminalProfileService', () => {
}
}
});
configurationService.onDidChangeConfigurationEmitter.fire({ affectsConfiguration: () => true } as any);
await terminalProfileService.hasRefreshedProfiles;
deepStrictEqual(calls, [
[powershellProfile]