fix(storage): keep a page changed by another device when saving over it

A change from another device could reach the page file while a stroke was
being drawn; the check that takes it over waits until everything is saved,
so the next autosave overwrote it. save_page now notices that the file is
not what this process last read or wrote: their version is kept as a
conflict copy (which becomes a page of its own), or simply stays if there
is nothing new to save here.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This commit is contained in:
haraldandClaude Fable 5.2 committed 2026-11-14 16:46:06 +01:00
1 parent 41323950dc
commit 36bb77c299
6 files changed
+186 -12

No files matched your search

+96
View File
@@ -461,6 +461,102 @@ mod tests {
assert!(outcome.is_empty(), "{outcome:?}");
}
/// Writes the page file the way a sync client does: behind the back of `storage`.
fn write_from_another_device(dir: &Path, page: &Page) {
let bytes = serde_json::to_vec(&PageData::from(page)).unwrap();
fs::write(dir.join(format!("page_{}.json", page.id)), bytes).unwrap();
}
fn conflict_copies(dir: &Path) -> Vec<String> {
fs::read_dir(dir)
.unwrap()
.flatten()
.map(|e| e.file_name().to_string_lossy().into_owned())
.filter(|n| conflict_copy_of(n).is_some())
.collect()
}
#[test]
fn test_saving_over_a_change_from_another_device_keeps_both() {
let dir = tempfile::tempdir().unwrap();
let (mut notebook, mut manifest) = saved_notebook(dir.path());
let now = Instant::now();
let mut watch = DiskWatch::new(dir.path().to_path_buf(), now);
// Their stroke arrives while a stroke is being drawn here, so the check has to wait
let mut theirs = notebook.current_page().clone();
theirs.add_stroke(stroke(5, 300.0));
write_from_another_device(dir.path(), &theirs);
// The stroke is finished and saved before the check ran
notebook.current_page_mut().add_stroke(stroke(2, 200.0));
notebook.next_stroke_id = 3;
storage::save_page(dir.path(), &PageData::from(notebook.current_page())).unwrap();
// Ours is in the page file, theirs next to it
let saved = storage::load_page(dir.path(), 1).unwrap();
let ids: Vec<u64> = saved.strokes.iter().map(|s| s.id).collect();
assert_eq!(ids, vec![1, 2]);
assert_eq!(conflict_copies(dir.path()).len(), 1);
// The check turns their version into a page of its own
let outcome = watch.check(&mut notebook, &mut manifest, now);
assert_eq!(outcome.conflict_pages.len(), 1);
assert_eq!(notebook.pages.len(), 2);
assert_eq!(notebook.pages[0].strokes.len(), 2);
assert_eq!(notebook.pages[1].strokes.len(), 2);
assert!(conflict_copies(dir.path()).is_empty());
// Saving again is an ordinary save
notebook.pages[0].add_stroke(stroke(9, 500.0));
storage::save_page(dir.path(), &PageData::from(&notebook.pages[0])).unwrap();
assert!(conflict_copies(dir.path()).is_empty());
}
#[test]
fn test_saving_an_unchanged_page_keeps_the_change_from_another_device() {
let dir = tempfile::tempdir().unwrap();
let (mut notebook, mut manifest) = saved_notebook(dir.path());
let now = Instant::now();
let mut watch = DiskWatch::new(dir.path().to_path_buf(), now);
let mut theirs = notebook.current_page().clone();
theirs.add_stroke(stroke(5, 300.0));
write_from_another_device(dir.path(), &theirs);
// E.g. turning pages marks the page for saving although nothing changed on it
storage::save_page(dir.path(), &PageData::from(notebook.current_page())).unwrap();
assert!(conflict_copies(dir.path()).is_empty());
let outcome = watch.check(&mut notebook, &mut manifest, now);
assert_eq!(outcome.reloaded_pages, 1);
assert_eq!(notebook.pages.len(), 1);
assert_eq!(notebook.pages[0].strokes.len(), 2);
}
#[test]
fn test_saving_a_new_page_over_one_from_another_device_keeps_both() {
let dir = tempfile::tempdir().unwrap();
let (mut notebook, _) = saved_notebook(dir.path());
// Both devices add a second page; it gets the same id on both
let index = notebook.add_page(PageBackground::Blank);
let mut theirs = notebook.pages[index].clone();
theirs.add_stroke(stroke(7, 300.0));
write_from_another_device(dir.path(), &theirs);
notebook.pages[index].add_stroke(stroke(8, 400.0));
storage::save_page(dir.path(), &PageData::from(&notebook.pages[index])).unwrap();
assert_eq!(conflict_copies(dir.path()).len(), 1);
// A file never read here but with the content to be saved is no conflict
let index = notebook.add_page(PageBackground::Blank);
notebook.pages[index].add_stroke(stroke(9, 300.0));
write_from_another_device(dir.path(), &notebook.pages[index]);
storage::save_page(dir.path(), &PageData::from(&notebook.pages[index])).unwrap();
assert_eq!(conflict_copies(dir.path()).len(), 1);
}
#[test]
fn test_page_still_being_synced_is_tried_again() {
let dir = tempfile::tempdir().unwrap();
+86 -10
View File
@@ -721,21 +721,96 @@ pub fn quarantine_corrupted_page(notebook_dir: &Path, page_id: u64) -> Result<Pa
}
/// Speichert eine Seite atomar in `page_<id>.json`.
///
/// The file may have been changed behind our back since this process last read or wrote it:
/// by the built-in sync or a sync client that brought a change from another device, before
/// `disk_watch` got to take it over (it waits while something is being drawn or is unsaved).
/// Overwriting it would silently drop that change. So, as the sync does for a page changed on
/// both sides, their version is kept as a conflict copy next to the page (`disk_watch` turns
/// it into a page of its own); if we have nothing new ourselves, their version simply stays.
pub fn save_page(notebook_dir: &Path, page: &PageData) -> Result<(), StorageError> {
let path = notebook_dir.join(format!("page_{}.json", page.id));
if path.exists() {
let bak_path = notebook_dir.join(format!("page_{}.json.v0.bak", page.id));
if !bak_path.exists() {
if let Ok(content) = fs::read_to_string(&path) {
if let Ok(old_p) = serde_json::from_str::<PageData>(&content) {
if old_p.format_version == 0 {
let _ = fs::copy(&path, &bak_path);
}
}
let bytes = serde_json::to_vec(page)?;
let ours = file_hash(&bytes);
let key = seen_key(&path);
if let Ok(theirs) = fs::read(&path) {
let seen = seen_files().get(&key).copied();
let their_page = serde_json::from_slice::<PageData>(&theirs).ok();
if seen != Some(file_hash(&theirs)) && theirs != bytes {
if seen == Some(ours) {
// Nothing changed here since we last read or wrote the page
return Ok(());
}
let differs = their_page.as_ref().is_some_and(|their_page| {
let mut their_page = their_page.clone();
their_page.format_version = page.format_version;
their_page != *page
});
if differs {
// Fails rather than overwrites: the caller tries again
write_conflict_copy(notebook_dir, page.id, &theirs)?;
}
}
let bak_path = notebook_dir.join(format!("page_{}.json.v0.bak", page.id));
if !bak_path.exists() && their_page.is_some_and(|p| p.format_version == 0) {
let _ = fs::copy(&path, &bak_path);
}
}
atomic_write_json(&path, page)
atomic_write_file(&path, &bytes)?;
seen_files().insert(key, ours);
Ok(())
}
type FileHash = [u8; 32];
fn file_hash(bytes: &[u8]) -> FileHash {
use sha2::Digest;
sha2::Sha256::digest(bytes).into()
}
/// Content of the page files as this process last read or wrote them (see [`save_page`]).
fn seen_files() -> std::sync::MutexGuard<'static, std::collections::HashMap<PathBuf, FileHash>> {
static SEEN: std::sync::OnceLock<
std::sync::Mutex<std::collections::HashMap<PathBuf, FileHash>>,
> = std::sync::OnceLock::new();
SEEN.get_or_init(Default::default)
.lock()
.unwrap_or_else(|e| e.into_inner())
}
/// The same file must get the same key however its folder is spelled.
fn seen_key(path: &Path) -> PathBuf {
match (path.parent().map(Path::canonicalize), path.file_name()) {
(Some(Ok(dir)), Some(name)) => dir.join(name),
_ => path.to_path_buf(),
}
}
/// Keeps `content` as `page_<id> (conflict <unix time>).json`, the name the sync uses too.
fn write_conflict_copy(notebook_dir: &Path, page_id: u64, content: &[u8]) -> io::Result<PathBuf> {
let ts = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_secs();
let mut n = 0;
let path = loop {
let name = match n {
0 => format!("page_{page_id} (conflict {ts}).json"),
n => format!("page_{page_id} (conflict {ts}-{n}).json"),
};
let path = notebook_dir.join(name);
if !path.exists() {
break path;
}
n += 1;
};
atomic_write_file(&path, content)?;
eprintln!(
"[Storage] Seite {page_id} wurde außerhalb geändert, Konfliktkopie: {}",
path.display()
);
Ok(path)
}
/// Lädt eine Seite aus `page_<id>.json`.
@@ -767,6 +842,7 @@ pub fn load_page(notebook_dir: &Path, page_id: u64) -> Result<PageData, StorageE
});
}
seen_files().insert(seen_key(&path), file_hash(json_str.as_bytes()));
Ok(page_data)
}