vscode/src/vs/workbench/services/configuration/browser/configurationService.ts

1163 lines
53 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { URI } from 'vs/base/common/uri';
import { Event, Emitter } from 'vs/base/common/event';
import { ResourceMap } from 'vs/base/common/map';
import { equals } from 'vs/base/common/objects';
import { Disposable } from 'vs/base/common/lifecycle';
import { Queue, Barrier, runWhenIdle, Promises } from 'vs/base/common/async';
import { IJSONContributionRegistry, Extensions as JSONExtensions } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
import { IWorkspaceContextService, Workspace as BaseWorkspace, WorkbenchState, IWorkspaceFolder, IWorkspaceFoldersChangeEvent, WorkspaceFolder, toWorkspaceFolder, isWorkspaceFolder, IWorkspaceFoldersWillChangeEvent } from 'vs/platform/workspace/common/workspace';
import { ConfigurationModel, ConfigurationChangeEvent, AllKeysConfigurationChangeEvent, mergeChanges } from 'vs/platform/configuration/common/configurationModels';
import { IConfigurationChangeEvent, ConfigurationTarget, IConfigurationOverrides, isConfigurationOverrides, IConfigurationData, IConfigurationValue, IConfigurationChange, ConfigurationTargetToString, IConfigurationUpdateOverrides, isConfigurationUpdateOverrides, IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { Configuration } from 'vs/workbench/services/configuration/common/configurationModels';
import { FOLDER_CONFIG_FOLDER_NAME, defaultSettingsSchemaId, userSettingsSchemaId, workspaceSettingsSchemaId, folderSettingsSchemaId, IConfigurationCache, machineSettingsSchemaId, LOCAL_MACHINE_SCOPES, IWorkbenchConfigurationService, RestrictedSettings } from 'vs/workbench/services/configuration/common/configuration';
import { Registry } from 'vs/platform/registry/common/platform';
import { IConfigurationRegistry, Extensions, allSettings, windowSettings, resourceSettings, applicationSettings, machineSettings, machineOverridableSettings, ConfigurationScope, IConfigurationPropertySchema, keyFromOverrideIdentifiers } from 'vs/platform/configuration/common/configurationRegistry';
import { IWorkspaceIdentifier, isWorkspaceIdentifier, IStoredWorkspaceFolder, isStoredWorkspaceFolder, IWorkspaceFolderCreationData, IWorkspaceInitializationPayload, IEmptyWorkspaceIdentifier, useSlashForPath, getStoredWorkspaceFolder, isSingleFolderWorkspaceIdentifier, ISingleFolderWorkspaceIdentifier, toWorkspaceFolders } from 'vs/platform/workspaces/common/workspaces';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { ConfigurationEditingService, EditableConfigurationTarget } from 'vs/workbench/services/configuration/common/configurationEditingService';
import { WorkspaceConfiguration, FolderConfiguration, RemoteUserConfiguration, UserConfiguration, DefaultConfiguration } from 'vs/workbench/services/configuration/browser/configuration';
import { JSONEditingService } from 'vs/workbench/services/configuration/common/jsonEditingService';
import { IJSONSchema, IJSONSchemaMap } from 'vs/base/common/jsonSchema';
import { mark } from 'vs/base/common/performance';
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
import { IFileService } from 'vs/platform/files/common/files';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IWorkbenchContribution, IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions } from 'vs/workbench/common/contributions';
import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { ILogService } from 'vs/platform/log/common/log';
import { toErrorMessage } from 'vs/base/common/errorMessage';
import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
import { IWorkspaceTrustManagementService } from 'vs/platform/workspace/common/workspaceTrust';
import { delta, distinct } from 'vs/base/common/arrays';
import { forEach, IStringDictionary } from 'vs/base/common/collections';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { IWorkbenchAssignmentService } from 'vs/workbench/services/assignment/common/assignmentService';
import { isUndefined } from 'vs/base/common/types';
class Workspace extends BaseWorkspace {
initialized: boolean = false;
}
export class WorkspaceService extends Disposable implements IWorkbenchConfigurationService, IWorkspaceContextService {
public _serviceBrand: undefined;
private workspace!: Workspace;
private initRemoteUserConfigurationBarrier: Barrier;
private completeWorkspaceBarrier: Barrier;
private readonly configurationCache: IConfigurationCache;
private _configuration: Configuration;
private initialized: boolean = false;
private defaultConfiguration: DefaultConfiguration;
private localUserConfiguration: UserConfiguration;
private remoteUserConfiguration: RemoteUserConfiguration | null = null;
private workspaceConfiguration: WorkspaceConfiguration;
private cachedFolderConfigs: ResourceMap<FolderConfiguration>;
private workspaceEditingQueue: Queue<void>;
private readonly logService: ILogService;
private readonly fileService: IFileService;
private readonly uriIdentityService: IUriIdentityService;
private readonly _onDidChangeConfiguration: Emitter<IConfigurationChangeEvent> = this._register(new Emitter<IConfigurationChangeEvent>());
public readonly onDidChangeConfiguration: Event<IConfigurationChangeEvent> = this._onDidChangeConfiguration.event;
protected readonly _onWillChangeWorkspaceFolders: Emitter<IWorkspaceFoldersWillChangeEvent> = this._register(new Emitter<IWorkspaceFoldersWillChangeEvent>());
public readonly onWillChangeWorkspaceFolders: Event<IWorkspaceFoldersWillChangeEvent> = this._onWillChangeWorkspaceFolders.event;
private readonly _onDidChangeWorkspaceFolders: Emitter<IWorkspaceFoldersChangeEvent> = this._register(new Emitter<IWorkspaceFoldersChangeEvent>());
public readonly onDidChangeWorkspaceFolders: Event<IWorkspaceFoldersChangeEvent> = this._onDidChangeWorkspaceFolders.event;
private readonly _onDidChangeWorkspaceName: Emitter<void> = this._register(new Emitter<void>());
public readonly onDidChangeWorkspaceName: Event<void> = this._onDidChangeWorkspaceName.event;
private readonly _onDidChangeWorkbenchState: Emitter<WorkbenchState> = this._register(new Emitter<WorkbenchState>());
public readonly onDidChangeWorkbenchState: Event<WorkbenchState> = this._onDidChangeWorkbenchState.event;
private isWorkspaceTrusted: boolean = true;
private _restrictedSettings: RestrictedSettings = { default: [] };
get restrictedSettings() { return this._restrictedSettings; }
private readonly _onDidChangeRestrictedSettings = this._register(new Emitter<RestrictedSettings>());
public readonly onDidChangeRestrictedSettings = this._onDidChangeRestrictedSettings.event;
private readonly configurationRegistry: IConfigurationRegistry;
// TODO@sandeep debt with cyclic dependencies
private configurationEditingService!: ConfigurationEditingService;
private jsonEditingService!: JSONEditingService;
private cyclicDependencyReady!: Function;
private cyclicDependency = new Promise<void>(resolve => this.cyclicDependencyReady = resolve);
constructor(
{ remoteAuthority, configurationCache }: { remoteAuthority?: string, configurationCache: IConfigurationCache },
environmentService: IWorkbenchEnvironmentService,
fileService: IFileService,
remoteAgentService: IRemoteAgentService,
uriIdentityService: IUriIdentityService,
logService: ILogService,
) {
super();
this.configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
this.initRemoteUserConfigurationBarrier = new Barrier();
this.completeWorkspaceBarrier = new Barrier();
this.defaultConfiguration = new DefaultConfiguration(configurationCache, environmentService);
this.configurationCache = configurationCache;
this.fileService = fileService;
this.uriIdentityService = uriIdentityService;
this.logService = logService;
this._configuration = new Configuration(this.defaultConfiguration.configurationModel, new ConfigurationModel(), new ConfigurationModel(), new ConfigurationModel(), new ResourceMap(), new ConfigurationModel(), new ResourceMap<ConfigurationModel>(), this.workspace);
this.cachedFolderConfigs = new ResourceMap<FolderConfiguration>();
this.localUserConfiguration = this._register(new UserConfiguration(environmentService.settingsResource, remoteAuthority ? LOCAL_MACHINE_SCOPES : undefined, fileService, uriIdentityService, logService));
this._register(this.localUserConfiguration.onDidChangeConfiguration(userConfiguration => this.onLocalUserConfigurationChanged(userConfiguration)));
if (remoteAuthority) {
const remoteUserConfiguration = this.remoteUserConfiguration = this._register(new RemoteUserConfiguration(remoteAuthority, configurationCache, fileService, uriIdentityService, remoteAgentService));
this._register(remoteUserConfiguration.onDidInitialize(remoteUserConfigurationModel => {
this._register(remoteUserConfiguration.onDidChangeConfiguration(remoteUserConfigurationModel => this.onRemoteUserConfigurationChanged(remoteUserConfigurationModel)));
this.onRemoteUserConfigurationChanged(remoteUserConfigurationModel);
this.initRemoteUserConfigurationBarrier.open();
}));
} else {
this.initRemoteUserConfigurationBarrier.open();
}
this.workspaceConfiguration = this._register(new WorkspaceConfiguration(configurationCache, fileService));
this._register(this.workspaceConfiguration.onDidUpdateConfiguration(fromCache => {
this.onWorkspaceConfigurationChanged(fromCache).then(() => {
this.workspace.initialized = this.workspaceConfiguration.initialized;
this.checkAndMarkWorkspaceComplete(fromCache);
});
}));
this._register(this.defaultConfiguration.onDidChangeConfiguration(configurationModel => this.onDefaultConfigurationChanged(configurationModel)));
this.workspaceEditingQueue = new Queue<void>();
}
// Workspace Context Service Impl
public async getCompleteWorkspace(): Promise<Workspace> {
await this.completeWorkspaceBarrier.wait();
return this.getWorkspace();
}
public getWorkspace(): Workspace {
return this.workspace;
}
public getWorkbenchState(): WorkbenchState {
// Workspace has configuration file
if (this.workspace.configuration) {
return WorkbenchState.WORKSPACE;
}
// Folder has single root
if (this.workspace.folders.length === 1) {
return WorkbenchState.FOLDER;
}
// Empty
return WorkbenchState.EMPTY;
}
public getWorkspaceFolder(resource: URI): IWorkspaceFolder | null {
return this.workspace.getFolder(resource);
}
public addFolders(foldersToAdd: IWorkspaceFolderCreationData[], index?: number): Promise<void> {
return this.updateFolders(foldersToAdd, [], index);
}
public removeFolders(foldersToRemove: URI[]): Promise<void> {
return this.updateFolders([], foldersToRemove);
}
public async updateFolders(foldersToAdd: IWorkspaceFolderCreationData[], foldersToRemove: URI[], index?: number): Promise<void> {
await this.cyclicDependency;
return this.workspaceEditingQueue.queue(() => this.doUpdateFolders(foldersToAdd, foldersToRemove, index));
}
public isInsideWorkspace(resource: URI): boolean {
return !!this.getWorkspaceFolder(resource);
}
public isCurrentWorkspace(workspaceIdOrFolder: IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier | URI): boolean {
switch (this.getWorkbenchState()) {
case WorkbenchState.FOLDER:
let folderUri: URI | undefined = undefined;
if (URI.isUri(workspaceIdOrFolder)) {
folderUri = workspaceIdOrFolder;
} else if (isSingleFolderWorkspaceIdentifier(workspaceIdOrFolder)) {
folderUri = workspaceIdOrFolder.uri;
}
return URI.isUri(folderUri) && this.uriIdentityService.extUri.isEqual(folderUri, this.workspace.folders[0].uri);
case WorkbenchState.WORKSPACE:
return isWorkspaceIdentifier(workspaceIdOrFolder) && this.workspace.id === workspaceIdOrFolder.id;
}
return false;
}
private async doUpdateFolders(foldersToAdd: IWorkspaceFolderCreationData[], foldersToRemove: URI[], index?: number): Promise<void> {
if (this.getWorkbenchState() !== WorkbenchState.WORKSPACE) {
return Promise.resolve(undefined); // we need a workspace to begin with
}
if (foldersToAdd.length + foldersToRemove.length === 0) {
return Promise.resolve(undefined); // nothing to do
}
let foldersHaveChanged = false;
// Remove first (if any)
let currentWorkspaceFolders = this.getWorkspace().folders;
let newStoredFolders: IStoredWorkspaceFolder[] = currentWorkspaceFolders.map(f => f.raw).filter((folder, index): folder is IStoredWorkspaceFolder => {
if (!isStoredWorkspaceFolder(folder)) {
return true; // keep entries which are unrelated
}
return !this.contains(foldersToRemove, currentWorkspaceFolders[index].uri); // keep entries which are unrelated
});
const slashForPath = useSlashForPath(newStoredFolders);
foldersHaveChanged = currentWorkspaceFolders.length !== newStoredFolders.length;
// Add afterwards (if any)
if (foldersToAdd.length) {
// Recompute current workspace folders if we have folders to add
const workspaceConfigPath = this.getWorkspace().configuration!;
const workspaceConfigFolder = this.uriIdentityService.extUri.dirname(workspaceConfigPath);
currentWorkspaceFolders = toWorkspaceFolders(newStoredFolders, workspaceConfigPath, this.uriIdentityService.extUri);
const currentWorkspaceFolderUris = currentWorkspaceFolders.map(folder => folder.uri);
const storedFoldersToAdd: IStoredWorkspaceFolder[] = [];
for (const folderToAdd of foldersToAdd) {
const folderURI = folderToAdd.uri;
if (this.contains(currentWorkspaceFolderUris, folderURI)) {
continue; // already existing
}
try {
const result = await this.fileService.resolve(folderURI);
if (!result.isDirectory) {
continue;
}
} catch (e) { /* Ignore */ }
storedFoldersToAdd.push(getStoredWorkspaceFolder(folderURI, false, folderToAdd.name, workspaceConfigFolder, slashForPath, this.uriIdentityService.extUri));
}
// Apply to array of newStoredFolders
if (storedFoldersToAdd.length > 0) {
foldersHaveChanged = true;
if (typeof index === 'number' && index >= 0 && index < newStoredFolders.length) {
newStoredFolders = newStoredFolders.slice(0);
newStoredFolders.splice(index, 0, ...storedFoldersToAdd);
} else {
newStoredFolders = [...newStoredFolders, ...storedFoldersToAdd];
}
}
}
// Set folders if we recorded a change
if (foldersHaveChanged) {
return this.setFolders(newStoredFolders);
}
return Promise.resolve(undefined);
}
private async setFolders(folders: IStoredWorkspaceFolder[]): Promise<void> {
await this.cyclicDependency;
await this.workspaceConfiguration.setFolders(folders, this.jsonEditingService);
return this.onWorkspaceConfigurationChanged(false);
}
private contains(resources: URI[], toCheck: URI): boolean {
return resources.some(resource => this.uriIdentityService.extUri.isEqual(resource, toCheck));
}
// Workspace Configuration Service Impl
getConfigurationData(): IConfigurationData {
return this._configuration.toData();
}
getValue<T>(): T;
getValue<T>(section: string): T;
getValue<T>(overrides: IConfigurationOverrides): T;
getValue<T>(section: string, overrides: IConfigurationOverrides): T;
getValue(arg1?: any, arg2?: any): any {
const section = typeof arg1 === 'string' ? arg1 : undefined;
const overrides = isConfigurationOverrides(arg1) ? arg1 : isConfigurationOverrides(arg2) ? arg2 : undefined;
return this._configuration.getValue(section, overrides);
}
updateValue(key: string, value: any): Promise<void>;
updateValue(key: string, value: any, overrides: IConfigurationOverrides | IConfigurationUpdateOverrides): Promise<void>;
updateValue(key: string, value: any, target: ConfigurationTarget): Promise<void>;
updateValue(key: string, value: any, overrides: IConfigurationOverrides | IConfigurationUpdateOverrides, target: ConfigurationTarget, donotNotifyError?: boolean): Promise<void>;
async updateValue(key: string, value: any, arg3?: any, arg4?: any, donotNotifyError?: any): Promise<void> {
await this.cyclicDependency;
const overrides: IConfigurationUpdateOverrides | undefined = isConfigurationUpdateOverrides(arg3) ? arg3
: isConfigurationOverrides(arg3) ? { resource: arg3.resource, overrideIdentifiers: arg3.overrideIdentifier ? [arg3.overrideIdentifier] : undefined } : undefined;
const target: ConfigurationTarget | undefined = overrides ? arg4 : arg3;
const targets: ConfigurationTarget[] = target ? [target] : [];
if (overrides?.overrideIdentifiers) {
overrides.overrideIdentifiers = distinct(overrides.overrideIdentifiers);
overrides.overrideIdentifiers = overrides.overrideIdentifiers.length ? overrides.overrideIdentifiers : undefined;
}
if (!targets.length) {
if (overrides?.overrideIdentifiers && overrides.overrideIdentifiers.length > 1) {
throw new Error('Configuration Target is required while updating the value for multiple override identifiers');
}
const inspect = this.inspect(key, { resource: overrides?.resource, overrideIdentifier: overrides?.overrideIdentifiers ? overrides.overrideIdentifiers[0] : undefined });
targets.push(...this.deriveConfigurationTargets(key, value, inspect));
// Remove the setting, if the value is same as default value and is updated only in user target
if (equals(value, inspect.defaultValue) && targets.length === 1 && (targets[0] === ConfigurationTarget.USER || targets[0] === ConfigurationTarget.USER_LOCAL)) {
value = undefined;
}
}
await Promises.settled(targets.map(target => this.writeConfigurationValue(key, value, target, overrides, donotNotifyError)));
}
async reloadConfiguration(target?: ConfigurationTarget | IWorkspaceFolder): Promise<void> {
if (target === undefined) {
const { local, remote } = await this.reloadUserConfiguration();
await this.reloadWorkspaceConfiguration();
await this.loadConfiguration(local, remote);
return;
}
if (isWorkspaceFolder(target)) {
await this.reloadWorkspaceFolderConfiguration(target);
return;
}
switch (target) {
case ConfigurationTarget.DEFAULT:
await this.reloadDefaultConfiguration();
return;
case ConfigurationTarget.USER:
const { local, remote } = await this.reloadUserConfiguration();
await this.loadConfiguration(local, remote);
return;
case ConfigurationTarget.USER_LOCAL:
await this.reloadLocalUserConfiguration();
return;
case ConfigurationTarget.USER_REMOTE:
await this.reloadRemoteUserConfiguration();
return;
case ConfigurationTarget.WORKSPACE:
case ConfigurationTarget.WORKSPACE_FOLDER:
await this.reloadWorkspaceConfiguration();
return;
}
}
inspect<T>(key: string, overrides?: IConfigurationOverrides): IConfigurationValue<T> {
return this._configuration.inspect<T>(key, overrides);
}
keys(): {
default: string[];
user: string[];
workspace: string[];
workspaceFolder: string[];
} {
return this._configuration.keys();
}
public async whenRemoteConfigurationLoaded(): Promise<void> {
await this.initRemoteUserConfigurationBarrier.wait();
}
/**
* At present, all workspaces (empty, single-folder, multi-root) in local and remote
* can be initialized without requiring extension host except following case:
*
* A multi root workspace with .code-workspace file that has to be resolved by an extension.
* Because of readonly `rootPath` property in extension API we have to resolve multi root workspace
* before extension host starts so that `rootPath` can be set to first folder.
*
* This restriction is lifted partially for web in `MainThreadWorkspace`.
* In web, we start extension host with empty `rootPath` in this case.
*
* Related root path issue discussion is being tracked here - https://github.com/microsoft/vscode/issues/69335
*/
async initialize(arg: IWorkspaceInitializationPayload): Promise<void> {
mark('code/willInitWorkspaceService');
const workspace = await this.createWorkspace(arg);
await this.updateWorkspaceAndInitializeConfiguration(workspace);
this.checkAndMarkWorkspaceComplete(false);
mark('code/didInitWorkspaceService');
}
updateWorkspaceTrust(trusted: boolean): void {
if (this.isWorkspaceTrusted !== trusted) {
this.isWorkspaceTrusted = trusted;
const data = this._configuration.toData();
const folderConfigurationModels: (ConfigurationModel | undefined)[] = [];
for (const folder of this.workspace.folders) {
const folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
let configurationModel: ConfigurationModel | undefined;
if (folderConfiguration) {
configurationModel = folderConfiguration.updateWorkspaceTrust(this.isWorkspaceTrusted);
this._configuration.updateFolderConfiguration(folder.uri, configurationModel);
}
folderConfigurationModels.push(configurationModel);
}
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
if (folderConfigurationModels[0]) {
this._configuration.updateWorkspaceConfiguration(folderConfigurationModels[0]);
}
} else {
this._configuration.updateWorkspaceConfiguration(this.workspaceConfiguration.updateWorkspaceTrust(this.isWorkspaceTrusted));
}
this.updateRestrictedSettings();
let keys: string[] = [];
if (this.restrictedSettings.userLocal) {
keys.push(...this.restrictedSettings.userLocal);
}
if (this.restrictedSettings.userRemote) {
keys.push(...this.restrictedSettings.userRemote);
}
if (this.restrictedSettings.workspace) {
keys.push(...this.restrictedSettings.workspace);
}
if (this.restrictedSettings.workspaceFolder) {
this.restrictedSettings.workspaceFolder.forEach((value) => keys.push(...value));
}
keys = distinct(keys);
if (keys.length) {
this.triggerConfigurationChange({ keys, overrides: [] }, { data, workspace: this.workspace }, ConfigurationTarget.WORKSPACE);
}
}
}
acquireInstantiationService(instantiationService: IInstantiationService): void {
this.configurationEditingService = instantiationService.createInstance(ConfigurationEditingService);
this.jsonEditingService = instantiationService.createInstance(JSONEditingService);
if (this.cyclicDependencyReady) {
this.cyclicDependencyReady();
} else {
this.cyclicDependency = Promise.resolve(undefined);
}
}
private async createWorkspace(arg: IWorkspaceInitializationPayload): Promise<Workspace> {
if (isWorkspaceIdentifier(arg)) {
return this.createMultiFolderWorkspace(arg);
}
if (isSingleFolderWorkspaceIdentifier(arg)) {
return this.createSingleFolderWorkspace(arg);
}
return this.createEmptyWorkspace(arg);
}
private async createMultiFolderWorkspace(workspaceIdentifier: IWorkspaceIdentifier): Promise<Workspace> {
await this.workspaceConfiguration.initialize({ id: workspaceIdentifier.id, configPath: workspaceIdentifier.configPath }, this.isWorkspaceTrusted);
const workspaceConfigPath = workspaceIdentifier.configPath;
const workspaceFolders = toWorkspaceFolders(this.workspaceConfiguration.getFolders(), workspaceConfigPath, this.uriIdentityService.extUri);
const workspaceId = workspaceIdentifier.id;
const workspace = new Workspace(workspaceId, workspaceFolders, this.workspaceConfiguration.isTransient(), workspaceConfigPath, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = this.workspaceConfiguration.initialized;
return workspace;
}
private createSingleFolderWorkspace(singleFolderWorkspaceIdentifier: ISingleFolderWorkspaceIdentifier): Workspace {
const workspace = new Workspace(singleFolderWorkspaceIdentifier.id, [toWorkspaceFolder(singleFolderWorkspaceIdentifier.uri)], false, null, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = true;
return workspace;
}
private createEmptyWorkspace(emptyWorkspaceIdentifier: IEmptyWorkspaceIdentifier): Promise<Workspace> {
const workspace = new Workspace(emptyWorkspaceIdentifier.id, [], false, null, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = true;
return Promise.resolve(workspace);
}
private checkAndMarkWorkspaceComplete(fromCache: boolean): void {
if (!this.completeWorkspaceBarrier.isOpen() && this.workspace.initialized) {
this.completeWorkspaceBarrier.open();
this.validateWorkspaceFoldersAndReload(fromCache);
}
}
private async updateWorkspaceAndInitializeConfiguration(workspace: Workspace): Promise<void> {
const hasWorkspaceBefore = !!this.workspace;
let previousState: WorkbenchState | undefined;
let previousWorkspacePath: string | undefined;
let previousFolders: WorkspaceFolder[] = [];
if (hasWorkspaceBefore) {
previousState = this.getWorkbenchState();
previousWorkspacePath = this.workspace.configuration ? this.workspace.configuration.fsPath : undefined;
previousFolders = this.workspace.folders;
this.workspace.update(workspace);
} else {
this.workspace = workspace;
}
await this.initializeConfiguration();
// Trigger changes after configuration initialization so that configuration is up to date.
if (hasWorkspaceBefore) {
const newState = this.getWorkbenchState();
if (previousState && newState !== previousState) {
this._onDidChangeWorkbenchState.fire(newState);
}
const newWorkspacePath = this.workspace.configuration ? this.workspace.configuration.fsPath : undefined;
if (previousWorkspacePath && newWorkspacePath !== previousWorkspacePath || newState !== previousState) {
this._onDidChangeWorkspaceName.fire();
}
const folderChanges = this.compareFolders(previousFolders, this.workspace.folders);
if (folderChanges && (folderChanges.added.length || folderChanges.removed.length || folderChanges.changed.length)) {
await this.handleWillChangeWorkspaceFolders(folderChanges, false);
this._onDidChangeWorkspaceFolders.fire(folderChanges);
}
}
if (!this.localUserConfiguration.hasTasksLoaded) {
// Reload local user configuration again to load user tasks
this._register(runWhenIdle(() => this.reloadLocalUserConfiguration(), 5000));
}
}
private compareFolders(currentFolders: IWorkspaceFolder[], newFolders: IWorkspaceFolder[]): IWorkspaceFoldersChangeEvent {
const result: IWorkspaceFoldersChangeEvent = { added: [], removed: [], changed: [] };
result.added = newFolders.filter(newFolder => !currentFolders.some(currentFolder => newFolder.uri.toString() === currentFolder.uri.toString()));
for (let currentIndex = 0; currentIndex < currentFolders.length; currentIndex++) {
let currentFolder = currentFolders[currentIndex];
let newIndex = 0;
for (newIndex = 0; newIndex < newFolders.length && currentFolder.uri.toString() !== newFolders[newIndex].uri.toString(); newIndex++) { }
if (newIndex < newFolders.length) {
if (currentIndex !== newIndex || currentFolder.name !== newFolders[newIndex].name) {
result.changed.push(currentFolder);
}
} else {
result.removed.push(currentFolder);
}
}
return result;
}
private async initializeConfiguration(): Promise<void> {
await this.defaultConfiguration.initialize();
mark('code/willInitUserConfiguration');
const { local, remote } = await this.initializeUserConfiguration();
mark('code/didInitUserConfiguration');
mark('code/willInitWorkspaceConfiguration');
await this.loadConfiguration(local, remote);
mark('code/didInitWorkspaceConfiguration');
}
private async initializeUserConfiguration(): Promise<{ local: ConfigurationModel, remote: ConfigurationModel }> {
const [local, remote] = await Promise.all([this.localUserConfiguration.initialize(), this.remoteUserConfiguration ? this.remoteUserConfiguration.initialize() : Promise.resolve(new ConfigurationModel())]);
return { local, remote };
}
private async reloadDefaultConfiguration(): Promise<void> {
this.onDefaultConfigurationChanged(this.defaultConfiguration.reload());
}
private async reloadUserConfiguration(): Promise<{ local: ConfigurationModel, remote: ConfigurationModel }> {
const [local, remote] = await Promise.all([this.reloadLocalUserConfiguration(true), this.reloadRemoteUserConfiguration(true)]);
return { local, remote };
}
async reloadLocalUserConfiguration(donotTrigger?: boolean): Promise<ConfigurationModel> {
const model = await this.localUserConfiguration.reload();
if (!donotTrigger) {
this.onLocalUserConfigurationChanged(model);
}
return model;
}
private async reloadRemoteUserConfiguration(donotTrigger?: boolean): Promise<ConfigurationModel> {
if (this.remoteUserConfiguration) {
const model = await this.remoteUserConfiguration.reload();
if (!donotTrigger) {
this.onRemoteUserConfigurationChanged(model);
}
return model;
}
return new ConfigurationModel();
}
private async reloadWorkspaceConfiguration(): Promise<void> {
const workbenchState = this.getWorkbenchState();
if (workbenchState === WorkbenchState.FOLDER) {
return this.onWorkspaceFolderConfigurationChanged(this.workspace.folders[0]);
}
if (workbenchState === WorkbenchState.WORKSPACE) {
return this.workspaceConfiguration.reload().then(() => this.onWorkspaceConfigurationChanged(false));
}
}
private reloadWorkspaceFolderConfiguration(folder: IWorkspaceFolder): Promise<void> {
return this.onWorkspaceFolderConfigurationChanged(folder);
}
private async loadConfiguration(userConfigurationModel: ConfigurationModel, remoteUserConfigurationModel: ConfigurationModel): Promise<void> {
// reset caches
this.cachedFolderConfigs = new ResourceMap<FolderConfiguration>();
const folders = this.workspace.folders;
const folderConfigurations = await this.loadFolderConfigurations(folders);
let workspaceConfiguration = this.getWorkspaceConfigurationModel(folderConfigurations);
const folderConfigurationModels = new ResourceMap<ConfigurationModel>();
folderConfigurations.forEach((folderConfiguration, index) => folderConfigurationModels.set(folders[index].uri, folderConfiguration));
const currentConfiguration = this._configuration;
this._configuration = new Configuration(this.defaultConfiguration.configurationModel, userConfigurationModel, remoteUserConfigurationModel, workspaceConfiguration, folderConfigurationModels, new ConfigurationModel(), new ResourceMap<ConfigurationModel>(), this.workspace);
if (this.initialized) {
const change = this._configuration.compare(currentConfiguration);
this.triggerConfigurationChange(change, { data: currentConfiguration.toData(), workspace: this.workspace }, ConfigurationTarget.WORKSPACE);
} else {
this._onDidChangeConfiguration.fire(new AllKeysConfigurationChangeEvent(this._configuration, this.workspace, ConfigurationTarget.WORKSPACE, this.getTargetConfiguration(ConfigurationTarget.WORKSPACE)));
this.initialized = true;
}
this.updateRestrictedSettings();
}
private getWorkspaceConfigurationModel(folderConfigurations: ConfigurationModel[]): ConfigurationModel {
switch (this.getWorkbenchState()) {
case WorkbenchState.FOLDER:
return folderConfigurations[0];
case WorkbenchState.WORKSPACE:
return this.workspaceConfiguration.getConfiguration();
default:
return new ConfigurationModel();
}
}
private onDefaultConfigurationChanged(configurationModel: ConfigurationModel): void {
if (this.workspace) {
const previousData = this._configuration.toData();
const change = this._configuration.compareAndUpdateDefaultConfiguration(configurationModel);
if (this.remoteUserConfiguration) {
this._configuration.updateLocalUserConfiguration(this.localUserConfiguration.reparse());
this._configuration.updateRemoteUserConfiguration(this.remoteUserConfiguration.reparse());
}
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
const folderConfiguration = this.cachedFolderConfigs.get(this.workspace.folders[0].uri);
if (folderConfiguration) {
this._configuration.updateWorkspaceConfiguration(folderConfiguration.reparse());
this._configuration.updateFolderConfiguration(this.workspace.folders[0].uri, folderConfiguration.reparse());
}
} else {
this._configuration.updateWorkspaceConfiguration(this.workspaceConfiguration.reparseWorkspaceSettings());
for (const folder of this.workspace.folders) {
const folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
if (folderConfiguration) {
this._configuration.updateFolderConfiguration(folder.uri, folderConfiguration.reparse());
}
}
}
this.triggerConfigurationChange(change, { data: previousData, workspace: this.workspace }, ConfigurationTarget.DEFAULT);
this.updateRestrictedSettings();
}
}
private onLocalUserConfigurationChanged(userConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateLocalUserConfiguration(userConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.USER);
}
private onRemoteUserConfigurationChanged(userConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateRemoteUserConfiguration(userConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.USER);
}
private async onWorkspaceConfigurationChanged(fromCache: boolean): Promise<void> {
if (this.workspace && this.workspace.configuration) {
let newFolders = toWorkspaceFolders(this.workspaceConfiguration.getFolders(), this.workspace.configuration, this.uriIdentityService.extUri);
// Validate only if workspace is initialized
if (this.workspace.initialized) {
const { added, removed, changed } = this.compareFolders(this.workspace.folders, newFolders);
/* If changed validate new folders */
if (added.length || removed.length || changed.length) {
newFolders = await this.toValidWorkspaceFolders(newFolders);
}
/* Otherwise use existing */
else {
newFolders = this.workspace.folders;
}
}
await this.updateWorkspaceConfiguration(newFolders, this.workspaceConfiguration.getConfiguration(), fromCache);
}
}
private updateRestrictedSettings(): void {
const changed: string[] = [];
const allProperties = this.configurationRegistry.getConfigurationProperties();
const defaultRestrictedSettings: string[] = Object.keys(allProperties).filter(key => allProperties[key].restricted).sort((a, b) => a.localeCompare(b));
const defaultDelta = delta(defaultRestrictedSettings, this._restrictedSettings.default, (a, b) => a.localeCompare(b));
changed.push(...defaultDelta.added, ...defaultDelta.removed);
const userLocal = this.localUserConfiguration.getRestrictedSettings().sort((a, b) => a.localeCompare(b));
const userLocalDelta = delta(userLocal, this._restrictedSettings.userLocal || [], (a, b) => a.localeCompare(b));
changed.push(...userLocalDelta.added, ...userLocalDelta.removed);
const userRemote = (this.remoteUserConfiguration?.getRestrictedSettings() || []).sort((a, b) => a.localeCompare(b));
const userRemoteDelta = delta(userRemote, this._restrictedSettings.userRemote || [], (a, b) => a.localeCompare(b));
changed.push(...userRemoteDelta.added, ...userRemoteDelta.removed);
const workspaceFolderMap = new ResourceMap<ReadonlyArray<string>>();
for (const workspaceFolder of this.workspace.folders) {
const cachedFolderConfig = this.cachedFolderConfigs.get(workspaceFolder.uri);
const folderRestrictedSettings = (cachedFolderConfig?.getRestrictedSettings() || []).sort((a, b) => a.localeCompare(b));
if (folderRestrictedSettings.length) {
workspaceFolderMap.set(workspaceFolder.uri, folderRestrictedSettings);
}
const previous = this._restrictedSettings.workspaceFolder?.get(workspaceFolder.uri) || [];
const workspaceFolderDelta = delta(folderRestrictedSettings, previous, (a, b) => a.localeCompare(b));
changed.push(...workspaceFolderDelta.added, ...workspaceFolderDelta.removed);
}
const workspace = this.getWorkbenchState() === WorkbenchState.WORKSPACE ? this.workspaceConfiguration.getRestrictedSettings().sort((a, b) => a.localeCompare(b))
: this.workspace.folders[0] ? (workspaceFolderMap.get(this.workspace.folders[0].uri) || []) : [];
const workspaceDelta = delta(workspace, this._restrictedSettings.workspace || [], (a, b) => a.localeCompare(b));
changed.push(...workspaceDelta.added, ...workspaceDelta.removed);
if (changed.length) {
this._restrictedSettings = {
default: defaultRestrictedSettings,
userLocal: userLocal.length ? userLocal : undefined,
userRemote: userRemote.length ? userRemote : undefined,
workspace: workspace.length ? workspace : undefined,
workspaceFolder: workspaceFolderMap.size ? workspaceFolderMap : undefined,
};
this._onDidChangeRestrictedSettings.fire(this.restrictedSettings);
}
}
private async updateWorkspaceConfiguration(workspaceFolders: WorkspaceFolder[], configuration: ConfigurationModel, fromCache: boolean): Promise<void> {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateWorkspaceConfiguration(configuration);
const changes = this.compareFolders(this.workspace.folders, workspaceFolders);
if (changes.added.length || changes.removed.length || changes.changed.length) {
this.workspace.folders = workspaceFolders;
const change = await this.onFoldersChanged();
await this.handleWillChangeWorkspaceFolders(changes, fromCache);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.WORKSPACE_FOLDER);
this._onDidChangeWorkspaceFolders.fire(changes);
} else {
this.triggerConfigurationChange(change, previous, ConfigurationTarget.WORKSPACE);
}
this.updateRestrictedSettings();
}
private async handleWillChangeWorkspaceFolders(changes: IWorkspaceFoldersChangeEvent, fromCache: boolean): Promise<void> {
const joiners: Promise<void>[] = [];
this._onWillChangeWorkspaceFolders.fire({
join(updateWorkspaceTrustStatePromise) {
joiners.push(updateWorkspaceTrustStatePromise);
},
changes,
fromCache
});
try { await Promises.settled(joiners); } catch (error) { /* Ignore */ }
}
private async onWorkspaceFolderConfigurationChanged(folder: IWorkspaceFolder): Promise<void> {
const [folderConfiguration] = await this.loadFolderConfigurations([folder]);
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const folderConfiguraitonChange = this._configuration.compareAndUpdateFolderConfiguration(folder.uri, folderConfiguration);
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
const workspaceConfigurationChange = this._configuration.compareAndUpdateWorkspaceConfiguration(folderConfiguration);
this.triggerConfigurationChange(mergeChanges(folderConfiguraitonChange, workspaceConfigurationChange), previous, ConfigurationTarget.WORKSPACE);
} else {
this.triggerConfigurationChange(folderConfiguraitonChange, previous, ConfigurationTarget.WORKSPACE_FOLDER);
}
this.updateRestrictedSettings();
}
private async onFoldersChanged(): Promise<IConfigurationChange> {
const changes: IConfigurationChange[] = [];
// Remove the configurations of deleted folders
for (const key of this.cachedFolderConfigs.keys()) {
if (!this.workspace.folders.filter(folder => folder.uri.toString() === key.toString())[0]) {
const folderConfiguration = this.cachedFolderConfigs.get(key);
folderConfiguration!.dispose();
this.cachedFolderConfigs.delete(key);
changes.push(this._configuration.compareAndDeleteFolderConfiguration(key));
}
}
const toInitialize = this.workspace.folders.filter(folder => !this.cachedFolderConfigs.has(folder.uri));
if (toInitialize.length) {
const folderConfigurations = await this.loadFolderConfigurations(toInitialize);
folderConfigurations.forEach((folderConfiguration, index) => {
changes.push(this._configuration.compareAndUpdateFolderConfiguration(toInitialize[index].uri, folderConfiguration));
});
}
return mergeChanges(...changes);
}
private loadFolderConfigurations(folders: IWorkspaceFolder[]): Promise<ConfigurationModel[]> {
return Promise.all([...folders.map(folder => {
let folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
if (!folderConfiguration) {
folderConfiguration = new FolderConfiguration(!this.initialized, folder, FOLDER_CONFIG_FOLDER_NAME, this.getWorkbenchState(), this.isWorkspaceTrusted, this.fileService, this.uriIdentityService, this.logService, this.configurationCache);
this._register(folderConfiguration.onDidChange(() => this.onWorkspaceFolderConfigurationChanged(folder)));
this.cachedFolderConfigs.set(folder.uri, this._register(folderConfiguration));
}
return folderConfiguration.loadConfiguration();
})]);
}
private async validateWorkspaceFoldersAndReload(fromCache: boolean): Promise<void> {
const validWorkspaceFolders = await this.toValidWorkspaceFolders(this.workspace.folders);
const { removed } = this.compareFolders(this.workspace.folders, validWorkspaceFolders);
if (removed.length) {
await this.updateWorkspaceConfiguration(validWorkspaceFolders, this.workspaceConfiguration.getConfiguration(), fromCache);
}
}
// Filter out workspace folders which are files (not directories)
// Workspace folders those cannot be resolved are not filtered because they are handled by the Explorer.
private async toValidWorkspaceFolders(workspaceFolders: WorkspaceFolder[]): Promise<WorkspaceFolder[]> {
const validWorkspaceFolders: WorkspaceFolder[] = [];
for (const workspaceFolder of workspaceFolders) {
try {
const result = await this.fileService.resolve(workspaceFolder.uri);
if (!result.isDirectory) {
continue;
}
} catch (e) {
this.logService.warn(`Ignoring the error while validating workspace folder ${workspaceFolder.uri.toString()} - ${toErrorMessage(e)}`);
}
validWorkspaceFolders.push(workspaceFolder);
}
return validWorkspaceFolders;
}
private async writeConfigurationValue(key: string, value: any, target: ConfigurationTarget, overrides: IConfigurationUpdateOverrides | undefined, donotNotifyError: boolean): Promise<void> {
if (target === ConfigurationTarget.DEFAULT) {
throw new Error('Invalid configuration target');
}
if (target === ConfigurationTarget.MEMORY) {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
this._configuration.updateValue(key, value, overrides);
this.triggerConfigurationChange({ keys: overrides?.overrideIdentifiers?.length ? [keyFromOverrideIdentifiers(overrides.overrideIdentifiers), key] : [key], overrides: overrides?.overrideIdentifiers?.length ? overrides.overrideIdentifiers.map(overrideIdentifier => ([overrideIdentifier, [key]])) : [] }, previous, target);
return;
}
const editableConfigurationTarget = this.toEditableConfigurationTarget(target, key);
if (!editableConfigurationTarget) {
throw new Error('Invalid configuration target');
}
if (editableConfigurationTarget === EditableConfigurationTarget.USER_REMOTE && !this.remoteUserConfiguration) {
throw new Error('Invalid configuration target');
}
await this.configurationEditingService.writeConfiguration(editableConfigurationTarget, { key, value }, { scopes: overrides, donotNotifyError });
switch (editableConfigurationTarget) {
case EditableConfigurationTarget.USER_LOCAL:
return this.reloadLocalUserConfiguration().then(() => undefined);
case EditableConfigurationTarget.USER_REMOTE:
return this.reloadRemoteUserConfiguration().then(() => undefined);
case EditableConfigurationTarget.WORKSPACE:
return this.reloadWorkspaceConfiguration();
case EditableConfigurationTarget.WORKSPACE_FOLDER:
const workspaceFolder = overrides && overrides.resource ? this.workspace.getFolder(overrides.resource) : null;
if (workspaceFolder) {
return this.reloadWorkspaceFolderConfiguration(workspaceFolder);
}
}
}
private deriveConfigurationTargets(key: string, value: any, inspect: IConfigurationValue<any>): ConfigurationTarget[] {
if (equals(value, inspect.value)) {
return [];
}
const definedTargets: ConfigurationTarget[] = [];
if (inspect.workspaceFolderValue !== undefined) {
definedTargets.push(ConfigurationTarget.WORKSPACE_FOLDER);
}
if (inspect.workspaceValue !== undefined) {
definedTargets.push(ConfigurationTarget.WORKSPACE);
}
if (inspect.userRemoteValue !== undefined) {
definedTargets.push(ConfigurationTarget.USER_REMOTE);
}
if (inspect.userLocalValue !== undefined) {
definedTargets.push(ConfigurationTarget.USER_LOCAL);
}
if (value === undefined) {
// Remove the setting in all defined targets
return definedTargets;
}
return [definedTargets[0] || ConfigurationTarget.USER];
}
private triggerConfigurationChange(change: IConfigurationChange, previous: { data: IConfigurationData, workspace?: Workspace } | undefined, target: ConfigurationTarget): void {
if (change.keys.length) {
if (target !== ConfigurationTarget.DEFAULT) {
this.logService.debug(`Configuration keys changed in ${ConfigurationTargetToString(target)} target`, ...change.keys);
}
const configurationChangeEvent = new ConfigurationChangeEvent(change, previous, this._configuration, this.workspace);
configurationChangeEvent.source = target;
configurationChangeEvent.sourceConfig = this.getTargetConfiguration(target);
this._onDidChangeConfiguration.fire(configurationChangeEvent);
}
}
private getTargetConfiguration(target: ConfigurationTarget): any {
switch (target) {
case ConfigurationTarget.DEFAULT:
return this._configuration.defaults.contents;
case ConfigurationTarget.USER:
return this._configuration.userConfiguration.contents;
case ConfigurationTarget.WORKSPACE:
return this._configuration.workspaceConfiguration.contents;
}
return {};
}
private toEditableConfigurationTarget(target: ConfigurationTarget, key: string): EditableConfigurationTarget | null {
if (target === ConfigurationTarget.USER) {
if (this.remoteUserConfiguration) {
const scope = this.configurationRegistry.getConfigurationProperties()[key]?.scope;
if (scope === ConfigurationScope.MACHINE || scope === ConfigurationScope.MACHINE_OVERRIDABLE) {
return EditableConfigurationTarget.USER_REMOTE;
}
if (this.inspect(key).userRemoteValue !== undefined) {
return EditableConfigurationTarget.USER_REMOTE;
}
}
return EditableConfigurationTarget.USER_LOCAL;
}
if (target === ConfigurationTarget.USER_LOCAL) {
return EditableConfigurationTarget.USER_LOCAL;
}
if (target === ConfigurationTarget.USER_REMOTE) {
return EditableConfigurationTarget.USER_REMOTE;
}
if (target === ConfigurationTarget.WORKSPACE) {
return EditableConfigurationTarget.WORKSPACE;
}
if (target === ConfigurationTarget.WORKSPACE_FOLDER) {
return EditableConfigurationTarget.WORKSPACE_FOLDER;
}
return null;
}
}
class RegisterConfigurationSchemasContribution extends Disposable implements IWorkbenchContribution {
constructor(
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@IWorkspaceTrustManagementService private readonly workspaceTrustManagementService: IWorkspaceTrustManagementService,
) {
super();
this.registerConfigurationSchemas();
const configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
this._register(configurationRegistry.onDidUpdateConfiguration(e => this.registerConfigurationSchemas()));
this._register(configurationRegistry.onDidSchemaChange(e => this.registerConfigurationSchemas()));
this._register(workspaceTrustManagementService.onDidChangeTrust(() => this.registerConfigurationSchemas()));
}
private registerConfigurationSchemas(): void {
const jsonRegistry = Registry.as<IJSONContributionRegistry>(JSONExtensions.JSONContribution);
const allSettingsSchema: IJSONSchema = {
properties: allSettings.properties,
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
const userSettingsSchema: IJSONSchema = this.environmentService.remoteAuthority ?
{
properties: {
...applicationSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
}
: allSettingsSchema;
const machineSettingsSchema: IJSONSchema = {
properties: {
...machineSettings.properties,
...machineOverridableSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
const workspaceSettingsSchema: IJSONSchema = {
properties: {
...this.checkAndFilterPropertiesRequiringTrust(machineOverridableSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(windowSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(resourceSettings.properties)
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
jsonRegistry.registerSchema(defaultSettingsSchemaId, {
properties: Object.keys(allSettings.properties).reduce<IJSONSchemaMap>((result, key) => {
result[key] = {
...allSettings.properties[key],
deprecationMessage: undefined
};
return result;
}, {}),
patternProperties: Object.keys(allSettings.patternProperties).reduce<IJSONSchemaMap>((result, key) => {
result[key] = {
...allSettings.patternProperties[key],
deprecationMessage: undefined
};
return result;
}, {}),
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
});
jsonRegistry.registerSchema(userSettingsSchemaId, userSettingsSchema);
jsonRegistry.registerSchema(machineSettingsSchemaId, machineSettingsSchema);
if (WorkbenchState.WORKSPACE === this.workspaceContextService.getWorkbenchState()) {
const folderSettingsSchema: IJSONSchema = {
properties: {
...this.checkAndFilterPropertiesRequiringTrust(machineOverridableSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(resourceSettings.properties)
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
jsonRegistry.registerSchema(workspaceSettingsSchemaId, workspaceSettingsSchema);
jsonRegistry.registerSchema(folderSettingsSchemaId, folderSettingsSchema);
} else {
jsonRegistry.registerSchema(workspaceSettingsSchemaId, workspaceSettingsSchema);
jsonRegistry.registerSchema(folderSettingsSchemaId, workspaceSettingsSchema);
}
}
private checkAndFilterPropertiesRequiringTrust(properties: IStringDictionary<IConfigurationPropertySchema>): IStringDictionary<IConfigurationPropertySchema> {
if (this.workspaceTrustManagementService.isWorkspaceTrusted()) {
return properties;
}
const result: IStringDictionary<IConfigurationPropertySchema> = {};
forEach(properties, ({ key, value }) => {
if (!value.restricted) {
result[key] = value;
}
});
return result;
}
}
class ResetConfigurationDefaultsOverridesCache extends Disposable implements IWorkbenchContribution {
constructor(
@IConfigurationService configurationService: IConfigurationService,
@IExtensionService extensionService: IExtensionService,
) {
super();
extensionService.whenInstalledExtensionsRegistered().then(() => configurationService.reloadConfiguration(ConfigurationTarget.DEFAULT));
}
}
class UpdateExperimentalSettingsDefaults extends Disposable implements IWorkbenchContribution {
private readonly processedExperimentalSettings = new Set<string>();
private readonly configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
constructor(
@IWorkbenchAssignmentService private readonly workbenchAssignmentService: IWorkbenchAssignmentService
) {
super();
this.processExperimentalSettings(Object.keys(this.configurationRegistry.getConfigurationProperties()));
this._register(this.configurationRegistry.onDidUpdateConfiguration(({ properties }) => this.processExperimentalSettings(properties)));
}
private async processExperimentalSettings(properties: string[]): Promise<void> {
const overrides: IStringDictionary<any> = {};
const allProperties = this.configurationRegistry.getConfigurationProperties();
for (const property of properties) {
const schema = allProperties[property];
if (!schema.tags?.includes('experimental')) {
continue;
}
if (this.processedExperimentalSettings.has(property)) {
continue;
}
this.processedExperimentalSettings.add(property);
try {
const value = await this.workbenchAssignmentService.getTreatment(`config.${property}`);
if (!isUndefined(value) && !equals(value, schema.default)) {
overrides[property] = value;
}
} catch (error) {/*ignore */ }
}
if (Object.keys(overrides).length) {
this.configurationRegistry.registerDefaultConfigurations([{ overrides }]);
}
}
}
const workbenchContributionsRegistry = Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench);
workbenchContributionsRegistry.registerWorkbenchContribution(RegisterConfigurationSchemasContribution, LifecyclePhase.Restored);
workbenchContributionsRegistry.registerWorkbenchContribution(ResetConfigurationDefaultsOverridesCache, LifecyclePhase.Ready);
workbenchContributionsRegistry.registerWorkbenchContribution(UpdateExperimentalSettingsDefaults, LifecyclePhase.Restored);