Fix partial result transfer in quick search (microsoft#201917)

Author: andreamah

src/vs/workbench/contrib/search/browser/quickTextSearch/textSearchQuickAccess.ts

@@ -2,7 +2,7 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { CancellationToken } from 'vs/base/common/cancellation';
+import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
 import { IMatch } from 'vs/base/common/filters';
 import { DisposableStore, IDisposable } from 'vs/base/common/lifecycle';
 import { ResourceSet } from 'vs/base/common/map';
@@ -22,12 +22,12 @@ import { IWorkspaceContextService, IWorkspaceFolder } from 'vs/platform/workspac
 import { IWorkbenchEditorConfiguration } from 'vs/workbench/common/editor';
 import { IViewsService } from 'vs/workbench/services/views/common/viewsService';
 import { searchDetailsIcon, searchOpenInFileIcon, searchActivityBarIcon } from 'vs/workbench/contrib/search/browser/searchIcons';
-import { FileMatch, Match, RenderableMatch, SearchModel, searchComparer } from 'vs/workbench/contrib/search/browser/searchModel';
+import { FileMatch, Match, RenderableMatch, SearchModel, SearchModelLocation, searchComparer } from 'vs/workbench/contrib/search/browser/searchModel';
 import { SearchView, getEditorSelectionFromMatch } from 'vs/workbench/contrib/search/browser/searchView';
 import { IWorkbenchSearchConfiguration, getOutOfWorkspaceEditorResources } from 'vs/workbench/contrib/search/common/search';
 import { ACTIVE_GROUP, IEditorService, SIDE_GROUP } from 'vs/workbench/services/editor/common/editorService';
 import { ITextQueryBuilderOptions, QueryBuilder } from 'vs/workbench/services/search/common/queryBuilder';
-import { IPatternInfo, ITextQuery, VIEW_ID } from 'vs/workbench/services/search/common/search';
+import { IPatternInfo, ISearchComplete, ITextQuery, VIEW_ID } from 'vs/workbench/services/search/common/search';
 
 export const TEXT_SEARCH_QUICK_ACCESS_PREFIX = '%';
 
@@ -45,6 +45,10 @@ const MAX_RESULTS_PER_FILE = 10;
 export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuickAccessItem> {
 	private queryBuilder: QueryBuilder;
 	private searchModel: SearchModel;
+	private currentAsyncSearch: Promise<ISearchComplete> = Promise.resolve({
+		results: [],
+		messages: []
+	});
 
 	private _getTextQueryBuilderOptions(charsPerLine: number): ITextQueryBuilderOptions {
 		return {
@@ -74,6 +78,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 
 		this.queryBuilder = this._instantiationService.createInstance(QueryBuilder);
 		this.searchModel = this._instantiationService.createInstance(SearchModel);
+		this.searchModel.location = SearchModelLocation.QUICK_ACCESS;
 	}
 
 	override dispose(): void {
@@ -89,7 +94,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 		picker.customButton = true;
 		picker.customLabel = '$(link-external)';
 		picker.onDidCustom(() => {
-			this.moveToSearchViewlet(this.searchModel, undefined);
+			this.moveToSearchViewlet(undefined);
 			picker.hide();
 		});
 		disposables.add(super.provide(picker, token, runOptions));
@@ -137,6 +142,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 		const result = this.searchModel.search(query, undefined, token);
 
 		const getAsyncResults = async () => {
+			this.currentAsyncSearch = result.asyncResults;
 			await result.asyncResults;
 			const syncResultURIs = new ResourceSet(result.syncResults.map(e => e.resource));
 			return this.searchModel.searchResult.matches().filter(e => !syncResultURIs.has(e.resource));
@@ -147,12 +153,15 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 		};
 	}
 
-	private moveToSearchViewlet(model: SearchModel, currentElem: RenderableMatch | undefined) {
-		// this function takes this._searchModel.searchResult and moves it to the search viewlet's search model.
-		// then, this._searchModel will construct a new (empty) SearchResult, and the search viewlet's search result will be disposed.
+	private moveToSearchViewlet(currentElem: RenderableMatch | undefined) {
+		// this function takes this._searchModel and moves it to the search viewlet's search model.
+		// then, this._searchModel will construct a new (empty) SearchModel.
 		this._viewsService.openView(VIEW_ID, false);
 		const viewlet: SearchView | undefined = this._viewsService.getActiveViewWithId(VIEW_ID) as SearchView;
-		viewlet.importSearchResult(model);
+		viewlet.replaceSearchModel(this.searchModel, this.currentAsyncSearch);
+
+		this.searchModel = this._instantiationService.createInstance(SearchModel);
+		this.searchModel.location = SearchModelLocation.QUICK_ACCESS;
 
 		const viewer: WorkbenchCompressibleObjectTree<RenderableMatch> | undefined = viewlet?.getControl();
 		if (currentElem) {
@@ -181,7 +190,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 					label: localize('QuickSearchSeeMoreFiles', "See More Files"),
 					iconClass: ThemeIcon.asClassName(searchDetailsIcon),
 					accept: async () => {
-						this.moveToSearchViewlet(this.searchModel, matches[limit]);
+						this.moveToSearchViewlet(matches[limit]);
 					}
 				});
 				break;
@@ -212,7 +221,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 						label: localize('QuickSearchMore', "More"),
 						iconClass: ThemeIcon.asClassName(searchDetailsIcon),
 						accept: async () => {
-							this.moveToSearchViewlet(this.searchModel, element);
+							this.moveToSearchViewlet(element);
 						}
 					});
 					break;
@@ -243,7 +252,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 						});
 					},
 					trigger: (): TriggerAction => {
-						this.moveToSearchViewlet(this.searchModel, element);
+						this.moveToSearchViewlet(element);
 						return TriggerAction.CLOSE_PICKER;
 					}
 				});
