feat(core): add console messenger to TUI

Author: Cammisuli

Cargo.lock

@@ -12,6 +12,13 @@ opt-level = "z"
 strip = "none"
 
 [dependencies]
+tokio = { version = "1.44.0", features = [
+    "sync",
+    "macros",
+    "io-util",
+    "rt",
+    "time",
+] }
 anyhow = "1.0.71"
 better-panic = "0.3.0"
 colored = "2"
@@ -51,14 +58,17 @@ terminal-colorsaurus = "0.4.0"
 thiserror = "1.0.40"
 tracing = "0.1.37"
 tracing-subscriber = { version = "0.3.17", features = ["env-filter"] }
-tokio = { version = "1.32.0", features = ['sync','macros','io-util','rt','time'] }
 tokio-util = "0.7.9"
 tracing-appender = "0.2"
 tui-logger = { version = "0.17.2", features = ["tracing-support"] }
 tui-term = { git = "https://github.com/JamesHenry/tui-term", rev = "88e3b61425c97220c528ef76c188df10032a75dd" }
 walkdir = '2.3.3'
 xxhash-rust = { version = '0.8.5', features = ['xxh3', 'xxh64'] }
 vt100-ctt = { git = "https://github.com/JamesHenry/vt100-rust", rev = "b15dc3b0f7db94167a9c584f1d403899c0cc871d" }
