Expose null progress reporter detection

server/src/common/api.ts

@@ -5,10 +5,11 @@
 
 import { _, Features, _Connection, _LanguagesImpl } from './server';
 import { SemanticTokensBuilder } from './semanticTokens';
-import type { WorkDoneProgressReporter, WorkDoneProgressServerReporter, ResultProgressReporter } from './progress';
+import { isNullProgressReporter, type WorkDoneProgressReporter, type WorkDoneProgressServerReporter, type ResultProgressReporter } from './progress';
 
 export * from 'vscode-languageserver-protocol';
 export { WorkDoneProgressReporter, WorkDoneProgressServerReporter, ResultProgressReporter };
+export { isNullProgressReporter };
 export { SemanticTokensBuilder };
 import { TextDocuments, TextDocumentsConfiguration, TextDocumentChangeEvent, TextDocumentWillSaveEvent } from './textDocuments';
 export { TextDocuments, TextDocumentsConfiguration, TextDocumentChangeEvent, TextDocumentWillSaveEvent };
@@ -22,4 +23,4 @@ export namespace ProposedFeatures {
 	};
 
 	export type Connection = _Connection<_, _, _, _, _, _, _, _>;
-}
+}

server/src/common/progress.ts

@@ -143,6 +143,13 @@ class NullProgressServerReporter extends NullProgressReporter implements WorkDon
 	}
 }
 
+/**
+ * Tests whether the given work done progress reporter discards progress.
+ */
+export function isNullProgressReporter(reporter: WorkDoneProgressReporter): boolean {
+	return reporter instanceof NullProgressReporter;
+}
+
 export function attachWorkDone(connection: ProgressContext, params: WorkDoneProgressParams | undefined): WorkDoneProgressReporter {
 	if (params === undefined || params.workDoneToken === undefined) {
 		return new NullProgressReporter();

server/src/node/test/connection.test.ts

@@ -10,7 +10,7 @@ import { Duplex } from 'stream';
 import {
 	InitializeParams, InitializeRequest, InitializeResult, createConnection, DidChangeConfigurationNotification,
 	DidChangeConfigurationParams, Connection, DeclarationRequest, DeclarationParams, ProgressToken, WorkDoneProgress,
-	LocationLink
+	LocationLink, isNullProgressReporter
 } from '../main';
 
 class TestStream extends Duplex {
@@ -73,6 +73,7 @@ suite('Connection Tests', () => {
 	test('Ensure work done converted', (done) => {
 		serverConnection.onDeclaration((_params, _cancel, workDone, result) => {
 			assert.ok(workDone !== undefined, 'Work Done token converted.');
+			assert.ok(!isNullProgressReporter(workDone), 'Work Done token uses a progress reporter.');
 			assert.ok(result === undefined, 'Result token undefined.');
 			done();
 			return [];
@@ -89,7 +90,7 @@ suite('Connection Tests', () => {
 
 	test('Ensure result converted', (done) => {
 		serverConnection.onDeclaration((_params, _cancel, workDone, result) => {
-			assert.ok(workDone === undefined || workDone.constructor.name === 'NullProgressReporter', 'Work Done token undefined or null progress.');
+			assert.ok(isNullProgressReporter(workDone), 'Work Done token uses a null progress reporter.');
 			assert.ok(result !== undefined, 'Result token converted.');
 			done();
 			return [];
@@ -177,4 +178,4 @@ suite('Connection Tests', () => {
 			done();
 		});
 	});
-});
+});