provideWorkspaceSymbols API does not take into account multi-word queries

[gabrielBusuioc]

Does this issue occur when all extensions are disabled?: Yes

• VS Code Version: 1.81.1
• OS Version: Ubuntu 22.04.2 LTS

Steps to Reproduce:

1. Register a dummy WorkspaceSymbolsProvider and log the query argument

export function activate(context: vscode.ExtensionContext) {
   function provideWorkspaceSymbols(myQuery, token): vscode.SymbolInformation[] {
        vscode.window.showInformationMessage(myQuery)
        return [];
    }

    let disposable = vscode.languages.registerWorkspaceSymbolProvider({
        provideWorkspaceSymbols
    });

    context.subscriptions.push(disposable);
}

2. Use ''go to Symbol in Workspace'' -> "query1 query2"
3. myQuery will have its value equal to "query1"

I`m not sure if this is intended but I think it should be up to the symbols provider to decide whether or not to treat ( or make use of ) such cases.

[vscodenpa]

Thanks for creating this issue! It looks like you may be using an old version of VS Code, the latest stable release is 1.83.0. Please try upgrading to the latest version and checking whether this issue remains.

Happy Coding!

[gabrielBusuioc]

Reproducible in VS Code 1.83.0 as well.

[jrieken]

@bpasero @TylerLeonhardt Is this on purpose and/or a quick pick feature for nested filtering?

[bpasero]

Quick open allows you to run a multi-query on providers when you separate search terms by space. The idea is to run multiple queries on each segment and then require each to match, but its up to the quick access provider how to deal with it.

This can be disabled when you surround with quotes:

vscode/src/vs/workbench/contrib/search/browser/symbolsQuickAccess.ts

Lines 102 to 113 in 9dbe483

	// Split between symbol and container query
	let symbolQuery: IPreparedQuery;
	let containerQuery: IPreparedQuery | undefined;
	if (query.values && query.values.length > 1) {
	symbolQuery = pieceToQuery(query.values[0]); // symbol: only match on first part
	containerQuery = pieceToQuery(query.values.slice(1)); // container: match on all but first parts
	} else {
	symbolQuery = query;
	}
	// Run the workspace symbol query
	const workspaceSymbols = await getWorkspaceSymbols(symbolQuery.original, token);

I think the part after the first segment is used to narrow down results based on the container. Quite sure we had that for a long time and its nothing new.

If we change this to query workspace symbols on the original value the user provided it will likely break those providers that cannot deal with these kinds of queries?

[vscodenpa]

The described behavior is how it is expected to work. If you disagree, please explain what is expected and what is not in more detail. See also our issue reporting guidelines.

Happy Coding!