Fix @mention search performance and refactor search functionality #614

ZhangHanDong · 2025-10-22T03:34:31Z

Fixed issue #506

This is a remastered version of the PR #550 .

Add a lightweight cpu_worker thread that stays alive for the app lifetime and runs CPU-bound jobs (currently the room-member search); App::handle_startup initializes it and widgets enqueue work via cpu_worker::spawn_cpu_job.
Rework MentionableTextInput into an explicit state machine with search IDs, cancellation tokens, loading/empty UI states, and streaming updates that arrive over the background worker channel.
Replace the old MatrixRequest::SearchRoomMembers path: sliding_sync now fetches joined-member lists directly, emits RoomMembersListFetched, and RoomScreen caches those members plus precomputed sort data for downstream widgets.
Refactor room/member_search.rs to support batched streaming, cancellation, richer match heuristics, optional precomputed sort reuse, and add unit tests for the new helpers.

There are three related issues that still need to be fixed.

#615
#617

…reuse BouncingDots

kevinaboos · 2025-10-22T20:46:59Z

@alanpoon & @tyreseluo, can you please give this a review before I dig in? Thanks.

tyreseluo · 2025-10-23T04:42:51Z

@alanpoon & @tyreseluo, can you please give this a review before I dig in? Thanks.

yep, i will.

…tartup so CPU-bound work like member searches runs off the UI thread. - Reworked mention search to enqueue jobs on the CPU worker with cancellation tokens, unique search IDs, and better handling of loading state when the member list is still fetching. - Updated room loading and sync flow to fetch the full member list from the homeserver and deliver it through a new RoomMembersListFetched timeline update, removing the old MatrixRequest::SearchRoomMembers path. - Refactored the member search algorithm for batching, cancellation, richer match strategies, and added unit tests for the new helpers.

…tion bug after re-login

…ix into fixed-issue-452

ZhangHanDong · 2025-10-28T04:07:15Z

Review suggestions:
• Select a large room (thousands or tens of thousands of members), @ a user, and search.
• Continue testing in rooms with more than 50 members.
• Continue testing in rooms with fewer than 50 members.
• Close large/small rooms, reopen them, and continue testing.
• Logout, then login again, and rerun the above four steps.

alanpoon

Overall the performance of loading the mentionable list seems to be impacted.
There's seem too many fields added MentionableTextInput.
There's also bug when clicking the user from mentionable list, it does not apply into the text box.
The search does not work after "comma".

5. There should not be "Notify the Room" for direct message.

alanpoon · 2025-10-29T05:16:24Z

src/sliding_sync.rs

+                    match timeline.room().members(RoomMemberships::JOIN).await {
+                        Ok(members) => {
+                            let count = members.len();
+                            log!("Fetched {count} members for room {room_id} after sync.");
+                            if let Err(err) = sender.send(TimelineUpdate::RoomMembersListFetched { members }) {
+                                warning!("Failed to send RoomMembersListFetched update for room {room_id}: {err:?}");
+                            } else {
+                                SignalToUI::set_ui_signal();
+                            }
+                        }
+                        Err(err) => {
+                            warning!("Failed to fetch room members from server for room {room_id}: {err:?}");
+                        }
+                    }


There is already timeline.fetched_members above. This looks like a redundant call. There is extra matrix sqlite call. This could explain why this PR is slower when loading the mentionable list.
It looks like the mentionable list still loads even this change is reverted.

src/home/room_screen.rs

src/room/member_search.rs

src/cpu_worker.rs

alanpoon · 2025-10-29T09:01:39Z

src/room/member_search.rs

+    sender: &Sender<SearchResult>,
+    cancel_token: &Option<Arc<AtomicBool>>,
+    search_id: u64,
+    search_text: &Arc<String>,


No need for Arc

alanpoon · 2025-10-29T09:18:03Z

src/shared/mentionable_text_input.rs

