feat: strip OSC paste codes

Relates to #104

Author: tombh

.github/workflows/ci.yaml

@@ -21,6 +21,7 @@ env:
   CARGO_TERM_COLOR: always
   RUST_VERSION: 1.87.0
   RUST_BACKTRACE: 1
+  RUST_LOG: "trace,tattoy_wezterm_term=off"
 
 jobs:
   build-test:
@@ -71,7 +72,7 @@ jobs:
             --no-fail-fast --retries 2
       - name: Output e2e test logs (on failure)
         if: failure()
-        run: cat crates/tests/tattoy.log
+        run: cat crates/tests/tests.log
 
   lints:
     name: "Lints 💅"

Cargo.lock

@@ -23,7 +23,7 @@ tracing = "0.1.40"
 tracing-subscriber = {version = "0.3.18", features = ["env-filter"]}
 
 [workspace.dependencies.shadow-terminal]
-version = "0.2.2"
+version = "0.2.3"
 # path = "../shadow-terminal/shadow-terminal/"
 
 # Canonical lints for whole crate

Cargo.toml

@@ -83,7 +83,7 @@ impl Tattoyer {
         message: crate::run::Protocol,
     ) -> Result<()> {
         tracing::trace!(
-            "'{}' tattoy recevied protocol message: {message:?}",
+            "'{}' tattoy received protocol message: {message:?}",
             self.id
         );
 

crates/tattoy/src/tattoys/tattoyer.rs

@@ -14,16 +14,25 @@ impl crate::terminal_proxy::proxy::Proxy {
             return Ok(());
         }
 
-        self.forward_input_to_pty(input).await
+        self.forward_input_to_pty(input.to_owned()).await
     }
 
     /// Forward raw input bytes to the underlying PTY.
-    async fn forward_input_to_pty(&self, input: &crate::raw_input::ParsedInput) -> Result<()> {
+    async fn forward_input_to_pty(&self, input: crate::raw_input::ParsedInput) -> Result<()> {
+        // If the input is from an OSC paste event, then only forward the contents of the paste,
+        // and not the surrounding OSC codes.
+        let bytes = if let termwiz::input::InputEvent::Paste(string) = input.event {
+            string.into_bytes()
+        } else {
+            input.bytes
+        };
+
         tracing::trace!(
             "Terminal proxy received input bytes: {}",
-            String::from_utf8_lossy(&input.bytes)
+            String::from_utf8_lossy(&bytes)
         );
-        for chunk in input.bytes.chunks(128) {
+
+        for chunk in bytes.chunks(128) {
             let mut buffer: crate::raw_input::BytesFromSTDIN = [0; 128];
             for (i, chunk_byte) in chunk.iter().enumerate() {
                 let buffer_byte = buffer.get_mut(i).context("Couldn't get byte from buffer")?;

crates/tattoy/src/terminal_proxy/input_handler.rs

@@ -15,7 +15,7 @@ async fn basic_interactivity() {
 
     crate::utils::assert_random_walker_moves(&mut tattoy).await;
 
-    tattoy.send_command("echo $((1+1))").unwrap();
+    tattoy.send_command_with_osc_paste("echo $((1+1))").unwrap();
     tattoy.wait_for_string("2", None).await.unwrap();
 
     crate::utils::assert_random_walker_moves(&mut tattoy).await;
@@ -112,7 +112,7 @@ async fn scrolling() {
 
     let (mut tattoy, _) = crate::utils::start_tattoy(None).await;
     tattoy
-        .send_command("cat resources/LOREM_IPSUM.txt")
+        .send_command_with_osc_paste("cat resources/LOREM_IPSUM.txt")
         .unwrap();
     assert_scrolling_off(&mut tattoy).await;
 
@@ -136,7 +136,7 @@ async fn palette_to_true_colour() {
     let (mut tattoy, _) = crate::utils::start_tattoy(None).await;
 
     tattoy
-        .send_command("echo -e \"\\033[0;31m$((1000-1))\\033[m\"")
+        .send_command_with_osc_paste("echo -e \"\\033[0;31m$((1000-1))\\033[m\"")
         .unwrap();
     tattoy.wait_for_string("999", None).await.unwrap();
 
@@ -157,7 +157,7 @@ async fn minimap() {
     let size = tattoy.shadow_terminal.terminal.get_size();
 
     tattoy
-        .send_command("cat resources/LOREM_IPSUM.txt")
+        .send_command_with_osc_paste("cat resources/LOREM_IPSUM.txt")
         .unwrap();
     tattoy.wait_for_string("nulla", None).await.unwrap();
     tattoy
@@ -218,7 +218,7 @@ async fn plugins() {
     conf_file.write_all(config.as_bytes()).unwrap();
 
     let (mut tattoy, _) = crate::utils::start_tattoy(Some(conf_dir.to_string_lossy().into())).await;
-    tattoy.send_command("ls").unwrap();
+    tattoy.send_command_with_osc_paste("ls").unwrap();
     let size = tattoy.shadow_terminal.terminal.get_size();
     let bottom = size.rows - 1;
     let right = size.cols - 1;
@@ -305,9 +305,11 @@ async fn auto_text_contrast() {
         bg.relative_contrast(fg)
     }
 
+    crate::utils::setup_logging();
+
     let (mut tattoy, _) = crate::utils::start_tattoy(None).await;
     tattoy
-        .send_command("resources/print_low_contrast_samples.sh")
+        .send_command_with_osc_paste("resources/print_low_contrast_samples.sh")
         .unwrap();
     tattoy.wait_for_string("middle", None).await.unwrap();
     tattoy.wait_for_string("dark", None).await.unwrap();