Reuse diagnostic collections and introduce a provider (#1814)

* Reuse the push diagnostics collection if it has the same name

* Introduce a DiagnosticCollectionProvider

Author: dbaeumer

client/src/common/client.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import {
-	workspace as Workspace, window as Window, languages as Languages, LogLevel, version as VSCodeVersion, TextDocument, Disposable,
+	workspace as Workspace, window as Window, LogLevel, version as VSCodeVersion, TextDocument, Disposable,
 	FileSystemWatcher as VFileSystemWatcher, DiagnosticCollection, Diagnostic as VDiagnostic, Uri, CancellationToken, WorkspaceEdit as VWorkspaceEdit,
 	MessageItem, WorkspaceFolder as VWorkspaceFolder, env as Env, TextDocumentShowOptions, CancellationError, CancellationTokenSource, FileCreateEvent,
 	FileRenameEvent, FileDeleteEvent, FileWillCreateEvent, FileWillRenameEvent, FileWillDeleteEvent, CompletionItemProvider, HoverProvider, SignatureHelpProvider,
@@ -49,7 +49,7 @@ import * as UUID from './utils/uuid';
 import { ProgressPart } from './progressPart';
 import {
 	DynamicFeature, ensure, FeatureClient, LSPCancellationError, TextDocumentSendFeature, RegistrationData, StaticFeature,
-	TextDocumentProviderFeature, WorkspaceProviderFeature, type VisibleDocuments
+	TextDocumentProviderFeature, WorkspaceProviderFeature, DefaultDiagnosticCollectionProvider, DiagnosticCollectionSource, type VisibleDocuments
 } from './features';
 
 import { DiagnosticFeature, DiagnosticProviderMiddleware, DiagnosticProviderShape, $DiagnosticPullOptions, DiagnosticFeatureShape } from './diagnostic';
@@ -735,6 +735,7 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 			// 	interval: clientOptions.suspend?.interval ? Math.max(clientOptions.suspend.interval, defaultInterval) : defaultInterval
 			// },
 			diagnosticPullOptions: clientOptions.diagnosticPullOptions ?? { onChange: true, onSave: false },
+			diagnosticCollectionProvider: clientOptions.diagnosticCollectionProvider ?? new DefaultDiagnosticCollectionProvider(),
 			notebookDocumentOptions: clientOptions.notebookDocumentOptions ?? { },
 			textSynchronization: this.createTextSynchronizationOptions(clientOptions.textSynchronization)
 		};
@@ -866,7 +867,7 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 			return undefined;
 		}
 		if (this._diagnostics === undefined) {
-			this._diagnostics = Languages.createDiagnosticCollection(this._clientOptions.diagnosticCollectionName ?? this._id);
+			this._diagnostics = this._clientOptions.diagnosticCollectionProvider.create(this._clientOptions.diagnosticCollectionName ?? this._id, DiagnosticCollectionSource.push);
 		}
 		return this._diagnostics;
 	}
@@ -1672,7 +1673,7 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 				this._diagnostics = null;
 			}
 			if (this._diagnostics !== null) {
-				this._diagnostics.dispose();
+				this._clientOptions.diagnosticCollectionProvider.dispose(this._diagnostics, DiagnosticCollectionSource.push);
 				this._diagnostics = null;
 			}
 		}

client/src/common/diagnostic.ts

