Skip to content

Support requests of multiple custom configs #14582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Colengms merged 3 commits into from
Jul 14, 2026
+34 −34
Merged

Support requests of multiple custom configs #14582

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2251999
Support requests of multiple custom configs
Colengms Jul 14, 2026
b8971d5
Merge branch 'main' into dev/coleng/custom_config_include_graph
Colengms Jul 14, 2026
3753372
Address PR feedback
Colengms Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions Extension/src/LanguageServer/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,8 +486,14 @@ interface CodeAnalysisParams {
scope: CodeAnalysisScope;
}

interface RequestCustomConfigsParams {
workspaceFolderUri: string;
files: string[];
batchId: number;
}

interface FinishedRequestCustomConfigParams {
uri: string;
batchId: number;
isProviderRegistered: boolean;
}

Expand Down Expand Up @@ -651,7 +657,7 @@ const ClearCustomConfigurationsNotification: NotificationType<WorkspaceFolderPar
const ClearCustomBrowseConfigurationNotification: NotificationType<WorkspaceFolderParams> = new NotificationType<WorkspaceFolderParams>('cpptools/clearCustomBrowseConfiguration');
const PreviewReferencesNotification: NotificationType<void> = new NotificationType<void>('cpptools/previewReferences');
const RescanFolderNotification: NotificationType<void> = new NotificationType<void>('cpptools/rescanFolder');
const FinishedRequestCustomConfig: NotificationType<FinishedRequestCustomConfigParams> = new NotificationType<FinishedRequestCustomConfigParams>('cpptools/finishedRequestCustomConfig');
const FinishedRequestCustomConfig: NotificationType<FinishedRequestCustomConfigParams> = new NotificationType<FinishedRequestCustomConfigParams>('cpptools/finishedRequestCustomConfigs');
const DidChangeSettingsNotification: NotificationType<SettingsParams> = new NotificationType<SettingsParams>('cpptools/didChangeSettings');
const DidChangeVisibleTextEditorsNotification: NotificationType<DidChangeVisibleTextEditorsParams> = new NotificationType<DidChangeVisibleTextEditorsParams>('cpptools/didChangeVisibleTextEditors');
const DidChangeTextEditorVisibleRangesNotification: NotificationType<DidChangeTextEditorVisibleRangesParams> = new NotificationType<DidChangeTextEditorVisibleRangesParams>('cpptools/didChangeTextEditorVisibleRanges');
Expand All @@ -674,7 +680,7 @@ const DebugLogNotification: NotificationType<LocalizeStringParams> = new Notific
const CompileCommandsPathsNotification: NotificationType<CompileCommandsPaths> = new NotificationType<CompileCommandsPaths>('cpptools/compileCommandsPaths');
const ReferencesNotification: NotificationType<refs.ReferencesResult> = new NotificationType<refs.ReferencesResult>('cpptools/references');
const ReportReferencesProgressNotification: NotificationType<refs.ReportReferencesProgressNotification> = new NotificationType<refs.ReportReferencesProgressNotification>('cpptools/reportReferencesProgress');
const RequestCustomConfig: NotificationType<string> = new NotificationType<string>('cpptools/requestCustomConfig');
const RequestCustomConfigs: NotificationType<RequestCustomConfigsParams> = new NotificationType<RequestCustomConfigsParams>('cpptools/requestCustomConfigs');
const PublishRefactorDiagnosticsNotification: NotificationType<PublishRefactorDiagnosticsParams> = new NotificationType<PublishRefactorDiagnosticsParams>('cpptools/publishRefactorDiagnostics');
const ShowMessageWindowNotification: NotificationType<ShowMessageWindowParams> = new NotificationType<ShowMessageWindowParams>('cpptools/showMessageWindow');
const ShowWarningNotification: NotificationType<ShowWarningParams> = new NotificationType<ShowWarningParams>('cpptools/showWarning');
Expand Down Expand Up @@ -804,7 +810,7 @@ export interface Client {
onRegisterCustomConfigurationProvider(provider: CustomConfigurationProvider1): Thenable<void>;
updateCustomConfigurations(requestingProvider?: CustomConfigurationProvider1): Thenable<void>;
updateCustomBrowseConfiguration(requestingProvider?: CustomConfigurationProvider1): Thenable<void>;
provideCustomConfiguration(docUri: vscode.Uri): Promise<void>;
provideCustomConfigurations(docUris: vscode.Uri[], batchId: number): Promise<void>;
logDiagnostics(): Promise<void>;
rescanFolder(): Promise<void>;
toggleReferenceResultsView(): void;
Expand Down Expand Up @@ -2274,10 +2280,10 @@ export class DefaultClient implements Client {
return this.languageClient.sendNotification(RescanFolderNotification);
}

public async provideCustomConfiguration(docUri: vscode.Uri): Promise<void> {
public async provideCustomConfigurations(docUris: vscode.Uri[], batchId: number): Promise<void> {
let isProviderRegistered: boolean = false;
const onFinished: () => void = () => {
void this.languageClient.sendNotification(FinishedRequestCustomConfig, { uri: docUri.toString(), isProviderRegistered });
void this.languageClient.sendNotification(FinishedRequestCustomConfig, { batchId, isProviderRegistered });
};
try {
const providerId: string | undefined = this.configurationProvider;
Expand All @@ -2289,29 +2295,21 @@ export class DefaultClient implements Client {
return;
}
isProviderRegistered = true;
const resultCode = await this.provideCustomConfigurationAsync(docUri, provider);
telemetry.logLanguageServerEvent('provideCustomConfiguration', { providerId, resultCode });
const resultCode = await this.provideCustomConfigurationAsync(docUris, provider);
telemetry.logLanguageServerEvent('provideCustomConfigurations', { providerId, resultCode });
} finally {
onFinished();
}
}

private async provideCustomConfigurationAsync(docUri: vscode.Uri, provider: CustomConfigurationProvider1): Promise<string> {
private async provideCustomConfigurationAsync(docUris: vscode.Uri[], provider: CustomConfigurationProvider1): Promise<string> {
const tokenSource: vscode.CancellationTokenSource = new vscode.CancellationTokenSource();

// Need to loop through candidates, to see if we can get a custom configuration from any of them.
// Wrap all lookups in a single task, so we can apply a timeout to the entire duration.
// Wrap the provider lookup in a single task, so we can apply a timeout to the entire duration.
const provideConfigurationAsync: () => Thenable<SourceFileConfigurationItem[] | undefined> = async () => {
try {
if (!await provider.canProvideConfiguration(docUri, tokenSource.token)) {
return [];
}
} catch {
console.warn("Caught exception from canProvideConfiguration");
}
let configs: util.Mutable<SourceFileConfigurationItem>[] = [];
try {
configs = await provider.provideConfigurations([docUri], tokenSource.token);
configs = await provider.provideConfigurations(docUris, tokenSource.token);
} catch {
Comment thread
Colengms marked this conversation as resolved.
console.warn("Caught exception from provideConfigurations");
}
Expand Down Expand Up @@ -2358,7 +2356,13 @@ export class DefaultClient implements Client {
};
let result: string = "success";
try {
const configs: SourceFileConfigurationItem[] | undefined = await this.callTaskWithTimeout(provideConfigurationAsync, configProviderTimeout, tokenSource);
let configs: SourceFileConfigurationItem[] | undefined;
// Multi-file requests are async, and do not require a timeout.
if (docUris.length > 1) {
configs = await provideConfigurationAsync();
} else {
configs = await this.callTaskWithTimeout(provideConfigurationAsync, configProviderTimeout, tokenSource);
}
if (configs && configs.length > 0) {
this.sendCustomConfigurations(configs, provider.version);
} else {
Expand All @@ -2367,16 +2371,16 @@ export class DefaultClient implements Client {
} catch (err) {
result = "timeout";
const settings: CppSettings = new CppSettings(this.RootUri);
if (settings.isConfigurationWarningsEnabled && !this.isExternalHeader(docUri) && !vscode.debug.activeDebugSession) {
if (settings.isConfigurationWarningsEnabled && !vscode.debug.activeDebugSession) {
Comment thread
Colengms marked this conversation as resolved.
const dismiss: string = localize("dismiss.button", "Dismiss");
const disable: string = localize("disable.warnings.button", "Disable Warnings");
const configName: string | undefined = this.configuration.CurrentConfiguration?.name;
if (!configName) {
return "noConfigName";
}
let message: string = localize("unable.to.provide.configuration",
"{0} is unable to provide IntelliSense configuration information for '{1}'. Settings from the '{2}' configuration will be used instead.",
provider.name, docUri.fsPath, configName);
"{0} is unable to provide IntelliSense configuration information. Settings from the '{1}' configuration will be used instead.",
provider.name, configName);
Comment thread
Colengms marked this conversation as resolved.
if (err) {
message += ` (${err})`;
}
Expand All @@ -2392,20 +2396,16 @@ export class DefaultClient implements Client {
return result;
}

private handleRequestCustomConfig(file: string): void {
const uri: vscode.Uri = vscode.Uri.file(file);
const client: Client = clients.getClientFor(uri);
private handleRequestCustomConfigs(params: RequestCustomConfigsParams): void {
const workspaceFolderUri: vscode.Uri = vscode.Uri.parse(params.workspaceFolderUri);
const client: Client = clients.getClientFor(workspaceFolderUri);
if (client instanceof DefaultClient) {
const defaultClient: DefaultClient = client as DefaultClient;
void defaultClient.provideCustomConfiguration(uri).catch(logAndReturn.undefined);
const uris: vscode.Uri[] = params.files.map(file => vscode.Uri.file(file));
void defaultClient.provideCustomConfigurations(uris, params.batchId).catch(logAndReturn.undefined);
}
}

private isExternalHeader(uri: vscode.Uri): boolean {
const rootUri: vscode.Uri | undefined = this.RootUri;
return !rootUri || (util.isHeaderFile(uri) && !uri.toString().startsWith(rootUri.toString()));
}

public async getCurrentConfigName(): Promise<string | undefined> {
await this.ready;
return this.configuration.CurrentConfiguration?.name;
Expand Down Expand Up @@ -2649,7 +2649,7 @@ export class DefaultClient implements Client {
this.languageClient.onNotification(CompileCommandsPathsNotification, (e) => void this.promptCompileCommands(e));
this.languageClient.onNotification(ReferencesNotification, (e) => this.processReferencesPreview(e));
this.languageClient.onNotification(ReportReferencesProgressNotification, (e) => this.handleReferencesProgress(e));
this.languageClient.onNotification(RequestCustomConfig, (e) => this.handleRequestCustomConfig(e));
this.languageClient.onNotification(RequestCustomConfigs, (e) => this.handleRequestCustomConfigs(e));
this.languageClient.onNotification(IntelliSenseResultNotification, (e) => this.handleIntelliSenseResult(e));
this.languageClient.onNotification(PublishRefactorDiagnosticsNotification, publishRefactorDiagnostics);
RegisterCodeAnalysisNotifications(this.languageClient);
Expand Down Expand Up @@ -4458,7 +4458,7 @@ class NullClient implements Client {
onRegisterCustomConfigurationProvider(provider: CustomConfigurationProvider1): Thenable<void> { return Promise.resolve(); }
updateCustomConfigurations(requestingProvider?: CustomConfigurationProvider1): Thenable<void> { return Promise.resolve(); }
updateCustomBrowseConfiguration(requestingProvider?: CustomConfigurationProvider1): Thenable<void> { return Promise.resolve(); }
provideCustomConfiguration(docUri: vscode.Uri): Promise<void> { return Promise.resolve(); }
provideCustomConfigurations(docUris: vscode.Uri[], batchId: number): Promise<void> { return Promise.resolve(); }
logDiagnostics(): Promise<void> { return Promise.resolve(); }
rescanFolder(): Promise<void> { return Promise.resolve(); }
toggleReferenceResultsView(): void { }
Expand Down
Loading