Do not attempt to launch Jedi language server in case when selected Python interpreter is invalid (#19449)

Kartik Raj · web-flow · commit 58e6409a8383 · 2022-07-11T16:01:14.000-07:00
* Do not attempt to launch Jedi server in case when selected Python interpreter is invalid

* Improve logging

* Oops
diff --git a/src/client/languageServer/jediLSExtensionManager.ts b/src/client/languageServer/jediLSExtensionManager.ts
@@ -17,6 +17,7 @@ import {
 import { IEnvironmentVariablesProvider } from '../common/variables/types';
 import { IInterpreterService } from '../interpreter/contracts';
 import { IServiceContainer } from '../ioc/types';
+import { traceError } from '../logging';
 import { PythonEnvironment } from '../pythonEnvironments/info';
 import { LanguageServerCapabilities } from './languageServerCapabilities';
 import { ILanguageServerExtensionManager } from './types';
@@ -78,10 +79,13 @@ export class JediLSExtensionManager extends LanguageServerCapabilities
     }
 
     // eslint-disable-next-line class-methods-use-this
-    canStartLanguageServer(): boolean {
-        // Return true for now since it's shipped with the extension.
+    canStartLanguageServer(interpreter: PythonEnvironment | undefined): boolean {
+        if (!interpreter) {
+            traceError('Unable to start Jedi language server as a valid interpreter is not selected');
+            return false;
+        }
+        // Otherwise return true for now since it's shipped with the extension.
         // Update this when JediLSP is pulled in a separate extension.
-
         return true;
     }
 
diff --git a/src/client/languageServer/types.ts b/src/client/languageServer/types.ts
@@ -31,7 +31,7 @@ export interface ILanguageServerCapabilities extends ILanguageServer {
 export interface ILanguageServerExtensionManager extends ILanguageServerCapabilities {
     startLanguageServer(resource: Resource, interpreter?: PythonEnvironment): Promise<void>;
     stopLanguageServer(): Promise<void>;
-    canStartLanguageServer(): boolean;
+    canStartLanguageServer(interpreter: PythonEnvironment | undefined): boolean;
     languageServerNotAvailable(): Promise<void>;
     dispose(): void;
 }
diff --git a/src/client/languageServer/watcher.ts b/src/client/languageServer/watcher.ts
@@ -180,7 +180,7 @@ export class LanguageServerWatcher
         const languageServerExtensionManager = this.createLanguageServer(serverType);
         this.workspaceLanguageServers.set(key, languageServerExtensionManager);
 
-        if (languageServerExtensionManager.canStartLanguageServer()) {
+        if (languageServerExtensionManager.canStartLanguageServer(interpreter)) {
             // Start the language server.
             await languageServerExtensionManager.startLanguageServer(lsResource, interpreter);
 
diff --git a/src/test/languageServer/jediLSExtensionManager.unit.test.ts b/src/test/languageServer/jediLSExtensionManager.unit.test.ts
@@ -9,6 +9,7 @@ import { IEnvironmentVariablesProvider } from '../../client/common/variables/typ
 import { IInterpreterService } from '../../client/interpreter/contracts';
 import { IServiceContainer } from '../../client/ioc/types';
 import { JediLSExtensionManager } from '../../client/languageServer/jediLSExtensionManager';
+import { PythonEnvironment } from '../../client/pythonEnvironments/info';
 
 suite('Language Server - Jedi LS extension manager', () => {
     let manager: JediLSExtensionManager;
@@ -37,9 +38,17 @@ suite('Language Server - Jedi LS extension manager', () => {
         assert.notStrictEqual(manager.serverProxy, undefined);
     });
 
-    test('canStartLanguageServer should return true', () => {
-        const result = manager.canStartLanguageServer();
+    test('canStartLanguageServer should return true if an interpreter is passed in', () => {
+        const result = manager.canStartLanguageServer(({
+            path: 'path/to/interpreter',
+        } as unknown) as PythonEnvironment);
 
         assert.strictEqual(result, true);
     });
+
+    test('canStartLanguageServer should return false otherwise', () => {
+        const result = manager.canStartLanguageServer(undefined);
+
+        assert.strictEqual(result, false);
+    });
 });

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export interface ILanguageServerCapabilities extends ILanguageServer {`
`31`	`31`	`export interface ILanguageServerExtensionManager extends ILanguageServerCapabilities {`
`32`	`32`	`startLanguageServer(resource: Resource, interpreter?: PythonEnvironment): Promise<void>;`
`33`	`33`	`stopLanguageServer(): Promise<void>;`
`34`		`- canStartLanguageServer(): boolean;`
	`34`	`+ canStartLanguageServer(interpreter: PythonEnvironment \| undefined): boolean;`
`35`	`35`	`languageServerNotAvailable(): Promise<void>;`
`36`	`36`	`dispose(): void;`
`37`	`37`	`}`