@@ -20,7 +20,7 @@ import { generateUuid } from './utils/uuid';
 import { matchGlobPattern } from './utils/globPattern';
 
 import {
-	TextDocumentLanguageFeature, FeatureClient, LSPCancellationError, type VisibleDocuments
+	TextDocumentLanguageFeature, FeatureClient, LSPCancellationError, DiagnosticCollectionSource, type DiagnosticCollectionProvider, type VisibleDocuments
 } from './features';
 
 function ensure<T, K extends keyof T>(target: T, key: K): T[K] {
@@ -167,6 +167,14 @@ export type DiagnosticPullOptions = {
 
 export type $DiagnosticPullOptions = {
 	diagnosticPullOptions?: DiagnosticPullOptions;
+
+	/**
+	 * The provider used to create and dispose the diagnostic collections for the
+	 * push (`textDocument/publishDiagnostics`) and the pull (`textDocument/diagnostic`)
+	 * model. If omitted a default provider is used that doesn't share a diagnostic
+	 * collection between the two models.
+	 */
+	diagnosticCollectionProvider?: DiagnosticCollectionProvider;
 };
 
 
@@ -314,12 +322,20 @@ class DiagnosticRequestor implements Disposable {
 		this.onDidChangeDiagnosticsEmitter = new EventEmitter<void>();
 		this.provider = this.createProvider();
 
-		this.diagnostics = Languages.createDiagnosticCollection(options.identifier);
+		this.diagnostics = this.createDiagnosticCollection();
 		this.openRequests = new Map();
 		this.documentStates = new DocumentPullStateTracker();
 		this.workspaceErrorCounter = 0;
 	}
 
+	private createDiagnosticCollection(): DiagnosticCollection {
+		if (this.client.clientOptions.diagnosticCollectionProvider === undefined) {
+			return Languages.createDiagnosticCollection(this.options.identifier);
+		} else {
+			return this.client.clientOptions.diagnosticCollectionProvider.create(this.options.identifier, DiagnosticCollectionSource.pull);
+		}
+	}
+
 	public knows(kind: PullState, document: TextDocument | Uri): boolean {
 		const uri = document instanceof Uri ? document : document.uri;
 		return this.documentStates.tracks(kind, document) || this.openRequests.has(uri.toString());
@@ -650,7 +666,11 @@ class DiagnosticRequestor implements Disposable {
 		}
 
 		// cleanup old diagnostics
-		this.diagnostics.dispose();
+		if (this.client.clientOptions.diagnosticCollectionProvider !== undefined) {
+			this.client.clientOptions.diagnosticCollectionProvider.dispose(this.diagnostics, DiagnosticCollectionSource.pull);
+		} else {
+			this.diagnostics.dispose();
+		}
 	}
 }
 

client/src/common/features.ts

@@ -10,7 +10,7 @@ import {
 	DocumentRangeFormattingEditProvider, OnTypeFormattingEditProvider, RenameProvider, DocumentSymbolProvider, DocumentLinkProvider, DocumentColorProvider,
 	DeclarationProvider, ImplementationProvider, SelectionRangeProvider, TypeDefinitionProvider, CallHierarchyProvider,
 	LinkedEditingRangeProvider, TypeHierarchyProvider, FileCreateEvent, FileRenameEvent, FileDeleteEvent, FileWillCreateEvent, FileWillRenameEvent,
-	FileWillDeleteEvent, CancellationError, InlineCompletionItemProvider, type Uri
+	FileWillDeleteEvent, CancellationError, InlineCompletionItemProvider, type Uri, type DiagnosticCollection
 } from 'vscode';
 
 import {
@@ -689,6 +689,55 @@ import type { DiagnosticFeatureShape, DiagnosticProviderShape } from './diagnost
 import type { NotebookDocumentProviderShape } from './notebook';
 import { FoldingRangeProviderShape } from './foldingRange';
 
+export enum DiagnosticCollectionSource {
+	push = 'push',
+	pull = 'pull'
+}
+
+/**
+ * A provider that creates and disposes the diagnostic collections used by the
+ * push (`textDocument/publishDiagnostics`) and the pull (`textDocument/diagnostic`)
+ * model. The same provider instance is shared between the client and the
+ * diagnostic pull implementation so that an implementation can decide whether the
+ * two models share the same underlying collection.
+ */
+export interface DiagnosticCollectionProvider {
+	/**
+	 * Creates or returns a diagnostic collection for the given name and source.
+	 *
+	 * @param name the name of the diagnostic collection or `undefined` if no name
+	 * is available.
+	 * @param source whether the collection is requested by the `push` or the
+	 * `pull` model.
+	 */
+	create(name: string | undefined, source: DiagnosticCollectionSource): DiagnosticCollection;
+
+	/**
+	 * Disposes the given diagnostic collection on behalf of the given source.
+	 *
+	 * @param collection the collection to dispose.
+	 * @param source whether the `push` or the `pull` model releases the collection.
+	 */
+	dispose(collection: DiagnosticCollection, source: DiagnosticCollectionSource): void;
+}
+
+/**
+ * The default {@link DiagnosticCollectionProvider}. It never shares a diagnostic
+ * collection between the push and the pull model. Every call to {@link create}
+ * returns a new collection and {@link dispose} disposes it directly.
+ */
+export class DefaultDiagnosticCollectionProvider implements DiagnosticCollectionProvider {
+	public create(name: string | undefined, _source: DiagnosticCollectionSource): DiagnosticCollection {
+		return name !== undefined
+			? Languages.createDiagnosticCollection(name)
+			: Languages.createDiagnosticCollection();
+	}
+
+	public dispose(collection: DiagnosticCollection, _source: DiagnosticCollectionSource): void {
+		collection.dispose();
+	}
+}
+
 export interface FeatureClient<M, CO = object> {
 
 	protocol2CodeConverter: p2c.Converter;