+serde = "1.0.219"
+serde_json = "1.0.140"
+
+sha2 = "0.10.8"
 
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3", features = ["fileapi", "psapi", "shellapi"] }
@@ -74,13 +84,22 @@ portable-pty = { git = "https://github.com/cammisuli/wezterm", rev = "b538ee29e1
 ignore-files = "2.1.0"
 fs4 = "0.12.0"
 ratatui = { version = "0.29", features = ["scrolling-regions"] }
-reqwest = {  version = "0.12.15", default-features = false, features = ["rustls-tls"] }
+reqwest = { version = "0.12.15", default-features = false, features = [
+    "rustls-tls",
+] }
 rusqlite = { version = "0.32.1", features = ["bundled", "array", "vtab"] }
 watchexec = "3.0.1"
 watchexec-events = "2.0.1"
 watchexec-filterer-ignore = "3.0.0"
 watchexec-signals = "2.1.0"
 machine-uid = "0.5.2"
+interprocess = { version = "2.2.3", features = ["tokio"] }
+jsonrpsee = { version = "0.25.1", features = [
+    "client-core",
+    "async-client",
+    "macros",
+    "http-client",
+] }
 
 [lib]
 crate-type = ['cdylib']
@@ -94,3 +113,4 @@ insta = "1.42.2"
 # This is only used for unit tests
 swc_ecma_dep_graph = "0.109.1"
 tempfile = "3.13.0"
+uuid = { version = "1.0", features = ["v4"] }

packages/nx/Cargo.toml

@@ -8,7 +8,7 @@ export declare class ExternalObject<T> {
   }
 }
 export declare class AppLifeCycle {
-  constructor(tasks: Array<Task>, initiatingTasks: Array<string>, runMode: RunMode, pinnedTasks: Array<string>, tuiCliArgs: TuiCliArgs, tuiConfig: TuiConfig, titleText: string)
+  constructor(tasks: Array<Task>, initiatingTasks: Array<string>, runMode: RunMode, pinnedTasks: Array<string>, tuiCliArgs: TuiCliArgs, tuiConfig: TuiConfig, titleText: string, workspaceRoot: string)
   startCommand(threadCount?: number | undefined | null): void
   scheduleTask(task: Task): void
   startTasks(tasks: Array<Task>, metadata: object): void
@@ -18,7 +18,7 @@ export declare class AppLifeCycle {
   __init(doneCallback: () => any): void
   registerRunningTask(taskId: string, parserAndWriter: ExternalObject<[ParserArc, WriterArc]>): void
   registerRunningTaskWithEmptyParser(taskId: string): void
-  appendTaskOutput(taskId: string, output: string, isPtyOutput: boolean): void
+  appendTaskOutput(taskId: string, output: string): void
   setTaskStatus(taskId: string, status: TaskStatus): void
   registerForcedShutdownCallback(forcedShutdownCallback: () => any): void
   __setCloudMessage(message: string): Promise<void>

packages/nx/src/native/index.d.ts

@@ -62,10 +62,15 @@ const originalLoad = Module._load;
 // Will only be called once because the require cache takes over afterwards.
 Module._load = function (request, parent, isMain) {
   const modulePath = request;
-  if (
+  // Check if we should use the native file cache (enabled by default)
+  const useNativeFileCache = process.env.NX_SKIP_NATIVE_FILE_CACHE !== 'true';
+  // Check if this is an Nx native module (either from npm or local file)
+  const isNxNativeModule =
     nxPackages.has(modulePath) ||
-    localNodeFiles.some((f) => modulePath.endsWith(f))
-  ) {
+    localNodeFiles.some((file) => modulePath.endsWith(file));
+
+  // Only use the file cache for Nx native modules when caching is enabled
+  if (useNativeFileCache && isNxNativeModule) {
     const nativeLocation = require.resolve(modulePath);
     const fileName = basename(nativeLocation);
 

packages/nx/src/native/index.js

@@ -35,4 +35,6 @@ pub enum Action {
     StartTasks(Vec<Task>),
     EndTasks(Vec<TaskResult>),
     ToggleDebugMode,
+    SendConsoleMessage(String),
+    ConsoleMessagesAvailable(bool),
 }

packages/nx/src/native/tui/action.rs

@@ -23,7 +23,6 @@ use crate::native::{
     tasks::types::{Task, TaskResult},
 };
 
-use super::action::Action;
 use super::components::Component;
 use super::components::countdown_popup::CountdownPopup;
 use super::components::help_popup::HelpPopup;
@@ -39,6 +38,7 @@ use super::pty::PtyInstance;
 use super::theme::THEME;
 use super::tui;
 use super::utils::normalize_newlines;
+use super::{action::Action, nx_console::messaging::NxConsoleMessageConnection};
 
 pub struct App {
     pub components: Vec<Box<dyn Component>>,
@@ -69,6 +69,7 @@ pub struct App {
     tasks: Vec<Task>,
     debug_mode: bool,
     debug_state: TuiWidgetState,
+    console_messenger: Option<NxConsoleMessageConnection>,
 }
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -136,6 +137,7 @@ impl App {
             tasks,
             debug_mode: false,
             debug_state: TuiWidgetState::default(),
+            console_messenger: None,
         })
     }
 
@@ -208,6 +210,10 @@ impl App {
 
     // Show countdown popup for the configured duration (making sure the help popup is not open first)
     pub fn end_command(&mut self) {
+        self.console_messenger
+            .as_ref()
+            .and_then(|c| c.end_running_tasks());
+
         // If the user has interacted with the app, or auto-exit is disabled, do nothing
         if self.user_has_interacted || !self.tui_config.auto_exit.should_exit_automatically() {
             return;
@@ -308,6 +314,10 @@ impl App {
                     && !(matches!(self.focus, Focus::MultipleOutput(_))
                         && self.is_interactive_mode())
                 {
+                    self.console_messenger
+                        .as_ref()
+                        .and_then(|c| c.end_running_tasks());
+
                     self.is_forced_shutdown = true;
                     // Quit immediately
                     self.quit_at = Some(std::time::Instant::now());
@@ -747,8 +757,25 @@ impl App {
             trace!("{action:?}");
         }
         match &action {
+            Action::StartCommand(_) => {
+                self.console_messenger
+                    .as_ref()
+                    .and_then(|c| c.start_running_tasks());
+            }
+            Action::Tick => {
+                self.console_messenger.as_ref().and_then(|messenger| {
+                    self.components
+                        .iter()
+                        .find_map(|c| c.as_any().downcast_ref::<TasksList>())
+                        .and_then(|tasks_list| {
+                            messenger.update_running_tasks(&tasks_list.tasks, &self.pty_instances)
+                        })
+                });
+            }
             // Quit immediately
-            Action::Quit => self.quit_at = Some(std::time::Instant::now()),
+            Action::Quit => {
+                self.quit_at = Some(std::time::Instant::now());
+            }
             // Cancel quitting
             Action::CancelQuit => {
                 self.quit_at = None;
@@ -958,6 +985,7 @@ impl App {
                                     is_focused,
                                     has_pty,
                                     is_next_tab_target,
+                                    self.console_messenger.is_some(),
                                 );
 
                                 let terminal_pane = TerminalPane::new()
@@ -984,6 +1012,13 @@ impl App {
                 })
                 .ok();
             }
+            Action::SendConsoleMessage(msg) => {
+                if let Some(connection) = &self.console_messenger {
+                    connection.send_terminal_string(msg);
+                } else {
+                    trace!("No console connection available");
+                }
+            }
             _ => {}
         }
 
@@ -1034,10 +1069,11 @@ impl App {
 
     /// Dispatches an action to the action tx for other components to handle however they see fit
     fn dispatch_action(&self, action: Action) {
-        let tx = self.action_tx.clone().unwrap();
-        tokio::spawn(async move {
-            let _ = tx.send(action);
-        });
+        if let Some(tx) = &self.action_tx {
+            tx.send(action).unwrap_or_else(|e| {
+                debug!("Failed to dispatch action: {}", e);
+            });
+        }
     }
 
     fn recalculate_layout_areas(&mut self) {
@@ -1330,7 +1366,10 @@ impl App {
     fn handle_key_event(&mut self, key: KeyEvent) -> io::Result<()> {
         if let Focus::MultipleOutput(pane_idx) = self.focus {
             let terminal_pane_data = &mut self.terminal_pane_data[pane_idx];
-            terminal_pane_data.handle_key_event(key)
+            if let Some(action) = terminal_pane_data.handle_key_event(key)? {
+                self.dispatch_action(action);
+            }
+            Ok(())
         } else {
             Ok(())
         }
@@ -1423,15 +1462,17 @@ impl App {
         parser_and_writer: External<(ParserArc, WriterArc)>,
     ) {
         // Access the contents of the External
-        let parser_and_writer_clone = parser_and_writer.clone();
-        let (parser, writer) = &parser_and_writer_clone;
         let pty = Arc::new(
-            PtyInstance::new(task_id.to_string(), parser.clone(), writer.clone())
-                .map_err(|e| napi::Error::from_reason(format!("Failed to create PTY: {}", e)))
-                .unwrap(),
+            PtyInstance::new(
+                task_id.to_string(),
+                parser_and_writer.0.clone(),
+                parser_and_writer.1.clone(),
+            )
+            .map_err(|e| napi::Error::from_reason(format!("Failed to create PTY: {}", e)))
+            .unwrap(),
         );
 
-        self.pty_instances.insert(task_id.to_string(), pty.clone());
+        self.pty_instances.insert(task_id.to_string(), pty);
     }
 
     fn create_empty_parser_and_noop_writer() -> (ParserArc, External<(ParserArc, WriterArc)>) {
@@ -1506,4 +1547,15 @@ impl App {
             self.debug_state.transition(event);
         }
     }
+
+    pub fn set_console_messenger(&mut self, messenger: NxConsoleMessageConnection) {
+        self.console_messenger = Some(messenger);
+        if self
+            .console_messenger
+            .as_ref()
+            .is_some_and(|c| c.is_connected())
+        {
+            self.dispatch_action(Action::ConsoleMessagesAvailable(true));
+        }
+    }
 }

packages/nx/src/native/tui/app.rs

@@ -13,15 +13,18 @@ use tokio::sync::mpsc::UnboundedSender;
 
 use super::{Component, Frame};
 use crate::native::tui::action::Action;
+
 use crate::native::tui::theme::THEME;
 
+#[derive(Default)]
 pub struct HelpPopup {
     scroll_offset: usize,
     scrollbar_state: ScrollbarState,
     content_height: usize,
     viewport_height: usize,
     visible: bool,
     action_tx: Option<UnboundedSender<Action>>,
+    console_available: bool,
 }
 
 impl HelpPopup {
@@ -33,13 +36,18 @@ impl HelpPopup {
             viewport_height: 0,
             visible: false,
             action_tx: None,
+            console_available: false,
         }
     }
 
     pub fn set_visible(&mut self, visible: bool) {
         self.visible = visible;
     }
 
+    pub fn set_console_available(&mut self, available: bool) {
+        self.console_available = available;
+    }
+
     // Ensure the scroll state is reset to avoid recalc issues
     pub fn handle_resize(&mut self, _width: u16, _height: u16) {
         self.scroll_offset = 0;
@@ -110,7 +118,7 @@ impl HelpPopup {
             ])
             .split(popup_layout[1])[1];
 
-        let keybindings = vec![
+        let mut keybindings = vec![
             // Misc
             ("?", "Toggle this popup"),
             ("q or <ctrl>+c", "Quit the TUI"),
@@ -149,6 +157,17 @@ impl HelpPopup {
             ("<ctrl>+z", "Stop interacting with a continuous task"),
         ];
 
+        if self.console_available {
+            // add Copilot specific keybindings for AI assistance
+            keybindings.extend([
+                ("", ""),
+                (
+                    "<ctrl>+a",
+                    "Send this output to Copilot so that it can assist with any issues",
+                ),
+            ]);
+        }
+
         let mut content: Vec<Line> = vec![
             // Welcome text
             Line::from(vec![
@@ -357,8 +376,14 @@ impl Component for HelpPopup {
     }
 
     fn update(&mut self, action: Action) -> Result<Option<Action>> {
-        if let Action::Resize(w, h) = action {
-            self.handle_resize(w, h);
+        match action {
+            Action::Resize(w, h) => {
+                self.handle_resize(w, h);
+            }
+            Action::ConsoleMessagesAvailable(available) => {
+                self.set_console_available(available);
+            }
+            _ => {}
         }
         Ok(None)
     }

packages/nx/src/native/tui/components/help_popup.rs

@@ -7,6 +7,7 @@ use ratatui::{
     text::{Line, Span},
     widgets::{Block, Cell, Paragraph, Row, Table},
 };
+use serde::{Deserialize, Serialize};
 use std::{
     any::Any,
     sync::{Arc, Mutex},
@@ -52,7 +53,7 @@ pub struct TaskItem {
     cache_status: String,
     // Public to aid with sorting utility and testing
     pub status: TaskStatus,
-    terminal_output: String,
+    pub terminal_output: String,
     pub continuous: bool,
     start_time: Option<i64>,
     // Public to aid with sorting utility and testing
@@ -115,7 +116,7 @@ impl TaskItem {
 }
 
 #[napi]
-#[derive(Debug, PartialEq, Eq)]
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
 pub enum TaskStatus {
     // Explicit statuses that can come from the task runner
     Success,