settingsEditor2.ts 48.4 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 } 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 } 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';
R
Rob Lourens 已提交
44

R
Rob Lourens 已提交
45 46 47 48 49 50 51 52 53 54 55 56 57
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
		};
	});
}

58 59
const $ = DOM.$;

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

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

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

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

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

87
	private defaultSettingsEditorModel: Settings2EditorModel;
R
Rob Lourens 已提交
88

89
	private rootElement: HTMLElement;
R
Rob Lourens 已提交
90
	private headerContainer: HTMLElement;
91
	private searchWidget: SuggestEnabledInput;
92
	private countElement: HTMLElement;
R
Rob Lourens 已提交
93 94
	private settingsTargetsWidget: SettingsTargetsWidget;

95
	private settingsTreeContainer: HTMLElement;
R
Rob Lourens 已提交
96 97
	private settingsTree: SettingsTree;
	private settingRenderers: SettingTreeRenderers;
98
	private tocTreeModel: TOCTreeModel;
99
	private settingsTreeModel: SettingsTreeModel;
100
	private noResultsMessage: HTMLElement;
101
	private clearFilterLinkContainer: HTMLElement;
R
Rob Lourens 已提交
102

R
Rob Lourens 已提交
103
	private tocTreeContainer: HTMLElement;
R
Rob Lourens 已提交
104
	private tocTree: TOCTree;
R
Rob Lourens 已提交
105

106 107
	private settingsAriaExtraLabelsContainer: HTMLElement;

R
Rob Lourens 已提交
108 109 110
	private delayedFilterLogging: Delayer<void>;
	private localSearchDelayer: Delayer<void>;
	private remoteSearchThrottle: ThrottledDelayer<void>;
R
Rob Lourens 已提交
111
	private searchInProgress: CancellationTokenSource | null;
112

113 114
	private settingFastUpdateDelayer: Delayer<void>;
	private settingSlowUpdateDelayer: Delayer<void>;
R
Rob Lourens 已提交
115
	private pendingSettingUpdate: { key: string, value: any } | null;
R
Rob Lourens 已提交
116

117
	private readonly viewState: ISettingsEditorViewState;
R
Rob Lourens 已提交
118
	private _searchResultModel: SearchResultModel | null;
119

120
	private tocRowFocused: IContextKey<boolean>;
121 122
	private inSettingsEditorContextKey: IContextKey<boolean>;
	private searchFocusContextKey: IContextKey<boolean>;
123

124
	private scheduledRefreshes: Map<string, DOM.IFocusTracker>;
R
Rob Lourens 已提交
125
	private lastFocusedSettingElement: string;
126

127 128 129
	/** Don't spam warnings */
	private hasWarnedMissingSettings: boolean;

130 131
	private editorMemento: IEditorMemento<ISettingsEditor2State>;

R
Rob Lourens 已提交
132
	private tocFocusedElement: SettingsTreeGroupElement | null;
133 134
	private settingsTreeScrollTop = 0;

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

155 156
		this.settingFastUpdateDelayer = new Delayer<void>(SettingsEditor2.SETTING_UPDATE_FAST_DEBOUNCE);
		this.settingSlowUpdateDelayer = new Delayer<void>(SettingsEditor2.SETTING_UPDATE_SLOW_DEBOUNCE);
157

158 159
		this.inSettingsEditorContextKey = CONTEXT_SETTINGS_EDITOR.bindTo(contextKeyService);
		this.searchFocusContextKey = CONTEXT_SETTINGS_SEARCH_FOCUS.bindTo(contextKeyService);
160
		this.tocRowFocused = CONTEXT_TOC_ROW_FOCUS.bindTo(contextKeyService);
161

162 163
		this.scheduledRefreshes = new Map<string, DOM.IFocusTracker>();

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

166
		this._register(configurationService.onDidChangeConfiguration(e => {
167 168 169
			if (e.source !== ConfigurationTarget.DEFAULT) {
				this.onConfigUpdate(e.affectedKeys);
			}
170
		}));
R
Rob Lourens 已提交
171 172
	}

173 174 175 176 177 178 179
	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 已提交
180 181 182 183
	private get currentSettingsModel() {
		return this.searchResultModel || this.settingsTreeModel;
	}

R
Rob Lourens 已提交
184
	private get searchResultModel(): SearchResultModel | null {
185 186 187
		return this._searchResultModel;
	}

