settingsEditor2.ts 50.6 KB
Newer Older
R
Rob Lourens 已提交
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as DOM from 'vs/base/browser/dom';
R
Rob Lourens 已提交
7
import { ITreeElement } from 'vs/base/browser/ui/tree/tree';
8
import * as arrays from 'vs/base/common/arrays';
9
import { Delayer, ThrottledDelayer, timeout } from 'vs/base/common/async';
10
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
R
Rob Lourens 已提交
11
import * as collections from 'vs/base/common/collections';
12
import { getErrorMessage, isPromiseCanceledError } from 'vs/base/common/errors';
R
Rob Lourens 已提交
13
import { Iterator } from 'vs/base/common/iterator';
P
Peng Lyu 已提交
14
import * as strings from 'vs/base/common/strings';
15
import { isArray, withNullAsUndefined, withUndefinedAsNull } from 'vs/base/common/types';
16
import { URI } from 'vs/base/common/uri';
R
Rob Lourens 已提交
17 18
import 'vs/css!./media/settingsEditor2';
import { localize } from 'vs/nls';
19
import { ConfigurationTarget, IConfigurationOverrides, IConfigurationService } from 'vs/platform/configuration/common/configuration';
R
Rob Lourens 已提交
20
import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
R
Rob Lourens 已提交
21
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
R
Rob Lourens 已提交
22
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
23
import { ILogService } from 'vs/platform/log/common/log';
J
Jackson Kearl 已提交
24
import { INotificationService } from 'vs/platform/notification/common/notification';
B
Benjamin Pasero 已提交
25
import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
R
Rob Lourens 已提交
26
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
J
Jackson Kearl 已提交
27
import { badgeBackground, badgeForeground, contrastBorder, editorForeground } from 'vs/platform/theme/common/colorRegistry';
28
import { attachStylerCallback } from 'vs/platform/theme/common/styler';
29
import { IThemeService } from 'vs/platform/theme/common/themeService';
R
Rob Lourens 已提交
30
import { BaseEditor } from 'vs/workbench/browser/parts/editor/baseEditor';
31
import { IEditor, IEditorMemento } from 'vs/workbench/common/editor';
32
import { attachSuggestEnabledInputBoxStyler, SuggestEnabledInput } from 'vs/workbench/contrib/codeEditor/browser/suggestEnabledInput/suggestEnabledInput';
33 34 35 36 37 38
import { SettingsTarget, SettingsTargetsWidget } from 'vs/workbench/contrib/preferences/browser/preferencesWidgets';
import { commonlyUsedData, tocData } from 'vs/workbench/contrib/preferences/browser/settingsLayout';
import { AbstractSettingRenderer, ISettingLinkClickEvent, ISettingOverrideClickEvent, resolveExtensionsSettings, resolveSettingsTree, SettingsTree, SettingTreeRenderers } from 'vs/workbench/contrib/preferences/browser/settingsTree';
import { ISettingsEditorViewState, parseQuery, SearchResultIdx, SearchResultModel, SettingsTreeElement, SettingsTreeGroupChild, SettingsTreeGroupElement, SettingsTreeModel, SettingsTreeSettingElement } from 'vs/workbench/contrib/preferences/browser/settingsTreeModels';
import { settingsTextInputBorder } from 'vs/workbench/contrib/preferences/browser/settingsWidgets';
import { createTOCIterator, TOCTree, TOCTreeModel } from 'vs/workbench/contrib/preferences/browser/tocTree';
39
import { CONTEXT_SETTINGS_EDITOR, CONTEXT_SETTINGS_SEARCH_FOCUS, CONTEXT_TOC_ROW_FOCUS, EXTENSION_SETTING_TAG, IPreferencesSearchService, ISearchProvider, MODIFIED_SETTING_TAG, SETTINGS_EDITOR_COMMAND_SHOW_CONTEXT_MENU, SETTINGS_EDITOR_COMMAND_CLEAR_SEARCH_RESULTS } from 'vs/workbench/contrib/preferences/common/preferences';
40
import { IEditorGroupsService } from 'vs/workbench/services/editor/common/editorGroupsService';
41
import { IPreferencesService, ISearchResult, ISettingsEditorModel, ISettingsEditorOptions, SettingsEditorOptions, SettingValueType } from 'vs/workbench/services/preferences/common/preferences';
42
import { SettingsEditor2Input } from 'vs/workbench/services/preferences/common/preferencesEditorInput';
43
import { Settings2EditorModel } from 'vs/workbench/services/preferences/common/preferencesModels';
44 45
import { Action } from 'vs/base/common/actions';
import { ActionBar } from 'vs/base/browser/ui/actionbar/actionbar';
R
Rob Lourens 已提交
46

R
Rob Lourens 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59
function createGroupIterator(group: SettingsTreeGroupElement): Iterator<ITreeElement<SettingsTreeGroupChild>> {
	const groupsIt = Iterator.fromArray(group.children);

	return Iterator.map(groupsIt, g => {
		return {
			element: g,
			children: g instanceof SettingsTreeGroupElement ?
				createGroupIterator(g) :
				undefined
		};
	});
}

60 61
const $ = DOM.$;

R
Rob Lourens 已提交
62 63 64 65
interface IFocusEventFromScroll extends KeyboardEvent {
	fromScroll: true;
}