@@ -270,11 +279,22 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
 
 	protected _getPicks(contentPattern: string, disposables: DisposableStore, token: CancellationToken): Picks<IQuickPickItem> | Promise<Picks<IQuickPickItem> | FastAndSlowPicks<IQuickPickItem>> | FastAndSlowPicks<IQuickPickItem> | null {
 
+		const conditionalTokenCts = disposables.add(new CancellationTokenSource());
+
+		const searchModelAtTimeOfSearch = this.searchModel;
+
+		disposables.add(token.onCancellationRequested(() => {
+			if (searchModelAtTimeOfSearch.location === SearchModelLocation.QUICK_ACCESS) {
+				// if the search model has not been imported to the panel, you can cancel
+				conditionalTokenCts.cancel();
+			}
+		}));
+
 		if (contentPattern === '') {
 			this.searchModel.searchResult.clear();
 			return [];
 		}
-		const allMatches = this.doSearch(contentPattern, token);
+		const allMatches = this.doSearch(contentPattern, conditionalTokenCts.token);
 
 		if (!allMatches) {
 			return null;

src/vs/workbench/contrib/search/browser/searchModel.ts

@@ -1580,6 +1580,7 @@ function createParentList(element: RenderableMatch): RenderableMatch[] {
 
 	return parentArray;
 }
+
 export class SearchResult extends Disposable {
 
 	private _onChange = this._register(new PauseableEmitter<IChangeEvent>({
@@ -1598,7 +1599,7 @@ export class SearchResult extends Disposable {
 	private _onDidChangeModelListener: IDisposable | undefined;
 
 	constructor(
-		public searchModel: SearchModel,
+		public readonly searchModel: SearchModel,
 		@IReplaceService private readonly replaceService: IReplaceService,
 		@IInstantiationService private readonly instantiationService: IInstantiationService,
 		@IModelService private readonly modelService: IModelService,
@@ -1607,7 +1608,6 @@ export class SearchResult extends Disposable {
 	) {
 		super();
 		this._rangeHighlightDecorations = this.instantiationService.createInstance(RangeHighlightDecorations);
-
 		this.modelService.getModels().forEach(model => this.onModelAdded(model));
 		this._register(this.modelService.onModelAdded(model => this.onModelAdded(model)));
 
@@ -1936,6 +1936,11 @@ export class SearchResult extends Disposable {
 	}
 }
 
+export enum SearchModelLocation {
+	PANEL,
+	QUICK_ACCESS
+}
+
 export class SearchModel extends Disposable {
 
 	private _searchResult: SearchResult;
@@ -1957,7 +1962,7 @@ export class SearchModel extends Disposable {
 
 	private currentCancelTokenSource: CancellationTokenSource | null = null;
 	private searchCancelledForNewSearch: boolean = false;
-	private _searchResultChangedListener: IDisposable;
+	public location: SearchModelLocation = SearchModelLocation.PANEL;
 
 	constructor(
 		@ISearchService private readonly searchService: ISearchService,
@@ -1969,7 +1974,7 @@ export class SearchModel extends Disposable {
 	) {
 		super();
 		this._searchResult = this.instantiationService.createInstance(SearchResult, this);
-		this._searchResultChangedListener = this._register(this._searchResult.onChange((e) => this._onSearchResultChanged.fire(e)));
+		this._register(this._searchResult.onChange((e) => this._onSearchResultChanged.fire(e)));
 	}
 
 	isReplaceActive(): boolean {
@@ -2008,15 +2013,6 @@ export class SearchModel extends Disposable {
 		return this._searchResult;
 	}
 
-	set searchResult(searchResult: SearchResult) {
-		this._searchResult.dispose();
-		this._searchResultChangedListener.dispose();
-
-		this._searchResult = searchResult;
-		this._searchResult.searchModel = this;
-		this._searchResultChangedListener = this._register(this._searchResult.onChange((e) => this._onSearchResultChanged.fire(e)));
-	}
-
 
 	private doSearch(query: ITextQuery, progressEmitter: Emitter<void>, searchQuery: ITextQuery, searchInstanceID: string, onProgress?: (result: ISearchProgressItem) => void, callerToken?: CancellationToken): {
 		asyncResults: Promise<ISearchComplete>;
@@ -2145,7 +2141,7 @@ export class SearchModel extends Disposable {
 		}
 	}
 
-	private onSearchCompleted(completed: ISearchComplete | null, duration: number, searchInstanceID: string): ISearchComplete | null {
+	private onSearchCompleted(completed: ISearchComplete | undefined, duration: number, searchInstanceID: string): ISearchComplete | undefined {
 		if (!this._searchQuery) {
 			throw new Error('onSearchCompleted must be called after a search is started');
 		}
@@ -2193,7 +2189,7 @@ export class SearchModel extends Disposable {
 			this.onSearchCompleted(
 				this.searchCancelledForNewSearch
 					? { exit: SearchCompletionExitCode.NewSearchStarted, results: [], messages: [] }
-					: null,
+					: undefined,
 				duration, '');
 			this.searchCancelledForNewSearch = false;
 		}
@@ -2238,10 +2234,6 @@ export class SearchModel extends Disposable {
 		super.dispose();
 	}
 
-	transferSearchResult(other: SearchModel): void {
-		other.searchResult = this._searchResult;
-		this._searchResult = this.instantiationService.createInstance(SearchResult, this);
-	}
 }
 
 export type FileMatchOrMatch = FileMatch | Match;
@@ -2262,14 +2254,19 @@ export class SearchViewModelWorkbenchService implements ISearchViewModelWorkbenc
 		}
 		return this._searchModel;
 	}
+
+	set searchModel(searchModel: SearchModel) {
+		this._searchModel?.dispose();
+		this._searchModel = searchModel;
+	}
 }
 
 export const ISearchViewModelWorkbenchService = createDecorator<ISearchViewModelWorkbenchService>('searchViewModelWorkbenchService');
 
 export interface ISearchViewModelWorkbenchService {
 	readonly _serviceBrand: undefined;
 
-	readonly searchModel: SearchModel;
+	searchModel: SearchModel;
 }
 
 /**

src/vs/workbench/contrib/search/browser/searchResultsView.ts

@@ -294,7 +294,6 @@ export class MatchRenderer extends Disposable implements ICompressibleTreeRender
 	readonly templateId = MatchRenderer.TEMPLATE_ID;
 
 	constructor(
-		private searchModel: SearchModel,
 		private searchView: SearchView,
 		@IWorkspaceContextService protected contextService: IWorkspaceContextService,
 		@IConfigurationService private readonly configurationService: IConfigurationService,
@@ -352,8 +351,8 @@ export class MatchRenderer extends Disposable implements ICompressibleTreeRender
 	renderElement(node: ITreeNode<Match, any>, index: number, templateData: IMatchTemplate): void {
 		const match = node.element;
 		const preview = match.preview();
-		const replace = this.searchModel.isReplaceActive() &&
-			!!this.searchModel.replaceString &&
+		const replace = this.searchView.model.isReplaceActive() &&
+			!!this.searchView.model.replaceString &&
 			!(match instanceof MatchInNotebook && match.isReadonly());
 
 		templateData.before.textContent = preview.before;
@@ -402,7 +401,7 @@ export class MatchRenderer extends Disposable implements ICompressibleTreeRender
 export class SearchAccessibilityProvider implements IListAccessibilityProvider<RenderableMatch> {
 
 	constructor(
-		private searchModel: SearchModel,
+		private searchView: SearchView,
 		@ILabelService private readonly labelService: ILabelService
 	) {
 	}
@@ -427,7 +426,7 @@ export class SearchAccessibilityProvider implements IListAccessibilityProvider<R
 
 		if (element instanceof Match) {
 			const match = <Match>element;
-			const searchModel: SearchModel = this.searchModel;
+			const searchModel: SearchModel = this.searchView.model;
 			const replace = searchModel.isReplaceActive() && !!searchModel.replaceString;
 			const matchString = match.getMatchString();
 			const range = match.range();