R
Rob Lourens 已提交
188
	private set searchResultModel(value: SearchResultModel | null) {
189 190 191 192 193
		this._searchResultModel = value;

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

R
Rob Lourens 已提交
194 195 196
	private get currentSettingsContextMenuKeyBindingLabel(): string {
		const keybinding = this.keybindingService.lookupKeybinding(SETTINGS_EDITOR_COMMAND_SHOW_CONTEXT_MENU);
		return (keybinding && keybinding.getAriaLabel()) || '';
197 198
	}

R
Rob Lourens 已提交
199
	createEditor(parent: HTMLElement): void {
200
		parent.setAttribute('tabindex', '-1');
201
		this.rootElement = DOM.append(parent, $('.settings-editor'));
R
Rob Lourens 已提交
202

203 204
		this.createHeader(this.rootElement);
		this.createBody(this.rootElement);
205
		this.updateStyles();
R
Rob Lourens 已提交
206 207
	}

R
Rob Lourens 已提交
208
	setInput(input: SettingsEditor2Input, options: SettingsEditorOptions | null, token: CancellationToken): Promise<void> {
209
		this.inSettingsEditorContextKey.set(true);
210
		return super.setInput(input, options, token)
211
			.then(() => timeout(0)) // Force setInput to be async
R
Rob Lourens 已提交
212 213 214
			.then(() => {
				return this.render(token);
			})
R
Rob Lourens 已提交
215
			.then(() => {
R
Rob Lourens 已提交
216 217
				options = options || SettingsEditorOptions.create({});

R
Rob Lourens 已提交
218
				if (!this.viewState.settingsTarget) {
R
Rob Lourens 已提交
219
					if (!options.target) {
R
Rob Lourens 已提交
220
						options.target = ConfigurationTarget.USER_LOCAL;
221
					}
222
				}
R
Rob Lourens 已提交
223

224
				this._setOptions(options);
225

R
Rob Lourens 已提交
226 227 228 229
				this._register(input.onDispose(() => {
					this.searchWidget.setValue('');
				}));

230 231
				// Init TOC selection
				this.updateTreeScrollSync();
232 233

				this.restoreCachedState();
R
Rob Lourens 已提交
234
			});
R
Rob Lourens 已提交
235 236
	}

237
	private restoreCachedState(): void {
R
Rob Lourens 已提交
238
		const cachedState = this.group && this.input && this.editorMemento.loadEditorState(this.group, this.input);
239
		if (cachedState && typeof cachedState.target === 'object') {
240 241 242 243 244 245 246 247 248 249 250
			cachedState.target = URI.revive(cachedState.target);
		}

		if (cachedState) {
			const settingsTarget = cachedState.target;
			this.settingsTargetsWidget.settingsTarget = settingsTarget;
			this.onDidSettingsTargetChange(settingsTarget);
			this.searchWidget.setValue(cachedState.searchQuery);
		}
	}

R
Rob Lourens 已提交
251
	setOptions(options: SettingsEditorOptions | null): void {
252 253
		super.setOptions(options);

R
Rob Lourens 已提交
254 255 256
		if (options) {
			this._setOptions(options);
		}
257
	}
258

259
	private _setOptions(options: SettingsEditorOptions): void {
260 261 262 263
		if (options.query) {
			this.searchWidget.setValue(options.query);
		}

264
		const target: SettingsTarget = options.folderUri || <SettingsTarget>options.target;
R
Rob Lourens 已提交
265 266 267 268
		if (target) {
			this.settingsTargetsWidget.settingsTarget = target;
			this.viewState.settingsTarget = target;
		}
269 270
	}

271 272
	clearInput(): void {
		this.inSettingsEditorContextKey.set(false);
R
Rob Lourens 已提交
273 274 275 276
		if (this.input) {
			this.editorMemento.clearEditorState(this.input, this.group);
		}

277 278 279
		super.clearInput();
	}

R
Rob Lourens 已提交
280
	layout(dimension: DOM.Dimension): void {
281 282
		this.layoutTrees(dimension);

R
Rob Lourens 已提交
283 284
		const innerWidth = dimension.width - 24 * 2; // 24px padding on left and right
		const monacoWidth = (innerWidth > 1000 ? 1000 : innerWidth) - 10;
285 286
		this.searchWidget.layout({ height: 20, width: monacoWidth });

287 288
		DOM.toggleClass(this.rootElement, 'mid-width', dimension.width < 1000 && dimension.width >= 600);
		DOM.toggleClass(this.rootElement, 'narrow-width', dimension.width < 600);
R
Rob Lourens 已提交
289 290 291
	}

	focus(): void {
R
Rob Lourens 已提交
292
		if (this.lastFocusedSettingElement) {
R
Rob Lourens 已提交
293
			const elements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), this.lastFocusedSettingElement);
R
Rob Lourens 已提交
294
			if (elements.length) {
R
Rob Lourens 已提交
295
				const control = elements[0].querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
R
Rob Lourens 已提交
296 297 298 299 300 301 302
				if (control) {
					(<HTMLElement>control).focus();
					return;
				}
			}
		}

303 304 305
		this.focusSearch();
	}

306
	focusSettings(): void {
307 308 309 310 311
		// Update ARIA global labels
		const labelElement = this.settingsAriaExtraLabelsContainer.querySelector('#settings_aria_more_actions_shortcut_label');
		if (labelElement) {
			const settingsContextMenuShortcut = this.currentSettingsContextMenuKeyBindingLabel;
			if (settingsContextMenuShortcut) {
312
				labelElement.setAttribute('aria-label', localize('settingsContextMenuAriaShortcut', "For more actions, Press {0}.", settingsContextMenuShortcut));
313 314 315
			}
		}

R
Rob Lourens 已提交
316
		const firstFocusable = this.settingsTree.getHTMLElement().querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
317 318
		if (firstFocusable) {
			(<HTMLElement>firstFocusable).focus();
319 320 321
		}
	}

322
	showContextMenu(): void {
R
Rob Lourens 已提交
323 324 325 326 327 328
		const activeElement = this.getActiveElementInSettingsTree();
		if (!activeElement) {
			return;
		}

		const settingDOMElement = this.settingRenderers.getSettingDOMElementForDOMElement(activeElement);
329 330 331 332
		if (!settingDOMElement) {
			return;
		}

R
Rob Lourens 已提交
333
		const focusedKey = this.settingRenderers.getKeyForDOMElementInSetting(settingDOMElement);
334 335 336 337 338 339
		if (!focusedKey) {
			return;
		}

		const elements = this.currentSettingsModel.getElementsByName(focusedKey);
		if (elements && elements[0]) {
R
Rob Lourens 已提交
340
			this.settingRenderers.showContextMenu(elements[0], settingDOMElement);
341 342 343
		}
	}

344
	focusSearch(filter?: string, selectAll = true): void {
345 346 347 348
		if (filter && this.searchWidget) {
			this.searchWidget.setValue(filter);
		}

349
		this.searchWidget.focus(selectAll);
R
Rob Lourens 已提交
350 351
	}

352
	clearSearchResults(): void {
353
		this.searchWidget.setValue('');
354 355
	}

