Skip to content

(#294) [v0.10] fix(s3): keep child objects visible beneath folder markers #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArnavBalyan merged 2 commits into from
Sep 29, 2026
Merged

(#294) [v0.10] fix(s3): keep child objects visible beneath folder markers #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3eed84
fix(s3): keep child objects visible beneath folder markers
Keda710 Sep 28, 2026
bc69887
fix(s3): skip object storage internals during recursive listing
Keda710 Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 56 additions & 25 deletions crates/openlake_io/src/local_fs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -962,6 +962,7 @@ impl StorageBackend for LocalFsBackend {
recursive,
start_after,
max_keys,
None,
&mut out,
)
.await?;
Expand Down Expand Up @@ -1269,6 +1270,7 @@ fn walk_dir_local_inner<'a>(
recursive: bool,
start_after: Option<&'a str>,
max_keys: Option<usize>,
skip_internal: Option<Vec<String>>,
out: &'a mut Vec<(String, FileInfo)>,
) -> std::pin::Pin<Box<dyn std::future::Future<Output = IoResult<()>> + 'a>> {
Box::pin(async move {
Expand All @@ -1280,6 +1282,13 @@ fn walk_dir_local_inner<'a>(
let mut entries = backend.list_dir(volume, dir, 0).await?;
entries.sort();
for name in entries {
if skip_internal.as_ref().is_some_and(|data_dirs| {
name == META_FILENAME
|| name == META_BACKUP_FILENAME
|| data_dirs.iter().any(|data_dir| data_dir == &name)
}) {
continue;
}
if let Some(n) = max_keys {
if out.len() >= n {
return Ok(());
Expand All @@ -1306,34 +1315,56 @@ fn walk_dir_local_inner<'a>(
continue;
}

match backend.read_version("", volume, &child, None, false).await {
Ok(fi) => {
if !prefix_filter.is_empty() && !fi.name.starts_with(prefix_filter) {
continue;
}
if let Some(after) = start_after {
if fi.name.as_str() <= after {
continue;
}
}
out.push((fi.name.clone(), fi));
}
Err(IoError::FileNotFound { .. }) => {
if recursive {
walk_dir_local_inner(
backend,
let (descend, child_skip_internal) =
match compio::fs::read(backend.meta_path(volume, &child)).await {
Ok(bytes) => {
let records = match xl_meta::decode_all(bytes::Bytes::from(bytes)) {
Ok(records) => records,
Err(_) => continue,
};
let data_dirs = records
.iter()
.filter(|record| !record.data_dir.is_empty())
.map(|record| record.data_dir.clone())
.collect();
let mut fi = xl_meta::file_info_from_record(
records
.into_iter()
.next()
.expect("decoded metadata has a version"),
volume,
&child,
prefix_filter,
recursive,
start_after,
max_keys,
out,
)
.await?;
);
fi.data = None;
if (prefix_filter.is_empty() || fi.name.starts_with(prefix_filter))
&& start_after.is_none_or(|after| fi.name.as_str() > after)
{
out.push((fi.name.clone(), fi));
}
// Descend into real children, skipping this object's shard directories.
(true, Some(data_dirs))
}
}
Err(_) => continue,
Err(error) if error.kind() == std::io::ErrorKind::NotFound => (
recursive
&& std::fs::symlink_metadata(backend.file_path(volume, &child))
.is_ok_and(|meta| meta.file_type().is_dir()),
None,
),
Err(_) => continue,
};
if recursive && descend {
walk_dir_local_inner(
backend,
volume,
&child,
prefix_filter,
recursive,
start_after,
max_keys,
child_skip_internal,
out,
)
.await?;
}
}
Ok(())
Expand Down
48 changes: 48 additions & 0 deletions crates/openlake_storage/src/engine.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3214,6 +3214,54 @@ mod tests {
}
}

#[compio::test]
async fn list_folder_marker_keeps_child_visible() {
let (_dirs, e) = eng(3, 3).await;
put_bytes(&e, "buk", "folder/child.txt", b"child".to_vec(), None).await;
put_bytes(&e, "buk", "folder/", Vec::new(), None).await;

let listed = e.list("buk", "folder/", None, 0).await.unwrap();
let keys: Vec<&str> = listed.iter().map(|object| object.key.as_str()).collect();
assert_eq!(keys, ["folder/child.txt"]);

let root = e.list("buk", "", None, 0).await.unwrap();
assert!(root.iter().any(|object| object.key == "folder/child.txt"));

let after_marker = e.list("buk", "folder/", Some("folder/"), 1).await.unwrap();
assert_eq!(after_marker[0].key, "folder/child.txt");
assert_eq!(get_bytes(&e, "buk", "folder/child.txt").await.1, b"child");
}

#[compio::test]
async fn list_folder_marker_skips_version_data_directories() {
let (dirs, e) = eng(3, 3).await;
e.put_bucket_versioning("buk", VersioningStatus::Enabled)
.await
.unwrap();
put_bytes(&e, "buk", "folder/child.txt", b"child".to_vec(), None).await;
put_bytes(&e, "buk", "folder/", vec![1; 200 * 1024], None).await;
std::thread::sleep(std::time::Duration::from_millis(2));
put_bytes(&e, "buk", "folder/", vec![2; 200 * 1024], None).await;

for dir in &dirs {
let folder = dir.path().join("buk/folder");
let records = openlake_io::xl_meta::decode_all(bytes::Bytes::from(
std::fs::read(folder.join("xl.meta")).unwrap(),
))
.unwrap();
assert_eq!(records.len(), 2);
for record in records {
let internal = folder.join(record.data_dir).join("sentinel");
std::fs::create_dir_all(&internal).unwrap();
std::fs::copy(folder.join("child.txt/xl.meta"), internal.join("xl.meta")).unwrap();
}
}

let listed = e.list("buk", "folder/", None, 0).await.unwrap();
let keys: Vec<&str> = listed.iter().map(|object| object.key.as_str()).collect();
assert_eq!(keys, ["folder/child.txt"]);
}

/// 1 MiB payload — straight onto the EC streaming path with the
/// default inline cutoff (128 KiB). EC(2+1) on a 3-disk set, no
/// faults, exact-bytes round trip via streaming.
Expand Down
Loading