Merge pull request #432 from TigerInYourDream/fix-logout

Author: kevinaboos

src/app.rs

@@ -9,33 +9,25 @@ use std::collections::HashMap;
 use makepad_widgets::{makepad_micro_serde::*, *};
 use matrix_sdk::ruma::{OwnedRoomId, RoomId};
 use crate::{
-    home::{
+    avatar_cache::clear_avatar_cache, home::{
         main_desktop_ui::MainDesktopUiAction,
         new_message_context_menu::NewMessageContextMenuWidgetRefExt,
-        room_screen::MessageAction,
-        rooms_list::RoomsListAction,
-    },
-    join_leave_room_modal::{
+        room_screen::{clear_timeline_states, MessageAction},
+        rooms_list::{clear_all_invited_rooms, RoomsListAction},
+    }, join_leave_room_modal::{
         JoinLeaveRoomModalAction,
         JoinLeaveRoomModalWidgetRefExt,
-    },
-    login::login_screen::LoginAction,
-    persistence,
-    shared::callout_tooltip::{
+    }, login::login_screen::LoginAction, logout::logout_confirm_modal::{LogoutAction, LogoutConfirmModalAction, LogoutConfirmModalWidgetRefExt}, persistence, profile::user_profile_cache::clear_user_profile_cache, shared::callout_tooltip::{
         CalloutTooltipOptions,
         CalloutTooltipWidgetRefExt,
         TooltipAction,
-    },
-    sliding_sync::current_user_id,
-    utils::{
+    }, sliding_sync::current_user_id, utils::{
         room_name_or_id,
         OwnedRoomIdRon,
-    },
-    verification::VerificationAction,
-    verification_modal::{
+    }, verification::VerificationAction, verification_modal::{
         VerificationModalAction,
         VerificationModalWidgetRefExt,
-    },
+    }
 };
 
 live_design! {
@@ -48,6 +40,7 @@ live_design! {
     use crate::verification_modal::VerificationModal;
     use crate::join_leave_room_modal::JoinLeaveRoomModal;
     use crate::login::login_screen::LoginScreen;
+    use crate::logout::logout_confirm_modal::LogoutConfirmModal;
     use crate::shared::popup_list::*;
     use crate::home::new_message_context_menu::*;
     use crate::shared::callout_tooltip::CalloutTooltip;
@@ -119,6 +112,13 @@ live_design! {
                             }
                         }
 
+                        // Logout confirmation modal 
+                        logout_confirm_modal = <Modal> {
+                            content: {
+                                logout_confirm_modal_inner = <LogoutConfirmModal> {}
+                            }
+                        }
+
                         // Tooltips must be shown in front of all other UI elements,
                         // since they can be shown as a hover atop any other widget.
                         app_tooltip = <CalloutTooltip> {}
@@ -171,6 +171,7 @@ impl LiveRegister for App {
         crate::home::live_design(cx);
         crate::profile::live_design(cx);
         crate::login::live_design(cx);
+        crate::logout::live_design(cx);
     }
 }
 
