From faa0e9b422c21a12c51a124413bed959a63cb3c0 Mon Sep 17 00:00:00 2001
From: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Date: Mon, 16 Sep 2024 12:24:07 +0200
Subject: [PATCH] Add test for ui wakeup

---
 Cargo.lock                            | 10 +++++
 crates/viewer/re_viewer/src/app.rs    |  2 +
 tests/rust/test_ui_wakeup/Cargo.toml  | 20 +++++++++
 tests/rust/test_ui_wakeup/src/main.rs | 63 +++++++++++++++++++++++++++
 4 files changed, 95 insertions(+)
 create mode 100644 tests/rust/test_ui_wakeup/Cargo.toml
 create mode 100644 tests/rust/test_ui_wakeup/src/main.rs

diff --git a/Cargo.lock b/Cargo.lock
index d5fe0b19c6df..c7b01e040aa9 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -7107,6 +7107,16 @@ dependencies = [
  "rerun",
 ]
 
+[[package]]
+name = "test_ui_wakeup"
+version = "0.19.0-alpha.1+dev"
+dependencies = [
+ "anyhow",
+ "clap",
+ "re_log",
+ "rerun",
+]
+
 [[package]]
 name = "thiserror"
 version = "1.0.63"
diff --git a/crates/viewer/re_viewer/src/app.rs b/crates/viewer/re_viewer/src/app.rs
index fae36b6cf3d9..9702e09a408c 100644
--- a/crates/viewer/re_viewer/src/app.rs
+++ b/crates/viewer/re_viewer/src/app.rs
@@ -1034,6 +1034,8 @@ impl App {
         let start = web_time::Instant::now();
 
         while let Some((channel_source, msg)) = self.rx.try_recv() {
+            re_log::trace!("Received a message from {channel_source:?}"); // Used by `test_ui_wakeup` test app!
+
             let msg = match msg.payload {
                 re_smart_channel::SmartMessagePayload::Msg(msg) => msg,
 
diff --git a/tests/rust/test_ui_wakeup/Cargo.toml b/tests/rust/test_ui_wakeup/Cargo.toml
new file mode 100644
index 000000000000..b70252ac2f0b
--- /dev/null
+++ b/tests/rust/test_ui_wakeup/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "test_ui_wakeup"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+publish = false
+
+[lints]
+workspace = true
+
+[dependencies]
+re_log = { workspace = true, features = ["setup"] }
+rerun = { path = "../../../crates/top/rerun", features = [
+  "clap",
+  "web_viewer",
+] }
+
+anyhow.workspace = true
+clap = { workspace = true, features = ["derive"] }
diff --git a/tests/rust/test_ui_wakeup/src/main.rs b/tests/rust/test_ui_wakeup/src/main.rs
new file mode 100644
index 000000000000..605d3d4fef17
--- /dev/null
+++ b/tests/rust/test_ui_wakeup/src/main.rs
@@ -0,0 +1,63 @@
+//! Test that the Rerun Viewer UI wakes up as new messages arrive,
+//! even if the viewer is hidden.
+//!
+//! ## Test setup - build the viewer
+//! * `pixi run rerun-build`
+//! * `pixi run rerun-build-web`
+//!
+//! ## Test matrix
+//! * Run `cargo r -p test_ui_wakeup` and test:
+//!   * That the viewer wakes up in the background when it's alt-tabbed
+//!   * That the viewer wakes up when minimized (it should log "Received a message from…")
+//! * Run `cargo r -p test_ui_wakeup -- --serve` and test:
+//!   * The viewer wakes up when browser is alt-tabbed away
+//!   * Switch to a different browser tab, send a few messages, switch back. The messages should be there
+//!     (this is not a conclusive test, as the messages might have been received on tab select)
+
+use std::io::Read as _;
+
+#[derive(Debug, clap::Parser)]
+#[clap(author, version, about)]
+struct Args {
+    #[command(flatten)]
+    rerun: rerun::clap::RerunArgs,
+}
+
+fn main() -> anyhow::Result<()> {
+    re_log::setup_logging();
+
+    use clap::Parser as _;
+    let args = Args::parse();
+
+    // This is so that re_viewer logs incoming messages:
+    let rust_log = "info,re_viewer=trace";
+    eprintln!("Setting RUST_LOG={rust_log}");
+    std::env::set_var("RUST_LOG", rust_log);
+
+    println!("Starting Viewer…");
+    let (rec, _serve_guard) = args.rerun.init("rerun_example_ui_wakeup")?;
+
+    // Wait out some log spam from the viewer starting:
+    std::thread::sleep(std::time::Duration::from_secs(1));
+
+    println!("Now put the viewer in the background (alt-tab, minimize, put in background tab, etc");
+
+    for i in 0..usize::MAX {
+        println!("Sending message number {i}…");
+        rec.log(
+            "Text",
+            &rerun::TextDocument::new(format!("This is message number {i}")),
+        )?;
+        println!("Press ENTER to send more data to the viewer");
+
+        wait_from_enter();
+    }
+
+    Ok(())
+}
+
+fn wait_from_enter() {
+    let _ = std::io::stdin()
+        .read(&mut [0u8])
+        .expect("Failed to read from stdin");
+}