856f865cf98d
scratch_release.rs
//! The process-wide scratch pool is isolated from parallel unit tests (#10479); these tests take
//! turns on it.
use photocraft_engine::Session;
use photocraft_engine::jobs::Started;
use photocraft_raster::scratch;
use serde_json::json;
/// Holds the test lock with the pool's idle release off, so a slow runner can't empty the pool
/// between a command and the check after it; the release comes back on when dropped.
struct Quiet {
_serial: std::sync::MutexGuard<'static, ()>,
}
impl Quiet {
/// Locks the test process and disables idle pool release for this guard's lifetime.
fn new() -> Self {
let _serial = crate::lock(&crate::PROCESS);
scratch::set_idle_release(false);
Quiet { _serial }
}
}
impl Drop for Quiet {
fn drop(&mut self) {
scratch::set_idle_release(true);
}
}
#[test]
/// Verifies closing one or all documents releases their scratch buffers.
fn closing_a_document_leaves_none_of_its_buffers_in_the_pool() {
let _q = Quiet::new();
for close in ["file.close", "file.closeAll"] {
let mut s = Session::new();
s.execute("file.new", json!({"width": 1024, "height": 1024})).unwrap();
s.execute("edit.fill", json!({"contents": "color", "color": "#808080"})).unwrap();
s.execute("filter.blur.gaussianBlur", json!({"radius": 3})).unwrap();
// Dispatch holds the active document across the command; its tiles must not land in
// the pool after the release.
s.execute(close, json!({})).unwrap();
assert_eq!(scratch::retained_bytes(), 0, "{close}");
}
}
#[test]
/// Verifies a command that keeps its document does not release unrelated pooled buffers.
fn commands_that_keep_their_documents_keep_the_pool() {
let _q = Quiet::new();
let mut s = Session::new();
s.execute("file.new", json!({"width": 1024, "height": 1024})).unwrap();
scratch::give(vec![0u8; scratch::MIN_POOLED_BYTES]);
s.execute("edit.fill", json!({"contents": "color", "color": "#808080"})).unwrap();
assert!(scratch::retained_bytes() > 0);
}
#[test]
/// Verifies a cancelled worker releases its document buffers after it exits.
fn a_cancelled_job_of_a_closed_document_returns_its_buffers_once_it_exits() {
let _q = Quiet::new();
let mut s = Session::new();
s.execute("file.new", json!({"width": 2048, "height": 2048})).unwrap();
s.execute("edit.fill", json!({"contents": "color", "color": "#808080"})).unwrap();
let Started::Job(_) = s.start("filter.blur.gaussianBlur", json!({"radius": 60})).unwrap() else {
panic!("Gaussian Blur runs as a background job");
};
// Closing cancels the job, but its worker still holds the document until it exits.
s.close(0);
scratch::give(vec![0u8; scratch::MIN_POOLED_BYTES]);
s.join_cancelled_jobs();
assert_eq!(scratch::retained_bytes(), 0);
}
#[test]
/// Verifies cancelling a job before document close still releases its buffers.
fn a_job_cancelled_before_its_document_closes_still_returns_its_buffers() {
let _q = Quiet::new();
let mut s = Session::new();
s.execute("file.new", json!({"width": 2048, "height": 2048})).unwrap();
s.execute("edit.fill", json!({"contents": "color", "color": "#808080"})).unwrap();
let Started::Job(id) = s.start("filter.blur.gaussianBlur", json!({"radius": 60})).unwrap() else {
panic!("Gaussian Blur runs as a background job");
};
// Cancelled first: the worker is already off the running list when the document closes.
assert!(s.cancel_job(id));
s.close(0);
scratch::give(vec![0u8; scratch::MIN_POOLED_BYTES]);
s.join_cancelled_jobs();
assert_eq!(scratch::retained_bytes(), 0);
}
/// Verifies polling alone releases buffers after a closed document's cancelled worker exits.
#[test]
fn a_cancelled_job_of_a_closed_document_is_released_by_polling() {
let _q = Quiet::new();
let mut s = Session::new();
s.execute("file.new", json!({"width": 2048, "height": 2048})).unwrap();
s.execute("edit.fill", json!({"contents": "color", "color": "#808080"})).unwrap();
let Started::Job(_) = s.start("filter.blur.gaussianBlur", json!({"radius": 60})).unwrap() else {
panic!("Gaussian Blur runs as a background job");
};
s.close(0);
// Seed after close so the close path cannot satisfy the assertion.
scratch::give(vec![0u8; scratch::MIN_POOLED_BYTES]);
assert!(scratch::retained_bytes() > 0);
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(30);
while scratch::retained_bytes() > 0 && std::time::Instant::now() < deadline {
s.poll_jobs();
std::thread::sleep(std::time::Duration::from_millis(5));
}
assert_eq!(scratch::retained_bytes(), 0);
}
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.