feat(debugger): new setting for outputTimestamps in launch and workspace configuration to enable/disable timestamps in debug console

Author: d-biehl

package.json

@@ -544,6 +544,12 @@
             "default": true,
             "scope": "resource"
           },
+          "robotcode.debug.outputTimestamps": {
+            "type": "boolean",
+            "description": "Include timestamps in log and output messages.",
+            "default": false,
+            "scope": "resource"
+          },
           "robotcode.debug.groupOutput": {
             "type": "boolean",
             "description": "Group start and stop suite/test/keyword messages in debug console.",
@@ -1001,6 +1007,11 @@
                 "description": "Output log messages from robotframework in debug console.",
                 "default": true
               },
+              "outputTimestamps": {
+                "type": "boolean",
+                "description": "Include timestamps in log and output messages.",
+                "default": false
+              },
               "groupOutput": {
                 "type": "boolean",
                 "description": "Group start and stop suite/test/keyword messages in debug console.",

robotcode/debugger/__main__.py

@@ -138,6 +138,7 @@ async def run_robot(
     debugpy_port: int = 5678,
     output_messages: bool = False,
     output_log: bool = False,
+    output_timestamps: bool = False,
     group_output: bool = False,
     stop_on_entry: bool = False,
 ) -> Any:
@@ -199,6 +200,7 @@ async def run_robot(
         Debugger.instance().output_messages = output_messages
         Debugger.instance().output_log = output_log
         Debugger.instance().group_output = group_output
+        Debugger.instance().output_timestamps = output_timestamps
         Debugger.instance().no_debug = no_debug
         Debugger.instance().set_main_thread(threading.current_thread())
         Debugger.instance().start()
@@ -331,6 +333,9 @@ def main() -> None:
     parser.add_argument(
         "-ol", "--output-log", action="store_true", help="Send log messages from robotframework to client."
     )
+    parser.add_argument(
+        "-ot", "--output-timestamps", action="store_true", help="Include timestamps in log and output messages."
+    )
     parser.add_argument(
         "-og", "--group-output", action="store_true", help="Fold messages/log from robotframework to client."
     )
@@ -408,6 +413,7 @@ def main() -> None:
             args.debugpy_port,
             args.output_messages,
             args.output_log,
+            args.output_timestamps,
             args.group_output,
             args.stop_on_entry,
         )

robotcode/debugger/debugger.py

@@ -243,6 +243,7 @@ def __init__(self) -> None:
         self._robot_output_file: Optional[str] = None
         self.output_messages: bool = False
         self.output_log: bool = False
+        self.output_timestamps: bool = False
         self.group_output: bool = False
         self.hit_counts: Dict[HitCountEntry, int] = {}
         self.last_fail_message: Optional[str] = None
@@ -1013,53 +1014,52 @@ def log_message(self, message: Dict[str, Any]) -> None:
         level = message["level"]
         msg = message["message"]
 
-        if message["level"] == "FAIL":
+        if level == "FAIL":
             self.last_fail_message = msg
 
+        if self.output_log:
+            self._send_log_event(message["timestamp"], level, msg, OutputCategory.CONSOLE)
+
+    def _send_log_event(self, timestamp: str, level: str, msg: str, category: Union[OutputCategory, str]) -> None:
         current_frame = self.full_stack_frames[0] if self.full_stack_frames else None
         source = (
             Source(path=str(self.map_path_to_client(current_frame.source)))
-            if current_frame and current_frame.source
+            if current_frame and current_frame.is_file and current_frame.source
             else None
         )
         line = current_frame.line if current_frame else None
 
-        if self.output_log:
-            self.send_event(
-                self,
-                OutputEvent(
-                    body=OutputEventBody(
-                        output=f"\u001b[38;5;237m{message['timestamp'].split(' ', 1)[1]}"
-                        f" {self.MESSAGE_COLORS.get(level, '')}{level}\u001b[0m: {msg}\n",
-                        category=OutputCategory.CONSOLE,
-                        source=source,
-                        line=line if line is not None else 0,
-                        column=0 if source is not None else None,
-                    )
-                ),
-            )
+        self.send_event(
+            self,
+            OutputEvent(
+                body=OutputEventBody(
+                    output=self._build_output(level, msg, timestamp),
+                    category=category,
+                    source=source,
+                    line=line if line is not None else 0,
+                    column=0 if source is not None else None,
+                )
+            ),
+        )
+
+    def _build_output(self, level: str, msg: str, timestamp: str) -> str:
+        return (
+            (f"\u001b[38;5;237m{timestamp.split(' ', 1)[1]}\u001b[0m " if self.output_timestamps else "")
+            + (f"[ {self.MESSAGE_COLORS.get(level, '')}{level}\u001b[0m ] " if level != "INFO" else "")
+            + f"{msg}\n"
+        )
 
     def message(self, message: Dict[str, Any]) -> None:
         level = message["level"]
         current_frame = self.full_stack_frames[0] if self.full_stack_frames else None
+
         if (
             self.output_messages
             or current_frame is not None
             and current_frame.type != "KEYWORD"
             and level in ["FAIL", "ERROR", "WARN"]
         ):
-            msg = message["message"]
-
-            self.send_event(
-                self,
-                OutputEvent(
-                    body=OutputEventBody(
-                        output=f"\u001b[38;5;237m{message['timestamp'].split(' ', 1)[1]}"
-                        f" {self.MESSAGE_COLORS.get(level, '')}{level}\u001b[0m: {msg}\n",
-                        category=OutputCategory.CONSOLE,
-                    )
-                ),
-            )
+            self._send_log_event(message["timestamp"], level, message["message"], "messages")
 
     def get_scopes(self, frame_id: int) -> List[Scope]:
         result: List[Scope] = []

robotcode/debugger/launcher/server.py

@@ -149,6 +149,7 @@ async def _launch(
         outputDir: Optional[str] = None,
         outputMessages: Optional[bool] = False,
         outputLog: Optional[bool] = False,
+        outputTimestamps: Optional[bool] = False,
         groupOutput: Optional[bool] = False,
         stopOnEntry: Optional[bool] = False,  # noqa: N803
         dryRun: Optional[bool] = None,
@@ -190,6 +191,9 @@ async def _launch(
         if outputLog:
             run_args += ["-ol"]
 
+        if outputTimestamps:
+            run_args += ["-ot"]
+
         if groupOutput:
             run_args += ["-og"]
 

vscode-client/debugmanager.ts

@@ -150,6 +150,9 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
 
       debugConfiguration.outputLog = debugConfiguration?.outputLog ?? config.get<boolean>("debug.outputLog");
 
+      debugConfiguration.outputTimestamps =
+        debugConfiguration?.outputTimestamps ?? config.get<boolean>("debug.outputTimestamps");
+
       debugConfiguration.groupOutput = debugConfiguration?.groupOutput ?? config.get<boolean>("debug.groupOutput");
 
       if (!debugConfiguration.attachPython || debugConfiguration.noDebug) {