Fixes #1488: _WindowMiddleware - wrong definition for showDocument (#1489)

Author: dbaeumer

README.md

@@ -40,6 +40,7 @@ After cloning the repository, run `npm install` to install dependencies and `npm
 - snippet support in Workspace edits
 - support to control the parallelism of the dispatch requests and notification. This is a breaking change since it allows notification handlers to return a promise to control this.
 - make client browser implementation consistent with the node implementation in terms of arguments. This is a breaking change since it re-ordered parameter declarations.
+- Added a `CancellationToken` to the show document middleware to make it consistent with the other middleware. This is a breaking change since it added a required parameter.
 
 ## 3.17.5 Protocol, 9.0.1 Client and 9.0.1 Server
 

client/src/common/client.ts

@@ -292,7 +292,7 @@ type _WorkspaceMiddleware = {
 export type WorkspaceMiddleware = _WorkspaceMiddleware & ConfigurationMiddleware & DidChangeConfigurationMiddleware & WorkspaceFolderMiddleware & FileOperationsMiddleware;
 
 interface _WindowMiddleware {
-	showDocument?: (this: void, params: ShowDocumentParams, next: ShowDocumentRequest.HandlerSignature) => Promise<ShowDocumentResult>;
+	showDocument?: ShowDocumentRequest.MiddlewareSignature;
 }
 export type WindowMiddleware = _WindowMiddleware;
 
@@ -1153,7 +1153,7 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 			connection.onNotification(TelemetryEventNotification.type, (data) => {
 				this._telemetryEmitter.fire(data);
 			});
-			connection.onRequest(ShowDocumentRequest.type, async (params): Promise<ShowDocumentResult> => {
+			connection.onRequest(ShowDocumentRequest.type, async (params, token) => {
 				const showDocument = async (params: ShowDocumentParams): Promise<ShowDocumentResult> => {
 					const uri = this.protocol2CodeConverter.asUri(params.uri);
 					try {
@@ -1179,7 +1179,7 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 				};
 				const middleware = this._clientOptions.middleware.window?.showDocument;
 				if (middleware !== undefined)  {
-					return middleware(params, showDocument);
+					return middleware(params, token, showDocument);
 				} else {
 					return showDocument(params);
 				}
@@ -2151,12 +2151,30 @@ interface Connection {
 
 	listen(): void;
 
+	sendRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, token?: CancellationToken): Promise<R>;
+	sendRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, params: P, token?: CancellationToken): Promise<R>;
+	sendRequest<R, E>(type: RequestType0<R, E>, token?: CancellationToken): Promise<R>;
+	sendRequest<P, R, E>(type: RequestType<P, R, E>, params: P, token?: CancellationToken): Promise<R>;
 	sendRequest<R>(type: string | MessageSignature, ...params: any[]): Promise<R>;
+
+	onRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, handler: RequestHandler0<R, E>): Disposable;
+	onRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, handler: RequestHandler<P, R, E>): Disposable;
+	onRequest<R, E>(type: RequestType0<R, E>, handler: RequestHandler0<R, E>): Disposable;
+	onRequest<P, R, E>(type: RequestType<P, R, E>, handler: RequestHandler<P, R, E>): Disposable;
 	onRequest<R, E>(method: string | MessageSignature, handler: GenericRequestHandler<R, E>): Disposable;
 
 	hasPendingResponse(): boolean;
 
+	sendNotification<RO>(type: ProtocolNotificationType0<RO>): Promise<void>;
+	sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): Promise<void>;
+	sendNotification(type: NotificationType0): Promise<void>;
+	sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>;
 	sendNotification(method: string | MessageSignature, params?: any): Promise<void>;
+
+	onNotification<RO>(type: ProtocolNotificationType0<RO>, handler: NotificationHandler0): Disposable;
+	onNotification<P, RO>(type: ProtocolNotificationType<P, RO>, handler: NotificationHandler<P>): Disposable;
+	onNotification(type: NotificationType0, handler: NotificationHandler0): Disposable;
+	onNotification<P>(type: NotificationType<P>, handler: NotificationHandler<P>): Disposable;
 	onNotification(method: string | MessageSignature, handler: GenericNotificationHandler): Disposable;
 
 	onProgress<P>(type: ProgressType<P>, token: string | number, handler: NotificationHandler<P>): Disposable;

package-lock.json

@@ -28,7 +28,7 @@
 		"shx": "^0.3.4",
 		"source-map-support": "^0.5.21",
 		"ts-json-schema-generator": "^1.4.0",
-		"typescript": "^5.2.2",
+		"typescript": "^5.4.5",
 		"webpack": "^5.89.0",
 		"webpack-cli": "^5.1.4",
 		"node-polyfill-webpack-plugin": "^2.0.1"

package.json

@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { HandlerResult, RequestHandler } from 'vscode-jsonrpc';
+import { CancellationToken, HandlerResult, RequestHandler } from 'vscode-jsonrpc';
 import { Range, URI } from 'vscode-languageserver-types';
 import { MessageDirection, ProtocolRequestType } from './messages';
 
@@ -80,5 +80,5 @@ export namespace ShowDocumentRequest {
 	export const messageDirection: MessageDirection = MessageDirection.serverToClient;
 	export const type = new ProtocolRequestType<ShowDocumentParams, ShowDocumentResult, void, void, void>(method);
 	export type HandlerSignature = RequestHandler<ShowDocumentParams, ShowDocumentResult, void>;
-	export type MiddlewareSignature = (params: ShowDocumentParams, next: HandlerSignature) => HandlerResult<ShowDocumentResult, void>;
+	export type MiddlewareSignature = (params: ShowDocumentParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<ShowDocumentResult, void>;
 }