introduce progress entering pause alongside paused

Author: Nejc Stebe

module_renderer.py

@@ -30,7 +30,7 @@ def __init__(
         run_state: RunState,
         event_bus: EventBus,
         stop_event: threading.Event | None = None,
-        pause_event: threading.Event | None = None,
+        enter_pause_event: threading.Event | None = None,
     ):
         self.codeplainAPI = codeplainAPI
         self.filename = filename
@@ -40,7 +40,7 @@ def __init__(
         self.run_state = run_state
         self.event_bus = event_bus
         self.stop_event = stop_event
-        self.pause_event = pause_event
+        self.enter_pause_event = enter_pause_event
 
     def _ensure_module_folders_exist(self, module_name: str, first_render_frid: str) -> tuple[str, str]:
         """
@@ -183,7 +183,7 @@ def _build_render_context_for_module(
             event_bus=self.event_bus,
             test_script_timeout=self.args.test_script_timeout,
             stop_event=self.stop_event,
-            pause_event=self.pause_event,
+            enter_pause_event=self.enter_pause_event,
         )
 
     def _render_module(

plain2code.py

@@ -203,7 +203,7 @@ def render(args, run_state: RunState, event_bus: EventBus):  # noqa: C901
     _check_connection(codeplainAPI)
 
     stop_event = threading.Event()
-    pause_event = threading.Event()
+    enter_pause_event = threading.Event()
     signal.signal(signal.SIGTERM, lambda _signum, _frame: stop_event.set())
 
     module_renderer = ModuleRenderer(
@@ -215,7 +215,7 @@ def render(args, run_state: RunState, event_bus: EventBus):  # noqa: C901
         run_state,
         event_bus,
         stop_event=stop_event,
-        pause_event=pause_event,
+        enter_pause_event=enter_pause_event,
     )
 
     render_error: list[Exception] = []
@@ -247,7 +247,7 @@ def run_render():
             conformance_tests_script=args.conformance_tests_script,
             prepare_environment_script=args.prepare_environment_script,
             state_machine_version=system_config.client_version,
-            pause_event=pause_event,
+            enter_pause_event=enter_pause_event,
             css_path="styles.css",
         )
         app.run()

plain2code_events.py

@@ -61,3 +61,8 @@ class RenderModuleCompleted(BaseEvent):
 @dataclass
 class RenderModuleStarted(BaseEvent):
     module_name: str
+
+
+@dataclass
+class RenderPaused(BaseEvent):
+    pass

render_machine/code_renderer.py

@@ -3,7 +3,7 @@
 
 from transitions.extensions.diagrams import HierarchicalGraphMachine
 
-from plain2code_events import RenderModuleCompleted, RenderModuleStarted, RenderStateUpdated
+from plain2code_events import RenderModuleCompleted, RenderModuleStarted, RenderPaused, RenderStateUpdated
 from render_machine.render_context import RenderContext
 from render_machine.state_machine_config import StateMachineConfig, States
 
@@ -40,8 +40,10 @@ def run(self):
         previous_state = None
 
         while True:
-            if self.render_context.pause_event and self.render_context.pause_event.is_set():
-                while self.render_context.pause_event.is_set():
+            if self.render_context.enter_pause_event.is_set():
+                self.render_context.event_bus.publish(RenderPaused())
+
+                while self.render_context.enter_pause_event.is_set():
                     time.sleep(PAUSE_POLL_INTERVAL_SECONDS)
 
             self.render_context.event_bus.publish(

render_machine/render_context.py

@@ -54,7 +54,7 @@ def __init__(
         event_bus: EventBus,
         test_script_timeout: Optional[int] = None,
         stop_event: Optional[threading.Event] = None,
-        pause_event: Optional[threading.Event] = None,
+        enter_pause_event: Optional[threading.Event] = None,
     ):
         self.codeplain_api: CodeplainAPI = codeplain_api
         self.memory_manager = memory_manager
@@ -78,7 +78,7 @@ def __init__(
         self.run_state = run_state
         self.event_bus = event_bus
         self.stop_event = stop_event
-        self.pause_event = pause_event
+        self.enter_pause_event = enter_pause_event
         self.script_execution_history = ScriptExecutionHistory()
         self.starting_frid = None
         self.test_script_timeout = test_script_timeout

tui/components.py

@@ -136,6 +136,7 @@ class ProgressItem(Vertical):
     COMPLETED = "COMPLETED"
     STOPPED = "STOPPED"
     PAUSED = "PAUSED"
+    PAUSING = "PAUSING"
 
     def __init__(self, initial_text: str, **kwargs):
         super().__init__(**kwargs)
@@ -159,7 +160,9 @@ def _get_status_text(self, status: str) -> str:
         elif status == self.STOPPED:
             return "◼ stopped"
         elif status == self.PAUSED:
-            return "⏸ paused"
+            return "⏸ paused - ready to resume"
+        elif status == self.PAUSING:
+            return "◉ pausing - please wait"
         else:
             return "○ pending"
 

tui/plain2code_tui.py

@@ -15,16 +15,18 @@
     RenderFailed,
     RenderModuleCompleted,
     RenderModuleStarted,
+    RenderPaused,
     RenderStateUpdated,
 )
 from render_machine.states import States
-from tui.widget_helpers import log_to_widget, set_frid_progress_to_paused
+from tui.widget_helpers import log_to_widget, transition_frid_progress
 
 from .components import (
     CustomFooter,
     FRIDProgress,
     LogFilterChanged,
     LogLevelFilter,
+    ProgressItem,
     RenderingInfoBox,
     ScriptOutputType,
     StructuredLogView,
@@ -65,7 +67,7 @@ def __init__(
         conformance_tests_script: str,
         prepare_environment_script: str,
         state_machine_version: str,
-        pause_event: threading.Event | None = None,
+        enter_pause_event: threading.Event | None = None,
         **kwargs,
     ):
         super().__init__(**kwargs)
@@ -77,7 +79,7 @@ def __init__(
         self.conformance_tests_script: Optional[str] = conformance_tests_script
         self.prepare_environment_script: Optional[str] = prepare_environment_script
         self.state_machine_version = state_machine_version
-        self.pause_event = pause_event
+        self.enter_pause_event = enter_pause_event
         self._render_finished = False
 
         # Initialize state handlers
@@ -138,6 +140,7 @@ def dispatch_wrapper(fn):
         self.event_bus.subscribe(RenderModuleStarted, self.on_render_module_started)
         self.event_bus.subscribe(RenderModuleCompleted, self.on_render_module_completed)
         self.event_bus.subscribe(LogMessageEmitted, self.on_log_message_emitted)
+        self.event_bus.subscribe(RenderPaused, self.on_render_paused)
 
         self._on_ready()
 
@@ -250,6 +253,10 @@ def _handle_frid_state(
 
         self._state_completion_handler.handle(segments, snapshot, previous_state_segments)
 
+    def on_render_paused(self, event: RenderPaused):
+        transition_frid_progress(self, ProgressItem.PAUSING, ProgressItem.PAUSED)
+        pass
+
     def on_render_completed(self, event: RenderCompleted):
         """Handle successful render completion."""
         self._render_success_handler.handle(event.rendered_code_path)
@@ -284,13 +291,14 @@ async def action_copy_selection(self) -> None:
 
     def action_pause(self) -> None:
         """Handle ctrl+shift+p: request the render machine to pause."""
-        if not self._render_finished and self.pause_event is not None:
-            set_frid_progress_to_paused(self)
-
-            if self.pause_event.is_set():
-                self.pause_event.clear()
+        if not self._render_finished and self.enter_pause_event is not None:
+            if self.enter_pause_event.is_set():
+                transition_frid_progress(self, ProgressItem.PAUSED, ProgressItem.PROCESSING)
+                transition_frid_progress(self, ProgressItem.PAUSING, ProgressItem.PROCESSING)
+                self.enter_pause_event.clear()
             else:
-                self.pause_event.set()
+                transition_frid_progress(self, ProgressItem.PROCESSING, ProgressItem.PAUSING)
+                self.enter_pause_event.set()
 
     def action_enter_exit(self) -> None:
         """Handle enter: exit the TUI only after rendering has finished."""

tui/state_handlers.py

@@ -13,7 +13,7 @@
     display_error_message,
     display_success_message,
     get_frid_progress,
-    set_frid_progress_to_stopped,
+    transition_frid_progress,
     update_progress_item_status,
     update_progress_item_substates,
 )
@@ -331,7 +331,7 @@ def __init__(self, tui):
         self.tui = tui
 
     def handle(self, error_message: str) -> None:
-        set_frid_progress_to_stopped(self.tui)
+        transition_frid_progress(self.tui, None, ProgressItem.STOPPED)
         display_error_message(self.tui, error_message)
 
 

tui/styles.css

@@ -194,9 +194,10 @@ TestScriptsContainer {
   background: #c77777;
 }
 
-.status.PAUSED {
+.status.PAUSED,
+.status.PAUSING {
   color: #fff;
-  background: #5b8bf5;
+  background: #0a1fd5;
 }
 
 .description {

tui/widget_helpers.py

@@ -111,32 +111,21 @@ def display_success_message(tui, rendered_code_path: str):
     widget.update(message)
 
 
-def set_frid_progress_to_stopped(tui):
-    progress_ids = [
-        TUIComponents.FRID_PROGRESS_RENDER_FR.value,
-        TUIComponents.FRID_PROGRESS_UNIT_TEST.value,
-        TUIComponents.FRID_PROGRESS_REFACTORING.value,
-        TUIComponents.FRID_PROGRESS_CONFORMANCE_TEST.value,
-    ]
-
-    for widget_id in progress_ids:
-        update_progress_item_status(tui, widget_id, ProgressItem.STOPPED)
-        clear_progress_item_substates(tui, widget_id)
-
+FRID_PROGRESS_IDS = [
+    TUIComponents.FRID_PROGRESS_RENDER_FR.value,
+    TUIComponents.FRID_PROGRESS_UNIT_TEST.value,
+    TUIComponents.FRID_PROGRESS_REFACTORING.value,
+    TUIComponents.FRID_PROGRESS_CONFORMANCE_TEST.value,
+]
 
-def set_frid_progress_to_paused(tui):
-    progress_ids = [
-        TUIComponents.FRID_PROGRESS_RENDER_FR.value,
-        TUIComponents.FRID_PROGRESS_UNIT_TEST.value,
-        TUIComponents.FRID_PROGRESS_REFACTORING.value,
-        TUIComponents.FRID_PROGRESS_CONFORMANCE_TEST.value,
-    ]
 
-    for widget_id in progress_ids:
+def transition_frid_progress(tui, from_status: str | None, to_status: str):
+    """Transition all FRID progress items matching from_status to to_status."""
+    for widget_id in FRID_PROGRESS_IDS:
         try:
             widget = tui.query_one(f"#{widget_id}", ProgressItem)
-            if widget.current_status == ProgressItem.PROCESSING:
-                update_progress_item_status(tui, widget_id, ProgressItem.PAUSED)
+            if widget.current_status == from_status or from_status is None:
+                update_progress_item_status(tui, widget_id, to_status)
         except Exception:
             pass