app: add tracing::instrument on some functions

Author: istudyatuni

crates/companion-app/src/config.rs

@@ -2,7 +2,7 @@ use std::path::{Path, PathBuf};
 
 use bincode::{Decode, Encode, serde::Compat};
 use serde::{Deserialize, Serialize};
-use tracing::{debug, error, trace};
+use tracing::{debug, error, instrument, trace};
 use uuid::Uuid;
 
 const ENCODE_CONFIG: bincode::config::Configuration =
@@ -43,6 +43,7 @@ pub struct Profile {
 }
 
 impl Config {
+    #[instrument(name = "Config::new")]
     pub fn new() -> Result<Self, ConfigError> {
         let Some(config_path) = config_path() else {
             error!("config dir not found");

crates/companion-app/src/game.rs

@@ -16,7 +16,7 @@ use notify::event::ModifyKind;
 #[cfg(target_os = "linux")]
 use notify::event::RemoveKind;
 use notify::{Event, EventKind, RecommendedWatcher, RecursiveMode, Watcher};
-use tracing::{debug, error, trace, warn};
+use tracing::{debug, error, instrument, trace, warn};
 
 #[cfg(target_os = "linux")]
 const LINUX_STEAM_GAME_DIR: &str =
@@ -40,6 +40,7 @@ impl Display for InstallType {
     }
 }
 
+#[instrument]
 pub fn detect_install() -> Result<(InstallType, PathBuf), DetectError> {
     let Some(home) = home_dir() else {
         return Err(DetectError::NoHome);
@@ -65,6 +66,7 @@ pub fn detect_install() -> Result<(InstallType, PathBuf), DetectError> {
 
     for (ty, path) in search {
         if path.exists() {
+            trace!("found game path: {}", path.display());
             return Ok((ty, path));
         }
     }
@@ -74,6 +76,7 @@ pub fn detect_install() -> Result<(InstallType, PathBuf), DetectError> {
 }
 
 /// Find profiles names
+#[instrument]
 pub fn find_profiles(path: &Path) -> Result<Vec<String>, FindProfilesError> {
     let entries = std::fs::read_dir(path)?
         .map(|res| res.map(|e| e.path()))
@@ -98,6 +101,7 @@ pub fn save_file_for_profile(path: &Path, name: &OsStr) -> PathBuf {
     path.join(name).join("data.owsave")
 }
 
+#[instrument(skip_all, fields(path = install_dir.display().to_string()))]
 pub fn file_watcher(
     install_dir: PathBuf,
     #[rustfmt::skip]

crates/companion-app/src/main.rs

@@ -16,7 +16,7 @@ use std::time::Duration;
 use iced::task::Handle;
 use iced::widget::{self, Column, Space, button, column, container, row, text};
 use iced::{Element, Fill, Font, Subscription, Task, Theme, clipboard, font};
-use tracing::{debug, error, trace};
+use tracing::{debug, error, instrument, trace};
 use uuid::Uuid;
 
 use config::Config;
@@ -52,6 +52,7 @@ pub fn main() -> iced::Result {
         .run_with(|| (State::new(), Task::done(Message::Auth { force: false })))
 }
 
+#[instrument(skip(state))]
 fn update(state: &mut State, message: Message) -> Task<Message> {
     let none = Task::none();
 
@@ -235,6 +236,7 @@ fn update(state: &mut State, message: Message) -> Task<Message> {
     none
 }
 
+#[instrument(skip(state))]
 fn view(state: &State) -> Element<'_, Message> {
     if let Some(ref err) = state.error {
         let inner: Element<_> = match err {
@@ -370,6 +372,7 @@ fn view(state: &State) -> Element<'_, Message> {
     .into()
 }
 
+#[instrument(skip(state))]
 fn subscription(state: &State) -> Subscription<Message> {
     if !state.server_ok {
         return Subscription::none();
@@ -443,6 +446,7 @@ struct State {
 }
 
 impl State {
+    #[instrument(name = "State::new")]
     fn new() -> Self {
         let install_dir = match game::detect_install() {
             Ok(dir) => dir,