356 357 358 359 360 361 362 363 364 365
	clearSearchFilters(): void {
		let query = this.searchWidget.getValue();

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

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

R
Rob Lourens 已提交
366 367 368 369
	private createHeader(parent: HTMLElement): void {
		this.headerContainer = DOM.append(parent, $('.settings-header'));

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

R
Rob Lourens 已提交
371
		const searchBoxLabel = localize('SearchSettings.AriaLabel', "Search settings");
372 373 374
		this.searchWidget = this._register(this.instantiationService.createInstance(SuggestEnabledInput, `${SettingsEditor2.ID}.searchbox`, searchContainer, {
			triggerCharacters: ['@'],
			provideResults: (query: string) => {
P
Peng Lyu 已提交
375
				return SettingsEditor2.SUGGESTIONS.filter(tag => query.indexOf(tag) === -1).map(tag => strings.endsWith(tag, ':') ? tag : tag + ' ');
376
			}
377
		}, searchBoxLabel, 'settingseditor:searchinput' + SettingsEditor2.NUM_INSTANCES++, {
378 379 380
				placeholderText: searchBoxLabel,
				focusContextKey: this.searchFocusContextKey,
				// TODO: Aria-live
J
Jeremy Shore 已提交
381 382
			})
		);
383

384 385 386 387
		this._register(this.searchWidget.onFocus(() => {
			this.lastFocusedSettingElement = '';
		}));

388 389 390 391
		this._register(attachSuggestEnabledInputBoxStyler(this.searchWidget, this.themeService, {
			inputBorder: settingsTextInputBorder
		}));

392 393 394 395
		this.countElement = DOM.append(searchContainer, DOM.$('.settings-count-widget'));
		this._register(attachStylerCallback(this.themeService, { badgeBackground, contrastBorder, badgeForeground }, colors => {
			const background = colors.badgeBackground ? colors.badgeBackground.toString() : null;
			const border = colors.contrastBorder ? colors.contrastBorder.toString() : null;
R
Rob Lourens 已提交
396
			const foreground = colors.badgeForeground ? colors.badgeForeground.toString() : null;
397 398

			this.countElement.style.backgroundColor = background;
R
Rob Lourens 已提交
399
			this.countElement.style.color = foreground;
400 401 402 403 404 405

			this.countElement.style.borderWidth = border ? '1px' : null;
			this.countElement.style.borderStyle = border ? 'solid' : null;
			this.countElement.style.borderColor = border;
		}));

406
		this._register(this.searchWidget.onInputDidChange(() => this.onSearchInputChanged()));
R
Rob Lourens 已提交
407

408
		const headerControlsContainer = DOM.append(this.headerContainer, $('.settings-header-controls'));
R
Rob Lourens 已提交
409
		const targetWidgetContainer = DOM.append(headerControlsContainer, $('.settings-target-container'));
R
Rob Lourens 已提交
410 411
		this.settingsTargetsWidget = this._register(this.instantiationService.createInstance(SettingsTargetsWidget, targetWidgetContainer, { enableRemoteSettings: true }));
		this.settingsTargetsWidget.settingsTarget = ConfigurationTarget.USER_LOCAL;
412
		this.settingsTargetsWidget.onDidTargetChange(target => this.onDidSettingsTargetChange(target));
R
Rob Lourens 已提交
413 414
	}

415 416 417
	private onDidSettingsTargetChange(target: SettingsTarget): void {
		this.viewState.settingsTarget = target;

418 419
		// TODO Instead of rebuilding the whole model, refresh and uncache the inspected setting value
		this.onConfigUpdate(undefined, true);
420 421
	}

422
	private onDidClickSetting(evt: ISettingLinkClickEvent, recursed?: boolean): void {
423
		const elements = this.currentSettingsModel.getElementsByName(evt.targetKey);
424
		if (elements && elements[0]) {
425
			let sourceTop = this.settingsTree.getRelativeTop(evt.source);
R
Rob Lourens 已提交
426 427 428 429
			if (typeof sourceTop !== 'number') {
				return;
			}

430 431
			if (sourceTop < 0) {
				// e.g. clicked a searched element, now the search has been cleared
432
				sourceTop = 0.5;
433 434
			}

435
			this.settingsTree.reveal(elements[0], sourceTop);
436

R
Rob Lourens 已提交
437
			const domElements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), evt.targetKey);
438
			if (domElements && domElements[0]) {
R
Rob Lourens 已提交
439
				const control = domElements[0].querySelector(AbstractSettingRenderer.CONTROL_SELECTOR);
440 441 442 443
				if (control) {
					(<HTMLElement>control).focus();
				}
			}
444 445 446 447 448 449
		} else if (!recursed) {
			const p = this.triggerSearch('');
			p.then(() => {
				this.searchWidget.setValue('');
				this.onDidClickSetting(evt, true);
			});
450 451 452
		}
	}

R
Rob Lourens 已提交
453
	switchToSettingsFile(): Promise<IEditor | null> {
454 455 456 457
		const query = parseQuery(this.searchWidget.getValue());
		return this.openSettingsFile(query.query);
	}

R
Rob Lourens 已提交
458
	private openSettingsFile(query?: string): Promise<IEditor | null> {
459 460
		const currentSettingsTarget = this.settingsTargetsWidget.settingsTarget;

461
		const options: ISettingsEditorOptions = { query };
R
Rob Lourens 已提交
462
		if (currentSettingsTarget === ConfigurationTarget.USER_LOCAL) {
463
			return this.preferencesService.openGlobalSettings(true, options);
R
Rob Lourens 已提交
464 465
		} else if (currentSettingsTarget === ConfigurationTarget.USER_REMOTE) {
			return this.preferencesService.openRemoteSettings();
466
		} else if (currentSettingsTarget === ConfigurationTarget.WORKSPACE) {
467
			return this.preferencesService.openWorkspaceSettings(true, options);
468
		} else {
469
			return this.preferencesService.openFolderSettings(currentSettingsTarget, true, options);
470
		}
R
Rob Lourens 已提交
471 472 473 474 475
	}

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

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

478
		this.noResultsMessage.innerText = localize('noResults', "No Settings Found");
479 480 481 482 483

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

		this.clearFilterLinkContainer.textContent = ' - ';
		const clearFilterLink = DOM.append(this.clearFilterLinkContainer, $('a.pointer.prominent', { tabindex: 0 }, localize('clearSearchFilters', 'Clear Filters')));