+        if self.is_searching() {
+            if let Event::KeyUp(key_event) = event {
+                if key_event.key_code == KeyCode::Escape {
+                    self.cancel_active_search();


After pressing KeyCode::Escaope, it is not cancelled. is_cancelled does not return true,

Screen.Recording.2025-11-28.at.10.54.10.PM.mov

Clear the cache.

Login

Go to Matrix HQ room

Quickly type "@", ensure it shows "Loading"

Quickly press "ESC"

The popup closes, but reopens after search result returns.

This should show that is_cancelled will never return "True.

alanpoon · 2025-10-29T09:18:49Z

src/shared/mentionable_text_input.rs

+            // ESC key is now handled in the main event handler using KeyUp event
+            // This avoids conflicts with escaped() method being consumed by other components
+


can be removed

alanpoon · 2025-10-29T09:25:47Z

src/shared/mentionable_text_input.rs

+                                // Force a fresh search now that members are available
+                                let search_text = self.cmd_text_input.search_text();
+                                self.last_search_text = None;
+                                self.update_user_list(cx, &search_text, scope);


There is a cyclic dependencies. MentionableTextInputAction::RoomMembersLoaded -> "update_user_list" -> submit_async_request(MatrixRequest::GetRoomMembers) -> TimelineUpdate::RoomMembersListFetched -> MentionableTextInputAction::RoomMembersLoaded

alanpoon · 2025-10-29T09:32:58Z

src/shared/mentionable_text_input.rs

+        if is_complete {
+            self.search_results_pending = false;
+            // Search is complete - get results for final UI update
+            let final_results = if let MentionSearchState::Searching {
+                accumulated_results,
+                ..
+            } = &self.search_state
+            {
+                accumulated_results.clone()
+            } else {
+                Vec::new()
+            };
+
+            if final_results.is_empty() {


For some reason, when it is loading, the search result is complete but is final results is empty. Hence result the overall code has several checks.

…omScreenProps

…digest locking/sends in sliding sync

…ix into fixed-issue-452

…tion

ZhangHanDong · 2025-11-26T05:58:03Z

@kevinaboos

Current PR progress:

Fix the issue where remote sync of members does not work after logout-login
- Previously, after logging out and then logging back in, remote synchronization of room members failed to trigger properly
- The relevant state reset logic has been corrected
Remove the behavior of automatically deleting the local members cache after closing a tab
- This behavior is considered unnecessary and harms the user experience
- In the future, a setting can be added to manually clear local cached data
Optimize the member list loading experience
- Automatically check local cached
members; if a cache exists, render the user list immediately without waiting for remote data
- Each room performs remote synchronization only once per application session
- During synchronization, show a loading
animation at the bottom of the user list; it will disappear automatically after sync completes
Fix the issue where the cursor disappears after clicking to select a mention user with the mouse
- Previously, after clicking to select a user in the mention
popup, the cursor would blink and then disappear, making it impossible to continue typing
- Resolved by retrying the focus restoration mechanism in draw_walk
Fix duplicate room tabs after app restart or logout-login
- Previously, restoring rooms could create duplicate tabs
- Avoided by looking up existing tabs based on room_id

Remote sync room_members trigger conditions:

Remote member synchronization (SyncRoomMemberList) is triggered in the following cases:

First time opening a room after the application starts
Login again after Logout
Switching to a new room that has never been loaded

Note: Within the same application session, closing a room tab
and reopening it will not trigger remote synchronization again.

The current code still needs another review; functional testing can proceed first.

alanpoon · 2025-11-28T14:13:57Z

src/shared/mentionable_text_input.rs

+                accumulated_results.clone()
+            } else {
+                Vec::new()
+            };

-        // Clear old list items, prepare to populate new list
-        self.cmd_text_input.clear_items();
+            if !results_for_ui.is_empty() {


No need to clone the accumulated_results just to get the length for the results for ui.

alanpoon · 2025-11-28T14:15:33Z

src/shared/mentionable_text_input.rs

+                accumulated_results.clone()
+            } else {
+                Vec::new()
+            };
+
+            if final_results.is_empty() {


Same as above

alanpoon · 2025-11-28T14:16:38Z

src/shared/mentionable_text_input.rs

+            accumulated_results.clone()
+        } else {
+            Vec::new()
+        };
+
+        // Add user mention items using the results
+        if !results_to_display.is_empty() {


Same as above

alanpoon · 2025-11-28T14:22:56Z

src/shared/mentionable_text_input.rs

+            if disconnected {
+                // Channel was closed - search completed or failed
+                self.search_results_pending = false;
+                self.handle_search_channel_closed(cx, scope);
+            }


Should it return "False" when the channel is closed? It is still check_search_channel even after search_channel_closed is closed.

alanpoon · 2025-11-28T14:59:34Z

src/shared/mentionable_text_input.rs

+        if self.is_searching() {
+            if let Event::KeyUp(key_event) = event {
+                if key_event.key_code == KeyCode::Escape {
+                    self.cancel_active_search();


Screen.Recording.2025-11-28.at.10.54.10.PM.mov

Clear the cache.

Login

Go to Matrix HQ room

Quickly type "@", ensure it shows "Loading"

Quickly press "ESC"

The popup closes, but reopens after search result returns.

This should show that is_cancelled will never return "True.

src/cpu_worker.rs

alanpoon · 2025-12-01T07:00:27Z

src/sliding_sync.rs

 pub async fn clear_app_state(config: &LogoutConfig) -> Result<()> {
+    // Get the database path before clearing CLIENT
+    // We need this to delete the Matrix SDK database after logout
+    let db_path_to_delete = if let Some(user_id) = current_user_id() {
+        use crate::persistence::session_file_path;


Not sure how deleting the Matrix SDK database after logout is related to this PR.

ZhangHanDong added 3 commits October 22, 2025 11:31

Streamlined @mention member search: precompute sort, stream results, …

2fcd9ed

…reuse BouncingDots

Merge branch 'main' into fixed-issue-452

c6df225

fixed fmt

3c9ec1a

ZhangHanDong requested a review from kevinaboos October 22, 2025 18:17

ZhangHanDong added the waiting-on-review This issue is waiting to be reviewed label Oct 22, 2025

kevinaboos requested review from alanpoon and tyreseluo October 22, 2025 20:46

ZhangHanDong added 2 commits October 23, 2025 14:54

Merge branch 'main' into fixed-issue-452

a009763

fixed Conflict

e93fd1e

kevinaboos mentioned this pull request Oct 23, 2025

Tighten mention search loading-state detection #616

Closed

ZhangHanDong added 2 commits October 25, 2025 00:51

Merge branch 'main' into fixed-issue-452

22bec53

ZhangHanDong 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 Oct 25, 2025

ZhangHanDong added 2 commits October 26, 2025 20:39

Introduced a CPU worker for member search and fixed the loading anima…

777967d

…tion bug after re-login

Merge branch 'fixed-issue-452' of github.com-robrix:ZhangHanDong/robr…

5938646

…ix into fixed-issue-452

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 Oct 26, 2025

Merge branch 'main' into fixed-issue-452

2d0abd0

alanpoon reviewed Oct 29, 2025

View reviewed changes

ZhangHanDong 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 Oct 30, 2025

ZhangHanDong added 5 commits November 1, 2025 02:30

fixed bug

048000b

Block @room mentions in direct rooms by plumbing is_direct through Ro…

d31c12a

…omScreenProps

Render the user list immediately once the local user data is retrieved

bb916a0

fixed logout-login bug

8d29838

refactor mentionable text input

89decb1

ZhangHanDong added 6 commits November 24, 2025 17:07

refactor mentionable text input

ac5414d

Merge branch 'main' into fixed-issue-452

480a52f

Deduplicate member list updates by hashing avatar/role and hardening …

75dc668

…digest locking/sends in sliding sync

Merge branch 'fixed-issue-452' of github.com-robrix:ZhangHanDong/robr…

be1321a

…ix into fixed-issue-452

fixed conflict

bb5e83e

Fix duplicate room tabs on restore and focus loss after mention selec…

df504c2

…tion

alanpoon reviewed Dec 1, 2025

View reviewed changes

		// ESC key is now handled in the main event handler using KeyUp event
		// This avoids conflicts with escaped() method being consumed by other components

Fix @mention search performance and refactor search functionality #614

Are you sure you want to change the base?

Fix @mention search performance and refactor search functionality #614

Uh oh!

Conversation

ZhangHanDong commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevinaboos commented Oct 22, 2025

Uh oh!

tyreseluo commented Oct 23, 2025

Uh oh!

ZhangHanDong commented Oct 28, 2025

Uh oh!

alanpoon left a comment • 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

ZhangHanDong commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ZhangHanDong commented Oct 22, 2025 •

edited

Loading

alanpoon left a comment •

edited

Loading

ZhangHanDong commented Nov 26, 2025 •

edited

Loading