From 949cd78d9472bf7b5ca410081a515810301b3483 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Mon, 11 Nov 2024 16:51:03 +0100 Subject: [PATCH] refactor: Move `event_cache_store/` to `event_cache/store/` in `matrix-sdk-base`. --- crates/matrix-sdk-base/src/client.rs | 2 +- crates/matrix-sdk-base/src/event_cache/mod.rs | 15 +++++++++++++++ .../store}/integration_tests.rs | 8 +++++--- .../store}/memory_store.rs | 0 .../store}/mod.rs | 0 .../store}/traits.rs | 0 crates/matrix-sdk-base/src/lib.rs | 2 +- crates/matrix-sdk-base/src/store/mod.rs | 2 +- crates/matrix-sdk-sqlite/src/error.rs | 2 +- crates/matrix-sdk-sqlite/src/event_cache_store.rs | 6 +++--- crates/matrix-sdk/src/client/builder/mod.rs | 2 +- crates/matrix-sdk/src/client/mod.rs | 2 +- crates/matrix-sdk/src/error.rs | 2 +- crates/matrix-sdk/src/send_queue.rs | 4 ++-- 14 files changed, 32 insertions(+), 15 deletions(-) create mode 100644 crates/matrix-sdk-base/src/event_cache/mod.rs rename crates/matrix-sdk-base/src/{event_cache_store => event_cache/store}/integration_tests.rs (97%) rename crates/matrix-sdk-base/src/{event_cache_store => event_cache/store}/memory_store.rs (100%) rename crates/matrix-sdk-base/src/{event_cache_store => event_cache/store}/mod.rs (100%) rename crates/matrix-sdk-base/src/{event_cache_store => event_cache/store}/traits.rs (100%) diff --git a/crates/matrix-sdk-base/src/client.rs b/crates/matrix-sdk-base/src/client.rs index 8fec8251d..a65d3e34e 100644 --- a/crates/matrix-sdk-base/src/client.rs +++ b/crates/matrix-sdk-base/src/client.rs @@ -70,7 +70,7 @@ use crate::RoomMemberships; use crate::{ deserialized_responses::{RawAnySyncOrStrippedTimelineEvent, SyncTimelineEvent}, error::{Error, Result}, - event_cache_store::EventCacheStoreLock, + event_cache::store::EventCacheStoreLock, response_processors::AccountDataProcessor, rooms::{ normal::{RoomInfoNotableUpdate, RoomInfoNotableUpdateReasons}, diff --git a/crates/matrix-sdk-base/src/event_cache/mod.rs b/crates/matrix-sdk-base/src/event_cache/mod.rs new file mode 100644 index 000000000..355d613dd --- /dev/null +++ b/crates/matrix-sdk-base/src/event_cache/mod.rs @@ -0,0 +1,15 @@ +// Copyright 2024 The Matrix.org Foundation C.I.C. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +pub mod store; diff --git a/crates/matrix-sdk-base/src/event_cache_store/integration_tests.rs b/crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs similarity index 97% rename from crates/matrix-sdk-base/src/event_cache_store/integration_tests.rs rename to crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs index 6b774a081..e1ea613cf 100644 --- a/crates/matrix-sdk-base/src/event_cache_store/integration_tests.rs +++ b/crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs @@ -193,7 +193,7 @@ impl EventCacheStoreIntegrationTests for DynEventCacheStore { /// /// ## Usage Example: /// ```no_run -/// # use matrix_sdk_base::event_cache_store::{ +/// # use matrix_sdk_base::event_cache::store::{ /// # EventCacheStore, /// # MemoryStore as MyStore, /// # Result as EventCacheStoreResult, @@ -217,7 +217,9 @@ macro_rules! event_cache_store_integration_tests { () => { mod event_cache_store_integration_tests { use matrix_sdk_test::async_test; - use $crate::event_cache_store::{EventCacheStoreIntegrationTests, IntoEventCacheStore}; + use $crate::event_cache::store::{ + EventCacheStoreIntegrationTests, IntoEventCacheStore, + }; use super::get_event_cache_store; @@ -249,7 +251,7 @@ macro_rules! event_cache_store_integration_tests_time { use std::time::Duration; use matrix_sdk_test::async_test; - use $crate::event_cache_store::IntoEventCacheStore; + use $crate::event_cache::store::IntoEventCacheStore; use super::get_event_cache_store; diff --git a/crates/matrix-sdk-base/src/event_cache_store/memory_store.rs b/crates/matrix-sdk-base/src/event_cache/store/memory_store.rs similarity index 100% rename from crates/matrix-sdk-base/src/event_cache_store/memory_store.rs rename to crates/matrix-sdk-base/src/event_cache/store/memory_store.rs diff --git a/crates/matrix-sdk-base/src/event_cache_store/mod.rs b/crates/matrix-sdk-base/src/event_cache/store/mod.rs similarity index 100% rename from crates/matrix-sdk-base/src/event_cache_store/mod.rs rename to crates/matrix-sdk-base/src/event_cache/store/mod.rs diff --git a/crates/matrix-sdk-base/src/event_cache_store/traits.rs b/crates/matrix-sdk-base/src/event_cache/store/traits.rs similarity index 100% rename from crates/matrix-sdk-base/src/event_cache_store/traits.rs rename to crates/matrix-sdk-base/src/event_cache/store/traits.rs diff --git a/crates/matrix-sdk-base/src/lib.rs b/crates/matrix-sdk-base/src/lib.rs index f884448c7..0c4f394fd 100644 --- a/crates/matrix-sdk-base/src/lib.rs +++ b/crates/matrix-sdk-base/src/lib.rs @@ -28,7 +28,7 @@ mod client; pub mod debug; pub mod deserialized_responses; mod error; -pub mod event_cache_store; +pub mod event_cache; pub mod latest_event; pub mod media; pub mod notification_settings; diff --git a/crates/matrix-sdk-base/src/store/mod.rs b/crates/matrix-sdk-base/src/store/mod.rs index 1bb92c27c..c33e3259b 100644 --- a/crates/matrix-sdk-base/src/store/mod.rs +++ b/crates/matrix-sdk-base/src/store/mod.rs @@ -58,7 +58,7 @@ use tokio::sync::{broadcast, Mutex, RwLock}; use tracing::warn; use crate::{ - event_cache_store, + event_cache::store as event_cache_store, rooms::{normal::RoomInfoNotableUpdate, RoomInfo, RoomState}, MinimalRoomMemberEvent, Room, RoomStateFilter, SessionMeta, }; diff --git a/crates/matrix-sdk-sqlite/src/error.rs b/crates/matrix-sdk-sqlite/src/error.rs index df6a64413..4a1eb5be8 100644 --- a/crates/matrix-sdk-sqlite/src/error.rs +++ b/crates/matrix-sdk-sqlite/src/error.rs @@ -14,7 +14,7 @@ use deadpool_sqlite::{CreatePoolError, PoolError}; #[cfg(feature = "event-cache")] -use matrix_sdk_base::event_cache_store::EventCacheStoreError; +use matrix_sdk_base::event_cache::store::EventCacheStoreError; #[cfg(feature = "state-store")] use matrix_sdk_base::store::StoreError as StateStoreError; #[cfg(feature = "crypto-store")] diff --git a/crates/matrix-sdk-sqlite/src/event_cache_store.rs b/crates/matrix-sdk-sqlite/src/event_cache_store.rs index 87a816579..c5a21fb0a 100644 --- a/crates/matrix-sdk-sqlite/src/event_cache_store.rs +++ b/crates/matrix-sdk-sqlite/src/event_cache_store.rs @@ -3,7 +3,7 @@ use std::{borrow::Cow, fmt, path::Path, sync::Arc}; use async_trait::async_trait; use deadpool_sqlite::{Object as SqliteAsyncConn, Pool as SqlitePool, Runtime}; use matrix_sdk_base::{ - event_cache_store::EventCacheStore, + event_cache::store::EventCacheStore, media::{MediaRequestParameters, UniqueKey}, }; use matrix_sdk_store_encryption::StoreCipher; @@ -279,7 +279,7 @@ mod tests { }; use matrix_sdk_base::{ - event_cache_store::{EventCacheStore, EventCacheStoreError}, + event_cache::store::{EventCacheStore, EventCacheStoreError}, event_cache_store_integration_tests, event_cache_store_integration_tests_time, media::{MediaFormat, MediaRequestParameters, MediaThumbnailSettings}, }; @@ -387,7 +387,7 @@ mod encrypted_tests { use std::sync::atomic::{AtomicU32, Ordering::SeqCst}; use matrix_sdk_base::{ - event_cache_store::EventCacheStoreError, event_cache_store_integration_tests, + event_cache::store::EventCacheStoreError, event_cache_store_integration_tests, event_cache_store_integration_tests_time, }; use once_cell::sync::Lazy; diff --git a/crates/matrix-sdk/src/client/builder/mod.rs b/crates/matrix-sdk/src/client/builder/mod.rs index a498df9f0..f64ca2777 100644 --- a/crates/matrix-sdk/src/client/builder/mod.rs +++ b/crates/matrix-sdk/src/client/builder/mod.rs @@ -643,7 +643,7 @@ async fn build_indexeddb_store_config( let store_config = { tracing::warn!("The IndexedDB backend does not implement an event cache store, falling back to the in-memory event cache store…"); - store_config.event_cache_store(matrix_sdk_base::event_cache_store::MemoryStore::new()) + store_config.event_cache_store(matrix_sdk_base::event_cache::store::MemoryStore::new()) }; Ok(store_config) diff --git a/crates/matrix-sdk/src/client/mod.rs b/crates/matrix-sdk/src/client/mod.rs index b707691fb..9be1fcd7b 100644 --- a/crates/matrix-sdk/src/client/mod.rs +++ b/crates/matrix-sdk/src/client/mod.rs @@ -33,7 +33,7 @@ use imbl::Vector; #[cfg(feature = "e2e-encryption")] use matrix_sdk_base::crypto::store::LockableCryptoStore; use matrix_sdk_base::{ - event_cache_store::EventCacheStoreLock, + event_cache::store::EventCacheStoreLock, store::{DynStateStore, ServerCapabilities}, sync::{Notification, RoomUpdates}, BaseClient, RoomInfoNotableUpdate, RoomState, RoomStateFilter, SendOutsideWasm, SessionMeta, diff --git a/crates/matrix-sdk/src/error.rs b/crates/matrix-sdk/src/error.rs index fb08d32b4..82fe040b8 100644 --- a/crates/matrix-sdk/src/error.rs +++ b/crates/matrix-sdk/src/error.rs @@ -25,7 +25,7 @@ use matrix_sdk_base::crypto::{ CryptoStoreError, DecryptorError, KeyExportError, MegolmError, OlmError, }; use matrix_sdk_base::{ - event_cache_store::EventCacheStoreError, Error as SdkBaseError, QueueWedgeError, RoomState, + event_cache::store::EventCacheStoreError, Error as SdkBaseError, QueueWedgeError, RoomState, StoreError, }; use reqwest::Error as ReqwestError; diff --git a/crates/matrix-sdk/src/send_queue.rs b/crates/matrix-sdk/src/send_queue.rs index 196854d7a..fc419b7b4 100644 --- a/crates/matrix-sdk/src/send_queue.rs +++ b/crates/matrix-sdk/src/send_queue.rs @@ -77,7 +77,7 @@ //! no thumbnails): //! //! - The file's content is immediately cached in the -//! [`matrix_sdk_base::event_cache_store::EventCacheStore`], using an MXC ID +//! [`matrix_sdk_base::event_cache::store::EventCacheStore`], using an MXC ID //! that is temporary and designates a local URI without any possible doubt. //! - An initial media event is created and uses this temporary MXC ID, and //! propagated as a local echo for an event. @@ -139,7 +139,7 @@ use std::{ use as_variant::as_variant; use matrix_sdk_base::{ - event_cache_store::EventCacheStoreError, + event_cache::store::EventCacheStoreError, media::MediaRequestParameters, store::{ ChildTransactionId, DependentQueuedRequest, DependentQueuedRequestKind,