484
		this._register(DOM.addDisposableListener(clearFilterLink, DOM.EventType.CLICK, (e: MouseEvent) => {
485 486 487 488 489 490 491 492 493 494
			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')));
495
		this._register(DOM.addDisposableListener(clearSearch, DOM.EventType.CLICK, (e: MouseEvent) => {
496 497
			DOM.EventHelper.stop(e, false);
			this.clearSearchResults();
498
			this.focusSearch();
499 500 501 502
		}));

		DOM.append(this.noResultsMessage, clearSearchContainer);

503 504 505 506
		this._register(attachStylerCallback(this.themeService, { editorForeground }, colors => {
			this.noResultsMessage.style.color = colors.editorForeground ? colors.editorForeground.toString() : null;
		}));

R
Rob Lourens 已提交
507 508
		this.createTOC(bodyContainer);

509 510 511 512 513
		this.createFocusSink(
			bodyContainer,
			e => {
				if (DOM.findParentWithClass(e.relatedTarget, 'settings-editor-tree')) {
					if (this.settingsTree.scrollTop > 0) {
514
						const firstElement = this.settingsTree.firstVisibleElement;
515 516 517 518 519 520 521 522 523 524 525 526 527
						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 已提交
528

R
Rob Lourens 已提交
529
		this.createSettingsTree(bodyContainer);
R
Rob Lourens 已提交
530

531 532 533 534 535
		this.createFocusSink(
			bodyContainer,
			e => {
				if (DOM.findParentWithClass(e.relatedTarget, 'settings-editor-tree')) {
					if (this.settingsTree.scrollTop < this.settingsTree.scrollHeight) {
536
						const lastElement = this.settingsTree.lastVisibleElement;
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
						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;
	}
560

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

565 566
		this.tocTree = this._register(this.instantiationService.createInstance(TOCTree,
			DOM.append(this.tocTreeContainer, $('.settings-toc-wrapper')),
R
Rob Lourens 已提交
567
			this.viewState));
R
Rob Lourens 已提交
568

569
		this._register(this.tocTree.onDidChangeFocus(e => {
R
Rob Lourens 已提交
570
			const element: SettingsTreeGroupElement | null = e.elements[0];
R
Rob Lourens 已提交
571 572 573
			if (this.tocFocusedElement === element) {
				return;
			}
574

R
Rob Lourens 已提交
575 576 577 578
			this.tocFocusedElement = element;
			this.tocTree.setSelection(element ? [element] : []);
			if (this.searchResultModel) {
				if (this.viewState.filterToCategory !== element) {
579
					this.viewState.filterToCategory = withNullAsUndefined(element);
580 581
					this.renderTree();
					this.settingsTree.scrollTop = 0;
R
Rob Lourens 已提交
582
				}
R
Rob Lourens 已提交
583
			} else if (element && (!e.browserEvent || !(<IFocusEventFromScroll>e.browserEvent).fromScroll)) {
R
Rob Lourens 已提交
584 585
				this.settingsTree.reveal(element, 0);
			}
586 587 588 589 590 591 592 593
		}));

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

		this._register(this.tocTree.onDidBlur(() => {
			this.tocRowFocused.set(false);
R
Rob Lourens 已提交
594 595 596 597
		}));
	}

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

600 601 602 603 604 605 606 607
		// 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 已提交
608 609 610
		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 => {
611
			this.openSettingsFile(settingKey);
612
		}));
R
Rob Lourens 已提交
613 614
		this._register(this.settingRenderers.onDidClickSettingLink(settingName => this.onDidClickSetting(settingName)));
		this._register(this.settingRenderers.onDidFocusSetting(element => {
R
Rob Lourens 已提交
615
			this.lastFocusedSettingElement = element.setting.key;
616 617
			this.settingsTree.reveal(element);
		}));
R
Rob Lourens 已提交
618
		this._register(this.settingRenderers.onDidClickOverrideElement((element: ISettingOverrideClickEvent) => {
619
			if (element.scope.toLowerCase() === 'workspace') {
J
Jeremy Shore 已提交
620
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.WORKSPACE);
621
			} else if (element.scope.toLowerCase() === 'user') {
R
Rob Lourens 已提交
622
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.USER_LOCAL);
623
			} else if (element.scope.toLowerCase() === 'remote') {
R
Rob Lourens 已提交
624
				this.settingsTargetsWidget.updateTarget(ConfigurationTarget.USER_REMOTE);
J
Jeremy Shore 已提交
625 626 627 628
			}

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

630
		this.settingsTree = this._register(this.instantiationService.createInstance(SettingsTree,
631 632
			this.settingsTreeContainer,
			this.viewState,
R
Rob Lourens 已提交
633
			this.settingRenderers.allRenderers));
R
Rob Lourens 已提交
634
		this.settingsTree.getHTMLElement().attributes.removeNamedItem('tabindex');
635

636
		this._register(this.settingsTree.onDidScroll(() => {
637 638 639 640 641 642 643 644 645 646 647
			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);
648
		}));
649 650
	}

B
Benjamin Pasero 已提交
651 652
	private notifyNoSaveNeeded() {
		if (!this.storageService.getBoolean('hasNotifiedOfSettingsAutosave', StorageScope.GLOBAL, false)) {
B
Benjamin Pasero 已提交
653
			this.storageService.store('hasNotifiedOfSettingsAutosave', true, StorageScope.GLOBAL);
654 655
			this.notificationService.info(localize('settingsNoSaveNeeded', "Your changes are automatically saved as you edit."));
		}
J
Jackson Kearl 已提交
656 657
	}

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

661 662
		if (this.pendingSettingUpdate && this.pendingSettingUpdate.key !== key) {
			this.updateChangedSetting(key, value);
663 664
		}

665
		this.pendingSettingUpdate = { key, value };
666 667 668 669 670
		if (SettingsEditor2.shouldSettingUpdateFast(type)) {
			this.settingFastUpdateDelayer.trigger(() => this.updateChangedSetting(key, value));
		} else {
			this.settingSlowUpdateDelayer.trigger(() => this.updateChangedSetting(key, value));
		}
671 672
	}

673
	private updateTreeScrollSync(): void {
R
Rob Lourens 已提交
674
		this.settingRenderers.cancelSuggesters();
675 676 677 678
		if (this.searchResultModel) {
			return;
		}

R
Rob Lourens 已提交
679
		if (!this.tocTreeModel) {
680 681
			return;
		}
682

683
		const elementToSync = this.settingsTree.firstVisibleElement;
684 685 686 687
		const element = elementToSync instanceof SettingsTreeSettingElement ? elementToSync.parent :
			elementToSync instanceof SettingsTreeGroupElement ? elementToSync :
				null;

R
Rob Lourens 已提交
688 689 690 691 692 693 694 695
		// 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;
		}

696 697 698 699 700 701
		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 已提交
702 703 704 705
			if (typeof elementTop !== 'number') {
				return;
			}

706 707 708 709 710 711 712 713 714 715
			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 已提交
716

717
			this.tocTree.setSelection([element]);
718

719
			const fakeKeyboardEvent = new KeyboardEvent('keydown');
R
Rob Lourens 已提交
720
			(<IFocusEventFromScroll>fakeKeyboardEvent).fromScroll = true;
721 722 723
			this.tocTree.setFocus([element], fakeKeyboardEvent);
		}
	}
724

725 726 727 728 729 730 731 732 733 734
	private getAncestors(element: SettingsTreeElement): SettingsTreeElement[] {
		const ancestors: any[] = [];

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

			element = element.parent;
		}
735

736
		return ancestors.reverse();
737 738
	}

J
Johannes Rieken 已提交
739
	private updateChangedSetting(key: string, value: any): Promise<void> {
740 741
		// 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 已提交
742 743
		const settingsTarget = this.settingsTargetsWidget.settingsTarget;
		const resource = URI.isUri(settingsTarget) ? settingsTarget : undefined;
744
		const configurationTarget = <ConfigurationTarget>(resource ? ConfigurationTarget.WORKSPACE_FOLDER : settingsTarget);
R
Rob Lourens 已提交
745 746
		const overrides: IConfigurationOverrides = { resource };

747 748
		const isManualReset = value === undefined;

R
Rob Lourens 已提交
749 750 751 752 753 754 755
		// 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)
756
			.then(() => {
757
				this.renderTree(key, isManualReset);
758 759 760 761 762
				const reportModifiedProps = {
					key,
					query: this.searchWidget.getValue(),
					searchResults: this.searchResultModel && this.searchResultModel.getUniqueResults(),
					rawResults: this.searchResultModel && this.searchResultModel.getRawResults(),
763
					showConfiguredOnly: !!this.viewState.tagFilters && this.viewState.tagFilters.has(MODIFIED_SETTING_TAG),
764 765 766 767 768 769
					isReset: typeof value === 'undefined',
					settingsTarget: this.settingsTargetsWidget.settingsTarget as SettingsTarget
				};

				return this.reportModifiedSetting(reportModifiedProps);
			});
770 771
	}

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

R
Rob Lourens 已提交
775 776 777
		let groupId: string | undefined = undefined;
		let nlpIndex: number | undefined = undefined;
		let displayIndex: number | undefined = undefined;
778
		if (props.searchResults) {
R
Rob Lourens 已提交
779 780 781 782
			const remoteResult = props.searchResults[SearchResultIdx.Remote];
			const localResult = props.searchResults[SearchResultIdx.Local];

			const localIndex = arrays.firstIndex(localResult!.filterMatches, m => m.setting.key === props.key);
783 784 785 786 787 788 789 790
			groupId = localIndex >= 0 ?
				'local' :
				'remote';

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

791 792 793 794 795 796
			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;
				}
797 798 799
			}
		}

