Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-24 20:26:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Old FileSearchProvider session not properly cancelled

Browse Source 
and should be object type
This commit is contained in:
andreamah
2024-08-28 17:26:57 -07:00
parent 0e542f326f
commit 0e62f015f7
2 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/vs/workbench/services/search/common/fileSearchManager.ts
View File

@@ -13,6 +13,8 @@ import { URI } from 'vs/base/common/uri';
import { IFileMatch, IFileSearchProviderStats, IFolderQuery, ISearchCompleteStats, IFileQuery, QueryGlobTester, resolvePatternsForProvider, hasSiblingFn, excludeToGlobPattern, DEFAULT_MAX_SEARCH_RESULTS } from 'vs/workbench/services/search/common/search';
import { FileSearchProviderFolderOptions, FileSearchProviderNew, FileSearchProviderOptions } from 'vs/workbench/services/search/common/searchExtTypes';
import { TernarySearchTree } from 'vs/base/common/ternarySearchTree';
import { Disposable } from 'vs/base/common/lifecycle';
import { OldFileSearchProviderConverter } from 'vs/workbench/services/search/common/searchExtConversionTypes';
interface IInternalFileMatch {
base: URI;
@@ -53,7 +55,7 @@ class FileSearchEngine {
private globalExcludePattern?: glob.ParsedExpression;
constructor(private config: IFileQuery, private provider: FileSearchProviderNew, private sessionToken?: unknown) {
constructor(private config: IFileQuery, private provider: FileSearchProviderNew, private sessionLifecycle?: SessionLifecycle) {
this.filePattern = config.filePattern;
this.includePattern = config.includePattern && glob.parse(config.includePattern);
this.maxResults = config.maxResults || undefined;
@@ -116,10 +118,11 @@ class FileSearchEngine {
private async doSearch(fqs: IFolderQuery<URI>[], onResult: (match: IInternalFileMatch) => void): Promise<IFileSearchProviderStats | null> {
const cancellation = new CancellationTokenSource();
const folderOptions = fqs.map(fq => this.getSearchOptionsForFolder(fq));
const session = this.provider instanceof OldFileSearchProviderConverter ? this.sessionLifecycle?.tokenSource.token : this.sessionLifecycle?.obj;
const options: FileSearchProviderOptions = {
folderOptions,
maxResults: this.config.maxResults ?? DEFAULT_MAX_SEARCH_RESULTS,
session: this.sessionToken
session
};
@@ -301,11 +304,30 @@ interface IInternalSearchComplete {
stats?: IFileSearchProviderStats;
}
/**
* For backwards compatibility, store both a cancellation token and a session object. The session object is the new implementation, where
*/
class SessionLifecycle extends Disposable {
public readonly obj: object;
public readonly tokenSource: CancellationTokenSource;
constructor() {
super();
this.obj = new Object();
this.tokenSource = new CancellationTokenSource();
}
public override dispose(): void {
this.tokenSource.cancel();
super.dispose();
}
}
export class FileSearchManager {
private static readonly BATCH_SIZE = 512;
private readonly sessions = new Map<string, unknown>();
private readonly sessions = new Map<string, SessionLifecycle>();
fileSearch(config: IFileQuery, provider: FileSearchProviderNew, onBatch: (matches: IFileMatch[]) => void, token: CancellationToken): Promise<ISearchCompleteStats> {
const sessionTokenSource = this.getSessionTokenSource(config.cacheKey);
@@ -333,17 +355,19 @@ export class FileSearchManager {
}
clearCache(cacheKey: string): void {
// cancel the token
this.sessions.get(cacheKey)?.dispose();
// with no reference to this, it will be removed from WeakMaps
this.sessions.delete(cacheKey);
}
private getSessionTokenSource(cacheKey: string | undefined): unknown {
private getSessionTokenSource(cacheKey: string | undefined): SessionLifecycle | undefined {
if (!cacheKey) {
return undefined;
}
if (!this.sessions.has(cacheKey)) {
this.sessions.set(cacheKey, new Object());
this.sessions.set(cacheKey, new SessionLifecycle());
}
return this.sessions.get(cacheKey);

2
src/vscode-dts/vscode.proposed.fileSearchProviderNew.d.ts vendored
View File

@@ -57,7 +57,7 @@ declare module 'vscode' {
* and searches with the same session object can search the same cache. When the object is garbage-collected, the session is complete and the cache can be cleared.
* Please do not store any references to the session object, except via a weak reference (e.g. `WeakRef` or `WeakMap`).
*/
session: unknown;
session: object;
/**
* The maximum number of results to be returned.