Merge pull request #4573 from benthecarman/fs-store-err

Add FilesystemStoreV2Error for v1 data detection

Author: tnull

lightning-persister/src/fs_store/v2.rs

@@ -10,13 +10,56 @@ use lightning::util::persist::{
 use std::fs;
 use std::path::PathBuf;
 use std::time::UNIX_EPOCH;
+use std::{error, fmt, io};
 
 #[cfg(feature = "tokio")]
 use core::future::Future;
 #[cfg(feature = "tokio")]
 use lightning::util::persist::{KVStore, PaginatedKVStore};
 use std::sync::Arc;
 
+/// An error returned when constructing a [`FilesystemStoreV2`].
+#[derive(Debug)]
+pub enum FilesystemStoreV2Error {
+	/// The data directory contains a file at the top level, indicating it was previously used
+	/// by [`FilesystemStore`] (v1). Contains the path of the offending file.
+	///
+	/// [`FilesystemStore`]: crate::fs_store::v1::FilesystemStore
+	V1DataDetected(PathBuf),
+	/// An I/O error occurred while inspecting the data directory.
+	Io(io::Error),
+}
+
+impl fmt::Display for FilesystemStoreV2Error {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+		match self {
+			Self::V1DataDetected(path) => write!(
+				f,
+				"Found file `{}` in the top-level data directory. \
+				 This indicates the directory was previously used by FilesystemStore (v1). \
+				 Please migrate your data or use a different directory.",
+				path.display()
+			),
+			Self::Io(err) => write!(f, "{}", err),
+		}
+	}
+}
+
+impl error::Error for FilesystemStoreV2Error {
+	fn source(&self) -> Option<&(dyn error::Error + 'static)> {
+		match self {
+			Self::V1DataDetected(_) => None,
+			Self::Io(err) => Some(err),
+		}
+	}
+}
+
+impl From<io::Error> for FilesystemStoreV2Error {
+	fn from(err: io::Error) -> Self {
+		Self::Io(err)
+	}
+}
+
 /// A [`KVStore`] and [`KVStoreSync`] implementation that writes to and reads from the file system.
 ///
 /// This is version 2 of the filesystem store which provides:
@@ -53,25 +96,18 @@ pub struct FilesystemStoreV2 {
 impl FilesystemStoreV2 {
 	/// Constructs a new [`FilesystemStoreV2`].
 	///
-	/// Returns an error if the data directory already exists and contains files at the top level,
-	/// which would indicate it was previously used by a [`FilesystemStore`] (v1). The v2 store
-	/// expects only directories (namespaces) at the top level.
+	/// Returns [`FilesystemStoreV2Error::V1DataDetected`] if the data directory already exists
+	/// and contains files at the top level, which would indicate it was previously used by a
+	/// [`FilesystemStore`] (v1). The v2 store expects only directories (namespaces) at the top
+	/// level.
 	///
 	/// [`FilesystemStore`]: crate::fs_store::v1::FilesystemStore
-	pub fn new(data_dir: PathBuf) -> std::io::Result<Self> {
+	pub fn new(data_dir: PathBuf) -> Result<Self, FilesystemStoreV2Error> {
 		if data_dir.exists() {
 			for entry in fs::read_dir(&data_dir)? {
 				let entry = entry?;
 				if entry.file_type()?.is_file() {
-					return Err(std::io::Error::new(
-						std::io::ErrorKind::InvalidData,
-						format!(
-							"Found file `{}` in the top-level data directory. \
-							This indicates the directory was previously used by FilesystemStore (v1). \
-							Please migrate your data or use a different directory.",
-							entry.path().display()
-						),
-					));
+					return Err(FilesystemStoreV2Error::V1DataDetected(entry.path()));
 				}
 			}
 		}
@@ -667,10 +703,10 @@ mod tests {
 
 		// V2 construction should fail
 		match FilesystemStoreV2::new(temp_path.clone()) {
-			Err(err) => {
-				assert_eq!(err.kind(), std::io::ErrorKind::InvalidData);
-				assert!(err.to_string().contains("FilesystemStore (v1)"));
+			Err(FilesystemStoreV2Error::V1DataDetected(path)) => {
+				assert_eq!(path, temp_path.join("some_key"));
 			},
+			Err(err) => panic!("Expected V1DataDetected, got {:?}", err),
 			Ok(_) => panic!("Expected error for directory with top-level files"),
 		}