Skip to content

Preserve TOC insert API compatibility #64

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
pathscale merged 2 commits into from
Aug 8, 2026
Merged

Preserve TOC insert API compatibility #64

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
029866a
fix: preserve TOC insert API compatibility
Aug 8, 2026
ebd4aa8
docs: pin TOC compatibility contract
Aug 8, 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
8 changes: 4 additions & 4 deletions src/persistence/space/index/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ where
self.next_page_id.fetch_add(1, Ordering::Relaxed).into()
};
self.table_of_contents
.insert((node_id.key.clone(), node_id.value), page_id)?;
.try_insert((node_id.key.clone(), node_id.value), page_id)?;
self.table_of_contents.persist(&mut self.index_file).await?;
self.add_new_index_page(node_id, page_id).await?;

Expand Down Expand Up @@ -276,7 +276,7 @@ where
&(node_id.key.clone(), node_id.value),
(page.inner.node_id.key.clone(), page.inner.node_id.link),
);
self.table_of_contents.insert(
self.table_of_contents.try_insert(
(splitted_page.node_id.key.clone(), splitted_page.node_id.link),
new_page_id,
)?;
Expand Down Expand Up @@ -437,7 +437,7 @@ where
self.next_page_id.fetch_add(1, Ordering::Relaxed).into()
};
self.table_of_contents
.insert((max_value.key.clone(), max_value.value), page_id)?;
.try_insert((max_value.key.clone(), max_value.value), page_id)?;

let size = get_index_page_size_from_data_length::<T>(INNER_PAGE_SIZE as usize);
let mut page = IndexPage::new(max_value.clone().into(), size);
Expand Down Expand Up @@ -489,7 +489,7 @@ where
page_to_update.inner.node_id.link,
),
);
self.table_of_contents.insert(
self.table_of_contents.try_insert(
(splitted_page.node_id.key.clone(), splitted_page.node_id.link),
new_page_id,
)?;
Expand Down
37 changes: 27 additions & 10 deletions src/persistence/space/index/table_of_contents.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,24 @@ where
&mut self.pages[self.current_page]
}

pub fn insert(&mut self, node_id: T, page_id: PageId) -> eyre::Result<()>
/// Inserts a fresh page identity into the table of contents.
///
/// This restores source compatibility with the public infallible API that
/// preceded PR #63. A fully constructed table of contents owns its complete
/// segment chain, so failure here is an internal invariant violation and
/// retains the historical panic-level contract. Loaded persistence paths,
/// where a truncated chain can be reported to the caller, must use
/// [`Self::try_insert`] instead.
pub fn insert(&mut self, node_id: T, page_id: PageId)
where
T: Clone + SizeMeasurable,
{
self.try_insert(node_id, page_id)
.expect("table-of-contents chain should be fully loaded");
}

