Implement client logout and add logout button #432

TigerInYourDream · 2025-03-11T15:26:22Z

Closes #277. Replaces #293 and #494.

Based on PR #293, I found an error message during logout:
2024-12-24T07:58:55.514036Z ERROR matrix_sdk_ui::sync_service: Error while processing encryption in sync service: Something wrong happened in sliding sync: the server returned an error: [401 / M_UNKNOWN_TOKEN] Invalid access token passed.
Root cause:
The error is related to SYNC_SERVICE handling during logout process.

Changes:

Updated SYNC_SERVICE handling during logout
Tested the fix with Google SSO login/logout flow

Signed-off-by: Alvin <[email protected]>

kevinaboos · 2025-03-11T20:13:27Z

Thanks Alvin. I'm a bit confused -- is this a replacement for #293, or something that should be merged in after #293 as an addition to it?

Also, is it ready for review or shall I wait for something else?

TigerInYourDream · 2025-03-12T04:28:26Z

Thanks Alvin. I'm a bit confused -- is this a replacement for #293, or something that should be merged in after #293 as an addition to it?

Also, is it ready for review or shall I wait for something else?

Due to the age of PR #293 and substantial changes in the codebase, resolving merge conflicts became quite challenging. I've contacted the original author, Guocork, who also suggested creating a new PR. Therefore, I've created a fresh PR implementing the same functionality with updated code and comprehensive testing. Could you please review this new implementation?

Signed-off-by: Alvin <[email protected]>

kevinaboos

Thanks Alvin, great start on this feature!

