[window-state] Window not rendering correctly due to cache file

[Tunglies]

Due to unknown behavior, the .window-state.json cache file may record unexpected values for the width and height fields, resulting in abnormal window sizes when users launch the application.

For related issue examples:
clash-verge-rev/clash-verge-rev#3493 (comment)

clash-verge-rev/clash-verge-rev#3237 (comment)

Since these feedbacks was submitted by users of our downstream repository, the available clues are limited. However, according to community reports, when this issue occurs, triggering a window resize using system shortcuts or deleting the {identifier}\.window-state.json file and restarting the application can restore the window to its normal size.

I tried to manually reproduce this unexpected behavior by modifying the width and height values in the cache file.

{
  "main": {
    "width": 0,
    "height": 0,
   ......
  }
}

No visible window will be created by this.

{
  "main": {
    "width": 400,
    "height": 40,
     "decorated": false,
   ......
  }
}

The window created is very similar to what has been reported in the community issues.

I found the following code to handle the window size settings, but I haven’t seen any width and height validation elsewhere.

plugins-workspace/plugins/window-state/src/lib.rs

Lines 210 to 215 in 9bc4b22

	if flags.contains(StateFlags::SIZE) {
	self.set_size(PhysicalSize {
	width: state.width,
	height: state.height,
	})?;
	}

[Tunglies]

Our community has reported abnormal data and behavior when using dual monitors. This may be caused by closing a display while a window is not visible, resulting in the system saving incorrect or abnormal state data.

{
  "main": {
    ......
    "x": -32000,
    "y": -32000,
    ......
  }
}

[Tunglies]

Should we add a check to ensure that position and size are not negative in the following part of the code?

plugins-workspace/plugins/window-state/src/lib.rs

Lines 525 to 547 in 9bc4b22

	impl MonitorExt for Monitor {
	fn intersects(&self, position: PhysicalPosition<i32>, size: PhysicalSize<u32>) -> bool {
	let PhysicalPosition { x, y } = *self.position();
	let PhysicalSize { width, height } = *self.size();
	let left = x;
	let right = x + width as i32;
	let top = y;
	let bottom = y + height as i32;
	[
	(position.x, position.y),
	(position.x + size.width as i32, position.y),
	(position.x, position.y + size.height as i32),
	(
	position.x + size.width as i32,
	position.y + size.height as i32,
	),
	]
	.into_iter()
	.any(|(x, y)| x >= left && x < right && y >= top && y < bottom)
	}
	}

Or add negative value checks for the following data operations?

plugins-workspace/plugins/window-state/src/lib.rs

Lines 453 to 496 in 9bc4b22

	WindowEvent::Moved(position) if flags.contains(StateFlags::POSITION) => {
	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;
	state.prev_y = state.y;
	state.x = position.x;
	state.y = position.y;
	}
	}
	}
	WindowEvent::Resized(size) if flags.contains(StateFlags::SIZE) => {
	if window_clone
	.state::<RestoringWindowState>()
	.0
	.try_lock()
	.is_ok()
	{
	// TODO: Remove once https://github.com/tauri-apps/tauri/issues/5812 is resolved.
	let is_maximized = if cfg!(target_os = "macos")
	&& (!window_clone.is_decorated().unwrap_or_default()
	|| !window_clone.is_resizable().unwrap_or_default())
	{
	false
	} else {
	window_clone.is_maximized().unwrap_or_default()
	};
	if !window_clone.is_minimized().unwrap_or_default() && !is_maximized {
	let mut c = cache.lock().unwrap();
	if let Some(state) = c.get_mut(&label) {
	state.width = size.width;
	state.height = size.height;
	}
	}
	}
	}

[FabianLars]

negative values are possible at least on some platforms (forgot which one) as not all global coordinate systems start on the upper left monitor but use the primary one instead.

iirc the intersects code you linked was added to prevent exactly the behavior you're describing. we're also checking if the window is minimized in both Moved and Resize events. I really wonder what's going on that your app ends up with those minimized values 🤔

[Legend-Master]

plugins-workspace/plugins/window-state/src/lib.rs

Lines 453 to 496 in 9bc4b22

	WindowEvent::Moved(position) if flags.contains(StateFlags::POSITION) => {
	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;
	state.prev_y = state.y;
	state.x = position.x;
	state.y = position.y;
	}
	}
	}
	WindowEvent::Resized(size) if flags.contains(StateFlags::SIZE) => {
	if window_clone
	.state::<RestoringWindowState>()
	.0
	.try_lock()
	.is_ok()
	{
	// TODO: Remove once https://github.com/tauri-apps/tauri/issues/5812 is resolved.
	let is_maximized = if cfg!(target_os = "macos")
	&& (!window_clone.is_decorated().unwrap_or_default()
	|| !window_clone.is_resizable().unwrap_or_default())
	{
	false
	} else {
	window_clone.is_maximized().unwrap_or_default()
	};
	if !window_clone.is_minimized().unwrap_or_default() && !is_maximized {
	let mut c = cache.lock().unwrap();
	if let Some(state) = c.get_mut(&label) {
	state.width = size.width;
	state.height = size.height;
	}
	}
	}
	}

We used to have this bug so it's probably a similar problem, I thought I have fixed this by doing the is_minimized check here #1702, but looks like it's not fully fixed yet

It might be easier to debug if you could provide some reproduce steps 🙃