aleleba/pdfcraft
1
0
Fork 0
mirror of https://github.com/storytold/pdfcraft.git synced 2026-10-26 19:19:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge PR #3961: fix(engine): guard undo and redo refresh and roll back on failure (#3925)

Browse Source
This commit is contained in:
aiongg
2026-10-22 01:45:10 +00:00
parent da6c3adedc 895ccb90c3
commit 073711cbbb
2 changed files with 160 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/engine/src/lib.rs
+53 -4
View File
@@ -171,6 +171,23 @@ use std::sync::{Arc, OnceLock};
#[cfg(test)]
thread_local! {
static SECONDARY_SCAN_COUNTS: std::cell::Cell<(usize, usize)> = const { std::cell::Cell::new((0, 0)) };
static REFRESH_PANICS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
}
#[cfg(test)]
fn panic_on_refresh(count: usize) {
REFRESH_PANICS.with(|n| n.set(count));
}
#[cfg(test)]
fn check_refresh_panic() {
REFRESH_PANICS.with(|n| {
let rem = n.get();
if rem > 0 {
n.set(rem - 1);
panic!("injected refresh panic");
}
});
}
#[cfg(test)]
@@ -3853,14 +3870,28 @@ impl Session {
pub fn undo(&mut self, id: DocId) -> Result<Label, EditError> {
let doc = self.doc_mut(id)?;
doc.edit_notices.clear();
let editor = doc.editor.as_mut().ok_or(EditError::NothingToUndo)?;
let (label, prev, keys, scope) = editor.undo.pop().ok_or(EditError::NothingToUndo)?;
let current = std::mem::replace(&mut editor.cos, prev);
let current_keys = std::mem::replace(&mut editor.keys, keys);
editor.redo.push((label.clone(), current, current_keys, scope));
Self::adopt_keys(doc);
Self::refresh_scoped(doc, scope).inspect_err(|_| Self::show_released(doc))?;
let refreshed = guard(|| Self::refresh_scoped(doc, scope)).unwrap_or_else(|m| Err(EditError::Reopen(m)));
if let Err(e) = refreshed {
if let Some(ed) = doc.editor.as_mut()
&& let Some((label, current, current_keys, scope)) = ed.redo.pop()
{
let prev = std::mem::replace(&mut ed.cos, current);
let keys = std::mem::replace(&mut ed.keys, current_keys);
ed.undo.push((label, prev, keys, scope));
}
Self::adopt_keys(doc);
if !matches!(guard(|| Self::refresh(doc)), Ok(Ok(()))) {
Self::show_released(doc);
}
return Err(e);
}
doc.edit_notices.clear();
Self::sync_dirty(doc);
doc.generation += 1;
Ok(label)
@@ -3868,14 +3899,28 @@ impl Session {
pub fn redo(&mut self, id: DocId) -> Result<Label, EditError> {
let doc = self.doc_mut(id)?;
doc.edit_notices.clear();
let editor = doc.editor.as_mut().ok_or(EditError::NothingToRedo)?;
let (label, next, keys, scope) = editor.redo.pop().ok_or(EditError::NothingToRedo)?;
let current = std::mem::replace(&mut editor.cos, next);
let current_keys = std::mem::replace(&mut editor.keys, keys);
editor.undo.push((label.clone(), current, current_keys, scope));
Self::adopt_keys(doc);
Self::refresh_scoped(doc, scope).inspect_err(|_| Self::show_released(doc))?;
let refreshed = guard(|| Self::refresh_scoped(doc, scope)).unwrap_or_else(|m| Err(EditError::Reopen(m)));
if let Err(e) = refreshed {
if let Some(ed) = doc.editor.as_mut()
&& let Some((label, current, current_keys, scope)) = ed.undo.pop()
{
let next = std::mem::replace(&mut ed.cos, current);
let keys = std::mem::replace(&mut ed.keys, current_keys);
ed.redo.push((label, next, keys, scope));
}
Self::adopt_keys(doc);
if !matches!(guard(|| Self::refresh(doc)), Ok(Ok(()))) {
Self::show_released(doc);
}
return Err(e);
}
doc.edit_notices.clear();
Self::sync_dirty(doc);
doc.generation += 1;
Ok(label)
@@ -3937,6 +3982,8 @@ impl Session {
doc.info.producer = info("Producer");
doc.info.custom = pdfcraft_organize::custom_info(&editor.cos);
doc.info.file_size = bytes.len();
#[cfg(test)]
check_refresh_panic();
if !doc.signatures.is_empty() {
let signatures = signatures_of(&editor.cos, &bytes, &doc.trust, &doc.sig_cache);
doc.signatures = Arc::new(signatures);
@@ -4050,6 +4097,8 @@ impl Session {
doc.renderer = RenderPool::new_inline(Arc::new(Vec::new()), doc.config.clone());
doc.display = original.clone();
doc.bytes = original;
#[cfg(test)]
check_refresh_panic();
}
/// After a refresh failed: draw the display bytes it left (the original, once released),
crates/engine/src/tests.rs
+107
View File
@@ -6147,3 +6147,110 @@ fn undo_never_makes_an_unsaved_document_clean() {
s.undo(new).unwrap();
assert!(!s.get(new).unwrap().dirty, "once saved, undo back to the saved state is clean");
}
#[test]
fn undo_and_redo_roll_back_on_a_refresh_panic_or_error() {
let (mut s, id) = session_with(1);
s.apply(id, Edit::RotatePages { pages: vec![0], degrees: 90 }).unwrap();
let (bytes_90, gen_90) = {
let d = s.get(id).unwrap();
(d.bytes.clone(), d.generation)
};
// 1. A panic during undo's refresh catches the unwind and rolls back cos, undo/redo, info, and working bytes.
panic_on_refresh(1);
let err = s.undo(id).unwrap_err();
assert_eq!(err, EditError::Reopen("injected refresh panic".into()));
{
let d = s.get(id).unwrap();
let ed = d.editor.as_ref().unwrap();
assert_eq!(d.info.pages[0].rotation, 90);
assert_eq!(d.bytes, bytes_90);
assert_eq!(d.generation, gen_90);
assert!(d.dirty);
assert!(ed.cos.is_modified());
assert_eq!(ed.undo.len(), 1);
assert!(ed.redo.is_empty());
}
let _ = shown(&s, id, 0);
// 2. If the rollback refresh also panics, `show_released` restores the renderer so the page still draws.
panic_on_refresh(2);
assert_eq!(s.undo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert_eq!(s.get(id).unwrap().editor.as_ref().unwrap().undo.len(), 1);
let _ = shown(&s, id, 0);
// Undo now succeeds cleanly.
assert_eq!(s.undo(id).unwrap().as_str(), "Rotate page");
let (bytes_0, gen_0) = {
let d = s.get(id).unwrap();
assert_eq!(d.info.pages[0].rotation, 0);
assert!(!d.dirty);
(d.bytes.clone(), d.generation)
};
// 3. A panic during redo's refresh catches the unwind and rolls back to the undone state.
panic_on_refresh(1);
let err = s.redo(id).unwrap_err();
assert_eq!(err, EditError::Reopen("injected refresh panic".into()));
{
let d = s.get(id).unwrap();
let ed = d.editor.as_ref().unwrap();
assert_eq!(d.info.pages[0].rotation, 0);
assert_eq!(d.bytes, bytes_0);
assert_eq!(d.generation, gen_0);
assert!(!d.dirty);
assert!(!ed.cos.is_modified());
assert!(ed.undo.is_empty());
assert_eq!(ed.redo.len(), 1);
}
let _ = shown(&s, id, 0);
// 4. If redo's rollback refresh also panics, `show_released` restores the renderer.
panic_on_refresh(2);
assert_eq!(s.redo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert_eq!(s.get(id).unwrap().editor.as_ref().unwrap().redo.len(), 1);
let _ = shown(&s, id, 0);
// Redo now succeeds cleanly.
assert_eq!(s.redo(id).unwrap().as_str(), "Rotate page");
assert_eq!(s.get(id).unwrap().info.pages[0].rotation, 90);
// 5. Metadata scope: a panic after `doc.info.title` was written rolls back `info.title` and keeps `edit_notices`.
s.apply(id, Edit::SetInfo { key: "Title".into(), value: "Draft".into() }).unwrap();
let notice = TextNotice { field: None, page: 0, ch: '☺', redrawn_elsewhere: false };
s.doc_mut(id).unwrap().edit_notices.push(notice.clone());
panic_on_refresh(1);
assert_eq!(s.undo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert_eq!(s.get(id).unwrap().info.title.as_deref(), Some("Draft"));
assert_eq!(s.get(id).unwrap().edit_notices, [notice]);
assert_eq!(s.undo(id).unwrap().as_str(), "Change Title");
assert_eq!(s.get(id).unwrap().info.title, None);
assert!(s.get(id).unwrap().edit_notices.is_empty());
panic_on_refresh(1);
assert_eq!(s.redo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert_eq!(s.get(id).unwrap().info.title, None);
assert_eq!(s.redo(id).unwrap().as_str(), "Change Title");
assert_eq!(s.get(id).unwrap().info.title.as_deref(), Some("Draft"));
// 6. Protection keys: undo/redo rollback restores `editor.keys` and `doc.password` before re-inspecting.
let protect = Protection { open_password: Some("u".into()), permissions_password: Some("o".into()), ..Protection::default() };
s.apply(id, Edit::Protect(protect)).unwrap();
assert!(s.get(id).unwrap().info.encrypted);
panic_on_refresh(1);
assert_eq!(s.undo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert!(s.get(id).unwrap().info.encrypted);
assert_eq!(s.get(id).unwrap().password.as_deref(), Some("u"));
assert_eq!(s.undo(id).unwrap().as_str(), "Protect with password");
assert!(!s.get(id).unwrap().info.encrypted);
assert_eq!(s.get(id).unwrap().password, None);
panic_on_refresh(1);
assert_eq!(s.redo(id), Err(EditError::Reopen("injected refresh panic".into())));
assert!(!s.get(id).unwrap().info.encrypted);
assert_eq!(s.get(id).unwrap().password, None);
assert_eq!(s.redo(id).unwrap().as_str(), "Protect with password");
assert!(s.get(id).unwrap().info.encrypted);
assert_eq!(s.get(id).unwrap().password.as_deref(), Some("u"));
}