feat: add profiling scopes

Author: c-git

src/app.rs

@@ -93,6 +93,8 @@ impl LogViewerApp {
     }
 
     fn show_log_lines(&mut self, ui: &mut egui::Ui) {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("show_log_lines");
         let text_height = egui::TextStyle::Body
             .resolve(ui.style())
             .size
@@ -220,6 +222,8 @@ impl LogViewerApp {
     }
 
     fn show_log_details(&mut self, ui: &mut egui::Ui) {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("show_log_details");
         let Some(data) = self.data.as_mut() else {
             ui.label("No data");
             return;
@@ -315,6 +319,8 @@ impl LogViewerApp {
                 self.loading_status = match Data::try_from((&self.data_display_options, &data[..]))
                 {
                     Ok(mut data) => {
+                        #[cfg(feature = "profiling")]
+                        puffin::profile_scope!("swap_data_after_load");
                         if let Some(old_data) = self.data.as_mut() {
                             // Preserve settings across loads of the data
                             data.take_config(old_data, self.data_display_options.common_fields());
@@ -474,6 +480,9 @@ impl LogViewerApp {
     #[cfg(not(target_arch = "wasm32"))]
     /// Attempts to read the contents of the last loaded file and return it in a loading status otherwise returns an error loading status
     fn reload_file(&self) -> LoadingStatus {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("reload_file");
+        // TODO 5: Determine if this should spawn a task to do the load
         let Some(folder) = self.start_open_path.lock().unwrap().clone() else {
             return LoadingStatus::Failed("no staring folder available".into());
         };
@@ -489,6 +498,9 @@ impl LogViewerApp {
 
     #[cfg(not(target_arch = "wasm32"))]
     fn load_most_recent_file(&self) -> LoadingStatus {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("load_most_recent_file");
+        // TODO 5: Determine if this should spawn a task to do the load (might be able to reuse the normal load)
         let Some(folder) = self.start_open_path.lock().unwrap().clone() else {
             return LoadingStatus::Failed("unable to find starting folder".into());
         };
@@ -739,6 +751,8 @@ impl LogViewerApp {
     }
 
     fn is_changed_since_last_save(&mut self) -> bool {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("is_changed_since_last_save");
         let as_ron = match ron::to_string(&self) {
             Ok(s) => s,
             Err(err_msg) => {
@@ -804,8 +818,12 @@ fn execute<F: std::future::Future<Output = Box<LoadingStatus>> + 'static>(
 impl eframe::App for LogViewerApp {
     /// Called by the frame work to save state before shutdown.
     fn save(&mut self, storage: &mut dyn eframe::Storage) {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("eframe::App::save");
         if self.is_changed_since_last_save() {
             info!("Saving data");
+            #[cfg(feature = "profiling")]
+            puffin::profile_scope!("Saving App State");
             eframe::set_value(storage, eframe::APP_KEY, self);
         } else {
             debug!("Save skipped, no change detected");
@@ -814,8 +832,12 @@ impl eframe::App for LogViewerApp {
 
     /// Called each time the UI needs repainting, which may be many times per second.
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("update_loop");
         egui::TopBottomPanel::top("top_panel").show(ctx, |ui| {
             // The top panel is often a good place for a menu bar:
+            #[cfg(feature = "profiling")]
+            puffin::profile_scope!("top_panel");
 
             self.check_global_shortcuts(ui);
 
@@ -837,6 +859,8 @@ impl eframe::App for LogViewerApp {
 
         egui::CentralPanel::default().show(ctx, |ui| {
             // The central panel the region left after adding TopPanel's and SidePanel's
+            #[cfg(feature = "profiling")]
+            puffin::profile_scope!("outer_central_panel");
             static HEADING: LazyLock<&'static str> =
                 LazyLock::new(|| format!("Log Viewer {}", env!("CARGO_PKG_VERSION")).leak());
             ui.heading(*HEADING);
@@ -857,6 +881,8 @@ impl eframe::App for LogViewerApp {
                 .max_height(max_details_height)
                 .min_height(60.)
                 .show_inside(ui, |ui| {
+                    #[cfg(feature = "profiling")]
+                    puffin::profile_scope!("bottom_panel");
                     ui.vertical_centered(|ui| {
                         ui.heading("Details");
                     });
@@ -871,6 +897,8 @@ impl eframe::App for LogViewerApp {
                 });
 
             egui::CentralPanel::default().show_inside(ui, |ui| {
+                #[cfg(feature = "profiling")]
+                puffin::profile_scope!("inner_central_panel");
                 egui::ScrollArea::horizontal()
                     .id_salt("log lines")
                     .show(ui, |ui| {

src/app/data.rs

@@ -313,6 +313,9 @@ impl Data {
     }
 
     pub(crate) fn row_heights(&self, text_height: f32) -> impl Iterator<Item = f32> {
+        #[cfg(feature = "profiling")]
+        puffin::profile_scope!("calculate row heights");
+        // TODO 5: See if this is taking too long and cache value instead of recalculating each frame
         self.rows_iter()
             .map(|x| {
                 // TODO 4: Remove hard coded "msg"