From 519a7c31b37c9aa29ae2f0e5af66056ffcd3d443 Mon Sep 17 00:00:00 2001
From: Astrid Yu <astrid@astrid.tech>
Date: Sat, 26 Aug 2023 22:35:13 -0700
Subject: [PATCH] tracing::instrument everywhere

---
 src/burn/state_tracking.rs   | 2 +-
 src/ui/ask_hash.rs           | 5 +++++
 src/ui/ask_outfile.rs        | 4 ++++
 src/ui/burn/fancy/display.rs | 2 ++
 src/ui/burn/fancy/state.rs   | 3 +++
 src/ui/burn/start.rs         | 2 ++
 src/ui/main.rs               | 1 +
 7 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/burn/state_tracking.rs b/src/burn/state_tracking.rs
index 4f577ad..7483403 100644
--- a/src/burn/state_tracking.rs
+++ b/src/burn/state_tracking.rs
@@ -28,6 +28,7 @@ impl ChildState {
         ChildState::Burning(Burning::new(now, is_input_compressed, input_file_bytes))
     }
 
+    #[tracing::instrument(skip_all, fields(now, msg))]
     pub fn on_status(mut self, now: Instant, msg: Option<StatusMessage>) -> Self {
         match msg {
             Some(StatusMessage::TotalBytes { src, dest }) => {
@@ -35,7 +36,6 @@ impl ChildState {
                 self
             }
             Some(StatusMessage::FinishedWriting { verifying }) => {
-                debug!(verifying, "Got FinishedWriting");
                 match self {
                     ChildState::Burning(st) => st.into_finished(now, verifying),
                     c => c,
diff --git a/src/ui/ask_hash.rs b/src/ui/ask_hash.rs
index 79e97f9..d880b1d 100644
--- a/src/ui/ask_hash.rs
+++ b/src/ui/ask_hash.rs
@@ -16,6 +16,7 @@ use crate::{
 
 use super::cli::{BurnArgs, HashArg, HashOf};
 
+#[tracing::instrument(skip_all, fields(cf))]
 pub fn ask_hash(args: &BurnArgs, cf: CompressionFormat) -> anyhow::Result<Option<FileHashInfo>> {
     let hash_params = match &args.hash {
         HashArg::Skip => None,
@@ -54,6 +55,7 @@ pub fn ask_hash(args: &BurnArgs, cf: CompressionFormat) -> anyhow::Result<Option
     Ok(Some(hash_result))
 }
 
+#[tracing::instrument]
 fn ask_hash_loop(cf: CompressionFormat) -> anyhow::Result<Option<BeginHashParams>> {
     loop {
         match ask_hash_once(cf) {
@@ -118,6 +120,7 @@ fn ask_hash_once(cf: CompressionFormat) -> anyhow::Result<BeginHashParams> {
     })
 }
 
+#[tracing::instrument]
 fn ask_hasher_compression(
     cf: CompressionFormat,
     hash_of: Option<HashOf>,
@@ -140,6 +143,7 @@ fn ask_hasher_compression(
     })
 }
 
+#[tracing::instrument(skip_all, fields(path))]
 fn do_hashing(path: &Path, params: &BeginHashParams) -> anyhow::Result<FileHashInfo> {
     let mut file = File::open(path)?;
 
@@ -170,6 +174,7 @@ fn do_hashing(path: &Path, params: &BeginHashParams) -> anyhow::Result<FileHashI
     }
 }
 
+#[derive(Debug)]
 struct BeginHashParams {
     expected_hash: Vec<u8>,
     alg: HashAlg,
diff --git a/src/ui/ask_outfile.rs b/src/ui/ask_outfile.rs
index e88735d..c3c7d97 100644
--- a/src/ui/ask_outfile.rs
+++ b/src/ui/ask_outfile.rs
@@ -11,6 +11,7 @@ use crate::{
 
 use super::burn::start::BeginParams;
 
+#[tracing::instrument(skip_all)]
 pub fn ask_compression(args: &BurnArgs) -> anyhow::Result<CompressionFormat> {
     let cf = match args.compression {
         CompressionArg::Auto | CompressionArg::Ask => {
@@ -53,6 +54,7 @@ pub fn ask_compression(args: &BurnArgs) -> anyhow::Result<CompressionFormat> {
     return Ok(format);
 }
 
+#[tracing::instrument(skip_all)]
 pub fn ask_outfile(args: &BurnArgs) -> anyhow::Result<BurnTarget> {
     let mut show_all_disks = args.show_all_disks;
 
@@ -83,6 +85,7 @@ pub fn ask_outfile(args: &BurnArgs) -> anyhow::Result<BurnTarget> {
     }
 }
 
+#[tracing::instrument(skip_all)]
 pub fn confirm_write(args: &BurnArgs, begin_params: &BeginParams) -> Result<bool, InquireError> {
     if args.force {
         debug!("Skipping confirm because of --force");
@@ -127,6 +130,7 @@ impl fmt::Display for ListOption {
     }
 }
 
+#[tracing::instrument]
 fn enumerate_options(show_all_disks: bool) -> anyhow::Result<Vec<ListOption>> {
     let mut burn_targets: Vec<BurnTarget> = enumerate_devices()
         .filter(|d| show_all_disks || d.removable == Removable::Yes)
diff --git a/src/ui/burn/fancy/display.rs b/src/ui/burn/fancy/display.rs
index de54156..cdb397f 100644
--- a/src/ui/burn/fancy/display.rs
+++ b/src/ui/burn/fancy/display.rs
@@ -57,6 +57,7 @@ where
         Ok(())
     }
 
+    #[tracing::instrument(skip_all)]
     async fn get_and_handle_events(mut self) -> anyhow::Result<FancyUI<'a, B>> {
         let msg = {
             if let Some(handle) = &mut self.handle {
@@ -81,6 +82,7 @@ async fn child_dead(events: &mut EventStream) -> anyhow::Result<UIEvent> {
     Ok(UIEvent::RecvTermEvent(events.next().await.unwrap()?))
 }
 
+#[tracing::instrument(skip_all)]
 async fn child_active(events: &mut EventStream, handle: &mut Handle) -> anyhow::Result<UIEvent> {
     let sleep = tokio::time::sleep(time::Duration::from_millis(250));
     select! {
diff --git a/src/ui/burn/fancy/state.rs b/src/ui/burn/fancy/state.rs
index a557b25..2f1276a 100644
--- a/src/ui/burn/fancy/state.rs
+++ b/src/ui/burn/fancy/state.rs
@@ -34,6 +34,8 @@ impl State {
             child: ChildState::initial(now, !params.compression.is_identity(), input_file_bytes),
         }
     }
+
+    #[tracing::instrument(skip_all, fields(ev))]
     pub fn on_event(self, ev: UIEvent) -> anyhow::Result<Self> {
         trace!("Handling {ev:?}");
 
@@ -47,6 +49,7 @@ impl State {
         })
     }
 
+    #[tracing::instrument(skip_all, fields(ev))]
     fn on_term_event(self, ev: Event) -> anyhow::Result<Self> {
         match ev {
             Event::Key(KeyEvent {
diff --git a/src/ui/burn/start.rs b/src/ui/burn/start.rs
index 4ef5f00..5a9be37 100644
--- a/src/ui/burn/start.rs
+++ b/src/ui/burn/start.rs
@@ -55,6 +55,7 @@ impl BeginParams {
     }
 }
 
+#[tracing::instrument(skip_all, fields(root, interactive))]
 pub async fn try_start_burn(
     args: &BurnConfig,
     root: UseSudo,
@@ -97,6 +98,7 @@ pub async fn try_start_burn(
     Err(dc.into())
 }
 
+#[tracing::instrument(skip_all, fields(interactive))]
 pub async fn begin_writing(
     interactive: Interactive,
     params: BeginParams,
diff --git a/src/ui/main.rs b/src/ui/main.rs
index 9f66d83..e79b194 100644
--- a/src/ui/main.rs
+++ b/src/ui/main.rs
@@ -13,6 +13,7 @@ use clap::Parser;
 use inquire::InquireError;
 use tracing::debug;
 
+#[tracing::instrument]
 #[tokio::main]
 pub async fn main() {
     init_logging_parent();