feat(multiverse): Add search feature to multiverse

Author: dragonfly1033

crates/matrix-sdk-search/src/index.rs

@@ -78,7 +78,7 @@ impl RoomIndex {
     pub fn new(path: &Path, room_id: &RoomId) -> Result<RoomIndex, IndexError> {
         let path = path.join(room_id.as_str());
         let schema = RoomMessageSchema::new();
-        fs::create_dir(path.clone())?;
+        fs::create_dir_all(path.clone())?;
         let index = Index::create_in_dir(path, schema.as_tantivy_schema())?;
         RoomIndex::new_with(index, schema, room_id)
     }
@@ -99,9 +99,11 @@ impl RoomIndex {
             Ok(dir) => Ok(dir),
             Err(err) => match err {
                 OpenDirectoryError::DoesNotExist(path) => {
-                    fs::create_dir(path.clone()).map_err(|err| OpenDirectoryError::IoError {
-                        io_error: Arc::new(err),
-                        directory_path: path.to_path_buf(),
+                    fs::create_dir_all(path.clone()).map_err(|err| {
+                        OpenDirectoryError::IoError {
+                            io_error: Arc::new(err),
+                            directory_path: path.to_path_buf(),
+                        }
                     })?;
                     MmapDirectory::open(path)
                 }

crates/matrix-sdk/src/lib.rs

@@ -67,6 +67,8 @@ pub mod widget;
 
 pub use account::Account;
 pub use authentication::{AuthApi, AuthSession, SessionTokens};
+#[cfg(feature = "experimental-search")]
+pub use client::search::SearchIndexStoreKind;
 pub use client::{
     sanitize_server_name, Client, ClientBuildError, ClientBuilder, LoopCtrl, ServerVendorInfo,
     SessionChange,

labs/multiverse/Cargo.toml

@@ -20,7 +20,7 @@ futures-util.workspace = true
 imbl.workspace = true
 indexmap.workspace = true
 itertools.workspace = true
-matrix-sdk = { path = "../../crates/matrix-sdk", features = ["sso-login"] }
+matrix-sdk = { path = "../../crates/matrix-sdk", features = ["sso-login", "experimental-search"] }
 matrix-sdk-base = { path = "../../crates/matrix-sdk-base" }
 matrix-sdk-common = { path = "../../crates/matrix-sdk-common" }
 matrix-sdk-ui = { path = "../../crates/matrix-sdk-ui" }

labs/multiverse/src/main.rs

@@ -20,8 +20,8 @@ use futures_util::{StreamExt as _, pin_mut};
 use imbl::Vector;
 use layout::Flex;
 use matrix_sdk::{
-    AuthSession, Client, SqliteCryptoStore, SqliteEventCacheStore, SqliteStateStore,
-    ThreadingSupport,
+    AuthSession, Client, SearchIndexStoreKind, SqliteCryptoStore, SqliteEventCacheStore,
+    SqliteStateStore, ThreadingSupport,
     authentication::matrix::MatrixSession,
     config::StoreConfig,
     encryption::{BackupDownloadStrategy, EncryptionSettings},
@@ -38,7 +38,7 @@ use matrix_sdk_ui::{
 use ratatui::{prelude::*, style::palette::tailwind, widgets::*};
 use throbber_widgets_tui::{Throbber, ThrobberState};
 use tokio::{spawn, task::JoinHandle};
-use tracing::{error, warn};
+use tracing::{debug, error, warn};
 use tracing_subscriber::EnvFilter;
 use widgets::{
     recovery::create_centered_throbber_area, room_view::RoomView, settings::SettingsView,
@@ -48,6 +48,7 @@ use crate::widgets::{
     create_room::CreateRoomView,
     help::HelpView,
     room_list::{ExtraRoomInfo, RoomInfos, RoomList, Rooms},
+    search::SearchingView,
     status::Status,
 };
 
@@ -88,6 +89,8 @@ pub enum GlobalMode {
     Exiting { shutdown_task: JoinHandle<()> },
     /// Mode where we have opened create room screen
     CreateRoom { view: CreateRoomView },
+    /// Mode where we have opened create room screen
+    Searching { view: SearchingView },
 }
 
 /// Helper function to create a centered rect using up certain percentage of the
@@ -358,6 +361,10 @@ impl App {
                 self.set_global_mode(GlobalMode::CreateRoom { view: CreateRoomView::new() })
             }
 
+            Event::Key(KeyEvent { modifiers: KeyModifiers::CONTROL, code: Char('s'), .. }) => {
+                self.set_global_mode(GlobalMode::Searching { view: SearchingView::new() })
+            }
+
             _ => self.room_view.handle_event(event).await,
         }
 
@@ -371,6 +378,7 @@ impl App {
             GlobalMode::Help
             | GlobalMode::Default
             | GlobalMode::CreateRoom { .. }
+            | GlobalMode::Searching { .. }
             | GlobalMode::Exiting { .. } => {}
             GlobalMode::Settings { view } => {
                 view.on_tick();
@@ -448,6 +456,29 @@ impl App {
                             }
                         }
                     }
+                    GlobalMode::Searching { view } => {
+                        if let Event::Key(key) = event
+                            && let KeyModifiers::NONE = key.modifiers
+                        {
+                            match key.code {
+                                Enter => {
+                                    if let Some(query) = view.get_text() {
+                                        if let Some(room) = self.room_view.room() {
+                                            if let Some(results) = room.search(&query, 100).await {
+                                                view.results(results);
+                                            } else {
+                                                debug!("No results found in search.")
+                                            }
+                                        } else {
+                                            warn!("No room in view.")
+                                        }
+                                    }
+                                }
+                                Esc => self.set_global_mode(GlobalMode::Default),
+                                _ => view.handle_key_press(key),
+                            }
+                        }
+                    }
                     GlobalMode::Exiting { .. } => {}
                 }
             }
@@ -456,6 +487,7 @@ impl App {
                 GlobalMode::Default
                 | GlobalMode::Help
                 | GlobalMode::CreateRoom { .. }
+                | GlobalMode::Searching { .. }
                 | GlobalMode::Settings { .. } => {}
                 GlobalMode::Exiting { shutdown_task } => {
                     if shutdown_task.is_finished() {
@@ -523,6 +555,9 @@ impl Widget for &mut App {
             GlobalMode::CreateRoom { view } => {
                 view.render(area, buf);
             }
+            GlobalMode::Searching { view } => {
+                view.render(area, buf);
+            }
         }
     }
 }
@@ -556,7 +591,8 @@ async fn configure_client(cli: Cli) -> Result<Client> {
             auto_enable_backups: true,
         })
         .with_enable_share_history_on_invite(true)
-        .with_threading_support(ThreadingSupport::Enabled { with_subscriptions: true });
+        .with_threading_support(ThreadingSupport::Enabled { with_subscriptions: true })
+        .search_index_store(SearchIndexStoreKind::Directory(session_path.join("indexData")));
 
     if let Some(proxy_url) = proxy {
         client_builder = client_builder.proxy(proxy_url).disable_ssl_verification();

labs/multiverse/src/widgets/help.rs

@@ -65,6 +65,7 @@ impl Widget for &mut HelpView {
                 Cell::from("Open a thread on the focused timeline item"),
             ]),
             Row::new(vec![Cell::from("Ctrl-r"), Cell::from("Create a new room")]),
+            Row::new(vec![Cell::from("Ctrl-s"), Cell::from("Search")]),
         ];
         let widths = [Constraint::Length(5), Constraint::Length(5)];
 

labs/multiverse/src/widgets/mod.rs

@@ -7,6 +7,7 @@ pub mod popup_input;
 pub mod recovery;
 pub mod room_list;
 pub mod room_view;
+pub mod search;
 pub mod settings;
 pub mod status;
 

labs/multiverse/src/widgets/room_view/mod.rs

@@ -189,7 +189,8 @@ impl RoomView {
         }
     }
 
-    fn room(&self) -> Option<Room> {
+    /// Get currently focused [`Room`]
+    pub fn room(&self) -> Option<Room> {
         self.room_id().and_then(|room_id| self.client.get_room(room_id))
     }
 

labs/multiverse/src/widgets/search/mod.rs

@@ -0,0 +1,68 @@
+use crossterm::event::KeyEvent;
+use matrix_sdk::ruma::OwnedEventId;
+use ratatui::{
+    layout::Flex,
+    prelude::*,
+    widgets::{Block, Borders, Cell, Clear, Padding, Row, Table, TableState},
+};
+
+use crate::widgets::popup_input::PopupInput;
+
+#[derive(Default)]
+pub struct SearchingView {
+    input: PopupInput,
+    results: Option<Vec<OwnedEventId>>,
+}
+
+impl SearchingView {
+    pub fn new() -> Self {
+        Self {
+            input: PopupInput::new("Search", "(Enter search query)")
+                .height_constraint(Constraint::Percentage(100))
+                .width_constraint(Constraint::Percentage(100)),
+            results: None,
+        }
+    }
+
+    pub fn results(&mut self, values: Vec<OwnedEventId>) {
+        self.results = Some(values);
+    }
+
+    pub fn get_text(&self) -> Option<String> {
+        let name = self.input.get_input();
+        if !name.is_empty() { Some(name) } else { None }
+    }
+
+    pub fn handle_key_press(&mut self, key: KeyEvent) {
+        self.input.handle_key_press(key);
+    }
+}
+
+impl Widget for &mut SearchingView {
+    fn render(self, area: Rect, buf: &mut Buffer) {
+        let vertical = Layout::vertical([Constraint::Length(3), Constraint::Percentage(80)])
+            .flex(Flex::Center);
+        let horizontal = Layout::horizontal([Constraint::Percentage(50)]).flex(Flex::Center);
+        let [area] = horizontal.areas(area);
+        let [search_area, results_area] = vertical.areas(area);
+
+        let rows = if let Some(results) = &self.results {
+            results
+                .iter()
+                .map(|ev_id| Row::new([Cell::new(ev_id.to_string())]))
+                .collect::<Vec<Row<'_>>>()
+        } else {
+            vec![Row::new([Cell::new("No results found!")])]
+        };
+
+        let block =
+            Block::bordered().title(" Search ").borders(Borders::ALL).padding(Padding::left(2));
+
+        let results_table = Table::new(rows, [Constraint::Percentage(100)]).block(block);
+
+        Clear.render(results_area, buf);
+        StatefulWidget::render(results_table, results_area, buf, &mut TableState::default());
+
+        self.input.render(search_area, buf);
+    }
+}

labs/multiverse/src/widgets/status.rs

@@ -130,6 +130,7 @@ impl StatefulWidget for &mut Status {
                 GlobalMode::Help => "Press q to exit the help screen",
                 GlobalMode::Settings { .. } => "Press ESC to exit the settings screen",
                 GlobalMode::CreateRoom { .. } => "Press ESC to exit the create room screen",
+                GlobalMode::Searching { .. } => "Press ESC to exit the search screen",
                 GlobalMode::Default => "Press F1 to show the help screen",
                 GlobalMode::Exiting { .. } => "",
             }