Provide better error messages if python and robot environment not matches RobotCode requirements, fixes #40

d-biehl · d-biehl · commit 3575d2a9682b · 2022-03-26T17:25:34.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/robotcode/jsonrpc2/server.py b/robotcode/jsonrpc2/server.py
@@ -10,7 +10,6 @@
     Callable,
     Coroutine,
     Generic,
-    Literal,
     NamedTuple,
     Optional,
     Type,
@@ -147,7 +146,7 @@ async def __aexit__(
         exception_type: Optional[Type[BaseException]],
         exception_value: Optional[BaseException],
         traceback: Optional[TracebackType],
-    ) -> Literal[False]:
+    ) -> bool:
         await self.close_async()
         return False
 
@@ -160,9 +159,8 @@ def __exit__(
         exception_type: Optional[Type[BaseException]],
         exception_value: Optional[BaseException],
         traceback: Optional[TracebackType],
-    ) -> Literal[False]:
+    ) -> None:
         self.close()
-        return False
 
     @abc.abstractmethod
     def create_protocol(self) -> TProtocol:
diff --git a/robotcode/language_server/robotframework/diagnostics/analyzer.py b/robotcode/language_server/robotframework/diagnostics/analyzer.py
@@ -18,7 +18,7 @@
 )
 from ...common.text_document import TextDocument
 from ..parts.model_helper import ModelHelperMixin
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Statement,
     Token,
diff --git a/robotcode/language_server/robotframework/diagnostics/entities.py b/robotcode/language_server/robotframework/diagnostics/entities.py
@@ -3,7 +3,7 @@
 from typing import Any, Optional, Tuple
 
 from ...common.lsp_types import Position, Range
-from ..utils.ast import Token
+from ..utils.ast_utils import Token
 
 
 @dataclass
diff --git a/robotcode/language_server/robotframework/diagnostics/imports_manager.py b/robotcode/language_server/robotframework/diagnostics/imports_manager.py
@@ -807,7 +807,7 @@ async def get_libdoc_from_model(
         from robot.running.usererrorhandler import UserErrorHandler
         from robot.running.userkeyword import UserLibrary
 
-        from ..utils.ast import HasError, HasErrors
+        from ..utils.ast_utils import HasError, HasErrors
 
         errors: List[Error] = []
 
diff --git a/robotcode/language_server/robotframework/diagnostics/namespace.py b/robotcode/language_server/robotframework/diagnostics/namespace.py
@@ -39,7 +39,7 @@
     Range,
 )
 from ...common.text_document import TextDocument
