Merge pull request #113 from galaxyproject/fix_#108

Display error notification when a code generation command fails

Author: davelopez

client/src/commands.ts

@@ -32,14 +32,15 @@ namespace SortDocumentParamsAttrsCommandRequest {
 }
 
 interface GeneratedSnippetResult {
-    snippet: string,
-    position: Position
-    replace_range: Range | null
+    snippet: string;
+    position: Position;
+    replace_range: Range | null;
+    error_message: string;
 }
 
 interface ReplaceTextRangeResult {
-    text: string,
-    replace_range: Range
+    text: string;
+    replace_range: Range;
 }
 
 
@@ -136,7 +137,12 @@ async function requestInsertSnippet(client: LanguageClient, request: RequestType
 
     let param = client.code2ProtocolConverter.asTextDocumentIdentifier(document);
     let response = await client.sendRequest(request, param);
-    if (!response || !response.snippet) return;
+    if (!response || !response.snippet || response.error_message) {
+        if (response.error_message) {
+            window.showErrorMessage(response.error_message);
+        }
+        return;
+    }
 
     try {
         const snippet = new SnippetString(response.snippet);

server/galaxyls/services/tools/generators/command.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Union, cast
+from typing import List, Optional, Tuple, Union, cast
 
 from anytree import PreOrderIter
 from galaxyls.services.tools.constants import (
@@ -44,22 +44,26 @@ class GalaxyToolCommandSnippetGenerator(SnippetGenerator):
     def __init__(self, tool_document: GalaxyToolXmlDocument, tabSize: int = 4) -> None:
         super().__init__(tool_document, tabSize)
 
-    def _build_snippet(self) -> Optional[str]:
+    def _build_snippet(self) -> Tuple[str, bool]:
         """This function tries to generate a code snippet in TextMate format with boilerplate
         Cheetah code extracted from the inputs and outputs of the tool.
 
         Returns:
-            Optional[str]: The code snippet in TextMate format or None if the generation failed.
+            Tuple[str, bool]: The code snippet in TextMate format or an error message if the
+            generation failed. The second value of the tuple indicates if it is an error.
         """
-        input_tree = self.expanded_document.analyze_inputs()
-        outputs = self.expanded_document.get_outputs()
-        result_snippet = self._generate_command_snippet(input_tree, outputs)
-        command_section = self.tool_document.find_element(COMMAND)
-        if command_section and not command_section.is_self_closed:
-            if command_section.get_cdata_section():
-                return result_snippet
-            return f"<![CDATA[\n\n{result_snippet}\n\n]]>\n"
-        return f"<{COMMAND}><![CDATA[\n\n{result_snippet}\n\n]]>\n</{COMMAND}>\n"
+        try:
+            input_tree = self.expanded_document.analyze_inputs()
+            outputs = self.expanded_document.get_outputs()
+            result_snippet = self._generate_command_snippet(input_tree, outputs)
+            command_section = self.tool_document.find_element(COMMAND)
+            if command_section and not command_section.is_self_closed:
+                if command_section.get_cdata_section():
+                    return (result_snippet, False)
+                return (f"<![CDATA[\n\n{result_snippet}\n\n]]>\n", False)
+            return (f"<{COMMAND}><![CDATA[\n\n{result_snippet}\n\n]]>\n</{COMMAND}>\n", False)
+        except BaseException as ex:
+            return (f"Automatic command section generation failed with reason: {ex}", True)
 
     def _find_snippet_insert_position(self) -> Union[Position, Range]:
         """Returns the position inside the document where command section

server/galaxyls/services/tools/generators/snippets.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import List, Optional, Union, cast
+from typing import List, Optional, Tuple, Union, cast
 
 from galaxy.util import xml_macros
 from galaxyls.services.tools.constants import DASH, UNDERSCORE
@@ -21,22 +21,24 @@ def __init__(self, tool_document: GalaxyToolXmlDocument, tabSize: int = 4) -> No
         self.indent_spaces: str = " " * tabSize
         super().__init__()
 
-    def generate_snippet(self) -> Optional[GeneratedSnippetResult]:
+    def generate_snippet(self) -> GeneratedSnippetResult:
         """Generates a code snippet using this generator."""
-        snippet = self._build_snippet()
-        if snippet:
-            insert_position = self._find_snippet_insert_position()
-            if type(insert_position) == Range:
-                insert_position = cast(Range, insert_position)
-                return GeneratedSnippetResult(snippet, insert_position.start, insert_position)
-            insert_position = cast(Position, insert_position)
-            return GeneratedSnippetResult(snippet, insert_position)
-        return None
+        result, is_error = self._build_snippet()
+        if is_error:
+            return GeneratedSnippetResult.as_error(result)
+        insert_position = self._find_snippet_insert_position()
+        if type(insert_position) == Range:
+            insert_position = cast(Range, insert_position)
+            return GeneratedSnippetResult(result, insert_position.start, insert_position)
+        insert_position = cast(Position, insert_position)
+        return GeneratedSnippetResult(result, insert_position)
 
     @abstractmethod
-    def _build_snippet(self) -> Optional[str]:
-        """This abstract function should return the generated snippet in TextMate format or None
-        if the snippet can't be generated."""
+    def _build_snippet(self) -> Tuple[str, bool]:
+        """This abstract function should return a tuple with the generated snippet text in TextMate format or
+        an error message if the snippet can't be generated.
+
+        The second value of the tuple is a bool indicating if there was an error."""
         pass
 
     @abstractmethod

server/galaxyls/services/tools/generators/tests.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Union, cast
+from typing import List, Optional, Tuple, Union, cast
 
 from galaxyls.services.tools.constants import (
     ARGUMENT,
@@ -58,20 +58,26 @@ class GalaxyToolTestSnippetGenerator(SnippetGenerator):
     def __init__(self, tool_document: GalaxyToolXmlDocument, tabSize: int = 4) -> None:
         super().__init__(tool_document, tabSize)
 
-    def _build_snippet(self) -> Optional[str]:
+    def _build_snippet(self) -> Tuple[str, bool]:
         """This function tries to generate a code snippet in TextMate format with all the tests cases extracted
         from the inputs and outputs of the tool.
 
         Returns:
-            Optional[str]: The code snippet in TextMate format or None if the generation failed.
+            Tuple[str, bool]: The code snippet in TextMate format or an error message if the generation failed.
+            The second value of the tuple indicates if there was an error.
         """
-        input_tree = self.expanded_document.analyze_inputs()
-        outputs = self.expanded_document.get_outputs()
-        result_snippet = "\n".join((self._generate_test_case_snippet(input_node, outputs) for input_node in input_tree.leaves))
-        tests_section = self.tool_document.find_element(TESTS)
-        if tests_section and not tests_section.is_self_closed:
-            return result_snippet
-        return f"\n<{TESTS}>\n{result_snippet}\n</{TESTS}>"
+        try:
+            input_tree = self.expanded_document.analyze_inputs()
+            outputs = self.expanded_document.get_outputs()
+            result_snippet = "\n".join(
+                (self._generate_test_case_snippet(input_node, outputs) for input_node in input_tree.leaves)
+            )
+            tests_section = self.tool_document.find_element(TESTS)
+            if tests_section and not tests_section.is_self_closed:
+                return (result_snippet, False)
+            return (f"\n<{TESTS}>\n{result_snippet}\n</{TESTS}>", False)
+        except BaseException as ex:
+            return (f"Automatic Test Case generation failed with reason: {ex}", True)
 
     def _find_snippet_insert_position(self) -> Union[Position, Range]:
         """Returns the position inside the document where new test cases
@@ -118,15 +124,12 @@ def _generate_test_case_snippet(self, input_node: InputNode, outputs: List[XmlEl
         Returns:
             str: The resulting code snippet in TextMate format.
         """
-        try:
-            test_element = self._create_test_element()
-            self._add_inputs_to_test_element(input_node, test_element)
-            self._add_outputs_to_test_element(outputs, test_element)
-            etree.indent(test_element, space=self.indent_spaces)
-            snippet = etree.tostring(test_element, pretty_print=True, encoding=str)
-            return cast(str, snippet)
-        except BaseException:
-            return ""
+        test_element = self._create_test_element()
+        self._add_inputs_to_test_element(input_node, test_element)
+        self._add_outputs_to_test_element(outputs, test_element)
+        etree.indent(test_element, space=self.indent_spaces)
+        snippet = etree.tostring(test_element, pretty_print=True, encoding=str)
+        return cast(str, snippet)
 
     def _create_test_element(self) -> etree._Element:
         """Returns a XML element representing a <test> tag with the basic information.

server/galaxyls/tests/unit/test_tools.py

@@ -167,9 +167,10 @@ def test_build_snippet_returns_expected_result(self, tool_file: str, expected_sn
         tool = GalaxyToolXmlDocument(document)
         generator = GalaxyToolTestSnippetGenerator(tool)
 
-        actual_snippet = generator._build_snippet()
+        actual_snippet, is_error = generator._build_snippet()
         print(actual_snippet)
         assert actual_snippet == expected_snippet
+        assert not is_error
 
     @pytest.mark.parametrize(
         "source, expected_position",
@@ -229,9 +230,10 @@ def test_build_snippet_returns_expected_result(self, tool_file: str, expected_sn
         tool = GalaxyToolXmlDocument(document)
         generator = GalaxyToolCommandSnippetGenerator(tool)
 
-        actual_snippet = generator._build_snippet()
+        actual_snippet, is_error = generator._build_snippet()
         print(actual_snippet)
         assert actual_snippet == expected_snippet
+        assert not is_error
 
     @pytest.mark.parametrize(
         "source, expected_position",

server/galaxyls/types.py

@@ -23,10 +23,24 @@ class GeneratedSnippetResult:
     text inside the given range.
     """
 
-    def __init__(self, snippet: str, insert_position: Position, replace_range: Optional[Range] = None):
+    def __init__(
+        self,
+        snippet: str,
+        insert_position: Position,
+        replace_range: Optional[Range] = None,
+        error_message: Optional[str] = None,
+    ):
         self.snippet = snippet
         self.position = insert_position
         self.replace_range = replace_range
+        self.error_message = error_message
+
+    @staticmethod
+    def as_error(error_message: str) -> "GeneratedSnippetResult":
+        """Returns a GeneratedSnippetResult with empty values and the given error message.
+
+        The error message should be displayed or logged by the client."""
+        return GeneratedSnippetResult("", Position(), error_message=error_message)
 
 
 class ReplaceTextRangeResult: