Use NPM package to pull in types for Python Ext (#14007)

* Use NPM package to pull in types for Python Ext * Work around * fix formatting
microsoft · Aug 1, 2023 · dda80e4 · dda80e4
1 parent 438c5b7
commit dda80e4
Show file tree

Hide file tree

Showing 16 changed files with 101 additions and 335 deletions.
diff --git a/build/ci/postInstall.js b/build/ci/postInstall.js
@@ -238,6 +238,31 @@ function verifyMomentIsOnlyUsedByJupyterLabCoreUtils() {
         throw new Error(`Moment is being used by other packages (${otherPackagesUsingMoment.join(', ')}).`);
     }
 }
+
+/**
+ * Work around for https://github.com/microsoft/vscode-python/issues/21720
+ *
+ * The npm package @vscode/python-extension has a peer dependency on @types/vscode.
+ * However Jupyter extensions uses @vscode-dts with the cli arg '-f' instead of @types/vscode.
+ * The webpack builds when running the command `npm list --production --parseable --depth=99999 --loglevel=error`
+ * Work around is to remove the peerDepencency on @types/vscode.
+ */
+function fixPythonExtensionNpmPackageJson() {
+    const jsonFilePath = path.join(
+        __dirname,
+        '..',
+        '..',
+        'node_modules',
+        '@vscode',
+        'python-extension',
+        'package.json'
+    );
+    const packageJson = JSON.parse(fs.readFileSync(jsonFilePath));
+    if (packageJson.peerDependencies && packageJson.peerDependencies['@types/vscode']) {
+        delete packageJson.peerDependencies['@types/vscode'];
+        fs.writeFileSync(jsonFilePath, JSON.stringify(packageJson, undefined, 4));
+    }
+}
 async function downloadZmqBinaries() {
     if (common.getBundleConfiguration() === common.bundleConfiguration.web) {
         // No need to download zmq binaries for web.
@@ -254,6 +279,7 @@ fixVariableNameInKernelDefaultJs();
 removeUnnecessaryLoggingFromKernelDefault();
 updateJSDomTypeDefinition();
 fixStripComments();
+fixPythonExtensionNpmPackageJson();
 verifyMomentIsOnlyUsedByJupyterLabCoreUtils();
 downloadZmqBinaries()
     .then(() => process.exit(0))

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2018,8 +2018,8 @@
         "clean": "gulp clean",
         "updateBuildNumber": "gulp updateBuildNumber",
         "webpack": "webpack",
-        "download-api": "vscode-dts dev",
-        "postdownload-api": "vscode-dts main",
+        "download-api": "vscode-dts dev -f",
+        "postdownload-api": "vscode-dts main -f",
         "generateTelemetry": "gulp generateTelemetry",
         "openInBrowser": "vscode-test-web --extensionDevelopmentPath=. ./src/test/datascience",
         "startJupyterServer": "node build/preDebugWebTest.js",
@@ -2044,6 +2044,7 @@
         "@nteract/messaging": "^7.0.0",
         "@vscode/extension-telemetry": "^0.7.7",
         "@vscode/jupyter-lsp-middleware": "^0.2.50",
+        "@vscode/python-extension": "^1.0.2",
         "ajv-keywords": "^3.5.2",
         "ansi-to-html": "^0.6.7",
         "bootstrap": "^4.3.1",

diff --git a/src/extension.node.ts b/src/extension.node.ts
@@ -79,7 +79,7 @@ import {
     isCI,
     isTestExecution,
     JUPYTER_OUTPUT_CHANNEL,
-    PythonExtension,
+    PythonExtensionId,
     STANDARD_OUTPUT_CHANNEL
 } from './platform/common/constants';
 import { getDisplayPath } from './platform/common/platform/fs-paths';
@@ -283,7 +283,7 @@ function addOutputChannel(context: IExtensionContext, serviceManager: IServiceMa
     // Log env info.
     standardOutputChannel.appendLine(`${env.appName} (${version}, ${env.remoteName}, ${env.appHost})`);
     standardOutputChannel.appendLine(`Jupyter Extension Version: ${context.extension.packageJSON['version']}.`);
-    const pythonExtension = extensions.getExtension(PythonExtension);
+    const pythonExtension = extensions.getExtension(PythonExtensionId);
     if (pythonExtension) {
         standardOutputChannel.appendLine(`Python Extension Version: ${pythonExtension.packageJSON['version']}.`);
     } else {

diff --git a/src/extension.web.ts b/src/extension.web.ts
@@ -89,7 +89,7 @@ import {
     isCI,
     isTestExecution,
     JUPYTER_OUTPUT_CHANNEL,
-    PythonExtension,
+    PythonExtensionId,
     STANDARD_OUTPUT_CHANNEL
 } from './platform/common/constants';
 import { getJupyterOutputChannel } from './standalone/devTools/jupyterOutputChannel';
@@ -257,7 +257,7 @@ function addOutputChannel(context: IExtensionContext, serviceManager: IServiceMa
     // Log env info.
     standardOutputChannel.appendLine(`${env.appName} (${version}, ${env.remoteName}, ${env.appHost})`);
     standardOutputChannel.appendLine(`Jupyter Extension Version: ${context.extension.packageJSON['version']}.`);
-    const pythonExtension = extensions.getExtension(PythonExtension);
+    const pythonExtension = extensions.getExtension(PythonExtensionId);
     if (pythonExtension) {
         standardOutputChannel.appendLine(`Python Extension Version: ${pythonExtension.packageJSON['version']}.`);
     } else {

diff --git a/src/notebooks/controllers/kernelSource/localPythonEnvKernelSourceSelector.node.ts b/src/notebooks/controllers/kernelSource/localPythonEnvKernelSourceSelector.node.ts
@@ -36,11 +36,11 @@ import { JupyterPaths } from '../../../kernels/raw/finder/jupyterPaths.node';
 import { IPythonApiProvider, IPythonExtensionChecker } from '../../../platform/api/types';
 import { pythonEnvToJupyterEnv } from '../../../platform/api/pythonApi';
 import { createInterpreterKernelSpec, getKernelId } from '../../../kernels/helpers';
-import { Environment } from '../../../platform/api/pythonApiTypes';
 import { noop } from '../../../platform/common/utils/misc';
 import { IExtensionSyncActivationService } from '../../../platform/activation/types';
 import { IInterpreterService } from '../../../platform/interpreter/contracts';
 import { KernelFinder } from '../../../kernels/kernelFinder';
+import { Environment } from '@vscode/python-extension';
 
 // Provides the UI to select a Kernel Source for a given notebook document
 @injectable()

diff --git a/src/platform/api/pythonApi.ts b/src/platform/api/pythonApi.ts
@@ -9,7 +9,7 @@ import * as localize from '../common/utils/localize';
 import { injectable, inject } from 'inversify';
 import { sendTelemetryEvent } from '../../telemetry';
 import { IWorkspaceService, IApplicationShell, ICommandManager } from '../common/application/types';
-import { isCI, PythonExtension, Telemetry } from '../common/constants';
+import { isCI, PythonExtensionId, Telemetry } from '../common/constants';
 import { IExtensions, IDisposableRegistry, Resource, IExtensionContext } from '../common/types';
 import { createDeferred, sleep } from '../common/utils/async';
 import { traceError, traceInfo, traceInfoIfCI, traceVerbose, traceWarning } from '../logging';
@@ -20,12 +20,12 @@ import { areInterpreterPathsSame, getInterpreterHash } from '../pythonEnvironmen
 import { EnvironmentType, PythonEnvironment } from '../pythonEnvironments/info';
 import { areObjectsWithUrisTheSame, isUri, noop } from '../common/utils/misc';
 import { StopWatch } from '../common/utils/stopWatch';
-import { Environment, KnownEnvironmentTools, ProposedExtensionAPI, ResolvedEnvironment } from './pythonApiTypes';
 import { PromiseMonitor } from '../common/utils/promises';
 import { PythonExtensionActicationFailedError } from '../errors/pythonExtActivationFailedError';
 import { PythonExtensionApiNotExportedError } from '../errors/pythonExtApiNotExportedError';
 import { getOSType, OSType } from '../common/utils/platform';
 import { SemVer } from 'semver';
+import { ResolvedEnvironment, KnownEnvironmentTools, Environment, PythonExtension } from '@vscode/python-extension';
 
 export function deserializePythonEnvironment(
     pythonVersion: Partial<PythonEnvironment_PythonApi> | undefined,
@@ -254,9 +254,9 @@ export class OldPythonApiProvider implements IPythonApiProvider {
         this.init().catch(noop);
         return this.api.promise;
     }
-    public async getNewApi(): Promise<ProposedExtensionAPI | undefined> {
+    public async getNewApi(): Promise<PythonExtension | undefined> {
         await this.init();
-        const extension = this.extensions.getExtension<ProposedExtensionAPI>(PythonExtension);
+        const extension = this.extensions.getExtension<PythonExtension>(PythonExtensionId);
         if (extension?.packageJSON?.version) {
             this._pythonExtensionVersion = new SemVer(extension?.packageJSON?.version);
         }
@@ -276,7 +276,7 @@ export class OldPythonApiProvider implements IPythonApiProvider {
         if (this.initialized) {
             return;
         }
-        const pythonExtension = this.extensions.getExtension<{ jupyter: { registerHooks(): void } }>(PythonExtension);
+        const pythonExtension = this.extensions.getExtension<{ jupyter: { registerHooks(): void } }>(PythonExtensionId);
         if (!pythonExtension) {
             await this.extensionChecker.showPythonExtensionInstallRequiredPrompt();
         } else {
@@ -288,7 +288,7 @@ export class OldPythonApiProvider implements IPythonApiProvider {
         if (this.hooksRegistered) {
             return;
         }
-        const pythonExtension = this.extensions.getExtension<{ jupyter: { registerHooks(): void } }>(PythonExtension);
+        const pythonExtension = this.extensions.getExtension<{ jupyter: { registerHooks(): void } }>(PythonExtensionId);
         if (!pythonExtension) {
             return;
         }
@@ -347,15 +347,15 @@ export class PythonExtensionChecker implements IPythonExtensionChecker {
     }
 
     public get isPythonExtensionInstalled() {
-        return this.extensions.getExtension(PythonExtension) !== undefined;
+        return this.extensions.getExtension(PythonExtensionId) !== undefined;
     }
     public get isPythonExtensionActive() {
-        return this.extensions.getExtension(PythonExtension)?.isActive === true;
+        return this.extensions.getExtension(PythonExtensionId)?.isActive === true;
     }
 
     // Directly install the python extension instead of just showing the extension open page
     public async directlyInstallPythonExtension(): Promise<void> {
-        return this.commandManager.executeCommand('workbench.extensions.installExtension', PythonExtension, {
+        return this.commandManager.executeCommand('workbench.extensions.installExtension', PythonExtensionId, {
             context: { skipWalkthrough: true }
         });
     }
@@ -386,7 +386,7 @@ export class PythonExtensionChecker implements IPythonExtensionChecker {
     }
     private async installPythonExtension() {
         // Have the user install python
-        this.commandManager.executeCommand('extension.open', PythonExtension).then(noop, noop);
+        this.commandManager.executeCommand('extension.open', PythonExtensionId).then(noop, noop);
     }
 
     private async extensionsChangeHandler(): Promise<void> {
@@ -445,8 +445,8 @@ export class InterpreterService implements IInterpreterService {
     public onDidEnvironmentVariablesChange = this._onDidEnvironmentVariablesChange.event;
     private eventHandlerAdded?: boolean;
     private interpreterListCachePromise: Promise<PythonEnvironment[]> | undefined = undefined;
-    private apiPromise: Promise<ProposedExtensionAPI | undefined> | undefined;
-    private api?: ProposedExtensionAPI;
+    private apiPromise: Promise<PythonExtension | undefined> | undefined;
+    private api?: PythonExtension;
     private _status: 'refreshing' | 'idle' = 'idle';
     public get status() {
         return this._status;
@@ -772,7 +772,7 @@ export class InterpreterService implements IInterpreterService {
         }
         this.pendingInterpretersChangeEventTriggers.clear();
     }
-    private async getApi(): Promise<ProposedExtensionAPI | undefined> {
+    private async getApi(): Promise<PythonExtension | undefined> {
         if (!this.extensionChecker.isPythonExtensionInstalled) {
             return;
         }

diff --git a/src/platform/api/pythonApi.unit.test.ts b/src/platform/api/pythonApi.unit.test.ts
@@ -15,8 +15,8 @@ import {
     ActiveEnvironmentPathChangeEvent,
     EnvironmentsChangeEvent,
     EnvironmentVariablesChangeEvent,
-    ProposedExtensionAPI
-} from './pythonApiTypes';
+    PythonExtension
+} from '@vscode/python-extension';
 import { IPythonApiProvider, IPythonExtensionChecker } from './types';
 
 suite(`Interpreter Service`, () => {
@@ -32,8 +32,8 @@ suite(`Interpreter Service`, () => {
     let onDidChangeActiveEnvironmentPath: EventEmitter<ActiveEnvironmentPathChangeEvent>;
     let onDidChangeEnvironments: EventEmitter<EnvironmentsChangeEvent>;
     let onDidEnvironmentVariablesChange: EventEmitter<EnvironmentVariablesChangeEvent>;
-    let newPythonApi: ProposedExtensionAPI;
-    let environments: ProposedExtensionAPI['environments'];
+    let newPythonApi: PythonExtension;
+    let environments: PythonExtension['environments'];
     setup(() => {
         interpreterService = mock<IInterpreterService>();
         apiProvider = mock<IPythonApiProvider>();
@@ -51,8 +51,8 @@ suite(`Interpreter Service`, () => {
         disposables.push(onDidChangeEnvironments);
         disposables.push(onDidEnvironmentVariablesChange);
 
-        newPythonApi = mock<ProposedExtensionAPI>();
-        environments = mock<ProposedExtensionAPI['environments']>();
+        newPythonApi = mock<PythonExtension>();
+        environments = mock<PythonExtension['environments']>();
         when(newPythonApi.environments).thenReturn(instance(environments));
         when(environments.onDidChangeActiveEnvironmentPath).thenReturn(onDidChangeActiveEnvironmentPath.event);
         when(environments.onDidChangeEnvironments).thenReturn(onDidChangeEnvironments.event);