feat: add puffin profiling

Author: c-git

.vscode/settings.json

@@ -8,5 +8,7 @@
     "logviewer",
     "pkill",
     "xfixes"
-  ]
+  ],
+
+  "rust-analyzer.cargo.features": ["profiling"]
 }

Cargo.lock

@@ -26,6 +26,9 @@ tracing = "0.1.41"
 poll-promise = { version = "0.3.0", features = ["tokio"] }
 tokio = { version = "1.43", default-features = false } # I suspect features are brought in with poll-promise (not able to separate out to see what we need)
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
+puffin = { version = "0.19", optional = true }
+puffin_http = { version = "0.16", optional = true }
+profiling = { version = "1", features = ["profile-with-puffin"], optional = true }
 
 # web:
 [target.'cfg(target_arch = "wasm32")'.dependencies]
@@ -41,11 +44,12 @@ opt-level = 2 # fast and small wasm
 [profile.dev.package."*"]
 opt-level = 2
 
-[patch.crates-io]
-
 [dev-dependencies]
 insta = { version = "1.42", features = ["ron", "glob", "yaml"] }
 pretty_assertions = "1.4.1"
 ron = "0.8.1"
 rstest = "0.24"
 strum = { version = "0.27.1", features = ["derive"] }
+
+[features]
+profiling = ["dep:profiling", "dep:puffin_http", "dep:puffin"]

Cargo.toml

@@ -12,5 +12,9 @@ background = false
 on_change_strategy = "kill_then_restart"
 kill = ["pkill", "-TERM", "-P"]
 
+[jobs.run-profiling]
+command = ["cargo", "run", "--features=profiling"]
+
 [keybindings]
 ctrl-d = "job:reset-settings-and-run"
+ctrl-r = "job:run-profiling"

bacon.toml

@@ -32,6 +32,9 @@ async fn main() -> eframe::Result<()> {
             ),
         ..Default::default()
     };
+    #[cfg(feature = "profiling")]
+    start_puffin_server();
+
     eframe::run_native(
         "Log Viewer",
         native_options,
@@ -85,3 +88,30 @@ fn main() {
         }
     });
 }
+
+#[cfg(feature = "profiling")]
+fn start_puffin_server() {
+    puffin::set_scopes_on(true); // tell puffin to collect data
+
+    match puffin_http::Server::new("127.0.0.1:8585") {
+        Ok(puffin_server) => {
+            tracing::info!(
+                "Run:  cargo install puffin_viewer && puffin_viewer --url 127.0.0.1:8585"
+            );
+
+            std::process::Command::new("puffin_viewer")
+                .arg("--url")
+                .arg("127.0.0.1:8585")
+                .spawn()
+                .ok();
+
+            // We can store the server if we want, but in this case we just want
+            // it to keep running. Dropping it closes the server, so let's not drop it!
+            #[allow(clippy::mem_forget)]
+            std::mem::forget(puffin_server);
+        }
+        Err(err) => {
+            tracing::error!("Failed to start puffin server: {err}");
+        }
+    };
+}