66
const SETTINGS_EDITOR_STATE_KEY = 'settingsEditorState';
R
Rob Lourens 已提交
67 68
export class SettingsEditor2 extends BaseEditor {

R
Rob Lourens 已提交
69
	static readonly ID: string = 'workbench.editor.settings2';
70
	private static NUM_INSTANCES: number = 0;
G
Guy Waldman 已提交
71 72
	private static SETTING_UPDATE_FAST_DEBOUNCE: number = 200;
	private static SETTING_UPDATE_SLOW_DEBOUNCE: number = 1000;
73
	private static CONFIG_SCHEMA_UPDATE_DELAYER = 500;
R
Rob Lourens 已提交
74

75
	private static readonly SUGGESTIONS: string[] = [
P
Peng Lyu 已提交
76
		`@${MODIFIED_SETTING_TAG}`, '@tag:usesOnlineServices', `@${EXTENSION_SETTING_TAG}`
77 78
	];

79 80 81
	private static shouldSettingUpdateFast(type: SettingValueType | SettingValueType[]): boolean {
		if (isArray(type)) {
			// nullable integer/number or complex
G
Guy Waldman 已提交
82
			return false;
83
		}
R
Rob Lourens 已提交
84
		return type === SettingValueType.Enum ||
P
Pine Wu 已提交
85
			type === SettingValueType.ArrayOfString ||
R
Rob Lourens 已提交
86 87 88
			type === SettingValueType.Complex ||
			type === SettingValueType.Boolean ||
			type === SettingValueType.Exclude;
89 90
	}

91 92
	// (!) Lots of props that are set once on the first render
	private defaultSettingsEditorModel!: Settings2EditorModel;
R
Rob Lourens 已提交
93

94 95 96 97 98
	private rootElement!: HTMLElement;
	private headerContainer!: HTMLElement;
	private searchWidget!: SuggestEnabledInput;
	private countElement!: HTMLElement;
	private settingsTargetsWidget!: SettingsTargetsWidget;
R
Rob Lourens 已提交
99

100 101 102 103 104 105 106
	private settingsTreeContainer!: HTMLElement;
	private settingsTree!: SettingsTree;
	private settingRenderers!: SettingTreeRenderers;
	private tocTreeModel!: TOCTreeModel;
	private settingsTreeModel!: SettingsTreeModel;
	private noResultsMessage!: HTMLElement;
	private clearFilterLinkContainer!: HTMLElement;
R
Rob Lourens 已提交
107

108 109
	private tocTreeContainer!: HTMLElement;
	private tocTree!: TOCTree;
R
Rob Lourens 已提交
110

111
	private settingsAriaExtraLabelsContainer!: HTMLElement;
112

R
Rob Lourens 已提交
113 114 115
	private delayedFilterLogging: Delayer<void>;
	private localSearchDelayer: Delayer<void>;
	private remoteSearchThrottle: ThrottledDelayer<void>;
116
	private searchInProgress: CancellationTokenSource | null = null;
117

118 119
	private updatedConfigSchemaDelayer: Delayer<void>;

120 121
	private settingFastUpdateDelayer: Delayer<void>;
	private settingSlowUpdateDelayer: Delayer<void>;
122
	private pendingSettingUpdate: { key: string, value: any } | null = null;
R
Rob Lourens 已提交
123

124
	private readonly viewState: ISettingsEditorViewState;
125
	private _searchResultModel: SearchResultModel | null = null;
126

127
	private tocRowFocused: IContextKey<boolean>;
128 129
	private inSettingsEditorContextKey: IContextKey<boolean>;
	private searchFocusContextKey: IContextKey<boolean>;
130

131
	private scheduledRefreshes: Map<string, DOM.IFocusTracker>;
132
	private lastFocusedSettingElement: string | null = null;
133

134
	/** Don't spam warnings */
135
	private hasWarnedMissingSettings = false;
136

137 138
	private editorMemento: IEditorMemento<ISettingsEditor2State>;

139
	private tocFocusedElement: SettingsTreeGroupElement | null = null;
140
	private settingsTreeScrollTop = 0;
141
	private dimension!: DOM.Dimension;
142

R
Rob Lourens 已提交
143 144
	constructor(
		@ITelemetryService telemetryService: ITelemetryService,
145
		@IConfigurationService private readonly configurationService: IConfigurationService,
R
Rob Lourens 已提交
146
		@IThemeService themeService: IThemeService,
147 148 149 150
		@IPreferencesService private readonly preferencesService: IPreferencesService,
		@IInstantiationService private readonly instantiationService: IInstantiationService,
		@IPreferencesSearchService private readonly preferencesSearchService: IPreferencesSearchService,
		@ILogService private readonly logService: ILogService,
151
		@IContextKeyService contextKeyService: IContextKeyService,
152 153
		@IStorageService private readonly storageService: IStorageService,
		@INotificationService private readonly notificationService: INotificationService,
154
		@IEditorGroupsService protected editorGroupService: IEditorGroupsService,
155
		@IKeybindingService private readonly keybindingService: IKeybindingService
R
Rob Lourens 已提交
156
	) {
157
		super(SettingsEditor2.ID, telemetryService, themeService, storageService);
R
Rob Lourens 已提交
158
		this.delayedFilterLogging = new Delayer<void>(1000);
159
		this.localSearchDelayer = new Delayer(300);
160
		this.remoteSearchThrottle = new ThrottledDelayer(200);
R
Rob Lourens 已提交
161
		this.viewState = { settingsTarget: ConfigurationTarget.USER_LOCAL };
R
Rob Lourens 已提交
162

163 164
		this.settingFastUpdateDelayer = new Delayer<void>(SettingsEditor2.SETTING_UPDATE_FAST_DEBOUNCE);
		this.settingSlowUpdateDelayer = new Delayer<void>(SettingsEditor2.SETTING_UPDATE_SLOW_DEBOUNCE);
165

166 167
		this.updatedConfigSchemaDelayer = new Delayer<void>(SettingsEditor2.CONFIG_SCHEMA_UPDATE_DELAYER);

168 169
		this.inSettingsEditorContextKey = CONTEXT_SETTINGS_EDITOR.bindTo(contextKeyService);
		this.searchFocusContextKey = CONTEXT_SETTINGS_SEARCH_FOCUS.bindTo(contextKeyService);
170
		this.tocRowFocused = CONTEXT_TOC_ROW_FOCUS.bindTo(contextKeyService);
171

172 173
		this.scheduledRefreshes = new Map<string, DOM.IFocusTracker>();

B
Benjamin Pasero 已提交
174
		this.editorMemento = this.getEditorMemento<ISettingsEditor2State>(editorGroupService, SETTINGS_EDITOR_STATE_KEY);
175

176
		this._register(configurationService.onDidChangeConfiguration(e => {
177 178 179
			if (e.source !== ConfigurationTarget.DEFAULT) {
				this.onConfigUpdate(e.affectedKeys);
			}
180
		}));
R
Rob Lourens 已提交
181 182
	}

183 184 185 186 187 188 189
	get minimumWidth(): number { return 375; }
	get maximumWidth(): number { return Number.POSITIVE_INFINITY; }

	// these setters need to exist because this extends from BaseEditor
	set minimumWidth(value: number) { /*noop*/ }
	set maximumWidth(value: number) { /*noop*/ }

R
Rob Lourens 已提交
190 191 192 193
	private get currentSettingsModel() {
		return this.searchResultModel || this.settingsTreeModel;
	}

R
Rob Lourens 已提交
194
	private get searchResultModel(): SearchResultModel | null {
195 196 197
		return this._searchResultModel;
	}

R
Rob Lourens 已提交
198
	private set searchResultModel(value: SearchResultModel | null) {
199 200 201 202 203
		this._searchResultModel = value;

		DOM.toggleClass(this.rootElement, 'search-mode', !!this._searchResultModel);
	}

R
Rob Lourens 已提交
204 205 206
	private get currentSettingsContextMenuKeyBindingLabel(): string {
		const keybinding = this.keybindingService.lookupKeybinding(SETTINGS_EDITOR_COMMAND_SHOW_CONTEXT_MENU);
		return (keybinding && keybinding.getAriaLabel()) || '';
207 208
	}

R
Rob Lourens 已提交
209
	createEditor(parent: HTMLElement): void {
210
		parent.setAttribute('tabindex', '-1');
R
Rob Lourens 已提交
211
		this.rootElement = DOM.append(parent, $('.settings-editor', { tabindex: '-1' }));
R
Rob Lourens 已提交
212

213 214
		this.createHeader(this.rootElement);
		this.createBody(this.rootElement);
215
		this.updateStyles();
R
Rob Lourens 已提交
216 217
	}

218
	setInput(input: SettingsEditor2Input, options: SettingsEditorOptions | undefined, token: CancellationToken): Promise<void> {
219
		this.inSettingsEditorContextKey.set(true);
220
		return super.setInput(input, options, token)
221
			.then(() => timeout(0)) // Force setInput to be async
R
Rob Lourens 已提交
222
			.then(() => {
223 224 225 226 227 228 229 230
				// Don't block setInput on render (which can trigger an async search)
				this.render(token).then(() => {
					options = options || SettingsEditorOptions.create({});

					if (!this.viewState.settingsTarget) {
						if (!options.target) {
							options.target = ConfigurationTarget.USER_LOCAL;
						}
231
					}
R
Rob Lourens 已提交
232

233
					this._setOptions(options);
234

235 236 237
					this._register(input.onDispose(() => {
						this.searchWidget.setValue('');
					}));
238

239 240 241
					// Init TOC selection
					this.updateTreeScrollSync();
				});
R
Rob Lourens 已提交
242
			});
R
Rob Lourens 已提交
243 244
	}

245
	private restoreCachedState(): ISettingsEditor2State | null {
R
Rob Lourens 已提交
246
		const cachedState = this.group && this.input && this.editorMemento.loadEditorState(this.group, this.input);
247
		if (cachedState && typeof cachedState.target === 'object') {
248 249 250 251 252 253
			cachedState.target = URI.revive(cachedState.target);
		}

		if (cachedState) {
			const settingsTarget = cachedState.target;
			this.settingsTargetsWidget.settingsTarget = settingsTarget;
254
			this.viewState.settingsTarget = settingsTarget;
255 256
			this.searchWidget.setValue(cachedState.searchQuery);
		}
257 258 259 260 261 262

		if (this.input) {
			this.editorMemento.clearEditorState(this.input, this.group);
		}

		return withUndefinedAsNull(cachedState);
263 264
	}

265
	setOptions(options: SettingsEditorOptions | undefined): void {
266 267
		super.setOptions(options);

R
Rob Lourens 已提交
268 269 270
		if (options) {
			this._setOptions(options);
		}
271
	}
272

273
	private _setOptions(options: SettingsEditorOptions): void {
274 275 276 277
		if (options.query) {
			this.searchWidget.setValue(options.query);
		}

278
		const target: SettingsTarget = options.folderUri || <SettingsTarget>options.target;
R
Rob Lourens 已提交
279 280 281 282
		if (target) {
			this.settingsTargetsWidget.settingsTarget = target;
			this.viewState.settingsTarget = target;
		}
283 284
	}

285 286 287 288 289
	clearInput(): void {
		this.inSettingsEditorContextKey.set(false);
		super.clearInput();
	}

R
Rob Lourens 已提交
290
	layout(dimension: DOM.Dimension): void {
291
		this.dimension = dimension;
J
Joao Moreno 已提交
292 293 294 295 296

		if (!this.isVisible()) {
			return;
		}

297 298
		this.layoutTrees(dimension);

299 300
		const innerWidth = Math.min(1000, dimension.width) - 24 * 2; // 24px padding on left and right;
		const monacoWidth = innerWidth - 10 - this.countElement.clientWidth - 12; // minus padding inside inputbox, countElement width, extra padding before countElement
301 302
		this.searchWidget.layout({ height: 20, width: monacoWidth });

303 304
		DOM.toggleClass(this.rootElement, 'mid-width', dimension.width < 1000 && dimension.width >= 600);
		DOM.toggleClass(this.rootElement, 'narrow-width', dimension.width < 600);
R
Rob Lourens 已提交
305 306 307
	}

