Bug fixes round 3 (#298)

* fixed bugs

* title case

* bugs; ioerror

* reset breadcrumbs

* more fixes

* more fixes

* scrolling bug

* more fixes

* more fixes

* clippy

* canonicalize fix

* fixed requested changes

* removed debouncer update

theseus/src/util/fetch.rs

@@ -9,10 +9,9 @@ use std::ffi::OsStr;
 use std::path::{Path, PathBuf};
 use std::time;
 use tokio::sync::{RwLock, Semaphore};
-use tokio::{
-    fs::{self, File},
-    io::AsyncWriteExt,
-};
+use tokio::{fs::File, io::AsyncWriteExt};
+
+use super::io::{self, IOError};
 
 #[derive(Debug)]
 pub struct IoSemaphore(pub RwLock<Semaphore>);
@@ -193,7 +192,7 @@ where
     let io_semaphore = semaphore.0.read().await;
     let _permit = io_semaphore.acquire().await?;
 
-    let json = fs::read(path).await?;
+    let json = io::read(path).await?;
     let json = serde_json::from_slice::<T>(&json)?;
 
     Ok(json)
@@ -209,11 +208,15 @@ pub async fn write<'a>(
     let _permit = io_semaphore.acquire().await?;
 
     if let Some(parent) = path.parent() {
-        fs::create_dir_all(parent).await?;
+        io::create_dir_all(parent).await?;
     }
 
-    let mut file = File::create(path).await?;
-    file.write_all(bytes).await?;
+    let mut file = File::create(path)
+        .await
+        .map_err(|e| IOError::with_path(e, path))?;
+    file.write_all(bytes)
+        .await
+        .map_err(|e| IOError::with_path(e, path))?;
     tracing::trace!("Done writing file {}", path.display());
     Ok(())
 }
@@ -235,7 +238,7 @@ pub async fn write_cached_icon(
 
     write(&path, &bytes, semaphore).await?;
 
-    let path = dunce::canonicalize(path)?;
+    let path = io::canonicalize(path)?;
     Ok(path)
 }
 

theseus/src/util/io.rs

@@ -0,0 +1,149 @@
+// IO error
+// A wrapper around the tokio IO functions that adds the path to the error message, instead of the uninformative std::io::Error.
+
+#[derive(Debug, thiserror::Error)]
+pub enum IOError {
+    #[error("{source}, path: {path}")]
+    IOPathError {
+        #[source]
+        source: std::io::Error,
+        path: String,
+    },
+    #[error(transparent)]
+    IOError(#[from] std::io::Error),
+}
+
+impl IOError {
+    pub fn from(source: std::io::Error) -> Self {
+        Self::IOError(source)
+    }
+    pub fn with_path(
+        source: std::io::Error,
+        path: impl AsRef<std::path::Path>,
+    ) -> Self {
+        let path = path.as_ref();
+
+        Self::IOPathError {
+            source,
+            path: path.to_string_lossy().to_string(),
+        }
+    }
+}
+
+// dunce canonicalize
+pub fn canonicalize(
+    path: impl AsRef<std::path::Path>,
+) -> Result<std::path::PathBuf, IOError> {
+    let path = path.as_ref();
+    dunce::canonicalize(path).map_err(|e| IOError::IOPathError {
+        source: e,
+        path: path.to_string_lossy().to_string(),
+    })
+}
+
+// read_dir
+pub async fn read_dir(
+    path: impl AsRef<std::path::Path>,
+) -> Result<tokio::fs::ReadDir, IOError> {
+    let path = path.as_ref();
+    tokio::fs::read_dir(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// create_dir_all
+pub async fn create_dir_all(
+    path: impl AsRef<std::path::Path>,
+) -> Result<(), IOError> {
+    let path = path.as_ref();
+    tokio::fs::create_dir_all(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// remove_dir_all
+pub async fn remove_dir_all(
+    path: impl AsRef<std::path::Path>,
+) -> Result<(), IOError> {
+    let path = path.as_ref();
+    tokio::fs::remove_dir_all(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// read_to_string
+pub async fn read_to_string(
+    path: impl AsRef<std::path::Path>,
+) -> Result<String, IOError> {
+    let path = path.as_ref();
+    tokio::fs::read_to_string(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// read
+pub async fn read(
+    path: impl AsRef<std::path::Path>,
+) -> Result<Vec<u8>, IOError> {
+    let path = path.as_ref();
+    tokio::fs::read(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// write
+pub async fn write(
+    path: impl AsRef<std::path::Path>,
+    data: impl AsRef<[u8]>,
+) -> Result<(), IOError> {
+    let path = path.as_ref();
+    tokio::fs::write(path, data)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}
+
+// rename
+pub async fn rename(
+    from: impl AsRef<std::path::Path>,
+    to: impl AsRef<std::path::Path>,
+) -> Result<(), IOError> {
+    let from = from.as_ref();
+    let to = to.as_ref();
+    tokio::fs::rename(from, to)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: from.to_string_lossy().to_string(),
+        })
+}
+
+// remove file
+pub async fn remove_file(
+    path: impl AsRef<std::path::Path>,
+) -> Result<(), IOError> {
+    let path = path.as_ref();
+    tokio::fs::remove_file(path)
+        .await
+        .map_err(|e| IOError::IOPathError {
+            source: e,
+            path: path.to_string_lossy().to_string(),
+        })
+}

theseus/src/util/jre.rs

@@ -1,4 +1,4 @@
-use dunce::canonicalize;
+use super::io;
 use futures::prelude::*;
 use serde::{Deserialize, Serialize};
 use std::env;
@@ -270,7 +270,7 @@ pub async fn check_java_at_filepaths(
 pub async fn check_java_at_filepath(path: &Path) -> Option<JavaVersion> {
     // Attempt to canonicalize the potential java filepath
     // If it fails, this path does not exist and None is returned (no Java here)
-    let Ok(path) = canonicalize(path) else { return None };
+    let Ok(path) = io::canonicalize(path) else { return None };
 
     // Checks for existence of Java at this filepath
     // Adds JAVA_BIN to the end of the path if it is not already there

theseus/src/util/mod.rs

@@ -1,5 +1,6 @@
 //! Theseus utility functions
 pub mod fetch;
+pub mod io;
 pub mod jre;
 pub mod platform;