Merge pull request #747 from UiPath/fix/local_debug_state_details

fix: improve local debug details

Author: cristipufu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.97"
+version = "2.1.98"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

src/uipath/_cli/__init__.py

@@ -3,6 +3,7 @@
 
 import click
 
+from .._utils._logs import setup_logging
 from ._utils._common import add_cwd_to_path, load_environment_variables
 from .cli_auth import auth as auth
 from .cli_debug import debug as debug  # type: ignore
@@ -47,6 +48,7 @@ def _get_safe_version() -> str:
 def cli(lv: bool, v: bool) -> None:
     load_environment_variables()
     add_cwd_to_path()
+    setup_logging()
     if lv:
         try:
             version = importlib.metadata.version("uipath-langchain")

src/uipath/_cli/_debug/_bridge.py

@@ -5,9 +5,11 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict, Optional
 
+from pydantic import BaseModel
 from pysignalr.client import SignalRClient
 from rich.console import Console
 from rich.syntax import Syntax
+from rich.tree import Tree
 
 from uipath._cli._runtime._contracts import (
     UiPathBreakpointResult,
@@ -115,7 +117,7 @@ async def emit_state_update(self, state_event: UiPathAgentStateEvent) -> None:
 
         self.console.print(f"[yellow]●[/yellow] [bold]{state_event.node_name}[/bold]")
         if state_event.payload:
-            self._print_json(state_event.payload, label="State")
+            self._print_json(state_event.payload, label="state")
 
     async def emit_breakpoint_hit(
         self, breakpoint_result: UiPathBreakpointResult
@@ -135,7 +137,7 @@ async def emit_breakpoint_hit(
 
         # Display current state
         if breakpoint_result.current_state:
-            self._print_json(breakpoint_result.current_state, label="State")
+            self._print_json(breakpoint_result.current_state, label="state")
 
     async def emit_execution_completed(
         self,
@@ -157,7 +159,7 @@ async def emit_execution_completed(
 
         self.console.print(f"[{color}]{symbol} END[/{color}]")
         if runtime_result.output:
-            self._print_json(runtime_result.output, label="Output")
+            self._print_json(runtime_result.output, label="output")
 
     async def emit_execution_error(
         self,
@@ -193,36 +195,83 @@ async def wait_for_resume(self) -> Any:
         self.console.print()
         return user_input
 
-    def _print_json(self, data: Dict[str, Any], label: str = "Data") -> None:
-        """Print JSON data in a readable format."""
+    def _print_json(self, data: Dict[str, Any], label: str = "data") -> None:
+        """Print JSON data with enhanced hierarchy."""
         try:
-            json_str = json.dumps(data, indent=2, default=str)
-
-            # Limit output if too large
-            is_truncated = False
-            if len(json_str) > 2000:
-                json_str = json_str[:2000] + "\n..."
-                is_truncated = True
-
-            syntax = Syntax(
-                json_str,
-                "json",
-                theme="monokai",
-                line_numbers=False,
-                background_color="default",
-            )
+            # Create a tree for nested structure
+            tree = Tree(f"[bold cyan]{label}[/bold cyan]")
+
+            def process_value(
+                node: Tree, value: Any, key_label: str, depth: int
+            ) -> None:
+                """Process a single value and add it to the tree."""
+                if isinstance(value, BaseModel):
+                    branch = node.add(
+                        f"{key_label} [dim]({type(value).__name__})[/dim]"
+                    )
+                    add_to_tree(branch, value, depth + 1)
+                elif isinstance(value, dict):
+                    branch = node.add(f"{key_label} [dim](dict)[/dim]")
+                    add_to_tree(branch, value, depth + 1)
+                elif isinstance(value, list):
+                    branch = node.add(
+                        f"{key_label} [dim](list, {len(value)} items)[/dim]"
+                    )
+                    add_to_tree(branch, value, depth + 1)
+                else:
+                    val_str = str(value)
+                    if len(val_str) > 250:
+                        val_str = val_str[:250] + "..."
+                    node.add(f"{key_label}: [green]{val_str}[/green]")
+
+            def add_to_tree(node: Tree, payload: Any, depth: int = 0):
+                if depth > 10:
+                    node.add("[dim]...[/dim]")
+                    return
+
+                if isinstance(payload, BaseModel):
+                    try:
+                        payload = payload.model_dump()  # Pydantic v2
+                    except AttributeError:
+                        payload = payload.dict()  # Pydantic v1
+                    add_to_tree(node, payload, depth)
+
+                elif isinstance(payload, dict):
+                    for key, value in payload.items():
+                        process_value(node, value, f"[yellow]{key}[/yellow]", depth)
+
+                elif isinstance(payload, list):
+                    for i, item in enumerate(payload):
+                        process_value(node, item, f"[cyan]#{i}[/cyan]", depth)
+
+                else:
+                    val_str = str(payload)
+                    if len(val_str) > 250:
+                        val_str = val_str[:250] + "..."
+                    node.add(f"[green]{val_str}[/green]")
+
+            add_to_tree(tree, data)
 
             self.console.print()
-            truncated_text = " (truncated)" if is_truncated else ""
-            self.console.print(f"[dim]{label}{truncated_text}:")
-            self.console.print(syntax)
+            self.console.print(tree)
             self.console.print()
+
         except Exception:
-            # Fallback to simple print
-            self.console.print()
-            self.console.print(f"[dim]{label}:")
-            self.console.print(str(data))
-            self.console.print()
+            try:
+                json_str = json.dumps(data, indent=2, default=str)
+                if len(json_str) > 10000:
+                    json_str = json_str[:10000] + "\n..."
+
+                syntax = Syntax(json_str, "json", theme="monokai", line_numbers=False)
+                self.console.print(f"\n[dim]{label}:")
+                self.console.print(syntax)
+                self.console.print()
+            except Exception:
+                # Fallback to simple print
+                self.console.print()
+                self.console.print(f"[dim]{label}:")
+                self.console.print(str(data))
+                self.console.print()
 
 
 class SignalRDebugBridge(UiPathDebugBridge):

src/uipath/_cli/_debug/_runtime.py

@@ -56,7 +56,7 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                 raise RuntimeError("Failed to create inner runtime")
 
             await self.debug_bridge.emit_execution_started(
-                execution_id=self.context.execution_id or "default"
+                execution_id=self.context.job_id or "default"
             )
 
             # Try to stream events from inner runtime
@@ -78,7 +78,7 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
         except Exception as e:
             # Emit execution error
             await self.debug_bridge.emit_execution_error(
-                execution_id=self.context.execution_id or "default",
+                execution_id=self.context.job_id or "default",
                 error=str(e),
             )
             raise

src/uipath/_cli/cli_debug.py

@@ -1,7 +1,6 @@
 # type: ignore
 import asyncio
 import os
-import uuid
 from os import environ as env
 from typing import Optional
 
@@ -110,7 +109,6 @@ def debug(
                 execution_output_file=output_file,
                 debug=debug,
             )
-            debug_context.execution_id = debug_context.job_id or str(uuid.uuid4())
 
             runtime_factory = UiPathRuntimeFactory(
                 UiPathScriptRuntime,

src/uipath/_uipath.py

@@ -21,7 +21,6 @@
     UiPathLlmChatService,
     UiPathOpenAIService,
 )
-from ._utils import setup_logging
 from ._utils._auth import resolve_config
 from .models.errors import BaseUrlMissingError, SecretMissingError
 
@@ -56,7 +55,6 @@ def __init__(
         self._attachments_service: Optional[AttachmentsService] = None
         self._connections_service: Optional[ConnectionsService] = None
 
-        setup_logging(debug)
         self._execution_context = ExecutionContext()
 
     @property

src/uipath/_utils/_logs.py

@@ -11,5 +11,4 @@ def setup_logging(should_debug: Optional[bool] = None) -> None:
         datefmt="%Y-%m-%d %H:%M:%S",
     )
     logger.setLevel(logging.DEBUG if should_debug else logging.INFO)
-    logger.removeHandler(logging.StreamHandler(sys.stdout))
     logger.addHandler(logging.StreamHandler(sys.stderr))