	focus(): void {
R
Rob Lourens 已提交
308
		if (this.lastFocusedSettingElement) {
R
Rob Lourens 已提交
309
			const elements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), this.lastFocusedSettingElement);
R
Rob Lourens 已提交
310
			if (elements.length) {
R
Rob Lourens 已提交
311
				const control = elements[0].querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
R
Rob Lourens 已提交
312 313 314 315 316 317 318
				if (control) {
					(<HTMLElement>control).focus();
					return;
				}
			}
		}

319 320 321
		this.focusSearch();
	}

322
	focusSettings(): void {
323 324 325 326 327
		// Update ARIA global labels
		const labelElement = this.settingsAriaExtraLabelsContainer.querySelector('#settings_aria_more_actions_shortcut_label');
		if (labelElement) {
			const settingsContextMenuShortcut = this.currentSettingsContextMenuKeyBindingLabel;
			if (settingsContextMenuShortcut) {
328
				labelElement.setAttribute('aria-label', localize('settingsContextMenuAriaShortcut', "For more actions, Press {0}.", settingsContextMenuShortcut));
329 330 331
			}
		}

R
Rob Lourens 已提交
332
		const firstFocusable = this.settingsTree.getHTMLElement().querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
333 334
		if (firstFocusable) {
			(<HTMLElement>firstFocusable).focus();
335 336 337
		}
	}

338
	showContextMenu(): void {
R
Rob Lourens 已提交
339 340 341 342 343 344
		const activeElement = this.getActiveElementInSettingsTree();
		if (!activeElement) {
			return;
		}

		const settingDOMElement = this.settingRenderers.getSettingDOMElementForDOMElement(activeElement);
345 346 347 348
		if (!settingDOMElement) {
			return;
		}

R
Rob Lourens 已提交
349
		const focusedKey = this.settingRenderers.getKeyForDOMElementInSetting(settingDOMElement);
350 351 352 353 354 355
		if (!focusedKey) {
			return;
		}

		const elements = this.currentSettingsModel.getElementsByName(focusedKey);
		if (elements && elements[0]) {
R
Rob Lourens 已提交
356
			this.settingRenderers.showContextMenu(elements[0], settingDOMElement);
357 358 359
		}
	}

360
	focusSearch(filter?: string, selectAll = true): void {
361 362 363 364
		if (filter && this.searchWidget) {
			this.searchWidget.setValue(filter);
		}

365
		this.searchWidget.focus(selectAll);
R
Rob Lourens 已提交
366 367
	}

368
	clearSearchResults(): void {
369
		this.searchWidget.setValue('');
370 371
	}

372 373 374 375 376 377 378 379 380 381
	clearSearchFilters(): void {
		let query = this.searchWidget.getValue();

		SettingsEditor2.SUGGESTIONS.forEach(suggestion => {
			query = query.replace(suggestion, '');
		});

		this.searchWidget.setValue(query.trim());
	}

382 383 384 385 386
	clearSearch(): void {
		this.clearSearchResults();
		this.focusSearch();
	}

R
Rob Lourens 已提交
387 388 389 390
	private createHeader(parent: HTMLElement): void {
		this.headerContainer = DOM.append(parent, $('.settings-header'));

		const searchContainer = DOM.append(this.headerContainer, $('.search-container'));
391

392 393
		const clearInputAction = new Action(SETTINGS_EDITOR_COMMAND_CLEAR_SEARCH_RESULTS, localize('clearInput', "Clear Settings Search Input"), 'codicon-clear-all', false, () => { this.clearSearch(); return Promise.resolve(null); });

R
Rob Lourens 已提交
394
		const searchBoxLabel = localize('SearchSettings.AriaLabel', "Search settings");
395 396 397
		this.searchWidget = this._register(this.instantiationService.createInstance(SuggestEnabledInput, `${SettingsEditor2.ID}.searchbox`, searchContainer, {
			triggerCharacters: ['@'],
			provideResults: (query: string) => {
P
Peng Lyu 已提交
398
				return SettingsEditor2.SUGGESTIONS.filter(tag => query.indexOf(tag) === -1).map(tag => strings.endsWith(tag, ':') ? tag : tag + ' ');
399
			}
400
		}, searchBoxLabel, 'settingseditor:searchinput' + SettingsEditor2.NUM_INSTANCES++, {
M
Matt Bierner 已提交
401 402 403 404
			placeholderText: searchBoxLabel,
			focusContextKey: this.searchFocusContextKey,
			// TODO: Aria-live
		})
J
Jeremy Shore 已提交
405
		);
406

407 408 409 410
		this._register(this.searchWidget.onFocus(() => {
			this.lastFocusedSettingElement = '';
		}));

411 412 413 414
		this._register(attachSuggestEnabledInputBoxStyler(this.searchWidget, this.themeService, {
			inputBorder: settingsTextInputBorder
		}));

415 416
		this.countElement = DOM.append(searchContainer, DOM.$('.settings-count-widget'));
		this._register(attachStylerCallback(this.themeService, { badgeBackground, contrastBorder, badgeForeground }, colors => {
417 418 419
			const background = colors.badgeBackground ? colors.badgeBackground.toString() : '';
			const border = colors.contrastBorder ? colors.contrastBorder.toString() : '';
			const foreground = colors.badgeForeground ? colors.badgeForeground.toString() : '';
420 421

			this.countElement.style.backgroundColor = background;
R
Rob Lourens 已提交
422
			this.countElement.style.color = foreground;
423

424 425
			this.countElement.style.borderWidth = border ? '1px' : '';
			this.countElement.style.borderStyle = border ? 'solid' : '';
426 427 428
			this.countElement.style.borderColor = border;
		}));

429 430 431 432 433
		this._register(this.searchWidget.onInputDidChange(() => {
			const searchVal = this.searchWidget.getValue();
			clearInputAction.enabled = !!searchVal;
			this.onSearchInputChanged();
		}));
R
Rob Lourens 已提交
434

435
		const headerControlsContainer = DOM.append(this.headerContainer, $('.settings-header-controls'));
R
Rob Lourens 已提交
436
		const targetWidgetContainer = DOM.append(headerControlsContainer, $('.settings-target-container'));
R
Rob Lourens 已提交
437 438
		this.settingsTargetsWidget = this._register(this.instantiationService.createInstance(SettingsTargetsWidget, targetWidgetContainer, { enableRemoteSettings: true }));
		this.settingsTargetsWidget.settingsTarget = ConfigurationTarget.USER_LOCAL;
439
		this.settingsTargetsWidget.onDidTargetChange(target => this.onDidSettingsTargetChange(target));
440

441
		const actionsContainer = DOM.append(searchContainer, DOM.$('.settings-clear-widget'));
442

443
		const actionBar = this._register(new ActionBar(actionsContainer, {
444 445 446 447
			animated: false,
			actionViewItemProvider: (action: Action) => { return undefined; }
		}));

448
		actionBar.push([clearInputAction], { label: false, icon: true });
R
Rob Lourens 已提交
449 450
	}

451 452 453
	private onDidSettingsTargetChange(target: SettingsTarget): void {
		this.viewState.settingsTarget = target;

454 455
		// TODO Instead of rebuilding the whole model, refresh and uncache the inspected setting value
		this.onConfigUpdate(undefined, true);
456 457
	}

458
	private onDidClickSetting(evt: ISettingLinkClickEvent, recursed?: boolean): void {
459
		const elements = this.currentSettingsModel.getElementsByName(evt.targetKey);
460
		if (elements && elements[0]) {
461
			let sourceTop = this.settingsTree.getRelativeTop(evt.source);
R
Rob Lourens 已提交
462 463 464 465
			if (typeof sourceTop !== 'number') {
				return;
			}

466 467
			if (sourceTop < 0) {
				// e.g. clicked a searched element, now the search has been cleared
468
				sourceTop = 0.5;
469 470
			}

471
			this.settingsTree.reveal(elements[0], sourceTop);
472

R
Rob Lourens 已提交
473
			const domElements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), evt.targetKey);
