Save and restore the dock's display state from persistent storage #422

alanpoon · 2025-03-05T13:19:47Z

Fixes #414

Screen.Recording.2025-03-12.at.1.21.32.PM.mov

Save the layout when the Desktop UI view is being hidden, e.g., due to a resize event. (Save the UI layout when transitioning from Desktop --> Mobile layout #251)
Preserve the proportional size of each pane in the dock.
If the user has resized a dock pane by dragging the splitter, that is currently not preserved.
When the user closes/exits the Robrix app, we should save the layout to the persistent settings on disk. Then, we can restore that saved layout automatically upon the next time the user re-opens Robrix.
This can also be offered as a preference/setting in the settings pane, once that is implement.
[] Future Save the layout on demand (a future feature), such that the user can store a list of "favorite" layouts that they can easily switch between, on demand.

I have also explored saving and restoring the window dimension. Currently makepad does not have a solution resize the window dynamically.

src/home/room_screen.rs

src/persistent_state.rs

src/app.rs

src/persistent_state.rs

src/home/room_screen.rs

Co-authored-by: Kevin Boos <[email protected]>

kevinaboos

a few nits about naming clarity:

The word "prompt" should be something like "notice" instead, since a prompt implies that we're asking the user to input some info. But really, we're just showing the user a notice that something is happening in the background.
Similarly, the word "timeout" should be replaced with "failure"/"failed"/"error", since timing out is just one potential error that could occur when loading a room.

See my other comments about how to potentially redesign the action handling logic for Pending, Success, and Timeout.

src/app.rs

src/sliding_sync.rs

src/persistent_state.rs

src/sliding_sync.rs

src/home/main_desktop_ui.rs

kevinaboos · 2025-04-15T15:59:19Z

@alanpoon is this blocked on makepad/makepad#711?

alanpoon · 2025-04-15T16:40:03Z

@alanpoon is this blocked on makepad/makepad#711?

Yes

alanpoon · 2025-04-25T06:50:15Z

src/app.rs

+    ///    it should show the room's timeline and hide its `Pending` message.
+    /// 2. When changing from the desktop to mobile view, we want to ensure that
+    ///    all newly-restored rooms that were loaded in the background are properly displayed. 
+    pub all_known_rooms_loaded: bool,


use cached widget rooms_list

alanpoon · 2025-04-29T12:16:11Z

Waiting for this PR to enhancement to Makepad makepad/makepad#726

Copilot

Pull Request Overview

This PR introduces the functionality to persist and restore the dock's and window's layout state in the application. The changes save the layout when the UI view is hidden and upon app shutdown and then restore these states on startup. Key changes include:

Adding functions to load and restore the rooms panel and window geometry state.
Enhancing UI components (RoomScreen, MainDesktopUI, etc.) to handle state restoration.
Modifying persistent state management by introducing new serialization routines for the restored types.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/sliding_sync.rs	Added asynchronous functions to load and restore panel/window state.
src/persistent_state.rs	Introduced save/load functions for dock and window state.
src/home/rooms_list.rs	Added helper methods to check room loading status.
src/home/room_screen.rs	Updated logic to check room state and handle restoration actions.
src/home/main_desktop_ui.rs	Updated UI logic to trigger dock state restoration on first draw.
src/app.rs	Integrated persistent state saving on shutdown and state restoration actions.

Comments suppressed due to low confidence (1)

src/home/main_desktop_ui.rs:373

Consider revising this error message to provide clearer context about the failure and removing the 'BUG' prefix, as it may be confusing in production logs.

error!("BUG: failed to load dock state upon DockLoad action.");

src/app.rs

Copilot · 2025-05-20T12:09:08Z

src/home/room_screen.rs

        // Obtain the current user's power levels for this room.
        submit_async_request(MatrixRequest::GetRoomPowerLevels { room_id: room_id.clone() });

        let state_opt = TIMELINE_STATES.lock().unwrap().remove(&room_id);
        let (mut tl_state, first_time_showing_room) = if let Some(existing) = state_opt {
            (existing, false)
        } else {
-            let (update_sender, update_receiver, request_sender) = take_timeline_endpoints(&room_id)
-                .expect("BUG: couldn't get timeline state for first-viewed room.");
+            let Some((update_sender, update_receiver, request_sender)) = take_timeline_endpoints(&room_id) else {


[nitpick] Consider logging a warning when timeline endpoints are not available instead of silently returning, to help diagnose issues during the first view of a room.

Suggested change

let Some((update_sender, update_receiver, request_sender)) = take_timeline_endpoints(&room_id) else {

let Some((update_sender, update_receiver, request_sender)) = take_timeline_endpoints(&room_id) else {

warn!("Timeline endpoints are not available for room_id: {}", room_id);

Co-authored-by: Copilot <[email protected]>

Dock save/restore improvement

9467b11

alanpoon self-assigned this Mar 5, 2025

alanpoon mentioned this pull request Mar 6, 2025

Persistent event cache for timeline event #419

Closed

alanpoon added 2 commits March 12, 2025 13:15

Added more comments

5944c27

Merge branch 'main' into save_ui_persistent#414

1f259e3

alanpoon commented Mar 12, 2025

View reviewed changes

src/home/room_screen.rs Outdated Show resolved Hide resolved

remove whitespace

3b5b3ae

alanpoon marked this pull request as ready for review March 12, 2025 05:28

alanpoon added the waiting-on-review This issue is waiting to be reviewed label Mar 12, 2025

kevinaboos requested changes Mar 12, 2025

View reviewed changes

src/persistent_state.rs Outdated Show resolved Hide resolved

src/app.rs Outdated Show resolved Hide resolved

src/persistent_state.rs Outdated Show resolved Hide resolved

src/persistent_state.rs Outdated Show resolved Hide resolved

src/home/room_screen.rs Outdated Show resolved Hide resolved

kevinaboos added waiting-on-author This issue is waiting on the original author for a response and removed waiting-on-review This issue is waiting to be reviewed labels Mar 12, 2025

alanpoon and others added 6 commits March 14, 2025 10:44

Prompt text for roomscreen pending

da9ef4c

remove unnecessary

29a2e9f

Update src/persistent_state.rs

6750fca

Co-authored-by: Kevin Boos <[email protected]>

fix format

d61863a

doc improvement

855aca3

Merge branch 'main' into save_ui_persistent#414

8dd1262

alanpoon added waiting-on-review This issue is waiting to be reviewed and removed waiting-on-author This issue is waiting on the original author for a response labels Mar 14, 2025

kevinaboos requested changes Mar 20, 2025

View reviewed changes

kevinaboos added waiting-on-author This issue is waiting on the original author for a response and removed waiting-on-review This issue is waiting to be reviewed labels Mar 20, 2025

alanpoon added 4 commits March 27, 2025 20:28

async_for read dock files

9acfdea

cleanup on save_ui

c99022e

minor cleanup

12a2e74

Merge branch 'main' into save_ui_persistent#414

1b8e6f2

alanpoon added waiting-on-review This issue is waiting to be reviewed and removed waiting-on-author This issue is waiting on the original author for a response labels Mar 27, 2025

remove extra lines

1a0d98b

alanpoon added blocked-on-makepad Blocked on a Makepad bug or missing Makepad feature and removed waiting-on-review This issue is waiting to be reviewed labels Apr 15, 2025

alanpoon commented Apr 25, 2025

View reviewed changes

remove set_restore_status

fc29024

alanpoon force-pushed the save_ui_persistent#414 branch from dad1373 to fc29024 Compare April 28, 2025 02:48

alanpoon added 2 commits April 28, 2025 11:12

Merge branch 'main' into save_ui_persistent#414

ff9068a

added assertion for saving room panel

88252db

alanpoon force-pushed the save_ui_persistent#414 branch from 4a19157 to 88252db Compare April 28, 2025 07:05

Using windowRef for WindowDimension

118a749

kevinaboos mentioned this pull request Apr 29, 2025

Restore dock collision fix makepad/makepad#724

Closed

alanpoon added 2 commits May 3, 2025 15:35

merged main in branch

2b84756

move RoomsPanelRestoreAction to top

35ab460

alanpoon force-pushed the save_ui_persistent#414 branch from 8e19eeb to 35ab460 Compare May 20, 2025 04:57

Merge branch 'main' into save_ui_persistent#414

1a44d9a

alanpoon removed the blocked-on-makepad Blocked on a Makepad bug or missing Makepad feature label May 20, 2025

fix formating

480813f

alanpoon force-pushed the save_ui_persistent#414 branch from 0e23051 to 480813f Compare May 20, 2025 09:28

comment out sanity check

abc8aa5

aaravlu requested a review from Copilot May 20, 2025 12:08

Copilot AI reviewed May 20, 2025

View reviewed changes

error improvement

82b9b71

Co-authored-by: Copilot <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Save and restore the dock's display state from persistent storage #422

Save and restore the dock's display state from persistent storage #422

Uh oh!

alanpoon commented Mar 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kevinaboos left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kevinaboos commented Apr 15, 2025

Uh oh!

alanpoon commented Apr 15, 2025

Uh oh!

alanpoon Apr 25, 2025 •

edited

Loading

Uh oh!

alanpoon commented Apr 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI May 20, 2025

Uh oh!

Uh oh!

	let Some((update_sender, update_receiver, request_sender)) = take_timeline_endpoints(&room_id) else {
	let Some((update_sender, update_receiver, request_sender)) = take_timeline_endpoints(&room_id) else {
	warn!("Timeline endpoints are not available for room_id: {}", room_id);

Save and restore the dock's display state from persistent storage #422

Are you sure you want to change the base?

Save and restore the dock's display state from persistent storage #422

Uh oh!

Conversation

alanpoon commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kevinaboos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kevinaboos commented Apr 15, 2025

Uh oh!

alanpoon commented Apr 15, 2025

Uh oh!

alanpoon Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanpoon commented Apr 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alanpoon commented Mar 5, 2025 •

edited

Loading

alanpoon Apr 25, 2025 •

edited

Loading