Use display name for mention completion

Author: VAWVAW

src/base.rs

@@ -914,6 +914,9 @@ pub struct RoomInfo {
     /// The display names for users in this room.
     pub display_names: HashMap<OwnedUserId, String>,
 
+    /// Tab completion for the display names in this room.
+    pub display_name_completion: CompletionMap<String, OwnedUserId>,
+
     /// The last time the room was rendered, used to detect if it is currently open.
     pub draw_last: Option<Instant>,
 }
@@ -935,6 +938,7 @@ impl Default for RoomInfo {
             fetch_last: Default::default(),
             users_typing: Default::default(),
             display_names: Default::default(),
+            display_name_completion: Default::default(),
             draw_last: Default::default(),
         }
     }
@@ -1960,7 +1964,9 @@ impl Completer<IambInfo> for IambCompleter {
         match content {
             IambBufferId::Command(CommandType::Command) => complete_cmdbar(text, cursor, store),
             IambBufferId::Command(CommandType::Search) => vec![],
-            IambBufferId::Room(_, _, RoomFocus::MessageBar) => complete_msgbar(text, cursor, store),
+            IambBufferId::Room(room_id, _, RoomFocus::MessageBar) => {
+                complete_msgbar(text, cursor, store, room_id)
+            },
             IambBufferId::Room(_, _, RoomFocus::Scrollback) => vec![],
 
             IambBufferId::DirectList => vec![],
@@ -1991,12 +1997,19 @@ fn complete_users(text: &EditRope, cursor: &mut Cursor, store: &ChatStore) -> Ve
 }
 
 /// Tab completion within the message bar.
-fn complete_msgbar(text: &EditRope, cursor: &mut Cursor, store: &ChatStore) -> Vec<String> {
+fn complete_msgbar(
+    text: &EditRope,
+    cursor: &mut Cursor,
+    store: &mut ChatStore,
+    room_id: &RoomId,
+) -> Vec<String> {
     let id = text
         .get_prefix_word_mut(cursor, &MATRIX_ID_WORD)
         .unwrap_or_else(EditRope::empty);
     let id = Cow::from(&id);
 
+    let info = store.rooms.get_or_default(room_id.to_owned());
+
     match id.chars().next() {
         // Complete room aliases.
         Some('#') => {
@@ -2028,12 +2041,29 @@ fn complete_msgbar(text: &EditRope, cursor: &mut Cursor, store: &ChatStore) -> V
 
         // Complete usernames for @ and empty strings.
         Some('@') | None => {
-            store
-                .presences
-                .complete(id.as_ref())
+            // spec says to mention with display name in anchor text
+            let mut users: HashSet<_> = info
+                .display_name_completion
+                .complete(id.strip_prefix('@').unwrap())
                 .into_iter()
-                .map(|i| format!("[{}]({})", i, i.matrix_to_uri()))
-                .collect()
+                .map(|n| {
+                    format!(
+                        "[{}]({})",
+                        n,
+                        info.display_name_completion.get(&n).unwrap().matrix_to_uri()
+                    )
+                })
+                .collect();
+
+            users.extend(store.presences.complete(id.as_ref()).into_iter().map(|i| {
+                format!(
+                    "[{}]({})",
+                    info.display_names.get(&i).unwrap_or(&i.to_string()),
+                    i.matrix_to_uri()
+                )
+            }));
+
+            users.into_iter().collect()
         },
 
         // Unknown sigil.
@@ -2314,23 +2344,30 @@ pub mod tests {
     #[tokio::test]
     async fn test_complete_msgbar() {
         let store = mock_store().await;
-        let store = store.application;
+        let mut store = store.application;
+        let room_id = TEST_ROOM1_ID.clone();
 
         let text = EditRope::from("going for a walk :walk ");
         let mut cursor = Cursor::new(0, 22);
-        let res = complete_msgbar(&text, &mut cursor, &store);
+        let res = complete_msgbar(&text, &mut cursor, &mut store, &room_id);
         assert_eq!(res, vec![":walking:", ":walking_man:", ":walking_woman:"]);
         assert_eq!(cursor, Cursor::new(0, 17));
 
         let text = EditRope::from("hello @user1 ");
         let mut cursor = Cursor::new(0, 12);
-        let res = complete_msgbar(&text, &mut cursor, &store);
+        let res = complete_msgbar(&text, &mut cursor, &mut store, &room_id);
         assert_eq!(res, vec!["[@user1:example.com](https://matrix.to/#/@user1:example.com)"]);
         assert_eq!(cursor, Cursor::new(0, 6));
 
+        let text = EditRope::from("hello @user2 ");
+        let mut cursor = Cursor::new(0, 12);
+        let res = complete_msgbar(&text, &mut cursor, &mut store, &room_id);
+        assert_eq!(res, vec!["[User 2](https://matrix.to/#/@user2:example.com)"]);
+        assert_eq!(cursor, Cursor::new(0, 6));
+
         let text = EditRope::from("see #room ");
         let mut cursor = Cursor::new(0, 9);
-        let res = complete_msgbar(&text, &mut cursor, &store);
+        let res = complete_msgbar(&text, &mut cursor, &mut store, &room_id);
         assert_eq!(res, vec!["[#room1:example.com](https://matrix.to/#/%23room1:example.com)"]);
         assert_eq!(cursor, Cursor::new(0, 4));
     }

src/tests.rs

@@ -154,6 +154,12 @@ pub fn mock_room() -> RoomInfo {
     room.name = Some("Watercooler Discussion".into());
     room.keys = mock_keys();
     *room.get_thread_mut(None) = mock_messages();
+
+    let user_id = TEST_USER2.clone();
+    let name = "User 2";
+    room.display_names.insert(user_id.clone(), name.to_string());
+    room.display_name_completion.insert(name.to_string(), user_id.clone());
+
     room
 }
 

src/worker.rs

@@ -424,7 +424,8 @@ fn members_insert(
             let user_id = member.user_id();
             let display_name =
                 member.display_name().map_or(user_id.to_string(), |str| str.to_string());
-            info.display_names.insert(user_id.to_owned(), display_name);
+            info.display_names.insert(user_id.to_owned(), display_name.clone());
+            info.display_name_completion.insert(display_name, user_id.to_owned());
         }
     }
     // else ???
@@ -1136,11 +1137,18 @@ impl ClientWorker {
                     let info = locked.application.get_room_info(room_id.to_owned());
 
                     if ambiguous {
-                        info.display_names.remove(&user_id);
+                        let old_name = info.display_names.remove(&user_id);
+                        if let Some(old_name) = old_name {
+                            info.display_name_completion.remove(&old_name);
+                        }
                     } else if let Some(display) = ev.content.displayname {
-                        info.display_names.insert(user_id, display);
+                        info.display_names.insert(user_id.clone(), display.clone());
+                        info.display_name_completion.insert(display, user_id);
                     } else {
-                        info.display_names.remove(&user_id);
+                        let old_name = info.display_names.remove(&user_id);
+                        if let Some(old_name) = old_name {
+                            info.display_name_completion.remove(&old_name);
+                        }
                     }
                 }
             },