feat: add option to start a debugpy session for debugging purpose

Author: d-biehl

package.json

@@ -374,6 +374,15 @@
             "description": "If the port is specified, connect to the language server previously started at the given port.",
             "scope": "resource"
           },
+          "robotcode.languageServer.extraArgs": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": "Specifies extra arguments to be passed to the `robotcode language-server` command line tool (i.e.: [`--log`, `--log-level=TRACE`, `--log-calls`]).",
+            "scope": "resource"
+          },
           "robotcode.debugLauncher.mode": {
             "type": "string",
             "default": "stdio",

packages/core/src/robotcode/core/utils/debugpy.py

@@ -1,4 +1,4 @@
-from typing import Sequence, Tuple, Union
+from typing import Optional, Sequence, Tuple, Union
 
 from ..logging import LoggingDescriptor
 from .net import find_free_port
@@ -43,20 +43,19 @@ def enable_debugpy(port: int, addresses: Union[Sequence[str], str, None] = None)
     return False
 
 
-def start_debugpy(end_point: Union[Tuple[str, int], int], wait_for_client: bool) -> bool:
+def start_debugpy(end_point: Union[Tuple[str, int], int], wait_for_client: bool) -> Optional[int]:
     if is_debugpy_installed():
         import debugpy
 
         if isinstance(end_point, int):
             end_point = ("127.0.0.1", end_point)
 
         real_port = find_free_port(end_point[1])
-        if real_port != end_point[1]:
-            _logger.warning(lambda: f"start debugpy session on port {real_port}")
+
         debugpy.listen((end_point[0], real_port))
 
         if wait_for_client:
             _logger.info("wait for debugpy client")
             debugpy.wait_for_client()
-        return True
-    return False
+        return real_port
+    return None

src/robotcode/cli/__init__.py

@@ -106,6 +106,24 @@
     type=str,
     help="Path to the launcher script. This is an internal option.",
 )
+@click.option(
+    "--debugpy",
+    is_flag=True,
+    help="Starts a debugpy session. "
+    "**This is an internal option and should only be use if you want to debug _RobotCode_.**",
+)
+@click.option(
+    "--debugpy-port",
+    type=int,
+    default=5678,
+    show_default=True,
+    help="Defines the port to use for the debugpy session.",
+)
+@click.option(
+    "--debugpy-wait-for-client",
+    is_flag=True,
+    help="Waits for a debugpy client to connect before starting the debugpy session.",
+)
 @click.version_option(version=__version__, prog_name="robotcode")
 @pass_application
 def robotcode(
@@ -122,6 +140,9 @@ def robotcode(
     log_calls: bool,
     default_path: Optional[List[str]],
     launcher_script: Optional[str] = None,
+    debugpy: bool = False,
+    debugpy_port: int = 5678,
+    debugpy_wait_for_client: bool = False,
 ) -> None:
     """\b
      _____       _           _    _____          _
@@ -155,6 +176,23 @@ def robotcode(
 
         logging.basicConfig(level=log_level, format="%(name)s:%(levelname)s: %(message)s")
 
+    if debugpy:
+        from robotcode.core.utils.debugpy import start_debugpy, wait_for_debugpy_connected
+
+        app.verbose(f"Try to start a debugpy session on port {debugpy_port}")
+
+        real_port = start_debugpy(debugpy_port, False)
+
+        if real_port is not None:
+            if real_port != debugpy_port:
+                app.verbose(f"Debugpy session started on port {real_port}")
+
+            if debugpy_wait_for_client:
+                app.verbose("Waiting for debugpy client to connect...")
+                wait_for_debugpy_connected()
+        else:
+            app.verbose("Could not start debugpy session. Enable logging for more information.")
+
 
 robotcode.add_command(config)
 robotcode.add_command(profiles)

vscode-client/languageclientsmanger.ts

@@ -271,7 +271,7 @@ export class LanguageClientsManager {
 
     this._pythonValidPythonAndRobotEnv.set(folder, true);
 
-    const robotCodeExtraArgs = config.get<string[]>("extraArgs", []);
+    const robotCodeExtraArgs = config.get<string[]>("languageServer.extraArgs", []);
 
     const args: string[] = ["-u", "-X", "utf8", this.pythonManager.robotCodeMain];
     const serverArgs: string[] = [...robotCodeExtraArgs, "language-server"];