I left some comments below. In general, make sure to name things carefully --- try to give variables and types very specific names that cannot be misinterpreted. (I know naming is hard, so it'll take some time to get that right. No worries.)

src/home/spaces_dock.rs

src/login/login_screen.rs

src/sliding_sync.rs

TigerInYourDream · 2025-03-13T04:35:10Z

Thanks Alvin, great start on this feature!

I left some comments below. In general, make sure to name things carefully --- try to give variables and types very specific names that cannot be misinterpreted. (I know naming is hard, so it'll take some time to get that right. No worries.)

Thank you for the review. I will try to improve the naming conventions and continue working on it.

Signed-off-by: Alvin <[email protected]>

alanpoon · 2025-03-18T07:59:03Z

Suggest adding a modal for logout confirmation
Perhaps delete the "latest_user_id.txt" in the app data directory
After logout, restarting the app will see a prompt saying fail to "Could not restore previous user session"

Signed-off-by: Alvin <[email protected]>

TigerInYourDream · 2025-03-18T13:35:07Z

Suggest adding a modal for logout confirmation

Perhaps delete the "latest_user_id.txt" in the app data directory

After logout, restarting the app will see a prompt saying fail to "Could not restore previous user session"

Thanks for the review.

Signed-off-by: Alvin <[email protected]>

src/home/spaces_dock.rs

src/login/login_screen.rs

Signed-off-by: Alvin <[email protected]>

kevinaboos · 2025-06-27T18:27:12Z

Relogin does not restore the dock state, Do you want to fix it in this PR or in another PR?

As I said on the Robrix matrix channel, I don't think re-logging in should restore the dock state by default. Generally, when logging out, most users would expect that the app be "reset" to its default state.

However, in the future, we could show a prompt after log-in asking the user if they want to restore their previous dock/UI layout.

Signed-off-by: Alvin <[email protected]>

ZhangHanDong · 2025-07-15T11:24:42Z

Currently, the logout function still logs panic messages, but these do not cause the robrix program to crash.

thread 'tokio-runtime-worker' panicked at /Users/zhangalex/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/deadpool-runtime-0.1.4/src/lib.rs:77:58:
`JoinError` reason is not a panic.: JoinError::Cancelled(Id(18764))

This is because the matrix SDK does not implement a graceful shutdown mechanism for deadpool-runtime. As a result, after the main loop of robrix’s tokio runtime exits, deadpool-runtime continues to run. Eventually, when robrix is terminated with ctrl-c, crash messages will appear in the logs:

thread 'main' panicked at /Users/zhangalex/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/deadpool-runtime-0.1.4/src/lib.rs:101:22:
there is no reactor running, must be called from the context of a Tokio 1.x runtime
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

thread 'main' panicked at /Users/zhangalex/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/deadpool-runtime-0.1.4/src/lib.rs:101:22:
there is no reactor running, must be called from the context of a Tokio 1.x runtime
stack backtrace:
   0:        0x1041bef7c - std::backtrace_rs::backtrace::libunwind::trace::hd09570c029a6744a
   ...

@kevinaboos Do we need to report this issue in the matrix repository?

update: After the refactoring, these exceptions should all be resolved, so there’s no need to report them upstream.

Signed-off-by: Alvin <[email protected]>

src/app.rs

src/login/logout_state_machine.rs

Signed-off-by: Alvin <[email protected]>

kevinaboos

Overall, the code looks quite nice, especially the detailed comments and structure in the logout state machine. Nice!

However, I have serious concerns about the approach of leaking a bunch of huge states by mem::forgetting them — that cannot possibly be the best solution. I left some comments about that and other issues, please let me know more about this issue so we can brainstorm an alternative solution.

kevinaboos · 2025-07-21T23:38:33Z

src/app.rs

@@ -128,7 +129,7 @@ live_design! {
                        // However, the DesktopButton widget doesn't support drawing a background color yet,
                        // so these colors are the colors of the icon itself, not the background highlight.
                        // When it supports that, we will keep the icon color always black,
-                        // and change the background color instead based on the above colors.
+                        // and change the background color instead bssed on instead e colors


strange typo here. Please undo.

kevinaboos · 2025-07-22T00:12:04Z

src/app.rs

+        // Immediately take and leak all resources to prevent any destructors from running
+        // This is a controlled leak at shutdown to avoid the deadpool panic
+
+        // Take the runtime first and leak it
+        if let Some(runtime) = TOKIO_RUNTIME.lock().unwrap().take() {
+            std::mem::forget(runtime);
+            log!("Leaked tokio runtime to prevent destructor");
+        }
+
+        // Take and leak the client
+        if let Some(client) = CLIENT.lock().unwrap().take() {
+            std::mem::forget(client);
+            log!("Leaked client to prevent destructor");
+        }
+
+        // Take and leak the sync service
+        if let Some(sync_service) = SYNC_SERVICE.lock().unwrap().take() {
+            std::mem::forget(sync_service);
+            log!("Leaked sync service to prevent destructor");
+        }
+
+        // Take and leak the request sender
+        if let Some(sender) = REQUEST_SENDER.lock().unwrap().take() {
+            std::mem::forget(sender);
+            log!("Leaked request sender to prevent destructor");
+        }


Sorry, but leaking a bunch of states is not a solution that I will accept.

What's the root cause here? Alex mentioned something about a Matrix SDK issue regarding deadpool, but I'm not really sure what that means. Please elaborate why this is needed.

@kevinaboos This intentional memory leak occurs because, when canceling asynchronous tasks during logout, the deadpool in the matrix SDK cannot be cancelled. As a result, when the robrix application is closed, a panic occurs, causing a crash and an exception dialog that affects the user experience. However, this intentional leak only happens during the shutdown process of robrix. In other words, as long as the user does not close the robrix program, the intentional leak will not occur.

Therefore, this intentional leak is a last-resort measure to preserve user experience when there is no other solution (at least, no proper way to destruct deadpool has been found so far). I think that after the program exits, an intentional leak shouldn’t be a problem, right? After all, the memory should be reclaimed by the system once the program is closed.

kevinaboos · 2025-07-22T00:14:03Z

src/home/spaces_dock.rs

+
+        }
+


lots of whitespace

Suggested change

}

}

kevinaboos · 2025-07-22T00:15:39Z

src/login/logout_confirm_modal.rs