474
			if (domElements && domElements[0]) {
R
Rob Lourens 已提交
475
				const control = domElements[0].querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
476 477 478 479
				if (control) {
					(<HTMLElement>control).focus();
				}
			}
480 481 482 483 484 485
		} else if (!recursed) {
			const p = this.triggerSearch('');
			p.then(() => {
				this.searchWidget.setValue('');
				this.onDidClickSetting(evt, true);
			});
486 487 488
		}
	}

489
	switchToSettingsFile(): Promise<IEditor | undefined> {
490 491 492 493
		const query = parseQuery(this.searchWidget.getValue());
		return this.openSettingsFile(query.query);
	}

494
	private async openSettingsFile(query?: string): Promise<IEditor | undefined> {
495 496
		const currentSettingsTarget = this.settingsTargetsWidget.settingsTarget;

497
		const options: ISettingsEditorOptions = { query };
R
Rob Lourens 已提交
498
		if (currentSettingsTarget === ConfigurationTarget.USER_LOCAL) {
499
			return this.preferencesService.openGlobalSettings(true, options);
R
Rob Lourens 已提交
500 501
		} else if (currentSettingsTarget === ConfigurationTarget.USER_REMOTE) {
			return this.preferencesService.openRemoteSettings();
502
		} else if (currentSettingsTarget === ConfigurationTarget.WORKSPACE) {
503
			return this.preferencesService.openWorkspaceSettings(true, options);
504
		} else if (URI.isUri(currentSettingsTarget)) {
505
			return this.preferencesService.openFolderSettings(currentSettingsTarget, true, options);
506
		}
507 508

		return undefined;
R
Rob Lourens 已提交
509 510 511 512 513
	}

	private createBody(parent: HTMLElement): void {
		const bodyContainer = DOM.append(parent, $('.settings-body'));

R
Rob Lourens 已提交
514
		this.noResultsMessage = DOM.append(bodyContainer, $('.no-results-message'));
515

516
		this.noResultsMessage.innerText = localize('noResults', "No Settings Found");
517 518 519 520 521

		this.clearFilterLinkContainer = $('span.clear-search-filters');

		this.clearFilterLinkContainer.textContent = ' - ';
		const clearFilterLink = DOM.append(this.clearFilterLinkContainer, $('a.pointer.prominent', { tabindex: 0 }, localize('clearSearchFilters', 'Clear Filters')));
522
		this._register(DOM.addDisposableListener(clearFilterLink, DOM.EventType.CLICK, (e: MouseEvent) => {
523 524 525 526 527 528 529 530 531 532
			DOM.EventHelper.stop(e, false);
			this.clearSearchFilters();
		}));

		DOM.append(this.noResultsMessage, this.clearFilterLinkContainer);

		const clearSearchContainer = $('span.clear-search');
		clearSearchContainer.textContent = ' - ';

		const clearSearch = DOM.append(clearSearchContainer, $('a.pointer.prominent', { tabindex: 0 }, localize('clearSearch', 'Clear Search')));
533
		this._register(DOM.addDisposableListener(clearSearch, DOM.EventType.CLICK, (e: MouseEvent) => {
534 535
			DOM.EventHelper.stop(e, false);
			this.clearSearchResults();
536
			this.focusSearch();
537 538 539 540
		}));

		DOM.append(this.noResultsMessage, clearSearchContainer);

541 542 543 544
		this._register(attachStylerCallback(this.themeService, { editorForeground }, colors => {
			this.noResultsMessage.style.color = colors.editorForeground ? colors.editorForeground.toString() : null;
		}));

R
Rob Lourens 已提交
545 546
		this.createTOC(bodyContainer);

547 548 549 550 551
		this.createFocusSink(
			bodyContainer,
			e => {
				if (DOM.findParentWithClass(e.relatedTarget, 'settings-editor-tree')) {
					if (this.settingsTree.scrollTop > 0) {
552
						const firstElement = this.settingsTree.firstVisibleElement;
553 554 555 556 557 558 559 560 561 562 563 564 565
						this.settingsTree.reveal(firstElement, 0.1);
						return true;
					}
				} else {
					const firstControl = this.settingsTree.getHTMLElement().querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
					if (firstControl) {
						(<HTMLElement>firstControl).focus();
					}
				}

				return false;
			},
			'settings list focus helper');
R
Rob Lourens 已提交
566

R
Rob Lourens 已提交
567
		this.createSettingsTree(bodyContainer);
R
Rob Lourens 已提交
568

569 570 571 572 573
		this.createFocusSink(
			bodyContainer,
			e => {
				if (DOM.findParentWithClass(e.relatedTarget, 'settings-editor-tree')) {
					if (this.settingsTree.scrollTop < this.settingsTree.scrollHeight) {
574
						const lastElement = this.settingsTree.lastVisibleElement;
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
						this.settingsTree.reveal(lastElement, 0.9);
						return true;
					}
				}

				return false;
			},
			'settings list focus helper'
		);
	}

	private createFocusSink(container: HTMLElement, callback: (e: any) => boolean, label: string): HTMLElement {
		const listFocusSink = DOM.append(container, $('.settings-tree-focus-sink'));
		listFocusSink.setAttribute('aria-label', label);
		listFocusSink.tabIndex = 0;
		this._register(DOM.addDisposableListener(listFocusSink, 'focus', (e: any) => {
			if (e.relatedTarget && callback(e)) {
				e.relatedTarget.focus();
			}
		}));

		return listFocusSink;
	}
598

R
Rob Lourens 已提交
599
	private createTOC(parent: HTMLElement): void {
600
		this.tocTreeModel = this.instantiationService.createInstance(TOCTreeModel, this.viewState);
R
Rob Lourens 已提交
601 602
		this.tocTreeContainer = DOM.append(parent, $('.settings-toc-container'));

603 604
		this.tocTree = this._register(this.instantiationService.createInstance(TOCTree,
			DOM.append(this.tocTreeContainer, $('.settings-toc-wrapper')),
R
Rob Lourens 已提交
605
			this.viewState));
R
Rob Lourens 已提交
606

607
		this._register(this.tocTree.onDidChangeFocus(e => {
R
Rob Lourens 已提交
608
			const element: SettingsTreeGroupElement | null = e.elements[0];
R
Rob Lourens 已提交
609 610 611
			if (this.tocFocusedElement === element) {
				return;
			}
612

R
Rob Lourens 已提交
613 614 615 616
			this.tocFocusedElement = element;
			this.tocTree.setSelection(element ? [element] : []);
			if (this.searchResultModel) {
				if (this.viewState.filterToCategory !== element) {
617
					this.viewState.filterToCategory = withNullAsUndefined(element);
618 619
					this.renderTree();
					this.settingsTree.scrollTop = 0;
R
Rob Lourens 已提交
620
				}
R
Rob Lourens 已提交
621
			} else if (element && (!e.browserEvent || !(<IFocusEventFromScroll>e.browserEvent).fromScroll)) {
R
Rob Lourens 已提交
622 623
				this.settingsTree.reveal(element, 0);
			}
624 625 626 627 628 629 630 631
		}));

		this._register(this.tocTree.onDidFocus(() => {
			this.tocRowFocused.set(true);
		}));

		this._register(this.tocTree.onDidBlur(() => {
			this.tocRowFocused.set(false);
R
Rob Lourens 已提交
632 633 634 635
		}));
	}

	private createSettingsTree(parent: HTMLElement): void {
636
		this.settingsTreeContainer = DOM.append(parent, $('.settings-tree-container'));
R
Rob Lourens 已提交
637

638 639 640 641 642 643 644 645
		// Add  ARIA extra labels div
		this.settingsAriaExtraLabelsContainer = DOM.append(this.settingsTreeContainer, $('.settings-aria-extra-labels'));
		this.settingsAriaExtraLabelsContainer.id = 'settings_aria_extra_labels';
		// Add global labels here
		const labelDiv = DOM.append(this.settingsAriaExtraLabelsContainer, $('.settings-aria-extra-label'));
		labelDiv.id = 'settings_aria_more_actions_shortcut_label';
		labelDiv.setAttribute('aria-label', '');

R
Rob Lourens 已提交
646 647 648
		this.settingRenderers = this.instantiationService.createInstance(SettingTreeRenderers);
		this._register(this.settingRenderers.onDidChangeSetting(e => this.onDidChangeSetting(e.key, e.value, e.type)));
		this._register(this.settingRenderers.onDidOpenSettings(settingKey => {
649
			this.openSettingsFile(settingKey);
650
		}));
R
Rob Lourens 已提交
651 652
		this._register(this.settingRenderers.onDidClickSettingLink(settingName => this.onDidClickSetting(settingName)));
		this._register(this.settingRenderers.onDidFocusSetting(element => {
R
Rob Lourens 已提交
653
			this.lastFocusedSettingElement = element.setting.key;
654 655
			this.settingsTree.reveal(element);
		}));
R
Rob Lourens 已提交
656
		this._register(this.settingRenderers.onDidClickOverrideElement((element: ISettingOverrideClickEvent) => {
657
			if (element.scope.toLowerCase() === 'workspace') {
J
Jeremy Shore 已提交
658
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.WORKSPACE);
659
			} else if (element.scope.toLowerCase() === 'user') {
R
Rob Lourens 已提交
660
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.USER_LOCAL);
661
			} else if (element.scope.toLowerCase() === 'remote') {
R
Rob Lourens 已提交
662
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.USER_REMOTE);
J
Jeremy Shore 已提交
663 664 665 666
			}

			this.searchWidget.setValue(element.targetKey);
		}));
