Update use of python extension environment api (#253)

* update package

* update api calls

* uUpdate the getInterpreter function

* fix lint

* fix tests

* activate extension

* install python for tests

* add console logs

* fix test for windows

* fix test in linux

* clean test code

* Update src/test/runTest.ts

Co-authored-by: Kartik Raj <[email protected]>

* fix import

---------

Co-authored-by: Kartik Raj <[email protected]>

Author: paulacamargo25

package-lock.json

@@ -23,7 +23,7 @@
         "debugpy"
     ],
     "engines": {
-        "vscode": "^1.86.0"
+        "vscode": "^1.87.0"
     },
     "categories": [
         "Debuggers"
@@ -484,6 +484,9 @@
             }
         ]
     },
+    "extensionDependencies": [
+        "ms-python.python"
+    ],
     "scripts": {
         "vscode:prepublish": "npm run package",
         "compile": "webpack",
@@ -508,7 +511,7 @@
         "@types/node": "18.x",
         "@types/semver": "^7.3.13",
         "@types/sinon": "^10.0.13",
-        "@types/vscode": "^1.78.0",
+        "@types/vscode": "^1.87.0",
         "@typescript-eslint/eslint-plugin": "^5.31.0",
         "@typescript-eslint/parser": "^5.62.0",
         "@vscode/test-electron": "^2.3.9",
@@ -532,6 +535,7 @@
     },
     "dependencies": {
         "@vscode/extension-telemetry": "^0.8.5",
+        "@vscode/python-extension": "^1.0.5",
         "fs-extra": "^11.2.0",
         "iconv-lite": "^0.6.3",
         "inversify": "^6.0.1",

package.json

@@ -2,37 +2,13 @@
 // Licensed under the MIT License.
 
 /* eslint-disable @typescript-eslint/naming-convention */
-import { commands, Disposable, Event, EventEmitter, extensions, Uri } from 'vscode';
-import { traceError, traceLog } from './log/logging';
-import { EnvironmentVariables } from './variables/types';
-import {
-    ActiveEnvironmentPathChangeEvent,
-    Environment,
-    EnvironmentPath,
-    EnvironmentsChangeEvent,
-    RefreshOptions,
-    ResolvedEnvironment,
-    Resource,
-} from './pythonTypes';
+import { Environment, EnvironmentPath, PythonExtension, Resource } from '@vscode/python-extension';
+import { commands, EventEmitter, extensions, Uri, Event, Disposable } from 'vscode';
 import { createDeferred } from './utils/async';
+import { traceError, traceLog } from './log/logging';
 
 interface IExtensionApi {
     ready: Promise<void>;
-    debug: {
-        getRemoteLauncherCommand(host: string, port: number, waitUntilDebuggerAttaches: boolean): Promise<string[]>;
-        getDebuggerPackagePath(): Promise<string | undefined>;
-    };
-    environments: {
-        known: Environment[];
-        getActiveEnvironmentPath(resource?: Resource): EnvironmentPath;
-        resolveEnvironment(
-            environment: Environment | EnvironmentPath | string | undefined,
-        ): Promise<ResolvedEnvironment | undefined>;
-        readonly onDidChangeActiveEnvironmentPath: Event<ActiveEnvironmentPathChangeEvent>;
-        getEnvironmentVariables(resource?: Resource): EnvironmentVariables;
-        refreshEnvironments(options?: RefreshOptions): Promise<void>;
-        readonly onDidChangeEnvironments: Event<EnvironmentsChangeEvent>;
-    };
     settings: {
         getExecutionDetails(resource?: Resource): { execCommand: string[] | undefined };
     };
@@ -45,7 +21,6 @@ export interface IInterpreterDetails {
 
 const onDidChangePythonInterpreterEvent = new EventEmitter<IInterpreterDetails>();
 export const onDidChangePythonInterpreter: Event<IInterpreterDetails> = onDidChangePythonInterpreterEvent.event;
-
 async function activateExtension() {
     const extension = extensions.getExtension('ms-python.python');
     if (extension) {
@@ -61,9 +36,15 @@ async function getPythonExtensionAPI(): Promise<IExtensionApi | undefined> {
     return extension?.exports as IExtensionApi;
 }
 
+async function getPythonExtensionEnviromentAPI(): Promise<PythonExtension> {
+    // Load the Python extension API
+    await activateExtension();
+    return await PythonExtension.api();
+}
+
 export async function initializePython(disposables: Disposable[]): Promise<void> {
     try {
-        const api = await getPythonExtensionAPI();
+        const api = await getPythonExtensionEnviromentAPI();
 
         if (api) {
             disposables.push(
@@ -80,11 +61,6 @@ export async function initializePython(disposables: Disposable[]): Promise<void>
     }
 }
 
-export async function getDebuggerPath(): Promise<string | undefined> {
-    const api = await getPythonExtensionAPI();
-    return api?.debug.getDebuggerPackagePath();
-}
-
 export async function runPythonExtensionCommand(command: string, ...rest: any[]) {
     await activateExtension();
     return await commands.executeCommand(command, ...rest);
@@ -96,51 +72,47 @@ export async function getSettingsPythonPath(resource?: Uri): Promise<string[] |
 }
 
 export async function getEnvironmentVariables(resource?: Resource) {
-    const api = await getPythonExtensionAPI();
-    return api?.environments.getEnvironmentVariables(resource);
+    const api = await getPythonExtensionEnviromentAPI();
+    return api.environments.getEnvironmentVariables(resource);
 }
 
-export async function resolveEnvironment(env: Environment | EnvironmentPath | string | undefined) {
-    const api = await getPythonExtensionAPI();
-    return api?.environments.resolveEnvironment(env);
+export async function resolveEnvironment(env: Environment | EnvironmentPath | string) {
+    const api = await getPythonExtensionEnviromentAPI();
+    return api.environments.resolveEnvironment(env);
 }
 
 export async function getActiveEnvironmentPath(resource?: Resource) {
-    const api = await getPythonExtensionAPI();
-    return api?.environments.getActiveEnvironmentPath(resource);
+    const api = await getPythonExtensionEnviromentAPI();
+    return api.environments.getActiveEnvironmentPath(resource);
 }
 
 export async function getInterpreterDetails(resource?: Uri): Promise<IInterpreterDetails> {
-    const api = await getPythonExtensionAPI();
-    const environment = await api?.environments.resolveEnvironment(
-        api?.environments.getActiveEnvironmentPath(resource),
-    );
+    const api = await getPythonExtensionEnviromentAPI();
+    const environment = await api.environments.resolveEnvironment(api.environments.getActiveEnvironmentPath(resource));
     if (environment?.executable.uri) {
         return { path: [environment?.executable.uri.fsPath], resource };
     }
     return { path: undefined, resource };
 }
 
 export async function hasInterpreters() {
-    const api = await getPythonExtensionAPI();
-    if (api) {
-        const onAddedToCollection = createDeferred();
-        api?.environments.onDidChangeEnvironments(async () => {
-            if (api.environments.known) {
-                onAddedToCollection.resolve();
-            }
-        });
-        const initialEnvs = api.environments.known;
-        if (initialEnvs.length > 0) {
-            return true;
+    const api = await getPythonExtensionEnviromentAPI();
+    const onAddedToCollection = createDeferred();
+    api.environments.onDidChangeEnvironments(async () => {
+        if (api.environments.known) {
+            onAddedToCollection.resolve();
         }
-        await Promise.race([onAddedToCollection.promise, api?.environments.refreshEnvironments()]);
-
-        return api.environments.known.length > 0;
+    });
+    const initialEnvs = api.environments.known;
+    if (initialEnvs.length > 0) {
+        return true;
     }
+    await Promise.race([onAddedToCollection.promise, api?.environments.refreshEnvironments()]);
+
+    return api.environments.known.length > 0;
 }
 
 export async function getInterpreters() {
-    const api = await getPythonExtensionAPI();
-    return api?.environments.known || [];
+    const api = await getPythonExtensionEnviromentAPI();
+    return api.environments.known || [];
 }