Upgrade to LSP 3.17 for LSP notebooks support (#18742)

* Fix sendCancellation

* Upgrade vscode-jupyter-lsp-middleware

* Update to latest LSP packages

* Update vscode.proposed.notebookEditor.d.ts

* Remove proposed api d.ts files that are no longer listed in package.json

* Update mocks

* Upgrade to @types/vscode 1.65.0

* Generate package-lock.json with NPM 8.5.2

* Upgrade to vscode-jupyter-lsp-middleware 0.2.40 to try to fix vscode-dts issue

* Upgrade to vscode-jupyter-lsp-middleware 0.2.41 to try to fix vscode-dts issue

* Back up to previous dot release of LSP which was dependent on VSC 1.63.0 instead of 1.66.0

* Add mocks to fix unit tests

* Remove vscode-dts devDependency; no longer needed with middleware change

* Upgrade webpack to fix Create VSIX error

* Switch to latest webpack 4 and upgrade plugins

* Reupgrade webpack to 5.x; upgrade ts-loader, copy-webpack-plugin

* Add webpack resolve fallback to path-browserify

* locators/index.ts -> wrappers.ts (webpack issues)

Co-authored-by: Kim-Adeline Miguel <[email protected]>

Author: debonte

build/webpack/webpack.extension.browser.config.js

@@ -32,6 +32,7 @@ const nodeConfig = (_, { mode }) => ({
     // },
     resolve: {
         extensions: ['.ts', '.js'],
+        fallback: { path: require.resolve('path-browserify') },
     },
     externals: {
         vscode: 'commonjs vscode',

build/webpack/webpack.extension.dependencies.config.js

@@ -28,7 +28,7 @@ const config = {
         // vsls requires our package.json to be next to node_modules. It's how they
         // 'find' the calling extension.
         // eslint-disable-next-line new-cap
-        new copyWebpackPlugin([{ from: './package.json', to: '.' }]),
+        new copyWebpackPlugin({ patterns: [{ from: './package.json', to: '.' }] }),
     ],
     resolve: {
         extensions: ['.js'],

package-lock.json

@@ -42,7 +42,7 @@
         "theme": "dark"
     },
     "engines": {
-        "vscode": "^1.63.1"
+        "vscode": "^1.65.0"
     },
     "keywords": [
         "python",
@@ -1828,7 +1828,7 @@
         "webpack": "webpack"
     },
     "dependencies": {
-        "@vscode/jupyter-lsp-middleware": "^0.2.35",
+        "@vscode/jupyter-lsp-middleware": "^0.2.41",
         "arch": "^2.1.0",
         "diff-match-patch": "^1.0.0",
         "fs-extra": "^9.1.0",
@@ -1856,10 +1856,10 @@
         "vscode-debugadapter": "^1.28.0",
         "vscode-debugprotocol": "^1.28.0",
         "vscode-extension-telemetry": "0.4.5",
-        "vscode-jsonrpc": "6.0.0",
-        "vscode-languageclient": "7.0.0",
-        "vscode-languageserver": "7.0.0",
-        "vscode-languageserver-protocol": "3.16.0",
+        "vscode-jsonrpc": "8.0.0-next.7",
+        "vscode-languageclient": "8.0.0-next.13",
+        "vscode-languageserver": "8.0.0-next.9",
+        "vscode-languageserver-protocol": "3.17.0-next.15",
         "vscode-tas-client": "^0.1.22",
         "winreg": "^1.2.4",
         "xml2js": "^0.4.19"
@@ -1886,7 +1886,7 @@
         "@types/tmp": "0.0.33",
         "@types/untildify": "^3.0.0",
         "@types/uuid": "^3.4.3",
-        "@types/vscode": "~1.63.0",
+        "@types/vscode": "~1.65.0",
         "@types/winreg": "^1.2.30",
         "@types/xml2js": "^0.4.2",
         "@typescript-eslint/eslint-plugin": "^3.7.0",
@@ -1895,7 +1895,7 @@
         "chai": "^4.1.2",
         "chai-arrays": "^2.0.0",
         "chai-as-promised": "^7.1.1",
-        "copy-webpack-plugin": "^5.1.2",
+        "copy-webpack-plugin": "^9.1.0",
         "cross-spawn": "^6.0.5",
         "del": "^3.0.0",
         "download": "^7.0.0",
@@ -1929,7 +1929,7 @@
         "shortid": "^2.2.8",
         "sinon": "^8.0.1",
         "source-map-support": "^0.5.12",
-        "ts-loader": "^5.3.0",
+        "ts-loader": "^9.2.8",
         "ts-mockito": "^2.5.0",
         "ts-node": "^8.3.0",
         "tsconfig-paths-webpack-plugin": "^3.2.0",
@@ -1939,13 +1939,13 @@
         "vsce": "^2.6.6",
         "vscode-debugadapter-testsupport": "^1.27.0",
         "vscode-telemetry-extractor": "^1.9.5",
-        "webpack": "^4.33.0",
-        "webpack-bundle-analyzer": "^3.6.0",
+        "webpack": "^5.70.0",
+        "webpack-bundle-analyzer": "^4.5.0",
         "webpack-cli": "^3.1.2",
         "webpack-fix-default-import-plugin": "^1.0.3",
-        "webpack-merge": "^4.1.4",
-        "webpack-node-externals": "^1.7.2",
-        "webpack-require-from": "^1.8.0",
+        "webpack-merge": "^5.8.0",
+        "webpack-node-externals": "^3.0.0",
+        "webpack-require-from": "^1.8.6",
         "yargs": "^15.3.1"
     },
     "__metadata": {

package.json

@@ -43,7 +43,7 @@ class FileCancellationSenderStrategy implements CancellationSenderStrategy {
         tryRun(() => fs.mkdirSync(folder, { recursive: true }));
     }
 
-    public sendCancellation(_: MessageConnection, id: CancellationId): void {
+    public async sendCancellation(_: MessageConnection, id: CancellationId) {
         const file = getCancellationFilePath(this.folderName, id);
         tryRun(() => fs.writeFileSync(file, '', { flag: 'w' }));
     }

src/client/activation/common/cancellationUtils.ts

@@ -6,6 +6,7 @@ import {
     ConfigurationParams,
     ConfigurationRequest,
     HandleDiagnosticsSignature,
+    LSPObject,
     Middleware,
     ResponseError,
 } from 'vscode-languageclient';
@@ -82,12 +83,13 @@ export class LanguageClientMiddlewareBase implements Middleware {
                     // value as though it were in the user's settings.json file.
                     // As this is for backwards compatibility, `ConfigService.pythonPath`
                     // can be considered as active interpreter path.
-                    settings[i].pythonPath = configService.getSettings(uri).pythonPath;
+                    const settingDict: LSPObject = settings[i] as LSPObject;
+                    settingDict.pythonPath = configService.getSettings(uri).pythonPath;
 
                     const env = await envService.getEnvironmentVariables(uri);
                     const envPYTHONPATH = env.PYTHONPATH;
                     if (envPYTHONPATH) {
-                        settings[i]._envPYTHONPATH = envPYTHONPATH;
+                        settingDict._envPYTHONPATH = envPYTHONPATH;
                     }
                 }
             }

src/client/activation/languageClientMiddlewareBase.ts

@@ -13,7 +13,7 @@ import { PythonEnvsResolver } from './base/locators/composite/envsResolver';
 import { WindowsPathEnvVarLocator } from './base/locators/lowLevel/windowsKnownPathsLocator';
 import { WorkspaceVirtualEnvironmentLocator } from './base/locators/lowLevel/workspaceVirtualEnvLocator';
 import { initializeExternalDependencies as initializeLegacyExternalDependencies } from './common/externalDependencies';
-import { ExtensionLocators, WatchRootsArgs, WorkspaceLocators } from './base/locators/';
+import { ExtensionLocators, WatchRootsArgs, WorkspaceLocators } from './base/locators/wrappers';
 import { CustomVirtualEnvironmentLocator } from './base/locators/lowLevel/customVirtualEnvLocator';
 import { CondaEnvironmentLocator } from './base/locators/lowLevel/condaLocator';
 import { GlobalVirtualEnvironmentLocator } from './base/locators/lowLevel/globalVirtualEnvronmentLocator';

src/client/pythonEnvironments/base/locators/index.ts renamed to src/client/pythonEnvironments/base/locators/wrappers.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable max-classes-per-file */
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
@@ -2078,6 +2080,8 @@ export enum ConfigurationTarget {
 }
 
 export class RelativePattern implements IRelativePattern {
+    baseUri: vscode.Uri;
+
     base: string;
 
     pattern: string;
@@ -2093,6 +2097,7 @@ export class RelativePattern implements IRelativePattern {
             throw illegalArgument('pattern');
         }
 
+        this.baseUri = typeof base === 'string' ? vscUri.URI.parse(base) : base.uri;
         this.base = typeof base === 'string' ? base : base.uri.fsPath;
         this.pattern = pattern;
     }
@@ -2279,3 +2284,72 @@ export enum CommentThreadCollapsibleState {
 export class QuickInputButtons {
     static readonly Back: vscode.QuickInputButton = { iconPath: vscUri.URI.file('back') };
 }
+
+export enum SymbolTag {
+    Deprecated = 1,
+}
+
+export class TypeHierarchyItem {
+    name: string;
+
+    kind: SymbolKind;
+
+    tags?: ReadonlyArray<SymbolTag>;
+
+    detail?: string;
+
+    uri: vscode.Uri;
+
+    range: Range;
+
+    selectionRange: Range;
+
+    constructor(kind: SymbolKind, name: string, detail: string, uri: vscode.Uri, range: Range, selectionRange: Range) {
+        this.name = name;
+        this.kind = kind;
+        this.detail = detail;
+        this.uri = uri;
+        this.range = range;
+        this.selectionRange = selectionRange;
+    }
+}
+
+export declare type LSPObject = {
+    [key: string]: LSPAny;
+};
+
+export declare type LSPArray = LSPAny[];
+
+export declare type integer = number;
+export declare type uinteger = number;
+export declare type decimal = number;
+
+export declare type LSPAny = LSPObject | LSPArray | string | integer | uinteger | decimal | boolean | null;
+
+export class ProtocolTypeHierarchyItem extends TypeHierarchyItem {
+    data?;
+
+    constructor(
+        kind: SymbolKind,
+        name: string,
+        detail: string,
+        uri: vscode.Uri,
+        range: Range,
+        selectionRange: Range,
+        data?: LSPAny,
+    ) {
+        super(kind, name, detail, uri, range, selectionRange);
+        this.data = data;
+    }
+}
+
+export class CancellationError extends Error {}
+
+export class LSPCancellationError extends CancellationError {
+    data;
+
+    constructor(data: any) {
+        super();
+        this.data = data;
+    }
+}

src/client/pythonEnvironments/index.ts

@@ -37,7 +37,7 @@ export enum LanguageStatusSeverity {
 
 export enum QuickPickItemKind {
     Separator = -1,
-    Default = 1,
+    Default = 0,
 }
 
 export class Disposable {