Improved Error Handling on Export (#476)

* Improved Error Handling on Export

While this doesn't directly address #474 as am unable to reproduce the error. It should help in diagnosing what's happening and protect from some crashes by reducing the unwraps() in the backend code.

* fix typos

Author: bencevans

src-tauri/Cargo.lock

@@ -37,6 +37,7 @@ time = "0.3.41"
 tauri-plugin-dialog = "2"
 tauri-plugin-notification = "2"
 tauri-plugin-log = "2"
+once_cell = "1.17.2"
 
 [target.'cfg(target_os = "windows")'.dependencies.ort]
 version = "2.0.0-rc.9"

src-tauri/Cargo.toml

@@ -37,7 +37,7 @@
   ],
   "definitions": {
     "Capability": {
-      "description": "A grouping and boundary mechanism developers can use to isolate access to the IPC layer.\n\nIt controls application windows' and webviews' fine grained access to the Tauri core, application, or plugin commands. If a webview or its window is not matching any capability then it has no access to the IPC layer at all.\n\nThis can be done to create groups of windows, based on their required system access, which can reduce impact of frontend vulnerabilities in less privileged windows. Windows can be added to a capability by exact name (e.g. `main-window`) or glob patterns like `*` or `admin-*`. A Window can have none, one, or multiple associated capabilities.\n\n## Example\n\n```json { \"identifier\": \"main-user-files-write\", \"description\": \"This capability allows the `main` window on macOS and Windows access to `filesystem` write related commands and `dialog` commands to enable programatic access to files selected by the user.\", \"windows\": [ \"main\" ], \"permissions\": [ \"core:default\", \"dialog:open\", { \"identifier\": \"fs:allow-write-text-file\", \"allow\": [{ \"path\": \"$HOME/test.txt\" }] }, ], \"platforms\": [\"macOS\",\"windows\"] } ```",
+      "description": "A grouping and boundary mechanism developers can use to isolate access to the IPC layer.\n\nIt controls application windows' and webviews' fine grained access to the Tauri core, application, or plugin commands. If a webview or its window is not matching any capability then it has no access to the IPC layer at all.\n\nThis can be done to create groups of windows, based on their required system access, which can reduce impact of frontend vulnerabilities in less privileged windows. Windows can be added to a capability by exact name (e.g. `main-window`) or glob patterns like `*` or `admin-*`. A Window can have none, one, or multiple associated capabilities.\n\n## Example\n\n```json { \"identifier\": \"main-user-files-write\", \"description\": \"This capability allows the `main` window on macOS and Windows access to `filesystem` write related commands and `dialog` commands to enable programmatic access to files selected by the user.\", \"windows\": [ \"main\" ], \"permissions\": [ \"core:default\", \"dialog:open\", { \"identifier\": \"fs:allow-write-text-file\", \"allow\": [{ \"path\": \"$HOME/test.txt\" }] }, ], \"platforms\": [\"macOS\",\"windows\"] } ```",
       "type": "object",
       "required": [
         "identifier",
@@ -49,7 +49,7 @@
           "type": "string"
         },
         "description": {
-          "description": "Description of what the capability is intended to allow on associated windows.\n\nIt should contain a description of what the grouped permissions should allow.\n\n## Example\n\nThis capability allows the `main` window access to `filesystem` write related commands and `dialog` commands to enable programatic access to files selected by the user.",
+          "description": "Description of what the capability is intended to allow on associated windows.\n\nIt should contain a description of what the grouped permissions should allow.\n\n## Example\n\nThis capability allows the `main` window access to `filesystem` write related commands and `dialog` commands to enable programmatic access to files selected by the user.",
           "default": "",
           "type": "string"
         },
@@ -1016,6 +1016,12 @@
           "const": "core:webview:allow-reparent",
           "markdownDescription": "Enables the reparent command without any pre-configured scope."
         },
+        {
+          "description": "Enables the set_webview_auto_resize command without any pre-configured scope.",
+          "type": "string",
+          "const": "core:webview:allow-set-webview-auto-resize",
+          "markdownDescription": "Enables the set_webview_auto_resize command without any pre-configured scope."
+        },
         {
           "description": "Enables the set_webview_background_color command without any pre-configured scope.",
           "type": "string",
@@ -1118,6 +1124,12 @@
           "const": "core:webview:deny-reparent",
           "markdownDescription": "Denies the reparent command without any pre-configured scope."
         },
+        {
+          "description": "Denies the set_webview_auto_resize command without any pre-configured scope.",
+          "type": "string",
+          "const": "core:webview:deny-set-webview-auto-resize",
+          "markdownDescription": "Denies the set_webview_auto_resize command without any pre-configured scope."
+        },
         {
           "description": "Denies the set_webview_background_color command without any pre-configured scope.",
           "type": "string",

src-tauri/gen/schemas/acl-manifests.json

@@ -37,7 +37,7 @@
   ],
   "definitions": {
     "Capability": {
-      "description": "A grouping and boundary mechanism developers can use to isolate access to the IPC layer.\n\nIt controls application windows' and webviews' fine grained access to the Tauri core, application, or plugin commands. If a webview or its window is not matching any capability then it has no access to the IPC layer at all.\n\nThis can be done to create groups of windows, based on their required system access, which can reduce impact of frontend vulnerabilities in less privileged windows. Windows can be added to a capability by exact name (e.g. `main-window`) or glob patterns like `*` or `admin-*`. A Window can have none, one, or multiple associated capabilities.\n\n## Example\n\n```json { \"identifier\": \"main-user-files-write\", \"description\": \"This capability allows the `main` window on macOS and Windows access to `filesystem` write related commands and `dialog` commands to enable programatic access to files selected by the user.\", \"windows\": [ \"main\" ], \"permissions\": [ \"core:default\", \"dialog:open\", { \"identifier\": \"fs:allow-write-text-file\", \"allow\": [{ \"path\": \"$HOME/test.txt\" }] }, ], \"platforms\": [\"macOS\",\"windows\"] } ```",
+      "description": "A grouping and boundary mechanism developers can use to isolate access to the IPC layer.\n\nIt controls application windows' and webviews' fine grained access to the Tauri core, application, or plugin commands. If a webview or its window is not matching any capability then it has no access to the IPC layer at all.\n\nThis can be done to create groups of windows, based on their required system access, which can reduce impact of frontend vulnerabilities in less privileged windows. Windows can be added to a capability by exact name (e.g. `main-window`) or glob patterns like `*` or `admin-*`. A Window can have none, one, or multiple associated capabilities.\n\n## Example\n\n```json { \"identifier\": \"main-user-files-write\", \"description\": \"This capability allows the `main` window on macOS and Windows access to `filesystem` write related commands and `dialog` commands to enable programmatic access to files selected by the user.\", \"windows\": [ \"main\" ], \"permissions\": [ \"core:default\", \"dialog:open\", { \"identifier\": \"fs:allow-write-text-file\", \"allow\": [{ \"path\": \"$HOME/test.txt\" }] }, ], \"platforms\": [\"macOS\",\"windows\"] } ```",
       "type": "object",
       "required": [
         "identifier",
@@ -49,7 +49,7 @@
           "type": "string"
         },
         "description": {
-          "description": "Description of what the capability is intended to allow on associated windows.\n\nIt should contain a description of what the grouped permissions should allow.\n\n## Example\n\nThis capability allows the `main` window access to `filesystem` write related commands and `dialog` commands to enable programatic access to files selected by the user.",
+          "description": "Description of what the capability is intended to allow on associated windows.\n\nIt should contain a description of what the grouped permissions should allow.\n\n## Example\n\nThis capability allows the `main` window access to `filesystem` write related commands and `dialog` commands to enable programmatic access to files selected by the user.",
           "default": "",
           "type": "string"
         },
@@ -1016,6 +1016,12 @@
           "const": "core:webview:allow-reparent",
           "markdownDescription": "Enables the reparent command without any pre-configured scope."
         },
+        {
+          "description": "Enables the set_webview_auto_resize command without any pre-configured scope.",
+          "type": "string",
+          "const": "core:webview:allow-set-webview-auto-resize",
+          "markdownDescription": "Enables the set_webview_auto_resize command without any pre-configured scope."
+        },
         {
           "description": "Enables the set_webview_background_color command without any pre-configured scope.",
           "type": "string",
@@ -1118,6 +1124,12 @@
           "const": "core:webview:deny-reparent",
           "markdownDescription": "Denies the reparent command without any pre-configured scope."
         },
+        {
+          "description": "Denies the set_webview_auto_resize command without any pre-configured scope.",
+          "type": "string",
+          "const": "core:webview:deny-set-webview-auto-resize",
+          "markdownDescription": "Denies the set_webview_auto_resize command without any pre-configured scope."
+        },
         {
           "description": "Denies the set_webview_background_color command without any pre-configured scope.",
           "type": "string",

src-tauri/gen/schemas/desktop-schema.json

@@ -3,29 +3,3 @@ pub mod megadetector;
 pub mod structures;
 pub mod util;
 pub mod yolov5;
-
-// #[cfg(test)]
-// mod tests {
-//     use super::yolov5::helpers::render_detections;
-//     use super::yolov5::YoloModel;
-
-//     #[test]
-//     fn create_model() {
-//         let image_path = "tests/fixtures/dataset/IMG_0089_peccary.JPG";
-
-//         let model = YoloModel::new_from_file("../md_v5a.0.0-dynamic.onnx", (1280, 1280));
-//         assert!(model.is_ok());
-
-//         let mut model = model.unwrap();
-
-//         let detections = model.detect(image_path, 0.1, 0.45);
-
-//         assert!(detections.is_ok());
-
-//         let detections = detections.unwrap();
-
-//         assert_eq!(detections.detections.len(), 1);
-
-//         render_detections(image_path, &detections, "output.jpg").unwrap();
-//     }
-// }

src-tauri/gen/schemas/macOS-schema.json

@@ -47,32 +47,38 @@ fn export_csv(
     results: Vec<structures::CamTrapImageDetections>,
     output_path: PathBuf,
 ) -> Result<(), String> {
-    let mut writer = csv::Writer::from_path(output_path).unwrap();
+    let mut writer = csv::Writer::from_path(&output_path)
+        .map_err(|e| format!("Failed to create CSV writer: {}", e))?;
 
     for result in results {
-        if let Some(error) = result.error {
-            writer
-                .serialize(CamTrapCSVDetection::new_error(result.file, error))
-                .unwrap();
+        let res = if let Some(error) = result.error {
+            writer.serialize(CamTrapCSVDetection::new_error(result.file, error))
         } else if result.detections.is_empty() {
-            writer
-                .serialize(CamTrapCSVDetection::new_empty(result.file))
-                .unwrap();
+            writer.serialize(CamTrapCSVDetection::new_empty(result.file))
         } else {
+            let mut row_result = Ok(());
             for detection in result.detections {
-                writer
-                    .serialize(CamTrapCSVDetection::new_detection(
-                        result.file.clone(),
-                        result.image_width.unwrap(),
-                        result.image_height.unwrap(),
-                        &detection,
-                    ))
-                    .unwrap();
+                if let Err(e) = writer.serialize(CamTrapCSVDetection::new_detection(
+                    result.file.clone(),
+                    result.image_width.unwrap_or(0),
+                    result.image_height.unwrap_or(0),
+                    &detection,
+                )) {
+                    row_result = Err(e);
+                    break;
+                }
             }
+            row_result
+        };
+
+        if let Err(e) = res {
+            return Err(format!("Failed to write CSV row: {}", e));
         }
     }
 
-    writer.flush().unwrap();
+    writer
+        .flush()
+        .map_err(|e| format!("Failed to flush CSV writer: {}", e))?;
 
     Ok(())
 }
@@ -81,12 +87,14 @@ fn export_json(
     results: Vec<structures::CamTrapImageDetections>,
     output_path: PathBuf,
 ) -> Result<(), String> {
-    let mut writer = std::fs::File::create(output_path).unwrap();
+    let mut writer = std::fs::File::create(&output_path)
+        .map_err(|e| format!("Failed to create JSON file: {}", e))?;
     let json_images: Vec<exports::json::CamTrapJSONImageDetections> =
         results.into_iter().map(|d| d.into()).collect();
     let json_container = exports::json::CamTrapJSONContainer::new(json_images);
 
-    serde_json::to_writer_pretty(&mut writer, &json_container).unwrap();
+    serde_json::to_writer_pretty(&mut writer, &json_container)
+        .map_err(|e| format!("Failed to write JSON: {}", e))?;
 
     Ok(())
 }
@@ -96,22 +104,14 @@ async fn export_image_set(
     state: tauri::State<'_, AppState>,
     output_path: PathBuf,
     filter_criteria: FilterCriteria,
-    draw_criteria: DrawCriteria,
-    window: Window,
-) -> Result<(), ()> {
+    draw_criteria: DrawCriteria
+) -> Result<String, String> {
     let results = state.0.lock().unwrap().results.clone();
     let base_dir = state.0.lock().unwrap().base_dir.clone();
 
     // Ensure it's not the same folder as the raw images
     if output_path == base_dir {
-        window
-            .dialog()
-            .message("The export folder cannot be the same as the raw images folder.")
-            .kind(MessageDialogKind::Error)
-            .title("Export Error")
-            .blocking_show();
-
-        return Err(());
+        return Err("The export folder cannot be the same as the raw images folder.".to_string());
     }
 
     export_image(
@@ -120,17 +120,9 @@ async fn export_image_set(
         output_path,
         filter_criteria,
         draw_criteria,
-    )
-    .unwrap();
+    ).map_err(|e| format!("Failed to export images: {}", e))?;
 
-    window
-        .dialog()
-        .message("The image export has completed.")
-        .kind(MessageDialogKind::Info)
-        .title("Image Export Complete")
-        .blocking_show();
-
-    Ok(())
+    Ok("The image export has completed.".to_string())
 }
 
 #[tauri::command]
@@ -172,6 +164,16 @@ async fn export(
         _ => "Unknown",
     };
 
+    if let Err(err) = r {
+        window
+            .dialog()
+            .message(format!("Failed to export {}: {}", format_name, err))
+            .kind(MessageDialogKind::Error)
+            .title("Export Failed")
+            .blocking_show();
+        return Err(err);
+    }
+
     window
         .dialog()
         .message(format!("The {} export has completed.", format_name))

src-tauri/src/lib.rs

@@ -2,25 +2,32 @@ use super::detections::YoloImageDetections;
 use image::{ImageError, Rgb};
 use imageproc::drawing::draw_hollow_rect_mut;
 use imageproc::rect::Rect;
+use std::collections::HashSet;
 use std::path::{Path, PathBuf};
+use once_cell::sync::Lazy;
 use walkdir::WalkDir;
 
-const IMAGE_EXTENTIONS: [&str; 3] = ["jpg", "jpeg", "png"];
+/// A set of known image file extensions
+static IMAGE_EXTENSIONS: Lazy<HashSet<&'static str>> = Lazy::new(|| {
+    ["jpg", "jpeg", "png"].iter().cloned().collect()
+});
 
-/// Check if path is a known image extention
+/// Check if path is a known image extension
 pub fn is_image_path(path: &Path) -> bool {
-    match path.extension() {
-        None => false,
-        Some(a) => IMAGE_EXTENTIONS.contains(&a.to_str().unwrap().to_lowercase().as_str()),
-    }
+    path.extension()
+        .and_then(|ext| ext.to_str())
+        .map(|ext| IMAGE_EXTENSIONS.contains(&ext.to_lowercase().as_str()))
+        .unwrap_or(false)
 }
 
-/// Find all images beleived to be an image.
+/// Find all images in a directory
+/// If `recursive` is true, it will search all subdirectories.
+/// If `recursive` is false, it will only search the root directory.
 pub fn enumerate_images(root_dir: PathBuf, recursive: bool) -> Vec<PathBuf> {
     let mut images: Vec<PathBuf> = vec![];
 
     for entry in WalkDir::new(root_dir)
-        .max_depth(if recursive { ::std::usize::MAX } else { 1 })
+        .max_depth(if recursive { usize::MAX } else { 1 })
         .into_iter()
         .filter_map(|e| e.ok())
         .filter(|e| is_image_path(e.path()))

src-tauri/src/main.rs

@@ -22,7 +22,7 @@ export interface ProgressReport {
 }
 
 export async function listenProgress(
-  onProgress: (report: ProgressReport) => void,
+  onProgress: (report: ProgressReport) => void
 ) {
   return await listen("progress", (event) => {
     const report = event.payload as ProgressReport;
@@ -37,7 +37,7 @@ export async function process(
   path: string,
   confidenceThreshold: number,
   recursive: boolean,
-  onProgress?: (report: ProgressReport) => void,
+  onProgress?: (report: ProgressReport) => void
 ) {
   await invoke("process", {
     path,
@@ -59,7 +59,10 @@ export type ExportFormat = "json" | "csv";
 export type ImageExportFormat = "image-dir";
 export type AllExportFormat = ExportFormat | ImageExportFormat;
 
-export async function createExport(format: ExportFormat, outputPath: string) {
+export async function createExport(
+  format: ExportFormat,
+  outputPath: string
+) {
   return await invoke("export", { format, outputPath });
 }
 
@@ -76,7 +79,7 @@ export function createFilterCriteria(
   animals: FilterCriteriaOption,
   humans: FilterCriteriaOption,
   vehicles: FilterCriteriaOption,
-  empty: FilterCriteriaOption,
+  empty: FilterCriteriaOption
 ): FilterCriteria {
   return {
     animals: animals,
@@ -95,7 +98,7 @@ interface DrawCriteria {
 export function createDrawCriteria(
   animals: boolean,
   humans: boolean,
-  vehicles: boolean,
+  vehicles: boolean
 ) {
   return {
     animals: animals,
@@ -107,7 +110,7 @@ export function createDrawCriteria(
 export function exportImageSet(
   outputPath: string,
   filterCriteria: FilterCriteria,
-  drawCriteria: DrawCriteria,
+  drawCriteria: DrawCriteria
 ) {
   return invoke("export_image_set", {
     outputPath,