Skip to content

Implement a much more efficient scrollback buffer - which only prints the required output to reconstruct a session #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Implement a much more efficient scrollback buffer - which only prints the required output to reconstruct a session #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 111 additions & 3 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions common/tab-api/src/pty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use serde::{Deserialize, Serialize};
pub enum PtyWebsocketResponse {
Started(TabMetadata),
Output(OutputChunk),
Resized((u16, u16)),
Stopped,
}

Expand Down
2 changes: 2 additions & 0 deletions tab-daemon/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ tab-websocket = "0.5.0"
lifeline = "0.6"
postage = "0.3"

vt100 = { git = "https://github.com/austinjones/vt100-rust.git" }

dirs = "3.0"
serde_yaml = "0.8"

Expand Down
92 changes: 46 additions & 46 deletions tab-daemon/src/bus/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,52 +305,52 @@ mod forward_tests {
Ok(())
}

#[tokio::test]
async fn scrollback() -> anyhow::Result<()> {
let cli_bus = CliBus::default();
let listener_bus = ListenerBus::default();

let _carrier = cli_bus.carry_from(&listener_bus)?;

let mut tx = listener_bus.tx::<TabSend>()?;
let mut rx = cli_bus.rx::<CliSubscriptionRecv>()?;

let mut buffer = ScrollbackBuffer::new();
buffer.push(OutputChunk {
index: 0,
data: vec![0, 1],
});
buffer.push(OutputChunk {
index: 2,
data: vec![1, 2],
});
let scrollback = PtyScrollback::new(Arc::new(Mutex::new(buffer)));
let scrollback = TabScrollback {
id: TabId(0),
scrollback,
};
tx.send(TabSend::Scrollback(scrollback)).await?;

assert_completes!(async move {
let msg = rx.recv().await;
assert!(msg.is_some());
if let CliSubscriptionRecv::Scrollback(scroll) = msg.unwrap() {
let mut iter = scroll.scrollback().await;
assert_eq!(
Some(OutputChunk {
index: 0,
data: vec![0, 1, 1, 2]
}),
iter.next()
);
assert_eq!(None, iter.next());
} else {
panic!("Expected CliRecv::Scrollback, found None");
}
});

Ok(())
}
// #[tokio::test]
// async fn scrollback() -> anyhow::Result<()> {
// let cli_bus = CliBus::default();
// let listener_bus = ListenerBus::default();

// let _carrier = cli_bus.carry_from(&listener_bus)?;

// let mut tx = listener_bus.tx::<TabSend>()?;
// let mut rx = cli_bus.rx::<CliSubscriptionRecv>()?;

// let mut buffer = ScrollbackBuffer::new();
// buffer.push(OutputChunk {
// index: 0,
// data: vec![0, 1],
// });
// buffer.push(OutputChunk {
// index: 2,
// data: vec![1, 2],
// });
// let scrollback = PtyScrollback::new(Arc::new(Mutex::new(buffer)));
// let scrollback = TabScrollback {
// id: TabId(0),
// scrollback,
// };
// tx.send(TabSend::Scrollback(scrollback)).await?;

// assert_completes!(async move {
// let msg = rx.recv().await;
// assert!(msg.is_some());
// if let CliSubscriptionRecv::Scrollback(scroll) = msg.unwrap() {
// let mut iter = scroll.scrollback().await;
// assert_eq!(
// Some(OutputChunk {
// index: 0,
// data: vec![0, 1, 1, 2]
// }),
// iter.next()
// );
// assert_eq!(None, iter.next());
// } else {
// panic!("Expected CliRecv::Scrollback, found None");
// }
// });

// Ok(())
// }

#[tokio::test]
async fn output() -> anyhow::Result<()> {
Expand Down
1 change: 1 addition & 0 deletions tab-daemon/src/bus/pty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ impl CarryFrom<ListenerBus> for PtyBus {
tx_tab_manager.send(TabManagerRecv::CloseTab(id)).await?;
tx_tab.send(TabSend::Stopped(id)).await.ok();
}
PtySend::Resized(_) => {}
}
}

Expand Down
9 changes: 9 additions & 0 deletions tab-daemon/src/message/pty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ pub enum PtySend {
Started(TabMetadata),
Output(OutputChunk),
Scrollback(PtyScrollback),
/// The pty has been resized to the given number of (cols, rows)
Resized((u16, u16)),
Stopped,
}

Expand Down Expand Up @@ -68,6 +70,13 @@ impl PartialEq for PtySend {
return false;
}
}
PtySend::Resized(size) => {
if let PtySend::Resized(other) = other {
return size == other;
} else {
return false;
}
}
}
}
}
9 changes: 0 additions & 9 deletions tab-daemon/src/message/tab.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,6 @@ impl TabScrollback {
scrollback: PtyScrollback::empty(),
}
}

#[cfg(test)]
pub async fn push(&self, chunk: OutputChunk) {
self.scrollback.push(chunk).await;
}

pub async fn scrollback(&self) -> impl Iterator<Item = OutputChunk> {
self.scrollback.scrollback().await
}
}

/// A message sent from an established tab, to provide lifecycle notification events,
Expand Down
Loading