settingsEditor2.ts 48.8 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
		return type === SettingValueType.Enum ||
P
Pine Wu 已提交
82
			type === SettingValueType.ArrayOfString ||
R
Rob Lourens 已提交
83 84 85
			type === SettingValueType.Complex ||
			type === SettingValueType.Boolean ||
			type === SettingValueType.Exclude;
86 87
	}

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

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

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

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

107 108
	private settingsAriaExtraLabelsContainer: HTMLElement;

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

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

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

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

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

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

131 132
	private editorMemento: IEditorMemento<ISettingsEditor2State>;

R
Rob Lourens 已提交
133
	private tocFocusedElement: SettingsTreeGroupElement | null;
134
	private settingsTreeScrollTop = 0;
135
	private dimension: DOM.Dimension;
136

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

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

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

164 165
		this.scheduledRefreshes = new Map<string, DOM.IFocusTracker>();

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

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

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

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

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

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

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

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

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

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

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

226
				this._setOptions(options);
227

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

232 233
				// Init TOC selection
				this.updateTreeScrollSync();
234 235

				this.restoreCachedState();
R
Rob Lourens 已提交
236
			});
R
Rob Lourens 已提交
237 238
	}

239
	private restoreCachedState(): void {
R
Rob Lourens 已提交
240
		const cachedState = this.group && this.input && this.editorMemento.loadEditorState(this.group, this.input);
241
		if (cachedState && typeof cachedState.target === 'object') {
242 243 244 245 246 247 248 249 250 251 252
			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 已提交
253
	setOptions(options: SettingsEditorOptions | null): void {
254 255
		super.setOptions(options);

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

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

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

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

279 280 281
		super.clearInput();
	}

R
Rob Lourens 已提交
282
	layout(dimension: DOM.Dimension): void {
283
		this.dimension = dimension;
284 285
		this.layoutTrees(dimension);

286 287
		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
288 289
		this.searchWidget.layout({ height: 20, width: monacoWidth });

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

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

306 307 308
		this.focusSearch();
	}

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

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

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

		const settingDOMElement = this.settingRenderers.getSettingDOMElementForDOMElement(activeElement);
332 333 334 335
		if (!settingDOMElement) {
			return;
		}

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

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

347
	focusSearch(filter?: string, selectAll = true): void {
348 349 350 351
		if (filter && this.searchWidget) {
			this.searchWidget.setValue(filter);
		}

352
		this.searchWidget.focus(selectAll);
R
Rob Lourens 已提交
353 354
	}

355
	clearSearchResults(): void {
356
		this.searchWidget.setValue('');
357 358
	}

359 360 361 362 363 364 365 366 367 368
	clearSearchFilters(): void {
		let query = this.searchWidget.getValue();

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

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

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

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

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

387 388 389 390
		this._register(this.searchWidget.onFocus(() => {
			this.lastFocusedSettingElement = '';
		}));

391 392 393 394
		this._register(attachSuggestEnabledInputBoxStyler(this.searchWidget, this.themeService, {
			inputBorder: settingsTextInputBorder
		}));

395 396 397 398
		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 已提交
399
			const foreground = colors.badgeForeground ? colors.badgeForeground.toString() : null;
400 401

			this.countElement.style.backgroundColor = background;
R
Rob Lourens 已提交
402
			this.countElement.style.color = foreground;
403 404 405 406 407 408

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

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

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

418 419 420
	private onDidSettingsTargetChange(target: SettingsTarget): void {
		this.viewState.settingsTarget = target;

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

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

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

438
			this.settingsTree.reveal(elements[0], sourceTop);
439

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

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

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

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

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

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

481
		this.noResultsMessage.innerText = localize('noResults', "No Settings Found");
482 483 484 485 486

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

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

		DOM.append(this.noResultsMessage, clearSearchContainer);

506 507 508 509
		this._register(attachStylerCallback(this.themeService, { editorForeground }, colors => {
			this.noResultsMessage.style.color = colors.editorForeground ? colors.editorForeground.toString() : null;
		}));

R
Rob Lourens 已提交
510 511
		this.createTOC(bodyContainer);

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

R
Rob Lourens 已提交
532
		this.createSettingsTree(bodyContainer);
R
Rob Lourens 已提交
533

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

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

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

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

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

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

		this._register(this.tocTree.onDidBlur(() => {
			this.tocRowFocused.set(false);
R
Rob Lourens 已提交
597 598 599 600
		}));
	}

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

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

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

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

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

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

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

664 665
		if (this.pendingSettingUpdate && this.pendingSettingUpdate.key !== key) {
			this.updateChangedSetting(key, value);
666 667
		}

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

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

R
Rob Lourens 已提交
682
		if (!this.tocTreeModel) {
683 684
			return;
		}
685

686
		const elementToSync = this.settingsTree.firstVisibleElement;
687 688 689 690
		const element = elementToSync instanceof SettingsTreeSettingElement ? elementToSync.parent :
			elementToSync instanceof SettingsTreeGroupElement ? elementToSync :
				null;

R
Rob Lourens 已提交
691 692 693 694 695 696 697 698
		// 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;
		}

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

709 710 711 712 713 714 715 716 717 718
			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 已提交
719

720
			this.tocTree.setSelection([element]);
721

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

728 729 730 731 732 733 734 735 736 737
	private getAncestors(element: SettingsTreeElement): SettingsTreeElement[] {
		const ancestors: any[] = [];

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

			element = element.parent;
		}
738

739
		return ancestors.reverse();
740 741
	}

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

750 751
		const isManualReset = value === undefined;

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

				return this.reportModifiedSetting(reportModifiedProps);
			});
