Skip stale fs store artifacts

The exhaustive filesystem store listing treated leftover temp and trash files as namespace directories after identifying them as non-keys. Skip those artifacts before recursing so migrations can ignore crash leftovers.

Author: benthecarman

lightning-persister/src/fs_store/common.rs

@@ -653,6 +653,9 @@ impl FilesystemStoreState {
 		'primary_loop: for primary_entry in fs::read_dir(prefixed_dest)? {
 			let primary_entry = primary_entry?;
 			let primary_path = primary_entry.path();
+			if dir_entry_is_store_artifact(&primary_path) {
+				continue 'primary_loop;
+			}
 
 			if dir_entry_is_key(&primary_entry)? {
 				let primary_namespace = String::new();
@@ -666,6 +669,9 @@ impl FilesystemStoreState {
 			'secondary_loop: for secondary_entry in fs::read_dir(&primary_path)? {
 				let secondary_entry = secondary_entry?;
 				let secondary_path = secondary_entry.path();
+				if dir_entry_is_store_artifact(&secondary_path) {
+					continue 'secondary_loop;
+				}
 
 				if dir_entry_is_key(&secondary_entry)? {
 					let primary_namespace = get_key_from_dir_entry_path(
@@ -683,6 +689,9 @@ impl FilesystemStoreState {
 				for tertiary_entry in fs::read_dir(&secondary_path)? {
 					let tertiary_entry = tertiary_entry?;
 					let tertiary_path = tertiary_entry.path();
+					if dir_entry_is_store_artifact(&tertiary_path) {
+						continue;
+					}
 
 					if dir_entry_is_key(&tertiary_entry)? {
 						let primary_namespace = get_key_from_dir_entry_path(
@@ -720,20 +729,24 @@ impl FilesystemStoreState {
 	}
 }
 
+fn dir_entry_is_store_artifact(path: &Path) -> bool {
+	path.extension()
+		.and_then(|ext| ext.to_str())
+		.map_or(false, |ext| ext == "tmp" || ext == "trash")
+}
+
 pub(crate) fn dir_entry_is_key(dir_entry: &fs::DirEntry) -> Result<bool, lightning::io::Error> {
 	let p = dir_entry.path();
-	if let Some(ext) = p.extension() {
+	if dir_entry_is_store_artifact(&p) {
 		#[cfg(target_os = "windows")]
 		{
 			// Clean up any trash files lying around.
-			if ext == "trash" {
+			if p.extension().and_then(|ext| ext.to_str()) == Some("trash") {
 				fs::remove_file(p).ok();
 				return Ok(false);
 			}
 		}
-		if ext == "tmp" {
-			return Ok(false);
-		}
+		return Ok(false);
 	}
 
 	let file_type = dir_entry.file_type()?;

lightning-persister/src/fs_store/v1.rs

@@ -199,6 +199,28 @@ mod tests {
 		do_test_data_migration(&mut source_store, &mut target_store);
 	}
 
+	#[test]
+	fn list_all_keys_skips_leftover_store_artifacts() {
+		let mut temp_path = std::env::temp_dir();
+		temp_path.push("test_list_all_keys_skips_leftover_store_artifacts");
+		let fs_store = FilesystemStore::new(temp_path.clone());
+		fs_store.write("primary", "secondary", "key", vec![1]).unwrap();
+
+		fs::write(temp_path.join("top_level.0.tmp"), b"stale").unwrap();
+		fs::write(temp_path.join("top_level.0.trash"), b"stale").unwrap();
+
+		let primary_path = temp_path.join("primary");
+		fs::write(primary_path.join("primary_level.0.tmp"), b"stale").unwrap();
+		fs::write(primary_path.join("primary_level.0.trash"), b"stale").unwrap();
+
+		let secondary_path = primary_path.join("secondary");
+		fs::write(secondary_path.join("secondary_level.0.tmp"), b"stale").unwrap();
+		fs::write(secondary_path.join("secondary_level.0.trash"), b"stale").unwrap();
+
+		let keys = fs_store.list_all_keys().unwrap();
+		assert_eq!(keys, vec![("primary".to_string(), "secondary".to_string(), "key".to_string())]);
+	}
+
 	#[test]
 	fn test_if_monitors_is_not_dir() {
 		let store = FilesystemStore::new("test_monitors_is_not_dir".into());