667

668
		this.settingsTree = this._register(this.instantiationService.createInstance(SettingsTree,
669 670
			this.settingsTreeContainer,
			this.viewState,
R
Rob Lourens 已提交
671
			this.settingRenderers.allRenderers));
R
Rob Lourens 已提交
672
		this.settingsTree.getHTMLElement().attributes.removeNamedItem('tabindex');
673

674
		this._register(this.settingsTree.onDidScroll(() => {
675 676 677 678 679 680 681 682 683 684 685
			if (this.settingsTree.scrollTop === this.settingsTreeScrollTop) {
				return;
			}

			this.settingsTreeScrollTop = this.settingsTree.scrollTop;

			// setTimeout because calling setChildren on the settingsTree can trigger onDidScroll, so it fires when
			// setChildren has called on the settings tree but not the toc tree yet, so their rendered elements are out of sync
			setTimeout(() => {
				this.updateTreeScrollSync();
			}, 0);
686
		}));
687 688
	}

B
Benjamin Pasero 已提交
689 690
	private notifyNoSaveNeeded() {
		if (!this.storageService.getBoolean('hasNotifiedOfSettingsAutosave', StorageScope.GLOBAL, false)) {
B
Benjamin Pasero 已提交
691
			this.storageService.store('hasNotifiedOfSettingsAutosave', true, StorageScope.GLOBAL);
692 693
			this.notificationService.info(localize('settingsNoSaveNeeded', "Your changes are automatically saved as you edit."));
		}
J
Jackson Kearl 已提交
694 695
	}

696
	private onDidChangeSetting(key: string, value: any, type: SettingValueType | SettingValueType[]): void {
B
Benjamin Pasero 已提交
697
		this.notifyNoSaveNeeded();
698

699 700
		if (this.pendingSettingUpdate && this.pendingSettingUpdate.key !== key) {
			this.updateChangedSetting(key, value);
701 702
		}

703
		this.pendingSettingUpdate = { key, value };
704 705 706 707 708
		if (SettingsEditor2.shouldSettingUpdateFast(type)) {
			this.settingFastUpdateDelayer.trigger(() => this.updateChangedSetting(key, value));
		} else {
			this.settingSlowUpdateDelayer.trigger(() => this.updateChangedSetting(key, value));
		}
709 710
	}

711
	private updateTreeScrollSync(): void {
R
Rob Lourens 已提交
712
		this.settingRenderers.cancelSuggesters();
713 714 715 716
		if (this.searchResultModel) {
			return;
		}

R
Rob Lourens 已提交
717
		if (!this.tocTreeModel) {
718 719
			return;
		}
720

721
		const elementToSync = this.settingsTree.firstVisibleElement;
722 723 724 725
		const element = elementToSync instanceof SettingsTreeSettingElement ? elementToSync.parent :
			elementToSync instanceof SettingsTreeGroupElement ? elementToSync :
				null;

R
Rob Lourens 已提交
726 727 728 729 730 731 732 733
		// It's possible for this to be called when the TOC and settings tree are out of sync - e.g. when the settings tree has deferred a refresh because
		// it is focused. So, bail if element doesn't exist in the TOC.
		let nodeExists = true;
		try { this.tocTree.getNode(element); } catch (e) { nodeExists = false; }
		if (!nodeExists) {
			return;
		}

734 735 736 737 738 739
		if (element && this.tocTree.getSelection()[0] !== element) {
			const ancestors = this.getAncestors(element);
			ancestors.forEach(e => this.tocTree.expand(<SettingsTreeGroupElement>e));

			this.tocTree.reveal(element);
			const elementTop = this.tocTree.getRelativeTop(element);
R
Rob Lourens 已提交
740 741 742 743
			if (typeof elementTop !== 'number') {
				return;
			}

744 745 746 747 748 749 750 751 752 753
			this.tocTree.collapseAll();

			ancestors.forEach(e => this.tocTree.expand(<SettingsTreeGroupElement>e));
			if (elementTop < 0 || elementTop > 1) {
				this.tocTree.reveal(element);
			} else {
				this.tocTree.reveal(element, elementTop);
			}

			this.tocTree.expand(element);
R
Rob Lourens 已提交
754

755
			this.tocTree.setSelection([element]);
756

757
			const fakeKeyboardEvent = new KeyboardEvent('keydown');
R
Rob Lourens 已提交
758
			(<IFocusEventFromScroll>fakeKeyboardEvent).fromScroll = true;
759 760 761
			this.tocTree.setFocus([element], fakeKeyboardEvent);
		}
	}
762

763 764 765 766 767 768 769 770 771 772
	private getAncestors(element: SettingsTreeElement): SettingsTreeElement[] {
		const ancestors: any[] = [];

		while (element.parent) {
			if (element.parent.id !== 'root') {
				ancestors.push(element.parent);
			}

			element = element.parent;
		}
773

774
		return ancestors.reverse();
775 776
	}

J
Johannes Rieken 已提交
777
	private updateChangedSetting(key: string, value: any): Promise<void> {
778 779
		// ConfigurationService displays the error if this fails.
		// Force a render afterwards because onDidConfigurationUpdate doesn't fire if the update doesn't result in an effective setting value change
R
Rob Lourens 已提交
780 781
		const settingsTarget = this.settingsTargetsWidget.settingsTarget;
		const resource = URI.isUri(settingsTarget) ? settingsTarget : undefined;
782
		const configurationTarget = <ConfigurationTarget>(resource ? ConfigurationTarget.WORKSPACE_FOLDER : settingsTarget);
R
Rob Lourens 已提交
783 784
		const overrides: IConfigurationOverrides = { resource };

785 786
		const isManualReset = value === undefined;

R
Rob Lourens 已提交
787 788 789 790 791 792 793
		// If the user is changing the value back to the default, do a 'reset' instead
		const inspected = this.configurationService.inspect(key, overrides);
		if (inspected.default === value) {
			value = undefined;
		}

		return this.configurationService.updateValue(key, value, overrides, configurationTarget)
794
			.then(() => {
795
				this.renderTree(key, isManualReset);
796 797 798 799 800
				const reportModifiedProps = {
					key,
					query: this.searchWidget.getValue(),
					searchResults: this.searchResultModel && this.searchResultModel.getUniqueResults(),
					rawResults: this.searchResultModel && this.searchResultModel.getRawResults(),
801
					showConfiguredOnly: !!this.viewState.tagFilters && this.viewState.tagFilters.has(MODIFIED_SETTING_TAG),
802 803 804 805 806 807
					isReset: typeof value === 'undefined',
					settingsTarget: this.settingsTargetsWidget.settingsTarget as SettingsTarget
				};

				return this.reportModifiedSetting(reportModifiedProps);
			});
808 809
	}