R
Rob Lourens 已提交
800 801 802 803
		const reportedTarget = props.settingsTarget === ConfigurationTarget.USER_LOCAL ? 'user' :
			props.settingsTarget === ConfigurationTarget.USER_REMOTE ? 'user_remote' :
				props.settingsTarget === ConfigurationTarget.WORKSPACE ? 'workspace' :
					'folder';
804 805 806 807 808 809 810 811 812 813 814 815 816

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

		/* __GDPR__
817
			"settingsEditor.settingModified" : {
818 819 820 821 822 823 824 825 826 827
				"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" }
			}
		*/
828
		this.telemetryService.publicLog('settingsEditor.settingModified', data);
R
Rob Lourens 已提交
829 830
	}

J
Johannes Rieken 已提交
831
	private render(token: CancellationToken): Promise<any> {
R
Rob Lourens 已提交
832 833
		if (this.input) {
			return this.input.resolve()
834
				.then((model: Settings2EditorModel) => {
835
					if (token.isCancellationRequested) {
R
Rob Lourens 已提交
836
						return undefined;
837 838
					}

839 840
					this._register(model.onDidChangeGroups(() => this.onConfigUpdate()));
					this.defaultSettingsEditorModel = model;
841
					return this.onConfigUpdate();
842
				});
R
Rob Lourens 已提交
843
		}
R
Rob Lourens 已提交
844
		return Promise.resolve(null);
R
Rob Lourens 已提交
845 846
	}

847
	private onSearchModeToggled(): void {
848
		DOM.removeClass(this.rootElement, 'no-toc-search');
849
		if (this.configurationService.getValue('workbench.settings.settingsSearchTocBehavior') === 'hide') {
850
			DOM.toggleClass(this.rootElement, 'no-toc-search', !!this.searchResultModel);
851
		}
852 853
	}

854 855
	private scheduleRefresh(element: HTMLElement, key = ''): void {
		if (key && this.scheduledRefreshes.has(key)) {
856 857 858
			return;
		}

859 860 861 862 863 864 865 866 867 868 869
		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]);
870 871 872
		});
	}