/// Fallible variant of [`Self::insert`] for persistence paths.
pub fn try_insert(&mut self, node_id: T, page_id: PageId) -> eyre::Result<()>
where
T: Clone + SizeMeasurable,
{
Expand Down Expand Up @@ -241,7 +258,7 @@ mod tests {
fn insert_to_empty() {
let mut toc = IndexTableOfContents::<u8, 128>::new(0.into(), Arc::new(AtomicU32::new(0)));
let key = 1;
toc.insert(key, 1.into()).unwrap();
toc.insert(key, 1.into());

let page = toc.pages[toc.current_page].clone();
assert!(
Expand All @@ -259,7 +276,7 @@ mod tests {
#[test]
fn checked_update_reports_a_missing_identity_without_mutating_the_toc() {
let mut toc = IndexTableOfContents::<u8, 128>::new(0.into(), Arc::new(AtomicU32::new(1)));
toc.insert(7, 2.into()).unwrap();
toc.insert(7, 2.into());

assert!(!toc.try_update_key(&8, 9));
assert_eq!(toc.get(&7), Some(2.into()));
Expand All @@ -271,7 +288,7 @@ mod tests {
let mut toc = IndexTableOfContents::<u8, 20>::new(0.into(), Arc::new(AtomicU32::new(0)));
let mut keys = vec![];
for key in 0..10 {
toc.insert(key, 1.into()).unwrap();
toc.insert(key, 1.into());
keys.push(key);
}

Expand All @@ -296,7 +313,7 @@ mod tests {
fn insert_reaches_existing_tail_after_reload_resets_cursor() {
let mut toc = IndexTableOfContents::<u8, 20>::new(0.into(), Arc::new(AtomicU32::new(0)));
for key in 0..10 {
toc.insert(key, u32::from(key).into()).unwrap();
toc.insert(key, u32::from(key).into());
}
assert!(toc.pages.len() > 1, "fixture must span TOC pages");

Expand All @@ -305,7 +322,7 @@ mod tests {
// forward until an existing or newly-created tail can accept it.
toc.current_page = 0;
let before_sizes: Vec<_> = toc.pages.iter().map(|page| page.inner.estimated_size()).collect();
toc.insert(200, PageId::from(200)).unwrap();
toc.insert(200, PageId::from(200));

assert_eq!(toc.get(&200), Some(PageId::from(200)));
for (page, before_size) in toc.pages.iter().zip(before_sizes) {
Expand All @@ -324,13 +341,13 @@ mod tests {
fn insert_reports_a_truncated_segment_chain() {
let mut toc = IndexTableOfContents::<u8, 20>::new(0.into(), Arc::new(AtomicU32::new(0)));
for key in 0..10 {
toc.insert(key, u32::from(key).into()).unwrap();
toc.insert(key, u32::from(key).into());
}
assert!(!toc.pages[0].header.next_id.is_empty());
toc.pages.truncate(1);
toc.current_page = 0;

let error = toc.insert(200, PageId::from(200)).unwrap_err();
let error = toc.try_insert(200, PageId::from(200)).unwrap_err();

assert!(error.to_string().contains("links past the loaded chain"));
}
Expand All @@ -340,7 +357,7 @@ mod tests {
let mut toc = IndexTableOfContents::<u8, 20>::new(0.into(), Arc::new(AtomicU32::new(0)));
let mut keys = vec![];
for key in 0..10 {
toc.insert(key, 1.into()).unwrap();
toc.insert(key, 1.into());
keys.push(key);
}

Expand Down Expand Up @@ -368,7 +385,7 @@ mod tests {
let new_key = keys.last().unwrap() + 1;
let id = toc.pop_empty_page_id().unwrap();
let before_insert_segments = toc.pages.len();
toc.insert(new_key, id).unwrap();
toc.insert(new_key, id);
assert_eq!(toc.get(&new_key), Some(id), "reused page id was not recorded");
assert_eq!(
toc.pages.len(),
Expand Down
8 changes: 4 additions & 4 deletions src/persistence/space/index/unsized_.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ where
self.next_page_id.fetch_add(1, Ordering::Relaxed).into()
};
self.table_of_contents
.insert((node_id.key.clone(), node_id.value), page_id)?;
.try_insert((node_id.key.clone(), node_id.value), page_id)?;
self.table_of_contents.persist(&mut self.index_file).await?;
self.add_new_index_page(node_id, page_id).await?;

Expand Down Expand Up @@ -304,7 +304,7 @@ where
&(node_id.key, node_id.value),
(page.inner.node_id.key.clone(), page.inner.node_id.link),
);
self.table_of_contents.insert(
self.table_of_contents.try_insert(
(splitted_page.node_id.key.clone(), splitted_page.node_id.link),
new_page_id,
)?;
Expand Down Expand Up @@ -489,7 +489,7 @@ where
self.next_page_id.fetch_add(1, Ordering::Relaxed).into()
};
self.table_of_contents
.insert((max_value.key.clone(), max_value.value), page_id)?;
.try_insert((max_value.key.clone(), max_value.value), page_id)?;

let page = UnsizedIndexPage::<T, INNER_PAGE_SIZE>::new(max_value.clone().into())?;
let header = GeneralHeader::new(page_id, PageType::IndexUnsized, self.space_id);
Expand Down Expand Up @@ -559,7 +559,7 @@ where
));
}
let right_page_key = (splitted_page.node_id.key.clone(), splitted_page.node_id.link);
self.table_of_contents.insert(right_page_key.clone(), new_page_id)?;
self.table_of_contents.try_insert(right_page_key.clone(), new_page_id)?;
if self.table_of_contents.get(&right_page_key) != Some(new_page_id) {
return Err(eyre!(
"unsized index split identity did not become canonical (page={new_page_id:?})"
Expand Down
6 changes: 2 additions & 4 deletions src/persistence/space/index/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ where
let mut toc = IndexTableOfContents::new(0.into(), next_page_id.clone());
for page in pages {
let page_id = next_page_id.fetch_add(1, Ordering::Relaxed);
toc.insert((page.node_id.key.clone(), page.node_id.link), page_id.into())
.expect("new in-memory TOC chain should remain internally consistent");
toc.insert((page.node_id.key.clone(), page.node_id.link), page_id.into());
let header = GeneralHeader::new(page_id.into(), PageType::Index, 0.into());
let index_page = GeneralPage { inner: page, header };
general_index_pages.push(index_page)
Expand All @@ -46,8 +45,7 @@ where
let mut toc = IndexTableOfContents::new(0.into(), next_page_id.clone());
for page in pages {
let page_id = next_page_id.fetch_add(1, Ordering::Relaxed);
toc.insert((page.node_id.key.clone(), page.node_id.link), page_id.into())
.expect("new in-memory TOC chain should remain internally consistent");
toc.insert((page.node_id.key.clone(), page.node_id.link), page_id.into());
let header = GeneralHeader::new(page_id.into(), PageType::IndexUnsized, 0.into());
let index_page = GeneralPage { inner: page, header };
general_index_pages.push(index_page)
Expand Down
4 changes: 3 additions & 1 deletion tests/persistence/toc/write.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ async fn test_persist_index_table_of_contents() {
remove_file_if_exists("tests/data/persist_index_table_of_contents.wt.idx".to_string()).await;

let mut toc = IndexTableOfContents::<u32, { INNER_PAGE_SIZE as u32 }>::new(0.into(), Arc::new(AtomicU32::new(1)));
toc.insert(13, 1.into()).unwrap();
// Compile-time compatibility regression: the public API before PR #63
// returned unit, including for callers that bind the expression's type.
let _: () = toc.insert(13, 1.into());
let mut file = File::create("tests/data/persist_index_table_of_contents.wt.idx")
.await
.unwrap();
Expand Down
Loading