Skip to content

fix(window-state): deadlock when trying to restore window states on initial load #1787

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
merged 2 commits into from
Sep 15, 2024
Merged

fix(window-state): deadlock when trying to restore window states on initial load #1787

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
01e282a
Fix deadlock when trying to restore window the size on initial load
Legend-Master Sep 15, 2024
a01bb76
Typo
Legend-Master Sep 15, 2024
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
5 changes: 5 additions & 0 deletions .changes/fix-restore-window-state-deadlock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"window-state": patch
---

Fix deadlock when trying to restore window states on initial load
20 changes: 18 additions & 2 deletions plugins/window-state/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ impl Default for WindowState {
}

struct WindowStateCache(Arc<Mutex<HashMap<String, WindowState>>>);
/// Used to prevent deadlocks from resize and position event listeners setting the cached state on restoring states
struct RestoringWindowState(Mutex<()>);
pub trait AppHandleExt {
/// Saves all open windows state to disk
fn save_window_state(&self, flags: StateFlags) -> Result<()>;
Expand Down Expand Up @@ -167,6 +169,8 @@ impl<R: Runtime> WindowExt for Window<R> {
.map(|map| map(self.label()))
.unwrap_or_else(|| self.label());

let restoring_window_state = self.state::<RestoringWindowState>();
let _restoring_window_lock = restoring_window_state.0.lock().unwrap();
let cache = self.state::<WindowStateCache>();
let mut c = cache.0.lock().unwrap();

Expand Down Expand Up @@ -396,6 +400,7 @@ impl Builder {
Default::default()
};
app.manage(WindowStateCache(cache));
app.manage(RestoringWindowState(Mutex::new(())));
app.manage(PluginState {
filename,
map_label,
Expand Down Expand Up @@ -443,7 +448,13 @@ impl Builder {
}

WindowEvent::Moved(position) if flags.contains(StateFlags::POSITION) => {
if !window_clone.is_minimized().unwrap_or_default() {
if window_clone
.state::<RestoringWindowState>()
.0
.try_lock()
.is_ok()
&& !window_clone.is_minimized().unwrap_or_default()
{
let mut c = cache.lock().unwrap();
if let Some(state) = c.get_mut(&label) {
state.prev_x = state.x;
Expand All @@ -455,7 +466,12 @@ impl Builder {
}
}
WindowEvent::Resized(size) if flags.contains(StateFlags::SIZE) => {
if !window_clone.is_minimized().unwrap_or_default()
if window_clone
.state::<RestoringWindowState>()
.0
.try_lock()
.is_ok()
&& !window_clone.is_minimized().unwrap_or_default()
&& !window_clone.is_maximized().unwrap_or_default()
{
let mut c = cache.lock().unwrap();
Expand Down
Loading