U
Ubuntu 已提交
873
	private onConfigUpdate(keys?: string[], forceRefresh = false): void {
874
		if (keys && this.settingsTreeModel) {
875 876 877
			return this.updateElementsByKey(keys);
		}

878
		const groups = this.defaultSettingsEditorModel.settingsGroups.slice(1); // Without commonlyUsed
879
		const dividedGroups = collections.groupBy(groups, g => g.contributedByExtension ? 'extension' : 'core');
880 881 882 883 884
		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 已提交
885
			const settingKeyList: string[] = [];
886 887 888 889 890 891 892 893
			settingsResult.leftoverSettings.forEach(s => {
				settingKeyList.push(s.key);
			});

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

894
		const commonlyUsed = resolveSettingsTree(commonlyUsedData, dividedGroups.core);
R
Rob Lourens 已提交
895
		resolvedSettingsRoot.children!.unshift(commonlyUsed.tree);
896

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

899 900 901 902
		if (this.searchResultModel) {
			this.searchResultModel.updateChildren();
		}

903 904
		if (this.settingsTreeModel) {
			this.settingsTreeModel.update(resolvedSettingsRoot);
905

906
			// Make sure that all extensions' settings are included in search results
R
Rob Lourens 已提交
907
			const cachedState = this.group && this.input && this.editorMemento.loadEditorState(this.group, this.input);
908 909 910
			if (cachedState && cachedState.searchQuery) {
				this.triggerSearch(cachedState.searchQuery);
			} else {
911 912
				this.renderTree(undefined, forceRefresh);
				this.refreshTOCTree();
913
			}
914
		} else {
915 916
			this.settingsTreeModel = this.instantiationService.createInstance(SettingsTreeModel, this.viewState);
			this.settingsTreeModel.update(resolvedSettingsRoot);
917
			this.tocTreeModel.settingsTreeRoot = this.settingsTreeModel.root as SettingsTreeGroupElement;
918

R
Rob Lourens 已提交
919
			this.refreshTOCTree();
920 921
			this.refreshTree();

R
Rob Lourens 已提交
922
			this.tocTree.collapseAll();
923 924 925
		}
	}

U
Ubuntu 已提交
926
	private updateElementsByKey(keys: string[]): void {
927 928
		if (keys.length) {
			if (this.searchResultModel) {
R
Rob Lourens 已提交
929
				keys.forEach(key => this.searchResultModel!.updateElementsByName(key));
930 931 932 933 934 935
			}

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

U
Ubuntu 已提交
936
			keys.forEach(key => this.renderTree(key));
937 938 939 940 941
		} else {
			return this.renderTree();
		}
	}

942 943 944 945 946 947
	private getActiveElementInSettingsTree(): HTMLElement | null {
		return (document.activeElement && DOM.isAncestor(document.activeElement, this.settingsTree.getHTMLElement())) ?
			<HTMLElement>document.activeElement :
			null;
	}

U
Ubuntu 已提交
948
	private renderTree(key?: string, force = false): void {
949
		if (!force && key && this.scheduledRefreshes.has(key)) {
950
			this.updateModifiedLabelForKey(key);
U
Ubuntu 已提交
951
			return;
952 953
		}

954 955
		// If the context view is focused, delay rendering settings
		if (this.contextViewFocused()) {
M
Matt Bierner 已提交
956 957 958 959
			const element = document.querySelector('.context-view');
			if (element) {
				this.scheduleRefresh(element as HTMLElement, key);
			}
U
Ubuntu 已提交
960
			return;
961 962
		}

963
		// If a setting control is currently focused, schedule a refresh for later
R
Rob Lourens 已提交
964 965
		const activeElement = this.getActiveElementInSettingsTree();
		const focusedSetting = activeElement && this.settingRenderers.getSettingDOMElementForDOMElement(activeElement);
966
		if (focusedSetting && !force) {
967 968
			// 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 已提交
969
				const focusedKey = focusedSetting.getAttribute(AbstractSettingRenderer.SETTING_KEY_ATTR);
970 971 972
				if (focusedKey === key &&
					!DOM.hasClass(focusedSetting, 'setting-item-exclude')) { // update `exclude`s live, as they have a separate "submit edit" step built in before this

973
					this.updateModifiedLabelForKey(key);
974
					this.scheduleRefresh(focusedSetting, key);
U
Ubuntu 已提交
975
					return;
976 977
				}
			} else {
978
				this.scheduleRefresh(focusedSetting);
U
Ubuntu 已提交
979
				return;
980
			}
981
		}
R
Rob Lourens 已提交
982

R
Rob Lourens 已提交
983 984
		this.renderResultCountMessages();

985
		if (key) {
986
			const elements = this.currentSettingsModel.getElementsByName(key);
987
			if (elements && elements.length) {
988
				// TODO https://github.com/Microsoft/vscode/issues/57360
R
Rob Lourens 已提交
989
				this.refreshTree();
990 991
			} else {
				// Refresh requested for a key that we don't know about
U
Ubuntu 已提交
992
				return;
993
			}
994
		} else {
R
Rob Lourens 已提交
995
			this.refreshTree();
996 997
		}

U
Ubuntu 已提交
998
		return;
R
Rob Lourens 已提交
999 1000
	}

1001 1002 1003 1004
	private contextViewFocused(): boolean {
		return !!DOM.findParentWithClass(<HTMLElement>document.activeElement, 'context-view');
	}

R
Rob Lourens 已提交
1005
	private refreshTree(): void {
1006 1007 1008
		if (this.isVisible()) {
			this.settingsTree.setChildren(null, createGroupIterator(this.currentSettingsModel.root));
		}
1009 1010
	}

R
Rob Lourens 已提交
1011
	private refreshTOCTree(): void {
1012
		if (this.isVisible()) {
R
Rob Lourens 已提交
1013
			this.tocTreeModel.update();
1014 1015
			this.tocTree.setChildren(null, createTOCIterator(this.tocTreeModel, this.tocTree));
		}
R
Rob Lourens 已提交
1016 1017
	}