773 774
	}

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

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

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

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

794 795 796 797 798 799
			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;
				}
800 801 802
			}
		}

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

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

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

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

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

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

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

862 863 864 865 866 867 868 869 870 871 872
		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]);
873 874 875
		});
	}

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

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

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

897
		const commonlyUsed = resolveSettingsTree(commonlyUsedData, dividedGroups.core);
R
Rob Lourens 已提交
898
		resolvedSettingsRoot.children!.unshift(commonlyUsed.tree);
899

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

902 903 904 905
		if (this.searchResultModel) {
			this.searchResultModel.updateChildren();
		}

906 907
		if (this.settingsTreeModel) {
			this.settingsTreeModel.update(resolvedSettingsRoot);
908

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

R
Rob Lourens 已提交
922
			this.refreshTOCTree();
923 924
			this.refreshTree();

R
Rob Lourens 已提交
925
			this.tocTree.collapseAll();
926 927 928
		}
	}

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

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

U
Ubuntu 已提交
939
			keys.forEach(key => this.renderTree(key));
940 941 942 943 944
		} else {
			return this.renderTree();
		}
	}

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

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

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

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

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

R
Rob Lourens 已提交
986 987
		this.renderResultCountMessages();

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

U
Ubuntu 已提交
1001
		return;
R
Rob Lourens 已提交
1002 1003
	}

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

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

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

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

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

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

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

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

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

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

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

			this.refreshTOCTree();
R
Rob Lourens 已提交
1092
		}
R
Rob Lourens 已提交
1093

R
Rob Lourens 已提交
1094
		return Promise.resolve();
R
Rob Lourens 已提交
1095 1096
	}

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

		filterModel.setResult(0, fullResult);

		return filterModel;
	}

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

1123 1124 1125
		const durations = {
			nlpResult: nlpMetadata && nlpMetadata.duration
		};
1126 1127

		// Count unique results
1128
		const counts: { nlpResult?: number, filterResult?: number } = {};
1129
		const filterResult = results[SearchResultIdx.Local];
1130 1131 1132 1133
		if (filterResult) {
			counts['filterResult'] = filterResult.filterMatches.length;
		}

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

		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 }
			}
		*/
1156
		this.telemetryService.publicLog('settingsEditor.filter', data);
1157 1158
	}

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

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

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

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

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

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

1216
			this.tocTree.setFocus([]);
R
Rob Lourens 已提交
1217
			this.viewState.filterToCategory = undefined;
R
Rob Lourens 已提交
1218
			this.tocTree.expandAll();
1219

U
Ubuntu 已提交
1220
			this.renderTree(undefined, true);