+        self.label(id!(message)).set_text(cx, message);
+    }
+
+    fn reset_state(&mut self, cx: &mut Cx) {


due to a Makepad bug, in this function, you also need to call reset_hover() on every button in the modal.

kevinaboos · 2025-07-22T00:21:32Z

src/profile/user_profile_cache.rs

+/// Clears the user profile cache.
+/// This is useful during shutdown to prevent thread-local destructors
+/// from running after the tokio runtime has been shut down.
+pub fn clear_cache() {
+    USER_PROFILE_CACHE.with_borrow_mut(|cache| {
+        cache.clear();
+    });
+}


This doesn't make any sense — can you explain?

Thread-local destructors are good, we want them to run.

Clearing the cache has nothing to do with thread-local destructors.

This cache is only accessed from the main thread, and the main thread is not being exited/killed, so its destructors wouldn't run anyway.

Note that I do agree that we need to clear all caches upon logout, including the USER_PROFILE_CACHE and AVATAR_CACHE (please add that as well). I just don't understand the comments here about thread locals..

In addition to clearing the user profile cache and the avatar cache, you also need to clear the list of ALL_INVITED_ROOMS here:

robrix/src/home/rooms_list.rs

Lines 19 to 25 in 5d5bc20

thread_local! {

/// The list of all invited rooms, which is only tracked here

/// because the backend doesn't need to track any info about them.

///

/// This must only be accessed by the main UI thread.

static ALL_INVITED_ROOMS: Rc<RefCell<HashMap<OwnedRoomId, InvitedRoomInfo>>> = Rc::new(RefCell::new(HashMap::new()));

}

and the set of all timeline states here:

robrix/src/home/room_screen.rs

Lines 2781 to 2788 in 5d5bc20

thread_local! {

/// The global set of all timeline states, one entry per room.

///

/// This is only useful when accessed from the main UI thread.

static TIMELINE_STATES: RefCell<BTreeMap<OwnedRoomId, TimelineUiState>> = const {

RefCell::new(BTreeMap::new())

};

}

kevinaboos · 2025-07-22T00:24:40Z

src/sliding_sync.rs

-static ALL_JOINED_ROOMS: Mutex<BTreeMap<OwnedRoomId, JoinedRoomDetails>> = Mutex::new(BTreeMap::new());
+pub(crate) static ALL_JOINED_ROOMS: Mutex<BTreeMap<OwnedRoomId, JoinedRoomDetails>> = Mutex::new(BTreeMap::new());

 /// Information about all of the rooms that have been tombstoned.
 ///
 /// The map key is the **NEW** replacement room ID, and the value is the **OLD** tombstoned room ID.
 /// This allows us to quickly query if a newly-encountered room is a replacement for an old tombstoned room.
-static TOMBSTONED_ROOMS: Mutex<BTreeMap<OwnedRoomId, OwnedRoomId>> = Mutex::new(BTreeMap::new());
+pub(crate) static TOMBSTONED_ROOMS: Mutex<BTreeMap<OwnedRoomId, OwnedRoomId>> = Mutex::new(BTreeMap::new());

 /// The logged-in Matrix client, which can be freely and cheaply cloned.
-static CLIENT: OnceLock<Client> = OnceLock::new();
+pub(crate) static CLIENT: Mutex<Option<Client>> = Mutex::new(None);

 pub fn get_client() -> Option<Client> {
-    CLIENT.get().cloned()
+    CLIENT.lock().unwrap().clone()
 }

 /// Returns the user ID of the currently logged-in user, if any.
 pub fn current_user_id() -> Option<OwnedUserId> {
-    CLIENT.get().and_then(|c|
+    CLIENT.lock().unwrap().as_ref().and_then(|c|
        c.session_meta().map(|m| m.user_id.clone())
    )
 }

 /// The singleton sync service.
-static SYNC_SERVICE: OnceLock<SyncService> = OnceLock::new();
+/// sync_service if build from the client, and is used to sync the client with the server.
+pub(crate) static SYNC_SERVICE: Mutex<Option<Arc<SyncService>>> = Mutex::new(None);


all of these static states should not be public in any way. We only want the sliding sync module's logic to be aware of them and be able to access them.

If you just need a function that clears all of these upon logout, then add a function to this module and call it from your logout logic. There's no reason to make them public if that's all you need.

fix pr project-robius#293 about logout

27871c3

Signed-off-by: Alvin <[email protected]>

TigerInYourDream and others added 2 commits March 12, 2025 12:34

Merge branch 'main' into fix-logout

708d493

explain key exchange

c380f0f

Signed-off-by: Alvin <[email protected]>

kevinaboos requested changes Mar 12, 2025

View reviewed changes

kevinaboos added the waiting-on-author This issue is waiting on the original author for a response label Mar 12, 2025

TigerInYourDream marked this pull request as draft March 13, 2025 04:50

TigerInYourDream and others added 4 commits March 15, 2025 01:28

CORE_TASKS for save and abort async task

9b0a7fd

Signed-off-by: Alvin <[email protected]>

refactor logout

b4242ed

Signed-off-by: Alvin <[email protected]>

Merge branch 'main' into fix-logout

82704ed

fix: typos

1b827fa

Signed-off-by: Alvin <[email protected]>

TigerInYourDream marked this pull request as ready for review March 18, 2025 07:24

trace more long term async task and resource async_task

66e00ea

Signed-off-by: Alvin <[email protected]>

TigerInYourDream and others added 4 commits March 19, 2025 01:50

Merge branch 'main' into fix-logout

d702758

Merge branch 'main' into fix-logout

0d3d156

Merge branch 'main' into fix-logout

ccfc991

fix with clippy check

53dc860

Signed-off-by: Alvin <[email protected]>

TigerInYourDream requested review from kevinaboos and Guocork March 20, 2025 16:40

TigerInYourDream changed the title ~~fix pr #293 about logout~~ logout feature Mar 21, 2025

Guocork reviewed Mar 23, 2025

View reviewed changes

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

Guocork reviewed Mar 23, 2025

View reviewed changes

src/login/login_screen.rs Outdated Show resolved Hide resolved

feat(auth): Enhance Matrix logout robustness and error handling

734536b

Signed-off-by: Alvin <[email protected]>

TigerInYourDream force-pushed the fix-logout branch from 273f1f1 to 734536b Compare March 24, 2025 05:14

feat(auth): delete_last_user_id file

f41d554

Signed-off-by: Alvin <[email protected]>

TigerInYourDream and others added 12 commits July 1, 2025 19:48

fix: fix crash when switch layout

2b80cae

Signed-off-by: Alvin <[email protected]>

feat: treat M_UNKNOWN_TOKEN as successful

712b4d2

Signed-off-by: Alvin <[email protected]>

improve CleanMobileResource

e44103f

Signed-off-by: Alvin <[email protected]>

improve UX

5d88a50

Signed-off-by: Alvin <[email protected]>

typo

c75eb9b

Signed-off-by: Alvin <[email protected]>

Add ApplicationRequiresRestart for corner case

d0e9abd

Signed-off-by: Alvin <[email protected]>

exchange seq

df39c2f

Signed-off-by: Alvin <[email protected]>

Merge branch 'origin/main' into fix-logout

d293459

add ALL_JOINED_ROOMS clear

8f14cc2

Signed-off-by: Alvin <[email protected]>

Merge branch 'main' into fix-logout

5ecc2fc

clean appstate both in mobile and desktop

f34e1de

Signed-off-by: Alvin <[email protected]>

doc

d8bff52

Signed-off-by: Alvin <[email protected]>

TigerInYourDream added 3 commits July 15, 2025 20:19

merge origin/main

6546418

Signed-off-by: Alvin <[email protected]>

ref: logout with state machine

a4a25bc

Signed-off-by: Alvin <[email protected]>

add doc

1b75c12

Signed-off-by: Alvin <[email protected]>

ZhangHanDong reviewed Jul 17, 2025

View reviewed changes

src/app.rs Outdated Show resolved Hide resolved

src/app.rs Outdated Show resolved Hide resolved

src/login/logout_state_machine.rs Show resolved Hide resolved

add doc and fix typos

ad67b4d

Signed-off-by: Alvin <[email protected]>

ZhangHanDong requested a review from kevinaboos July 18, 2025 04:48

ZhangHanDong 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 Jul 18, 2025

Merge branch 'main' into fix-logout

87d43f5

kevinaboos requested changes Jul 22, 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 Jul 22, 2025

	thread_local! {
	/// The list of all invited rooms, which is only tracked here
	/// because the backend doesn't need to track any info about them.
	///
	/// This must only be accessed by the main UI thread.
	static ALL_INVITED_ROOMS: Rc<RefCell<HashMap<OwnedRoomId, InvitedRoomInfo>>> = Rc::new(RefCell::new(HashMap::new()));
	}

	thread_local! {
	/// The global set of all timeline states, one entry per room.
	///
	/// This is only useful when accessed from the main UI thread.
	static TIMELINE_STATES: RefCell<BTreeMap<OwnedRoomId, TimelineUiState>> = const {
	RefCell::new(BTreeMap::new())
	};
	}

Implement client logout and add logout button #432

Are you sure you want to change the base?

Implement client logout and add logout button #432

Uh oh!

Conversation

TigerInYourDream commented Mar 11, 2025 • edited by kevinaboos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevinaboos commented Mar 11, 2025

Uh oh!

TigerInYourDream commented Mar 12, 2025

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!

TigerInYourDream commented Mar 13, 2025

Uh oh!

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

Uh oh!

Uh oh!

TigerInYourDream commented Mar 18, 2025

Uh oh!

Uh oh!

Uh oh!

kevinaboos commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhangHanDong commented Jul 15, 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!

kevinaboos left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TigerInYourDream commented Mar 11, 2025 •

edited by kevinaboos

Loading

alanpoon commented Mar 18, 2025 •

edited

Loading

kevinaboos commented Jun 27, 2025 •

edited

Loading

ZhangHanDong commented Jul 15, 2025 •

edited

Loading