1018
	private updateModifiedLabelForKey(key: string): void {
1019
		const dataElements = this.currentSettingsModel.getElementsByName(key);
1020
		const isModified = dataElements && dataElements[0] && dataElements[0].isConfigured; // all elements are either configured or not
R
Rob Lourens 已提交
1021
		const elements = this.settingRenderers.getDOMElementsForSettingKey(this.settingsTree.getHTMLElement(), key);
1022
		if (elements && elements[0]) {
R
Rob Lourens 已提交
1023
			DOM.toggleClass(elements[0], 'is-configured', !!isModified);
1024 1025 1026
		}
	}

1027
	private onSearchInputChanged(): void {
R
Rob Lourens 已提交
1028 1029
		const query = this.searchWidget.getValue().trim();
		this.delayedFilterLogging.cancel();
1030
		this.triggerSearch(query.replace(/›/g, ' ')).then(() => {
1031
			if (query && this.searchResultModel) {
R
Rob Lourens 已提交
1032
				this.delayedFilterLogging.trigger(() => this.reportFilteringUsed(query, this.searchResultModel!.getUniqueResults()));
1033 1034
			}
		});
R
Rob Lourens 已提交
1035 1036
	}

R
Rob Lourens 已提交
1037
	private parseSettingFromJSON(query: string): string | null {
1038 1039 1040 1041
		const match = query.match(/"([a-zA-Z.]+)": /);
		return match && match[1];
	}

J
Johannes Rieken 已提交
1042
	private triggerSearch(query: string): Promise<void> {
1043
		this.viewState.tagFilters = new Set<string>();
P
Peng Lyu 已提交
1044
		this.viewState.extensionFilters = new Set<string>();
1045
		if (query) {
1046
			const parsedQuery = parseQuery(query);
R
Rob Lourens 已提交
1047
			query = parsedQuery.query;
R
Rob Lourens 已提交
1048
			parsedQuery.tags.forEach(tag => this.viewState.tagFilters!.add(tag));
P
Peng Lyu 已提交
1049
			parsedQuery.extensionFilters.forEach(extensionId => this.viewState.extensionFilters!.add(extensionId));
1050
		}
1051 1052

		if (query && query !== '@') {
1053
			query = this.parseSettingFromJSON(query) || query;
1054
			return this.triggerFilterPreferences(query);
R
Rob Lourens 已提交
1055
		} else {
P
Peng Lyu 已提交
1056
			if ((this.viewState.tagFilters && this.viewState.tagFilters.size) || (this.viewState.extensionFilters && this.viewState.extensionFilters.size)) {
1057 1058 1059 1060 1061
				this.searchResultModel = this.createFilterModel();
			} else {
				this.searchResultModel = null;
			}

R
Rob Lourens 已提交
1062 1063
			this.localSearchDelayer.cancel();
			this.remoteSearchThrottle.cancel();
1064 1065 1066 1067
			if (this.searchInProgress) {
				this.searchInProgress.cancel();
				this.searchInProgress.dispose();
				this.searchInProgress = null;
R
Rob Lourens 已提交
1068
			}
R
Rob Lourens 已提交
1069

1070
			this.tocTree.setFocus([]);
R
Rob Lourens 已提交
1071
			this.viewState.filterToCategory = undefined;
1072
			this.tocTreeModel.currentSearchModel = this.searchResultModel;
1073
			this.onSearchModeToggled();
1074 1075

			if (this.searchResultModel) {
1076 1077
				// Added a filter model
				this.tocTree.setSelection([]);
R
Rob Lourens 已提交
1078
				this.tocTree.expandAll();
R
Rob Lourens 已提交
1079
				this.renderResultCountMessages();
R
Rob Lourens 已提交
1080
				this.refreshTree();
1081
			} else {
1082
				// Leaving search mode
R
Rob Lourens 已提交
1083
				this.tocTree.collapseAll();
R
Rob Lourens 已提交
1084
				this.renderResultCountMessages();
R
Rob Lourens 已提交
1085
				this.refreshTree();
1086
			}
1087 1088

			this.refreshTOCTree();
R
Rob Lourens 已提交
1089
		}
R
Rob Lourens 已提交
1090

R
Rob Lourens 已提交
1091
		return Promise.resolve();
R
Rob Lourens 已提交
1092 1093
	}

1094 1095 1096 1097 1098 1099 1100 1101 1102
	/**
	 * 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 已提交
1103 1104 1105
		for (const g of this.defaultSettingsEditorModel.settingsGroups.slice(1)) {
			for (const sect of g.sections) {
				for (const setting of sect.settings) {
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
					fullResult.filterMatches.push({ setting, matches: [], score: 0 });
				}
			}
		}

		filterModel.setResult(0, fullResult);

		return filterModel;
	}

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
	private reportFilteringUsed(query: string, results: ISearchResult[]): void {
		const nlpResult = results[SearchResultIdx.Remote];
		const nlpMetadata = nlpResult && nlpResult.metadata;

		const durations = {};
		durations['nlpResult'] = nlpMetadata && nlpMetadata.duration;

		// Count unique results
		const counts = {};
		const filterResult = results[SearchResultIdx.Local];
1126 1127 1128 1129
		if (filterResult) {
			counts['filterResult'] = filterResult.filterMatches.length;
		}

1130 1131
		if (nlpResult) {
			counts['nlpResult'] = nlpResult.filterMatches.length;
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
		}

		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 }
			}
		*/
1152
		this.telemetryService.publicLog('settingsEditor.filter', data);
1153 1154
	}

J
Johannes Rieken 已提交
1155
	private triggerFilterPreferences(query: string): Promise<void> {
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
		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 => {
1166
					if (result && !result.exactMatch) {
1167 1168
						this.remoteSearchThrottle.trigger(() => {
							return searchInProgress && !searchInProgress.token.isCancellationRequested ?
R
Rob Lourens 已提交
1169 1170
								this.remoteSearchPreferences(query, this.searchInProgress!.token) :
								Promise.resolve();
1171 1172
						});
					}
1173
				});
