feat(console): migrate to ratatui and update crossterm (#425)

See https://github.com/tui-rs-revival/ratatui/wiki/Migrating-from-TUI
tokio-rs · Sep 29, 2023 · b209dd6 · b209dd6
1 parent 02cf8a6
commit b209dd6
Show file tree

Hide file tree

Showing 21 changed files with 96 additions and 150 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/tokio-console/Cargo.toml b/tokio-console/Cargo.toml
@@ -33,13 +33,13 @@ clap = { version = "3", features = ["cargo", "derive", "env"] }
 tokio = { version = "1", features = ["full", "rt-multi-thread"] }
 tonic = { version = "0.9", features = ["transport"] }
 futures = "0.3"
-tui = { version = "0.16.0", default-features = false, features = ["crossterm"] }
+ratatui = { version = "0.20.1", default-features = false, features = ["crossterm"] }
 tower = "0.4.12"
 tracing = "0.1"
 tracing-subscriber = { version = "0.3.0", features = ["env-filter"] }
 tracing-journald = { version = "0.2", optional = true }
 prost-types = "0.11"
-crossterm = { version = "0.20", features = ["event-stream"] }
+crossterm = { version = "0.26.1", features = ["event-stream"] }
 color-eyre = { version = "0.6", features = ["issue-url"] }
 hdrhistogram = { version = "7.3.0", default-features = false, features = ["serialization"] }
 h2 = "0.3"

diff --git a/tokio-console/src/conn.rs b/tokio-console/src/conn.rs
@@ -183,8 +183,8 @@ impl Connection {
         }
     }
 
-    pub fn render(&self, styles: &crate::view::Styles) -> tui::text::Spans {
-        use tui::{
+    pub fn render(&self, styles: &crate::view::Styles) -> ratatui::text::Spans {
+        use ratatui::{
             style::{Color, Modifier},
             text::{Span, Spans},
         };

diff --git a/tokio-console/src/input.rs b/tokio-console/src/input.rs
@@ -1,4 +1,4 @@
-// TODO(eliza): support TUI backends other than crossterm?
+// TODO(eliza): support Ratatui backends other than crossterm?
 // This would probably involve using `spawn_blocking` to drive their blocking
 // input-handling mechanisms in the background...
 pub use crossterm::event::*;
@@ -13,10 +13,12 @@ pub fn should_quit(input: &Event) -> bool {
         Key(KeyEvent {
             code: Char('c'),
             modifiers,
+            ..
         })
         | Key(KeyEvent {
             code: Char('d'),
             modifiers,
+            ..
         }) if modifiers.contains(KeyModifiers::CONTROL) => true,
         _ => false,
     }

diff --git a/tokio-console/src/main.rs b/tokio-console/src/main.rs
@@ -3,13 +3,13 @@ use console_api::tasks::TaskDetails;
 use state::State;
 
 use futures::stream::StreamExt;
-use tokio::sync::{mpsc, watch};
-use tui::{
+use ratatui::{
     layout::{Constraint, Direction, Layout},
     style::Color,
     text::{Span, Spans},
     widgets::{Paragraph, Wrap},
 };
+use tokio::sync::{mpsc, watch};
 
 use crate::view::{bold, UpdateKind};
 

diff --git a/tokio-console/src/state/async_ops.rs b/tokio-console/src/state/async_ops.rs
@@ -10,14 +10,14 @@ use crate::{
     view,
 };
 use console_api as proto;
+use ratatui::text::Span;
 use std::{
     cell::RefCell,
     collections::HashMap,
     convert::{TryFrom, TryInto},
     rc::{Rc, Weak},
     time::{Duration, SystemTime},
 };
-use tui::text::Span;
 
 #[derive(Default, Debug)]
 pub(crate) struct AsyncOpsState {

diff --git a/tokio-console/src/state/mod.rs b/tokio-console/src/state/mod.rs
@@ -5,6 +5,10 @@ use crate::{
     warnings::Linter,
 };
 use console_api as proto;
+use ratatui::{
+    style::{Color, Modifier},
+    text::Span,
+};
 use std::{
     cell::RefCell,
     cmp::Ordering,
@@ -15,10 +19,6 @@ use std::{
     time::{Duration, SystemTime},
 };
 use tasks::{Details, Task, TasksState};
-use tui::{
-    style::{Color, Modifier},
-    text::Span,
-};
 
 pub mod async_ops;
 pub mod histogram;

diff --git a/tokio-console/src/state/resources.rs b/tokio-console/src/state/resources.rs
@@ -6,13 +6,13 @@ use crate::state::{
 };
 use crate::view;
 use console_api as proto;
+use ratatui::{style::Color, text::Span};
 use std::{
     collections::HashMap,
     convert::{TryFrom, TryInto},
     rc::Rc,
     time::{Duration, SystemTime},
 };
-use tui::{style::Color, text::Span};
 
 #[derive(Default, Debug)]
 pub(crate) struct ResourcesState {

diff --git a/tokio-console/src/state/tasks.rs b/tokio-console/src/state/tasks.rs
@@ -12,14 +12,14 @@ use crate::{
     warnings::Linter,
 };
 use console_api as proto;
+use ratatui::{style::Color, text::Span};
 use std::{
     cell::RefCell,
     collections::HashMap,
     convert::{TryFrom, TryInto},
     rc::{Rc, Weak},
     time::{Duration, SystemTime},
 };
-use tui::{style::Color, text::Span};
 
 #[derive(Default, Debug)]
 pub(crate) struct TasksState {

diff --git a/tokio-console/src/term.rs b/tokio-console/src/term.rs
@@ -1,6 +1,6 @@
 pub use color_eyre::eyre::WrapErr;
+pub use ratatui::{backend::CrosstermBackend, Terminal};
 use std::io;
-pub use tui::{backend::CrosstermBackend, Terminal};
 
 pub fn init_crossterm() -> color_eyre::Result<(Terminal<CrosstermBackend<io::Stdout>>, OnShutdown)>
 {

diff --git a/tokio-console/src/view/async_ops.rs b/tokio-console/src/view/async_ops.rs
@@ -11,7 +11,7 @@ use crate::{
     },
 };
 
-use tui::{
+use ratatui::{
     layout,
     style::{self, Color, Style},
     text::Spans,
@@ -55,10 +55,10 @@ impl TableList<9> for AsyncOpsTable {
         Self::HEADER[8].len() + 1,
     ];
 
-    fn render<B: tui::backend::Backend>(
+    fn render<B: ratatui::backend::Backend>(
         table_list_state: &mut TableListState<Self, 9>,
         styles: &view::Styles,
-        frame: &mut tui::terminal::Frame<B>,
+        frame: &mut ratatui::terminal::Frame<B>,
         area: layout::Rect,
         state: &mut State,
         ctx: Self::Context,