R
Rob Lourens 已提交
810
	private reportModifiedSetting(props: { key: string, query: string, searchResults: ISearchResult[] | null, rawResults: ISearchResult[] | null, showConfiguredOnly: boolean, isReset: boolean, settingsTarget: SettingsTarget }): void {
811
		this.pendingSettingUpdate = null;
812

R
Rob Lourens 已提交
813 814 815
		let groupId: string | undefined = undefined;
		let nlpIndex: number | undefined = undefined;
		let displayIndex: number | undefined = undefined;
816
		if (props.searchResults) {
R
Rob Lourens 已提交
817 818 819 820
			const remoteResult = props.searchResults[SearchResultIdx.Remote];
			const localResult = props.searchResults[SearchResultIdx.Local];

			const localIndex = arrays.firstIndex(localResult!.filterMatches, m => m.setting.key === props.key);
821 822 823 824 825 826 827 828
			groupId = localIndex >= 0 ?
				'local' :
				'remote';

			displayIndex = localIndex >= 0 ?
				localIndex :
				remoteResult && (arrays.firstIndex(remoteResult.filterMatches, m => m.setting.key === props.key) + localResult.filterMatches.length);

829 830 831 832 833 834
			if (this.searchResultModel) {
				const rawResults = this.searchResultModel.getRawResults();
				if (rawResults[SearchResultIdx.Remote]) {
					const _nlpIndex = arrays.firstIndex(rawResults[SearchResultIdx.Remote].filterMatches, m => m.setting.key === props.key);
					nlpIndex = _nlpIndex >= 0 ? _nlpIndex : undefined;
				}
835 836 837
			}
		}

R
Rob Lourens 已提交
838 839 840 841
		const reportedTarget = props.settingsTarget === ConfigurationTarget.USER_LOCAL ? 'user' :
			props.settingsTarget === ConfigurationTarget.USER_REMOTE ? 'user_remote' :
				props.settingsTarget === ConfigurationTarget.WORKSPACE ? 'workspace' :
					'folder';
842 843 844 845 846 847 848 849 850 851 852 853 854

		const data = {
			key: props.key,
			query: props.query,
			groupId,
			nlpIndex,
			displayIndex,
			showConfiguredOnly: props.showConfiguredOnly,
			isReset: props.isReset,
			target: reportedTarget
		};

		/* __GDPR__
855
			"settingsEditor.settingModified" : {
856 857 858 859 860 861 862 863 864 865
				"key" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"query" : { "classification": "CustomerContent", "purpose": "FeatureInsight" },
				"groupId" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"nlpIndex" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"displayIndex" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"showConfiguredOnly" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"isReset" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"target" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
			}
		*/
866
		this.telemetryService.publicLog('settingsEditor.settingModified', data);
R
Rob Lourens 已提交
867 868
	}

J
Johannes Rieken 已提交
869
	private render(token: CancellationToken): Promise<any> {
R
Rob Lourens 已提交
870 871
		if (this.input) {
			return this.input.resolve()
872
				.then((model: Settings2EditorModel) => {
873
					if (token.isCancellationRequested) {
R
Rob Lourens 已提交
874
						return undefined;
875 876
					}

877
					this._register(model.onDidChangeGroups(() => {
878 879 880
						this.updatedConfigSchemaDelayer.trigger(() => {
							this.onConfigUpdate(undefined, undefined, true);
						});
881
					}));
882
					this.defaultSettingsEditorModel = model;
883
					return this.onConfigUpdate(undefined, true);
884
				});
R
Rob Lourens 已提交
885
		}
R
Rob Lourens 已提交
886
		return Promise.resolve(null);
R
Rob Lourens 已提交
887 888
	}

889
	private onSearchModeToggled(): void {
890
		DOM.removeClass(this.rootElement, 'no-toc-search');
891
		if (this.configurationService.getValue('workbench.settings.settingsSearchTocBehavior') === 'hide') {
892
			DOM.toggleClass(this.rootElement, 'no-toc-search', !!this.searchResultModel);
893
		}
894 895
	}

896 897
	private scheduleRefresh(element: HTMLElement, key = ''): void {
		if (key && this.scheduledRefreshes.has(key)) {
898 899 900
			return;
		}

901 902 903 904 905 906 907 908 909 910 911
		if (!key) {
			this.scheduledRefreshes.forEach(r => r.dispose());
			this.scheduledRefreshes.clear();
		}

		const scheduledRefreshTracker = DOM.trackFocus(element);
		this.scheduledRefreshes.set(key, scheduledRefreshTracker);
		scheduledRefreshTracker.onDidBlur(() => {
			scheduledRefreshTracker.dispose();
			this.scheduledRefreshes.delete(key);
			this.onConfigUpdate([key]);
912 913 914
		});
	}

915
	private async onConfigUpdate(keys?: string[], forceRefresh = false, schemaChange = false): Promise<void> {
916
		if (keys && this.settingsTreeModel) {
917 918 919
			return this.updateElementsByKey(keys);
		}

920
		const groups = this.defaultSettingsEditorModel.settingsGroups.slice(1); // Without commonlyUsed
921
		const dividedGroups = collections.groupBy(groups, g => g.contributedByExtension ? 'extension' : 'core');
922 923 924 925 926
		const settingsResult = resolveSettingsTree(tocData, dividedGroups.core);
		const resolvedSettingsRoot = settingsResult.tree;

		// Warn for settings not included in layout
		if (settingsResult.leftoverSettings.size && !this.hasWarnedMissingSettings) {
M
Matt Bierner 已提交
927
			const settingKeyList: string[] = [];
928 929 930 931 932 933 934 935
			settingsResult.leftoverSettings.forEach(s => {
				settingKeyList.push(s.key);
			});

			this.logService.warn(`SettingsEditor2: Settings not included in settingsLayout.ts: ${settingKeyList.join(', ')}`);
			this.hasWarnedMissingSettings = true;
		}

936
		const commonlyUsed = resolveSettingsTree(commonlyUsedData, dividedGroups.core);
R
Rob Lourens 已提交
937
		resolvedSettingsRoot.children!.unshift(commonlyUsed.tree);
938

R
Rob Lourens 已提交
939
		resolvedSettingsRoot.children!.push(resolveExtensionsSettings(dividedGroups.extension || []));
940

941 942 943 944
		if (this.searchResultModel) {
			this.searchResultModel.updateChildren();
		}

945 946
		if (this.settingsTreeModel) {
			this.settingsTreeModel.update(resolvedSettingsRoot);
947

948 949 950
			if (schemaChange && !!this.searchResultModel) {
				// If an extension's settings were just loaded and a search is active, retrigger the search so it shows up
				return await this.onSearchInputChanged();
951
			}
952 953

			this.refreshTOCTree();
954
			this.renderTree(undefined, forceRefresh);
955
		} else {
956 957
			this.settingsTreeModel = this.instantiationService.createInstance(SettingsTreeModel, this.viewState);
			this.settingsTreeModel.update(resolvedSettingsRoot);
958
			this.tocTreeModel.settingsTreeRoot = this.settingsTreeModel.root as SettingsTreeGroupElement;
959

960 961 962 963 964 965 966 967
			const cachedState = this.restoreCachedState();
			if (cachedState && cachedState.searchQuery) {
				await this.onSearchInputChanged();
			} else {
				this.refreshTOCTree();
				this.refreshTree();
				this.tocTree.collapseAll();
			}
968 969 970
		}
	}

U
Ubuntu 已提交
971
	private updateElementsByKey(keys: string[]): void {
972 973
		if (keys.length) {
			if (this.searchResultModel) {
R
Rob Lourens 已提交
974
				keys.forEach(key => this.searchResultModel!.updateElementsByName(key));
975 976 977 978 979 980
			}

			if (this.settingsTreeModel) {
				keys.forEach(key => this.settingsTreeModel.updateElementsByName(key));
			}

U
Ubuntu 已提交
981
			keys.forEach(key => this.renderTree(key));
982 983 984 985 986
		} else {
			return this.renderTree();
		}
	}

987 988 989 990 991 992
	private getActiveElementInSettingsTree(): HTMLElement | null {
		return (document.activeElement && DOM.isAncestor(document.activeElement, this.settingsTree.getHTMLElement())) ?
			<HTMLElement>document.activeElement :
			null;
	}