@@ -210,6 +211,38 @@ impl MatchEvent for App {
 
     fn handle_actions(&mut self, cx: &mut Cx, actions: &Actions) {
         for action in actions {
+            if let Some(logout_modal_action) = action.downcast_ref::<LogoutConfirmModalAction>() {
+                match logout_modal_action {
+                    LogoutConfirmModalAction::Open => {
+                        self.ui.logout_confirm_modal(id!(logout_confirm_modal_inner)).reset_state(cx);
+                        self.ui.modal(id!(logout_confirm_modal)).open(cx)
+                    },
+                    LogoutConfirmModalAction::Close { was_internal, .. } => {
+                        if *was_internal {
+                            self.ui.modal(id!(logout_confirm_modal)).close(cx);
+                        }
+                    },
+                    _ => {}
+                }
+            }
+
+            if let Some(LogoutAction::LogoutSuccess) = action.downcast_ref() {
+                self.app_state.logged_in = false;
+                self.ui.modal(id!(logout_confirm_modal)).close(cx);
+                self.update_login_visibility(cx);
+                self.ui.redraw(cx);
+                continue;
+            }
+
+            if let Some(LogoutAction::ClearAppState { on_clear_appstate }) = action.downcast_ref() {
+                // Clear user profile cache, invited_rooms timeline states 
+                clear_all_app_state(cx);
+                // Reset all app state to its default.
+                self.app_state = Default::default();
+                on_clear_appstate.notify_one();
+                continue;
+            }
+
             if let Some(LoginAction::LoginSuccess) = action.downcast_ref() {
                 log!("Received LoginAction::LoginSuccess, hiding login view.");
                 self.app_state.logged_in = true;
@@ -363,6 +396,15 @@ impl MatchEvent for App {
     }
 }
 
+/// Clears all thread-local UI caches (user profiles, invited rooms, and timeline states).
+/// The `cx` parameter ensures that these thread-local caches are cleared on the main UI thread, 
+fn clear_all_app_state(cx: &mut Cx) {
+    clear_user_profile_cache(cx);
+    clear_all_invited_rooms(cx);
+    clear_timeline_states(cx);
+    clear_avatar_cache(cx);
+}
+
 impl AppMain for App {
     fn handle_event(&mut self, cx: &mut Cx, event: &Event) {
         // if let Event::WindowGeomChange(geom) = event {

src/avatar_cache.rs

@@ -82,3 +82,12 @@ pub fn get_or_fetch_avatar(
         AvatarCacheEntry::Requested
     })
 }
+
+/// Clears cached avatars.
+/// This function requires passing in a reference to `Cx`,
+/// which acts as a guarantee that this function must only be called by the main UI thread.
+pub fn clear_avatar_cache(_cx: &mut Cx) {
+    AVATAR_NEW_CACHE.with_borrow_mut(|cache| {
+        cache.clear();
+    });
+}

src/home/main_desktop_ui.rs

@@ -1,6 +1,7 @@
 use makepad_widgets::*;
 use matrix_sdk::ruma::OwnedRoomId;
-use std::collections::HashMap;
+use tokio::sync::Notify;
+use std::{collections::HashMap, sync::Arc};
 
 use crate::{app::{AppState, AppStateAction, SelectedRoom}, utils::room_name_or_id};
 use super::{invite_screen::InviteScreenWidgetRefExt, room_screen::RoomScreenWidgetRefExt, rooms_list::RoomsListAction};
@@ -216,6 +217,27 @@ impl MainDesktopUI {
         self.open_rooms.remove(&tab_id);
     }
 
+    /// Closes all tabs
+    pub fn close_all_tabs(&mut self, cx: &mut Cx) {
+        let dock = self.view.dock(id!(dock));
+        for tab_id in self.open_rooms.keys() {        
+            dock.close_tab(cx, *tab_id);
+        }
+
+        dock.select_tab(cx, live_id!(home_tab));
+        cx.widget_action(
+            self.widget_uid(),
+            &HeapLiveIdPath::default(),
+            AppStateAction::FocusNone,
+        );
+
+        // Clear tab-related dock UI state.
+        self.open_rooms.clear();
+        self.tab_to_close = None;
+        self.room_order.clear();
+        self.most_recently_selected_room = None;
+    }
+
     /// Replaces an invite with a joined room in the dock.
     fn replace_invite_with_joined_room(
         &mut self,
@@ -268,6 +290,12 @@ impl WidgetMatchEvent for MainDesktopUI {
         for action in actions {
             let widget_action = action.as_widget_action();
 
+            if let Some(MainDesktopUiAction::CloseAllTabs { on_close_all }) = action.downcast_ref() {
+                self.close_all_tabs(cx);
+                on_close_all.notify_one();
+                continue;
+            }
+
             // Handle actions emitted by the dock within the MainDesktopUI
             match widget_action.cast() { // TODO: don't we need to call `widget_uid_eq(dock.widget_uid())` here?
                 // Whenever a tab (except for the home_tab) is pressed, notify the app state.
@@ -404,11 +432,14 @@ impl WidgetMatchEvent for MainDesktopUI {
 }
 
 /// Actions sent to the MainDesktopUI widget for saving/restoring its dock state.
-#[derive(Clone, Debug, DefaultNone)]
+#[derive(Debug)]
 pub enum MainDesktopUiAction {
     /// Save the state of the dock into the AppState.
     SaveDockIntoAppState,
     /// Load the room panel state from the AppState to the dock.
     LoadDockFromAppState,
-    None,
+    /// Close all tabs; see [`MainDesktopUI::close_all_tabs()`]
+    CloseAllTabs {
+        on_close_all: Arc<Notify>,
+    },
 }

src/home/room_screen.rs

@@ -4387,3 +4387,15 @@ impl MessageRef {
         inner.set_data(details);
     }
 }
+
+/// Clears all UI-related timeline states for all known rooms.
+///
+/// This function requires passing in a reference to `Cx`,
+/// which isn't used, but acts as a guarantee that this function
+/// must only be called by the main UI thread. 
+pub fn clear_timeline_states(_cx: &mut Cx) {
+    // Clear timeline states cache
+    TIMELINE_STATES.with_borrow_mut(|states| {
+        states.clear();
+    });
+}

src/home/rooms_list.rs

@@ -33,6 +33,17 @@ pub fn get_invited_rooms(_cx: &mut Cx) -> Rc<RefCell<HashMap<OwnedRoomId, Invite
     ALL_INVITED_ROOMS.with(Rc::clone)
 }
 
+/// Clears all invited rooms
+///
+/// This function requires passing in a reference to `Cx`,
+/// which isn't used, but acts as a guarantee that this function
+/// must only be called by the main UI thread.
+pub fn clear_all_invited_rooms(_cx: &mut Cx) {
+    ALL_INVITED_ROOMS.with(|rooms| {
+       rooms.borrow_mut().clear();
+    });
+}
+
 
 live_design! {
     use link::theme::*;

src/lib.rs

@@ -13,6 +13,8 @@ pub mod settings;
 
 /// Login screen
 pub mod login;
+/// Logout confirmation and state management
+pub mod logout;
 /// Core UI content: the main home screen (rooms list), room screen.
 pub mod home;
 /// User profile info and a user profile sliding pane.