1221
			this.refreshTOCTree();
U
Ubuntu 已提交
1222
			return result;
R
Rob Lourens 已提交
1223 1224 1225
		});
	}

1226
	private renderResultCountMessages() {
1227
		if (!this.currentSettingsModel) {
1228 1229 1230
			return;
		}

R
Rob Lourens 已提交
1231 1232 1233 1234
		this.clearFilterLinkContainer.style.display = this.viewState.tagFilters && this.viewState.tagFilters.size > 0
			? 'initial'
			: 'none';

1235
		if (!this.searchResultModel) {
1236 1237 1238 1239 1240
			if (this.countElement.style.display !== 'none') {
				this.countElement.style.display = 'none';
				this.layout(this.dimension);
			}

R
Rob Lourens 已提交
1241 1242
			DOM.removeClass(this.rootElement, 'no-results');
			return;
1243 1244
		}

1245 1246 1247 1248 1249 1250 1251
		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);
			}
1252

1253 1254 1255 1256
			if (this.countElement.style.display !== 'block') {
				this.countElement.style.display = 'block';
				this.layout(this.dimension);
			}
R
Rob Lourens 已提交
1257
			DOM.toggleClass(this.rootElement, 'no-results', count === 0);
1258
		}
1259 1260
	}

R
Rob Lourens 已提交
1261
	private _filterOrSearchPreferencesModel(filter: string, model: ISettingsEditorModel, provider?: ISearchProvider, token?: CancellationToken): Promise<ISearchResult | null> {
R
Rob Lourens 已提交
1262
		const searchP = provider ? provider.searchModel(model, token) : Promise.resolve(null);
R
Rob Lourens 已提交
1263 1264 1265
		return searchP
			.then<ISearchResult>(null, err => {
				if (isPromiseCanceledError(err)) {
R
Rob Lourens 已提交
1266
					return Promise.reject(err);
R
Rob Lourens 已提交
1267 1268
				} else {
					/* __GDPR__
1269
						"settingsEditor.searchError" : {
R
Rob Lourens 已提交
1270 1271 1272 1273 1274 1275 1276
							"message": { "classification": "CallstackOrException", "purpose": "FeatureInsight" },
							"filter": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
						}
					*/
					const message = getErrorMessage(err).trim();
					if (message && message !== 'Error') {
						// "Error" = any generic network error
1277
						this.telemetryService.publicLog('settingsEditor.searchError', { message, filter });
R
Rob Lourens 已提交
1278 1279
						this.logService.info('Setting search error: ' + message);
					}
R
Rob Lourens 已提交
1280
					return Promise.resolve(null);
R
Rob Lourens 已提交
1281 1282 1283 1284
				}
			});
	}

1285
	private layoutTrees(dimension: DOM.Dimension): void {
1286
		const listHeight = dimension.height - (76 + 11 /* header height + padding*/);
1287 1288
		const settingsTreeHeight = listHeight - 14;
		this.settingsTreeContainer.style.height = `${settingsTreeHeight}px`;
1289
		this.settingsTree.layout(settingsTreeHeight, dimension.width);
1290

1291 1292
		const tocTreeHeight = listHeight - 16;
		this.tocTreeContainer.style.height = `${tocTreeHeight}px`;
R
Rob Lourens 已提交
1293
		this.tocTree.layout(tocTreeHeight);
1294
	}
1295

B
Benjamin Pasero 已提交
1296
	protected saveState(): void {
1297 1298 1299
		if (this.isVisible()) {
			const searchQuery = this.searchWidget.getValue().trim();
			const target = this.settingsTargetsWidget.settingsTarget as SettingsTarget;
R
Rob Lourens 已提交
1300 1301 1302
			if (this.group && this.input) {
				this.editorMemento.saveEditorState(this.group, this.input, { searchQuery, target });
			}
1303
		}
B
Benjamin Pasero 已提交
1304 1305

		super.saveState();
1306
	}
R
Rob Lourens 已提交
1307
}
1308

1309 1310 1311 1312
interface ISettingsEditor2State {
	searchQuery: string;
	target: SettingsTarget;
}