-from ..utils.ast import (
+from ..utils.ast_utils import (
     Token,
     range_from_node,
     range_from_token,
diff --git a/robotcode/language_server/robotframework/parts/codelens.py b/robotcode/language_server/robotframework/parts/codelens.py
@@ -8,7 +8,7 @@
 from ...common.decorators import language_id
 from ...common.lsp_types import CodeLens, Command
 from ...common.text_document import TextDocument
-from ..utils.ast import range_from_token
+from ..utils.ast_utils import range_from_token
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
diff --git a/robotcode/language_server/robotframework/parts/completion.py b/robotcode/language_server/robotframework/parts/completion.py
@@ -48,7 +48,7 @@
     KeywordMatcher,
 )
 from ..diagnostics.namespace import Namespace
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Token,
     get_nodes_at_position,
diff --git a/robotcode/language_server/robotframework/parts/debugging_utils.py b/robotcode/language_server/robotframework/parts/debugging_utils.py
@@ -9,7 +9,7 @@
 from ....utils.async_tools import run_coroutine_in_thread
 from ....utils.logging import LoggingDescriptor
 from ...common.lsp_types import Model, Position, Range, TextDocumentIdentifier
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Statement,
     Token,
diff --git a/robotcode/language_server/robotframework/parts/diagnostics.py b/robotcode/language_server/robotframework/parts/diagnostics.py
@@ -11,7 +11,12 @@
 from ...common.parts.diagnostics import DiagnosticsResult
 from ...common.text_document import TextDocument
 from ..diagnostics.analyzer import Analyzer
-from ..utils.ast import HeaderAndBodyBlock, Token, range_from_node, range_from_token
+from ..utils.ast_utils import (
+    HeaderAndBodyBlock,
+    Token,
+    range_from_node,
+    range_from_token,
+)
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
@@ -172,7 +177,7 @@ async def collect_token_errors(self, sender: Any, document: TextDocument) -> Dia
     @_logger.call
     async def collect_model_errors(self, sender: Any, document: TextDocument) -> DiagnosticsResult:
 
-        from ..utils.ast import HasError, HasErrors
+        from ..utils.ast_utils import HasError, HasErrors
         from ..utils.async_ast import iter_nodes
 
         try:
diff --git a/robotcode/language_server/robotframework/parts/document_highlight.py b/robotcode/language_server/robotframework/parts/document_highlight.py
@@ -21,7 +21,7 @@
 from ...common.lsp_types import DocumentHighlight, DocumentHighlightKind, Position
 from ...common.text_document import TextDocument
 from ..diagnostics.entities import VariableDefinition
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Statement,
     Token,
diff --git a/robotcode/language_server/robotframework/parts/document_symbols.py b/robotcode/language_server/robotframework/parts/document_symbols.py
@@ -9,7 +9,12 @@
 from ...common.decorators import language_id
 from ...common.lsp_types import DocumentSymbol, SymbolInformation, SymbolKind
 from ...common.text_document import TextDocument
-from ..utils.ast import Token, range_from_node, range_from_token, tokenize_variables
+from ..utils.ast_utils import (
+    Token,
+    range_from_node,
+    range_from_token,
+    tokenize_variables,
+)
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
diff --git a/robotcode/language_server/robotframework/parts/documents_cache.py b/robotcode/language_server/robotframework/parts/documents_cache.py
@@ -27,7 +27,7 @@
 from ..configuration import RobotConfig
 from ..diagnostics.imports_manager import ImportsManager
 from ..diagnostics.namespace import DocumentType, Namespace
-from ..utils.ast import Token
+from ..utils.ast_utils import Token
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
diff --git a/robotcode/language_server/robotframework/parts/goto.py b/robotcode/language_server/robotframework/parts/goto.py
@@ -22,7 +22,7 @@
 from ...common.decorators import language_id
 from ...common.lsp_types import Location, LocationLink, Position
 from ...common.text_document import TextDocument
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Token,
     get_nodes_at_position,
diff --git a/robotcode/language_server/robotframework/parts/hover.py b/robotcode/language_server/robotframework/parts/hover.py
@@ -20,7 +20,7 @@
 from ...common.decorators import language_id
 from ...common.lsp_types import Hover, MarkupContent, MarkupKind, Position
 from ...common.text_document import TextDocument
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Token,
     get_nodes_at_position,
diff --git a/robotcode/language_server/robotframework/parts/model_helper.py b/robotcode/language_server/robotframework/parts/model_helper.py
@@ -21,7 +21,7 @@
 from ..diagnostics.entities import VariableDefinition, VariableNotFoundDefinition
 from ..diagnostics.library_doc import KeywordDoc, KeywordError
 from ..diagnostics.namespace import LibraryEntry, Namespace
-from ..utils.ast import (
+from ..utils.ast_utils import (
     Token,
     is_not_variable_token,
     iter_over_keyword_names_and_owners,
diff --git a/robotcode/language_server/robotframework/parts/references.py b/robotcode/language_server/robotframework/parts/references.py
@@ -41,7 +41,7 @@
     LibraryDoc,
 )
 from ..diagnostics.namespace import Namespace
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Statement,
     Token,
diff --git a/robotcode/language_server/robotframework/parts/semantic_tokens.py b/robotcode/language_server/robotframework/parts/semantic_tokens.py
@@ -45,7 +45,7 @@
 )
 from ..diagnostics.namespace import LibraryEntry, Namespace, ResourceEntry
 from ..utils import async_ast
-from ..utils.ast import (
+from ..utils.ast_utils import (
     HasTokens,
     Token,
     is_not_variable_token,
diff --git a/robotcode/language_server/robotframework/parts/signature_help.py b/robotcode/language_server/robotframework/parts/signature_help.py
@@ -28,7 +28,7 @@
 )
 from ...common.text_document import TextDocument
 from ..diagnostics.library_doc import KeywordDoc, LibraryDoc
-from ..utils.ast import (
+from ..utils.ast_utils import (
     Token,
     get_node_at_position,
     get_tokens_at_position,
diff --git a/robotcode/language_server/robotframework/utils/ast_utils.py b/robotcode/language_server/robotframework/utils/ast_utils.py
diff --git a/robotcode/language_server/robotframework/utils/version.py b/robotcode/language_server/robotframework/utils/version.py
@@ -51,3 +51,7 @@ def s_to_i(s: Optional[str]) -> Optional[int]:
         raise InvalidRobotVersionError() from ex
 
     raise InvalidRobotVersionError()
+
+
+if __name__ == "__main__":
+    print(get_robot_version() >= (4, 0))
diff --git a/vscode-client/extension.ts b/vscode-client/extension.ts
@@ -67,7 +67,7 @@ export async function activateAsync(context: vscode.ExtensionContext): Promise<v
     vscode.workspace.onDidChangeConfiguration(async (event) => {
       for (const s of ["robotcode.python", "robotcode.languageServer", "robotcode.robot", "robotcode.robocop"]) {
         if (event.affectsConfiguration(s)) {
-          await languageClientManger.refresh();
+          await languageClientManger.restart();
         }
       }
     })
diff --git a/vscode-client/languageclientsmanger.ts b/vscode-client/languageclientsmanger.ts
@@ -91,6 +91,7 @@ export class LanguageClientsManager {
   public readonly outputChannels: Map<string, vscode.OutputChannel> = new Map();
 
   private _disposables: vscode.Disposable;
+  private _pythonValidPythonAndRobotEnv = new WeakMap<vscode.WorkspaceFolder, boolean>();
 
   private readonly _onClientStateChangedEmitter = new vscode.EventEmitter<ClientStateChangedEvent>();
 
@@ -104,9 +105,17 @@ export class LanguageClientsManager {
     public readonly outputChannel: vscode.OutputChannel
   ) {
     this._disposables = vscode.Disposable.from(
-      this.pythonManager.pythonExtension?.exports.settings.onDidChangeExecutionDetails(async (uri) =>
-        this.refresh(uri)
-      ) ?? {
+      this.pythonManager.pythonExtension?.exports.settings.onDidChangeExecutionDetails(async (uri) => {
+        if (uri !== undefined) {
+          const folder = vscode.workspace.getWorkspaceFolder(uri);
+          if (folder !== undefined) {
+            this._pythonValidPythonAndRobotEnv.delete(folder);
+          }
+          await this.refresh(uri);
+        } else {
+          await this.restart();
+        }
+      }) ?? {
         dispose() {
           //empty
         },
@@ -171,28 +180,73 @@ export class LanguageClientsManager {
     return serverOptions;
   }
 
-  private async getServerOptions(folder: vscode.WorkspaceFolder, mode: string): Promise<ServerOptions> {
+  private showErrorWithSelectPythonInterpreter(msg: string) {
+    this.outputChannel.appendLine(msg);
+    void vscode.window.showErrorMessage(msg, { title: "Select Python Interpreter", id: "select" }).then((item) => {
+      if (item && item.id === "select") {
+        void vscode.commands.executeCommand("python.setInterpreter");
+      }
+    });
+  }
+
+  private async getServerOptions(folder: vscode.WorkspaceFolder, mode: string): Promise<ServerOptions | undefined> {
     const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
 
     const pythonCommand = this.pythonManager.getPythonCommand(folder);
 
+    const envOk = this._pythonValidPythonAndRobotEnv.get(folder);
+    if (envOk === false) return undefined;
+
     if (!pythonCommand) {
-      throw new Error("Can't find a valid python executable.");
+      this._pythonValidPythonAndRobotEnv.set(folder, false);
+
+      this.showErrorWithSelectPythonInterpreter(
+        `Can't find a valid python executable for workspace folder '${folder.name}'. ` +
+          "Check if python and the python extension is installed."
+      );
+
+      return undefined;
     }
 
-    const serverArgs = config.get<string[]>("languageServer.args", []);
+    if (!this.pythonManager.checkPythonVersion(pythonCommand)) {
+      this._pythonValidPythonAndRobotEnv.set(folder, false);
 
-    const args: string[] = [
-      "-u",
+      this.showErrorWithSelectPythonInterpreter(
+        `Invalid python version for workspace folder '${folder.name}'. Only python version >= 3.8 supported. ` +
+          "Please update to a newer python version or select a valid python environment."
+      );
 
-      // "-m",
-      // "debugpy",
-      // "--listen",
-      // "5678",
-      // "--wait-for-client",
+      return undefined;
+    }
 
-      this.pythonManager.pythonLanguageServerMain,
-    ];
+    const robotCheck = this.pythonManager.checkRobotVersion(pythonCommand);
+    if (robotCheck === undefined) {
+      this._pythonValidPythonAndRobotEnv.set(folder, false);
+
+      this.showErrorWithSelectPythonInterpreter(
+        `Robot Framework package not found in workspace folder '${folder.name}'. ` +
+          "Please install Robot Framework >= Version 4.0 to the current python environment or select a valid python environment."
+      );
+
+      return undefined;
+    }
+
+    if (robotCheck === false) {
+      this._pythonValidPythonAndRobotEnv.set(folder, false);
+
+      this.showErrorWithSelectPythonInterpreter(
+        `Robot Framework version in workspace folder '${folder.name}' not supported. Only Robot Framework version >= 4.0.0 supported. ` +
+          "Please install or update Robot Framework >= Version 4.0 to the current python environment or select a valid python environment."
+      );
+
+      return undefined;
+    }
+
+    this._pythonValidPythonAndRobotEnv.set(folder, true);
+
+    const serverArgs = config.get<string[]>("languageServer.args", []);
+
+    const args: string[] = ["-u", this.pythonManager.pythonLanguageServerMain];
 
     const debug_args: string[] = ["--log"];
 
@@ -263,9 +317,13 @@ export class LanguageClientsManager {
 
       const mode = config.get<string>("languageServer.mode", "stdio");
 
-      const serverOptions: ServerOptions =
+      const serverOptions: ServerOptions | undefined =
         mode === "tcp" ? this.getServerOptionsTCP(workspaceFolder) : await this.getServerOptions(workspaceFolder, mode);
 
+      if (serverOptions === undefined) {
+        return undefined;
+      }
+
       const name = `RobotCode Language Server mode=${mode} for folder "${workspaceFolder.name}"`;
 
       const outputChannel = this.outputChannels.get(name) ?? vscode.window.createOutputChannel(name);
@@ -378,6 +436,11 @@ export class LanguageClientsManager {
     });
   }
 
+  public async restart(): Promise<void> {
+    this._pythonValidPythonAndRobotEnv = new WeakMap<vscode.WorkspaceFolder, boolean>();
+    await this.refresh();
+  }
+
   public async refresh(uri?: vscode.Uri): Promise<void> {
     await this.clientsMutex.dispatch(async () => {
       if (uri) {
diff --git a/vscode-client/pythonmanger.ts b/vscode-client/pythonmanger.ts

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`)`
`19`	`19`	`from ...common.text_document import TextDocument`
`20`	`20`	`from ..parts.model_helper import ModelHelperMixin`
`21`		`-from ..utils.ast import (`
	`21`	`+from ..utils.ast_utils import (`
`22`	`22`	`HasTokens,`
`23`	`23`	`Statement,`
`24`	`24`	`Token,`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`Range,`
`40`	`40`	`)`
`41`	`41`	`from ...common.text_document import TextDocument`
`42`		`-from ..utils.ast import (`
	`42`	`+from ..utils.ast_utils import (`
`43`	`43`	`Token,`
`44`	`44`	`range_from_node,`
`45`	`45`	`range_from_token,`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@`
`48`	`48`	`KeywordMatcher,`
`49`	`49`	`)`
`50`	`50`	`from ..diagnostics.namespace import Namespace`
`51`		`-from ..utils.ast import (`
	`51`	`+from ..utils.ast_utils import (`
`52`	`52`	`HasTokens,`
`53`	`53`	`Token,`
`54`	`54`	`get_nodes_at_position,`