U
Ubuntu 已提交
993
	private renderTree(key?: string, force = false): void {
994
		if (!force && key && this.scheduledRefreshes.has(key)) {
995
			this.updateModifiedLabelForKey(key);
U
Ubuntu 已提交
996
			return;
997 998
		}

999 1000
		// If the context view is focused, delay rendering settings
		if (this.contextViewFocused()) {
M
Matt Bierner 已提交
1001 1002 1003 1004
			const element = document.querySelector('.context-view');
			if (element) {
				this.scheduleRefresh(element as HTMLElement, key);
			}
U
Ubuntu 已提交
1005
			return;
1006 1007
		}

1008
		// If a setting control is currently focused, schedule a refresh for later
R
Rob Lourens 已提交
1009 1010
		const activeElement = this.getActiveElementInSettingsTree();
		const focusedSetting = activeElement && this.settingRenderers.getSettingDOMElementForDOMElement(activeElement);
1011
		if (focusedSetting && !force) {
1012 1013
			// If a single setting is being refreshed, it's ok to refresh now if that is not the focused setting
			if (key) {
R
Rob Lourens 已提交
1014
				const focusedKey = focusedSetting.getAttribute(AbstractSettingRenderer.SETTING_KEY_ATTR);
P
Pine Wu 已提交
1015
				if (focusedKey === key &&
P
Pine Wu 已提交
1016 1017 1018
					// update `list`s live, as they have a separate "submit edit" step built in before this
					(focusedSetting.parentElement && !DOM.hasClass(focusedSetting.parentElement, 'setting-item-list'))
				) {
1019

1020
					this.updateModifiedLabelForKey(key);
1021
					this.scheduleRefresh(focusedSetting, key);
U
Ubuntu 已提交
1022
					return;
1023 1024
				}
			} else {
1025
				this.scheduleRefresh(focusedSetting);
U
Ubuntu 已提交
1026
				return;
1027
			}
1028
		}
R
Rob Lourens 已提交
1029

R
Rob Lourens 已提交
1030 1031
		this.renderResultCountMessages();

1032
		if (key) {
1033
			const elements = this.currentSettingsModel.getElementsByName(key);
1034
			if (elements && elements.length) {
1035
				// TODO https://github.com/Microsoft/vscode/issues/57360
R
Rob Lourens 已提交
1036
				this.refreshTree();
1037 1038
			} else {
				// Refresh requested for a key that we don't know about
U
Ubuntu 已提交
1039
				return;
1040
			}
1041
		} else {
R
Rob Lourens 已提交
1042
			this.refreshTree();
1043 1044
		}

U
Ubuntu 已提交
1045
		return;
R
Rob Lourens 已提交
1046 1047
	}

1048 1049 1050 1051
	private contextViewFocused(): boolean {
		return !!DOM.findParentWithClass(<HTMLElement>document.activeElement, 'context-view');
	}

R
Rob Lourens 已提交
1052
	private refreshTree(): void {
1053 1054 1055
		if (this.isVisible()) {
			this.settingsTree.setChildren(null, createGroupIterator(this.currentSettingsModel.root));
		}
1056 1057
	}

R
Rob Lourens 已提交
1058
	private refreshTOCTree(): void {
1059
		if (this.isVisible()) {
R
Rob Lourens 已提交
1060
			this.tocTreeModel.update();
1061 1062
			this.tocTree.setChildren(null, createTOCIterator(this.tocTreeModel, this.tocTree));
		}
R
Rob Lourens 已提交
1063 1064
	}

1065
	private updateModifiedLabelForKey(key: string): void {
1066
		const dataElements = this.currentSettingsModel.getElementsByName(key);
1067
		const isModified = dataElements && dataElements[0] && dataElements[0].isConfigured; // all elements are either configured or not
R
Rob Lourens 已提交
1068
		const elements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), key);
1069
		if (elements && elements[0]) {
R
Rob Lourens 已提交
1070
			DOM.toggleClass(elements[0], 'is-configured', !!isModified);
1071 1072 1073
		}
	}

1074
	private async onSearchInputChanged(): Promise<void> {
R
Rob Lourens 已提交
1075 1076
		const query = this.searchWidget.getValue().trim();
		this.delayedFilterLogging.cancel();
1077 1078 1079 1080 1081
		await this.triggerSearch(query.replace(/›/g, ' '));

		if (query && this.searchResultModel) {
			this.delayedFilterLogging.trigger(() => this.reportFilteringUsed(query, this.searchResultModel!.getUniqueResults()));
		}
R
Rob Lourens 已提交
1082 1083
	}

R
Rob Lourens 已提交
1084
	private parseSettingFromJSON(query: string): string | null {
1085 1086 1087 1088
		const match = query.match(/"([a-zA-Z.]+)": /);
		return match && match[1];
	}

J
Johannes Rieken 已提交
1089
	private triggerSearch(query: string): Promise<void> {
1090
		this.viewState.tagFilters = new Set<string>();
P
Peng Lyu 已提交
1091
		this.viewState.extensionFilters = new Set<string>();
1092
		if (query) {
1093
			const parsedQuery = parseQuery(query);
R
Rob Lourens 已提交
1094
			query = parsedQuery.query;
R
Rob Lourens 已提交
1095
			parsedQuery.tags.forEach(tag => this.viewState.tagFilters!.add(tag));
P
Peng Lyu 已提交
1096
			parsedQuery.extensionFilters.forEach(extensionId => this.viewState.extensionFilters!.add(extensionId));
1097
		}
1098 1099

		if (query && query !== '@') {
1100
			query = this.parseSettingFromJSON(query) || query;
1101
			return this.triggerFilterPreferences(query);
R
Rob Lourens 已提交
1102
		} else {
P
Peng Lyu 已提交
1103
			if ((this.viewState.tagFilters && this.viewState.tagFilters.size) || (this.viewState.extensionFilters && this.viewState.extensionFilters.size)) {
1104 1105 1106 1107 1108
				this.searchResultModel = this.createFilterModel();
			} else {
				this.searchResultModel = null;
			}

R
Rob Lourens 已提交
1109 1110
			this.localSearchDelayer.cancel();
			this.remoteSearchThrottle.cancel();
1111 1112 1113 1114
			if (this.searchInProgress) {
				this.searchInProgress.cancel();
				this.searchInProgress.dispose();
				this.searchInProgress = null;
R
Rob Lourens 已提交
1115
			}
R
Rob Lourens 已提交
1116

1117
			this.tocTree.setFocus([]);
R
Rob Lourens 已提交
1118
			this.viewState.filterToCategory = undefined;
1119
			this.tocTreeModel.currentSearchModel = this.searchResultModel;
1120
			this.onSearchModeToggled();
1121 1122

			if (this.searchResultModel) {
1123 1124
				// Added a filter model
				this.tocTree.setSelection([]);
R
Rob Lourens 已提交
1125
				this.tocTree.expandAll();
1126
				this.refreshTOCTree();
R
Rob Lourens 已提交
1127
				this.renderResultCountMessages();
R
Rob Lourens 已提交
1128
				this.refreshTree();
1129
			} else {
1130
				// Leaving search mode
R
Rob Lourens 已提交
1131
				this.tocTree.collapseAll();
1132
				this.refreshTOCTree();
R
Rob Lourens 已提交
1133
				this.renderResultCountMessages();
R
Rob Lourens 已提交
1134
				this.refreshTree();
1135
			}
R
Rob Lourens 已提交
1136
		}
R
Rob Lourens 已提交
1137

R
Rob Lourens 已提交
1138
		return Promise.resolve();
R
Rob Lourens 已提交
1139 1140
	}

1141 1142 1143 1144 1145 1146 1147 1148 1149
	/**
	 * Return a fake SearchResultModel which can hold a flat list of all settings, to be filtered (@modified etc)
	 */
	private createFilterModel(): SearchResultModel {
		const filterModel = this.instantiationService.createInstance(SearchResultModel, this.viewState);

		const fullResult: ISearchResult = {
			filterMatches: []
		};
R
Rob Lourens 已提交
1150 1151 1152
		for (const g of this.defaultSettingsEditorModel.settingsGroups.slice(1)) {
			for (const sect of g.sections) {
				for (const setting of sect.settings) {
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
					fullResult.filterMatches.push({ setting, matches: [], score: 0 });
				}
			}
		}

		filterModel.setResult(0, fullResult);

		return filterModel;
	}

1163 1164 1165 1166
	private reportFilteringUsed(query: string, results: ISearchResult[]): void {
		const nlpResult = results[SearchResultIdx.Remote];
		const nlpMetadata = nlpResult && nlpResult.metadata;

1167 1168 1169
		const durations = {
			nlpResult: nlpMetadata && nlpMetadata.duration
		};
1170 1171

		// Count unique results
1172
		const counts: { nlpResult?: number, filterResult?: number } = {};
1173
		const filterResult = results[SearchResultIdx.Local];
1174 1175 1176 1177
		if (filterResult) {
			counts['filterResult'] = filterResult.filterMatches.length;
		}

1178 1179
		if (nlpResult) {
			counts['nlpResult'] = nlpResult.filterMatches.length;
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
		}

		const requestCount = nlpMetadata && nlpMetadata.requestCount;

		const data = {
			query,
			durations,
			counts,
			requestCount
		};

		/* __GDPR__
			"settingsEditor.filter" : {
				"query": { "classification": "CustomerContent", "purpose": "FeatureInsight" },
				"durations.nlpResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"counts.nlpResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"counts.filterResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"requestCount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true }
			}
		*/
1200
		this.telemetryService.publicLog('settingsEditor.filter', data);
1201 1202
	}