1174
			} else {
R
Rob Lourens 已提交
1175
				return Promise.resolve();
1176 1177 1178 1179
			}
		});
	}

R
Rob Lourens 已提交
1180
	private localFilterPreferences(query: string, token?: CancellationToken): Promise<ISearchResult | null> {
1181
		const localSearchProvider = this.preferencesSearchService.getLocalSearchProvider(query);
1182
		return this.filterOrSearchPreferences(query, SearchResultIdx.Local, localSearchProvider, token);
R
Rob Lourens 已提交
1183 1184
	}

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

R
Rob Lourens 已提交
1189
		return Promise.all([
1190 1191
			this.filterOrSearchPreferences(query, SearchResultIdx.Remote, remoteSearchProvider, token),
			this.filterOrSearchPreferences(query, SearchResultIdx.NewExtensions, newExtSearchProvider, token)
R
Rob Lourens 已提交
1192
		]).then(() => { });
R
Rob Lourens 已提交
1193 1194
	}

R
Rob Lourens 已提交
1195
	private filterOrSearchPreferences(query: string, type: SearchResultIdx, searchProvider?: ISearchProvider, token?: CancellationToken): Promise<ISearchResult | null> {
1196 1197 1198 1199 1200
		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;
			}
1201

1202 1203 1204 1205
			if (!this.searchResultModel) {
				this.searchResultModel = this.instantiationService.createInstance(SearchResultModel, this.viewState);
				this.searchResultModel.setResult(type, result);
				this.tocTreeModel.currentSearchModel = this.searchResultModel;
1206
				this.onSearchModeToggled();
1207 1208
			} else {
				this.searchResultModel.setResult(type, result);
1209
				this.tocTreeModel.update();
1210
			}
R
Rob Lourens 已提交
1211

1212
			this.tocTree.setFocus([]);
R
Rob Lourens 已提交
1213
			this.viewState.filterToCategory = undefined;
R
Rob Lourens 已提交
1214
			this.tocTree.expandAll();
1215

U
Ubuntu 已提交
1216
			this.renderTree(undefined, true);
1217
			this.refreshTOCTree();
U
Ubuntu 已提交
1218
			return result;
R
Rob Lourens 已提交
1219 1220 1221
		});
	}

1222
	private renderResultCountMessages() {
1223
		if (!this.currentSettingsModel) {
1224 1225 1226
			return;
		}

R
Rob Lourens 已提交
1227 1228 1229 1230
		this.clearFilterLinkContainer.style.display = this.viewState.tagFilters && this.viewState.tagFilters.size > 0
			? 'initial'
			: 'none';

1231 1232
		if (!this.searchResultModel) {
			this.countElement.style.display = 'none';
R
Rob Lourens 已提交
1233 1234
			DOM.removeClass(this.rootElement, 'no-results');
			return;
1235 1236
		}

1237 1238 1239 1240 1241 1242 1243
		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);
			}
1244

1245
			this.countElement.style.display = 'block';
R
Rob Lourens 已提交
1246
			DOM.toggleClass(this.rootElement, 'no-results', count === 0);
1247
		}
1248 1249
	}

R
Rob Lourens 已提交
1250
	private _filterOrSearchPreferencesModel(filter: string, model: ISettingsEditorModel, provider?: ISearchProvider, token?: CancellationToken): Promise<ISearchResult | null> {
R
Rob Lourens 已提交
1251
		const searchP = provider ? provider.searchModel(model, token) : Promise.resolve(null);
R
Rob Lourens 已提交
1252 1253 1254
		return searchP
			.then<ISearchResult>(null, err => {
				if (isPromiseCanceledError(err)) {
R
Rob Lourens 已提交
1255
					return Promise.reject(err);
R
Rob Lourens 已提交
1256 1257
				} else {
					/* __GDPR__
1258
						"settingsEditor.searchError" : {
R
Rob Lourens 已提交
1259 1260 1261 1262 1263 1264 1265
							"message": { "classification": "CallstackOrException", "purpose": "FeatureInsight" },
							"filter": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
						}
					*/
					const message = getErrorMessage(err).trim();
					if (message && message !== 'Error') {
						// "Error" = any generic network error
1266
						this.telemetryService.publicLog('settingsEditor.searchError', { message, filter });
R
Rob Lourens 已提交
1267 1268
						this.logService.info('Setting search error: ' + message);
					}
R
Rob Lourens 已提交
1269
					return Promise.resolve(null);
R
Rob Lourens 已提交
1270 1271 1272 1273
				}
			});
	}

1274
	private layoutTrees(dimension: DOM.Dimension): void {
1275
		const listHeight = dimension.height - (76 + 11 /* header height + padding*/);
1276 1277
		const settingsTreeHeight = listHeight - 14;
		this.settingsTreeContainer.style.height = `${settingsTreeHeight}px`;
1278
		this.settingsTree.layout(settingsTreeHeight, dimension.width);
1279

1280 1281
		const tocTreeHeight = listHeight - 16;
		this.tocTreeContainer.style.height = `${tocTreeHeight}px`;
R
Rob Lourens 已提交
1282
		this.tocTree.layout(tocTreeHeight);
1283
	}
1284

B
Benjamin Pasero 已提交
1285
	protected saveState(): void {
1286 1287 1288
		if (this.isVisible()) {
			const searchQuery = this.searchWidget.getValue().trim();
			const target = this.settingsTargetsWidget.settingsTarget as SettingsTarget;
R
Rob Lourens 已提交
1289 1290 1291
			if (this.group && this.input) {
				this.editorMemento.saveEditorState(this.group, this.input, { searchQuery, target });
			}
1292
		}
B
Benjamin Pasero 已提交
1293 1294

		super.saveState();
1295
	}
R
Rob Lourens 已提交
1296
}
1297

1298 1299 1300 1301
interface ISettingsEditor2State {
	searchQuery: string;
	target: SettingsTarget;
}