J
Johannes Rieken 已提交
1203
	private triggerFilterPreferences(query: string): Promise<void> {
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
		if (this.searchInProgress) {
			this.searchInProgress.cancel();
			this.searchInProgress = null;
		}

		// Trigger the local search. If it didn't find an exact match, trigger the remote search.
		const searchInProgress = this.searchInProgress = new CancellationTokenSource();
		return this.localSearchDelayer.trigger(() => {
			if (searchInProgress && !searchInProgress.token.isCancellationRequested) {
				return this.localFilterPreferences(query).then(result => {
1214
					if (result && !result.exactMatch) {
1215 1216
						this.remoteSearchThrottle.trigger(() => {
							return searchInProgress && !searchInProgress.token.isCancellationRequested ?
R
Rob Lourens 已提交
1217 1218
								this.remoteSearchPreferences(query, this.searchInProgress!.token) :
								Promise.resolve();
1219 1220
						});
					}
1221
				});
1222
			} else {
R
Rob Lourens 已提交
1223
				return Promise.resolve();
1224 1225 1226 1227
			}
		});
	}

R
Rob Lourens 已提交
1228
	private localFilterPreferences(query: string, token?: CancellationToken): Promise<ISearchResult | null> {
1229
		const localSearchProvider = this.preferencesSearchService.getLocalSearchProvider(query);
1230
		return this.filterOrSearchPreferences(query, SearchResultIdx.Local, localSearchProvider, token);
R
Rob Lourens 已提交
1231 1232
	}

J
Johannes Rieken 已提交
1233
	private remoteSearchPreferences(query: string, token?: CancellationToken): Promise<void> {
1234
		const remoteSearchProvider = this.preferencesSearchService.getRemoteSearchProvider(query);
1235 1236
		const newExtSearchProvider = this.preferencesSearchService.getRemoteSearchProvider(query, true);

R
Rob Lourens 已提交
1237
		return Promise.all([
1238 1239
			this.filterOrSearchPreferences(query, SearchResultIdx.Remote, remoteSearchProvider, token),
			this.filterOrSearchPreferences(query, SearchResultIdx.NewExtensions, newExtSearchProvider, token)
R
Rob Lourens 已提交
1240
		]).then(() => { });
R
Rob Lourens 已提交
1241 1242
	}

R
Rob Lourens 已提交
1243
	private filterOrSearchPreferences(query: string, type: SearchResultIdx, searchProvider?: ISearchProvider, token?: CancellationToken): Promise<ISearchResult | null> {
1244 1245 1246 1247 1248
		return this._filterOrSearchPreferencesModel(query, this.defaultSettingsEditorModel, searchProvider, token).then(result => {
			if (token && token.isCancellationRequested) {
				// Handle cancellation like this because cancellation is lost inside the search provider due to async/await
				return null;
			}
1249

1250 1251 1252 1253
			if (!this.searchResultModel) {
				this.searchResultModel = this.instantiationService.createInstance(SearchResultModel, this.viewState);
				this.searchResultModel.setResult(type, result);
				this.tocTreeModel.currentSearchModel = this.searchResultModel;
1254
				this.onSearchModeToggled();
1255 1256
			} else {
				this.searchResultModel.setResult(type, result);
1257
				this.tocTreeModel.update();
1258
			}
R
Rob Lourens 已提交
1259

1260
			this.tocTree.setFocus([]);
R
Rob Lourens 已提交
1261
			this.viewState.filterToCategory = undefined;
R
Rob Lourens 已提交
1262
			this.tocTree.expandAll();
1263

1264
			this.refreshTOCTree();
1265
			this.renderTree(undefined, true);
U
Ubuntu 已提交
1266
			return result;
R
Rob Lourens 已提交
1267 1268 1269
		});
	}

1270
	private renderResultCountMessages() {
1271
		if (!this.currentSettingsModel) {
1272 1273 1274
			return;
		}

R
Rob Lourens 已提交
1275 1276 1277 1278
		this.clearFilterLinkContainer.style.display = this.viewState.tagFilters && this.viewState.tagFilters.size > 0
			? 'initial'
			: 'none';

1279
		if (!this.searchResultModel) {
1280 1281 1282 1283 1284
			if (this.countElement.style.display !== 'none') {
				this.countElement.style.display = 'none';
				this.layout(this.dimension);
			}

R
Rob Lourens 已提交
1285 1286
			DOM.removeClass(this.rootElement, 'no-results');
			return;
1287 1288
		}

1289 1290 1291 1292 1293 1294 1295
		if (this.tocTreeModel && this.tocTreeModel.settingsTreeRoot) {
			const count = this.tocTreeModel.settingsTreeRoot.count;
			switch (count) {
				case 0: this.countElement.innerText = localize('noResults', "No Settings Found"); break;
				case 1: this.countElement.innerText = localize('oneResult', "1 Setting Found"); break;
				default: this.countElement.innerText = localize('moreThanOneResult', "{0} Settings Found", count);
			}
1296

1297 1298 1299 1300
			if (this.countElement.style.display !== 'block') {
				this.countElement.style.display = 'block';
				this.layout(this.dimension);
			}
R
Rob Lourens 已提交
1301
			DOM.toggleClass(this.rootElement, 'no-results', count === 0);
1302
		}
1303 1304
	}

R
Rob Lourens 已提交
1305
	private _filterOrSearchPreferencesModel(filter: string, model: ISettingsEditorModel, provider?: ISearchProvider, token?: CancellationToken): Promise<ISearchResult | null> {
R
Rob Lourens 已提交
1306
		const searchP = provider ? provider.searchModel(model, token) : Promise.resolve(null);
R
Rob Lourens 已提交
1307 1308 1309
		return searchP
			.then<ISearchResult>(null, err => {
				if (isPromiseCanceledError(err)) {
R
Rob Lourens 已提交
1310
					return Promise.reject(err);
R
Rob Lourens 已提交
1311 1312
				} else {
					/* __GDPR__
1313
						"settingsEditor.searchError" : {
R
Rob Lourens 已提交
1314 1315 1316 1317 1318 1319 1320
							"message": { "classification": "CallstackOrException", "purpose": "FeatureInsight" },
							"filter": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
						}
					*/
					const message = getErrorMessage(err).trim();
					if (message && message !== 'Error') {
						// "Error" = any generic network error
1321
						this.telemetryService.publicLog('settingsEditor.searchError', { message, filter });
R
Rob Lourens 已提交
1322 1323
						this.logService.info('Setting search error: ' + message);
					}
R
Rob Lourens 已提交
1324
					return Promise.resolve(null);
R
Rob Lourens 已提交
1325 1326 1327 1328
				}
			});
	}

1329
	private layoutTrees(dimension: DOM.Dimension): void {
1330
		const listHeight = dimension.height - (76 + 11 /* header height + padding*/);
1331 1332
		const settingsTreeHeight = listHeight - 14;
		this.settingsTreeContainer.style.height = `${settingsTreeHeight}px`;
1333
		this.settingsTree.layout(settingsTreeHeight, dimension.width);
1334

1335 1336
		const tocTreeHeight = listHeight - 16;
		this.tocTreeContainer.style.height = `${tocTreeHeight}px`;
R
Rob Lourens 已提交
1337
		this.tocTree.layout(tocTreeHeight);
1338
	}
1339

B
Benjamin Pasero 已提交
1340
	protected saveState(): void {
1341 1342 1343
		if (this.isVisible()) {
			const searchQuery = this.searchWidget.getValue().trim();
			const target = this.settingsTargetsWidget.settingsTarget as SettingsTarget;
R
Rob Lourens 已提交
1344 1345 1346
			if (this.group && this.input) {
				this.editorMemento.saveEditorState(this.group, this.input, { searchQuery, target });
			}
1347
		}
B
Benjamin Pasero 已提交
1348 1349

		super.saveState();
1350
	}
R
Rob Lourens 已提交
1351
}
1352

1353 1354 1355 1356
interface ISettingsEditor2State {
	searchQuery: string;
	target: SettingsTarget;
}